Skip to content
SHC Docs

shc

Selfhosted Cloud CLI

Selfhosted Cloud command-line interface.

Manage applications, deployments, backups, tenants, integrations and the cluster from a single tool.

--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)
-h, --help help for shc
-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)
  • shc adapter - work with foreign self-hosting platforms (see shc adapter ls)
  • shc addon - manage the add-ons an app publishes
  • shc auth - authenticate the CLI against a cluster
  • shc backup - create and manage backups
  • shc branding - manage brand asset bundles for the branding socket
  • shc ca - manage per-tenant certificate authorities
  • shc catalog - browse what the registered repositories publish
  • shc cert - inspect certificates (RBAC-filtered)
  • shc clone - clone a deployment
  • shc cluster - manage cluster nodes and membership
  • shc completion - generate shell completions
  • shc config - view and set configuration
  • shc connection - manage backend connections and their providers
  • shc constraint - set, list and clear placement constraints
  • shc container - act on one container of a deployment
  • shc convert - print the shc.yaml an app’s compose.yaml becomes
  • shc cron - inspect registered cron jobs
  • shc ctx - manage CLI contexts
  • shc db - inspect and maintain the control-plane database
  • shc deploy - deploy the deployments declared in one or more .shc.yaml deployfiles
  • shc dns - show the DNS records shc published
  • shc doctor - diagnose and fix system issues
  • shc events - list recent system events; -f follows them live
  • shc exec - run a command in a service container
  • shc export - export deployment data to an archive
  • shc finish-forward - finish an interrupted move or rename that the daemon refused to resolve itself
  • shc forward - forward local ports to deployment services
  • shc hud - open the platform TUI (k9s’s UX over the SHC provider)
  • shc import - import deployment data from an archive
  • shc ingress - show the rendered traefik ingress (routes, gates, drift)
  • shc init - initialize a new cluster
  • shc inspect - inspect deployment files and rendered configuration
  • shc install - install an application
  • shc integration - manage integrations
  • shc interrupted - list moves and renames this node was interrupted in the middle of
  • shc job - manage jobs
  • shc label - list and describe label values
  • shc leader - leader-state queries (am-I-leader, node health)
  • shc lease - manage a deployment’s TTL lease
  • shc license - manage this estate’s SHC EE license
  • shc logs - view deployment logs
  • shc ls - list deployments
  • shc mcp - serve the SHC API to AI agents over MCP
  • shc node - manage and inspect cluster nodes
  • shc notification - list, test and emit through notification routing rules
  • shc operation - list, follow or cancel operations
  • shc portal - register this cluster with the Selfhosted Cloud Portal
  • shc protect - refuse uninstall/destroy of a deployment (it can still be moved)
  • shc quota - manage resource quotas and limits
  • shc rebalance - plan or run the moves that even out load across nodes
  • shc reclaim - free the moved-from data a relocation kept on this node
  • shc reconcile - re-ensure the modules
  • shc recover - recover deployments from backup archives
  • shc rename - rename a deployment
  • shc repo - manage app repositories
  • shc repoint - move a deployment’s recorded source onto a catalogue app or a git remote (renders nothing)
  • shc restart - restart a deployment or service
  • shc retention - manage backup retention policies
  • shc roll-back - roll an interrupted rename back to its source name
  • shc run - run a container from an image beside a deployment
  • shc scan - scan app and deployment images for vulnerabilities
  • shc schedule - manage scheduled tasks
  • shc search - search available applications
  • shc shell - open a shell inside a container
  • shc show - show one application and the exact command that installs it
  • shc start - start a deployment or service
  • shc status - show deployment and service health
  • shc stop - stop a deployment or service
  • shc storage - manage storage providers
  • shc support - support and diagnostics
  • shc system - manage the platform’s modules
  • shc task - inspect background tasks and workers
  • shc tenant - manage tenants
  • shc uninstall - uninstall a deployment (full teardown; backs up first)
  • shc unprotect - lift a deployment’s destroy protection
  • shc update - update a deployment
  • shc user - manage users and access roles
  • shc validate - validate app and deployment configuration
  • shc vault - manage secrets and credentials
  • shc version - print the version
  • shc volume - manage and inspect cluster block volumes
  • shc workshop - open a workshop in tmux, the pages on the left and a tab per node on the right