Skip to content
SHC Docs

Command overview

PatternExamples
shc <action>install, uninstall, ls, status, init
shc <module> <action>backup create, vault set, cluster status
shc <module> lsbackup ls, vault ls, node ls
shc <module> <subcommand>cluster nodes, cluster ping
  • --stack, -s - Stack name
  • --environment, -e - Environment name
  • --tenant, -t - Tenant name
  • --output, -o - Output format (tty, json, yaml, text)
  • --debug - Enable debug logging

Output behavior is owned by the output contract — that doc is normative and supersedes the output sections of older references. In short: the global -o, --output flag selects tty | text | json | yaml; the default is tty when stdout is a terminal and text when piped. Data (tables, documents, result lines) goes to stdout; chrome (progress, warnings, hints, prompts, errors) goes to stderr, so pipes capture clean data. All four modes work on every command.