Skip to content
SHC Docs

shc recover

recover deployments from backup archives

Flags as shc recover registers them (ce modules/app/commands/stack_lifecycle.go). The generated page with the full help text is shc_recover.

This is a single-action command (no subcommands). It takes no node: to hold a recovered deployment to a place, change its --where afterwards (Relocating a deployment).

FlagTypeRequiredHelp
-b / --from-backuplist[str]nobackup file to recover from (<backup>[=<target>]; repeatable)
-f / --filestrnosingle backup file to recover from (.bak or .bkg)
--consistency-idstrnorecover a consistency group directly from the restic store, no .bkg export; takes precedence over --file and --from-backup
-e / --environmentstrnotarget environment
--skip-integrationlist[str]noskip integration during recovery
--renamelist[str]norename stacks during recovery (<old>=<new>)
--overridelist[str]nooverride ingress hostnames ([<stack>:]host:<old>=<new> or [<stack>:]hosts=<new>)
--runtimestrnotarget runtime (docker, podman, incus or apple)
--storagestrnostorage backend for every recovered stack, overriding the one recorded in each backup
--secrets-passwordlist[str]nocandidate password to decrypt backup secrets (repeatable; tried after the vault master)
--secrets-password-filelist[str]nofile of newline-separated candidate passwords (repeatable)
--dry-runboolnoshow what would be recovered without executing
-y / --yesboolnoskip the confirmation prompt