Skip to content
SHC Docs

shc backup

create and manage backups

Create, list, restore, and manage backups.

Scheduled backups go into the cluster’s restic repository and nowhere else: encrypted, indexed in the ledger, verifiable, mountable, swept by retention. There is no local backups folder.

A .bak file is the one-off format, and it does exactly three things:

export shc backup create --file <dir|path> and shc backup export -i <id> --file <dir|path> write one to a folder you name. There is no default folder. restore shc backup restore --file <archive> restores straight from it, here or on any other cluster. import shc backup import <archive> ingests it into the indexed store (restic snapshot plus ledger row) after checking the container adds up. Importing twice leaves one row.

A one-off .bak is not indexed, not encrypted, and never reclaimed by retention. Delete it when you are done with it.

shc backup [flags]
-h, --help help for backup
--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)