shc backup

shc backup create

Create a backup of a stack:

shc backup create --stack nextcloud
shc backup create --stack nextcloud --file ./myapp.bak
shc backup create --stack nextcloud --with-dependants
shc backup create --stack nextcloud --all-connected

shc backup ls

List backups:

shc backup ls
shc backup ls --stack nextcloud
shc backup ls --output json

For browsing backups stored in the Restic repository, use shc backup ls (above) and filter by --stack / --id. To inspect a local .bak / .bkg file’s manifest, see shc backup inspect below.

shc backup restore

Restore data to an existing stack:

shc backup restore --file /tmp/myapp.bak
shc backup restore --file /tmp/myapp.bak --stack myapp
shc backup restore --id abc123 --stack myapp

# Time-based restore (relative intervals only)
shc backup restore --stack myapp --before "2h"              # 2 hours ago
shc backup restore --stack myapp --before "1d"              # 1 day ago
shc backup restore --stack myapp --before "30m"             # 30 minutes ago

# Restore with connected stacks
shc backup restore --id abc123 --with-connected             # Same consistency_id
shc backup restore --id abc123 --with-dependants            # Stack and dependants

shc backup export

Export backups from Restic repository to portable .bak or .bkg files:

# Single backup -> .bak file
shc backup export --id abc123 --file /tmp/myapp.bak

# Multiple backups -> .bkg group file
shc backup export --id abc123 --id def456 --file /tmp/backups.bkg

# Export with related backups
shc backup export --stack myapp --latest --with-connected --file /tmp/group.bkg

# Export all backups from a stack
shc backup export --stack myapp --file /tmp/

shc backup import

Import .bak or .bkg files into Restic repository:

shc backup import --file /tmp/myapp.bak
shc -t other-org backup import --file /tmp/myapp.bak        # Import into different tenant
shc backup import --file /tmp/backups.bkg                    # Uses manifests for placement
shc backup import --file /tmp/myapp.bak --dry-run            # Preview without importing

shc backup verify

Confirm a backup’s snapshot still exists in its repository (a membership check — it does not scan the snapshot’s contents for corruption):

shc backup verify --id abc123
shc backup verify --file /tmp/myapp.bak

shc backup rm

Delete a backup:

shc backup rm --id abc123
shc backup rm --id abc123 --force

shc backup export —export-environment

Filter exports by environment:

shc backup export --stack myapp --export-environment prod --file /tmp/prod.bak

shc backup group

Create a .bkg (backup group) file from multiple .bak files:

shc backup group -b app.bak -b db.bak --out combined.bkg
shc backup group -b app.bak -b db.bak -b cache.bak --out /tmp/full-system.bkg

shc backup ungroup

Extract .bak files from a .bkg group file:

shc backup ungroup -i combined.bkg --out /tmp/extracted/

shc backup inspect

Display manifest information from .bak or .bkg files:

# Inspect a single backup
shc backup inspect myapp.bak

# Inspect a backup group
shc backup inspect combined.bkg

# Output formats
shc backup inspect myapp.bak --output json
shc backup inspect myapp.bak --output yaml
shc backup inspect myapp.bak --output table

shc recover

Create new deployments from backup files (top-level command):

# Single .bak file (using -f / --file)
shc recover -f myapp.bak

# Single .bkg group file (using -f / --file, auto-expands to individual .bak files)
shc recover -f combined.bkg

# Multiple .bak files (using -b / --from-backup)
shc recover -b myapp.bak -b mydb.bak
shc recover -b myapp.bak:newapp -b mydb.bak:newdb

# From .bkg group file (using -b)
shc recover -b combined.bkg
shc recover -b combined.bkg --rename oldapp:newapp --rename olddb:newdb

# Target environment and node
shc recover -f myapp.bak -e prod -n node-abc123

# Relocate specific stacks to specific nodes
shc recover -b combined.bkg --relocate myapp:node-2 --relocate mydb:node-3

# Skip integrations during recovery
shc recover -b combined.bkg --skip-integration traefik

# Override stack properties during recovery
shc recover -b combined.bkg --override myapp:stack=myapp-restored,node=node-2

# Dry run (preview without executing)
shc recover -b combined.bkg --dry-run

shc backup sync

Synchronize backup metadata with the Restic repository:

shc backup sync
shc backup sync --stack myapp

Rolling back to a safety snapshot

Install, update, and restore each take an automatic pre_* safety snapshot before changing a deployment (skip with --no-rollback). Restore one — or any point in time — with shc backup restore --before:

shc backup restore --stack myapp --before "2h"              # ~2 hours ago
shc backup restore --stack myapp --before "1d"              # ~1 day ago
shc backup restore --stack myapp --before "2026-01-05"      # Specific date