Skip to content
SHC Docs

shc backup group

bundle multiple .bak into one .bkg archive

Bundle several backups into one portable .bkg archive.

The .bkg is unencrypted: members that live in backup.repo are decrypted on the way in, so one file ends up holding every member’s data and config in the clear. For an app plus its database, that is the app’s credentials next to the database dump they open. SHC writes it readable only by its owner (0600) into an owner-only directory, but retention never prunes it: delete it yourself once it has served its purpose. To move a consistency group between clusters that share a backup.password, prefer shc recover --consistency-id <id>, which reads the group straight out of the repository and produces no plaintext at all.

shc backup group [flags]
--backup string comma-separated backup IDs or names
-b, --backup-file stringArray path to a .bak file to include (repeatable)
--dir string destination directory for the .bkg
-h, --help help for group
--out string destination .bkg file path (overrides --dir)
--config stringArray extra YAML config file to layer on top of auto-discovered config; repeatable, later files win
-d, --debug enable debug mode (default: $SHC_DEBUG)
-e, --environment string environment name (default: "prod", or "default" on an estate with no licence and no trial; $SHC_ENVIRONMENT and shc ctx -e override it, and the "master" tenant is always "default")
--exclude string comma-separated dotted paths to drop
--fields string comma-separated columns/keys to show (and their order)
--filter string comma-separated dotted paths to keep (drops everything else)
-o, --output string output format: tty|text|json|yaml (default: $SHC_OUTPUT)
-s, --stack string stack name (default: $SHC_STACK)
-t, --tenant string tenant name (default: $SHC_TENANT)
-v, --verbose verbose output (default: $SHC_VERBOSE)