Skip to content
SHC Docs

shc adapter load

shc adapter load

Section titled “shc adapter load”

load a live install off a foreign platform box (adapt it onto SHC)

Synopsis

Section titled “Synopsis”

Enumerate the apps installed on a live platform box, transpile each installed manifest through the named adapter into a native SHC package, and pull each app’s data volumes over SSH into a restore-consumable backup. is the platform the box runs (caprover|casaos|cloudron|coolify|dockge|dokploy|easypanel|portainer|runtipi|synology|truenas|umbrel|unraid). Pass an [app] id to load just one app; omit it to load every installed app the adapter accepts.

Auth: —identity (agent + password are also tried). Host keys are verified against known_hosts unless —insecure-host-key.

Multi-node platforms (coolify/caprover/portainer swarm): an app’s volumes live on the node that runs it — point the ssh target at THAT node.

—dry-run stops after transpile+materialize (no data pull).

shc adapter load <adapter> ssh://[user@]host[:port] [app] [flags]

Examples

Section titled “Examples”
  shc adapter load umbrel ssh://umbrel@10.0.0.5 nextcloud
  shc adapter load casaos ssh://root@box.local --dry-run

Options

Section titled “Options”
      --backup-dir string    directory for the pulled data backups (default <dest>/backups)
      --dest string          directory to materialize the adapted SHC packages under (default ./adapted-<adapter>)
      --dry-run              stop after transpile + materialize; do not pull any data
  -h, --help                 help for load
  -i, --identity string      ssh private key file for public-key auth
      --insecure-host-key    skip ssh host-key verification (lab / one-shot migrations only)
      --known-hosts string   known_hosts file for host-key verification (default ~/.ssh/known_hosts)
      --no-assemble          leave the pulled per-volume tars in place; do not assemble a .bak
      --no-quiesce           do not pause the app before pulling its volumes (accepts a live-volume tar)
      --password string      ssh password (also decrypts an encrypted --identity)
      --root string          override the platform's install base directory on the box (e.g. a non-default runtipi root)

Options inherited from parent commands

Section titled “Options inherited from parent commands”
      --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: $SHC_ENVIRONMENT)
      --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)

SEE ALSO

Section titled “SEE ALSO”
  • shc adapter - work with foreign self-hosting platforms (see shc adapter ls)