Skip to content
SHC Docs

shc run

run a container from an image beside a deployment

Run a container from an image for the deployment -s names, through the container broker, on a node that holds one of its replicas. It prints the container’s output and fails when the container exits non-zero, and the container is removed. --network deployment puts it on every network of the deployment, where its replicas reach it by --name; --network container: puts it in the network namespace of the deployment’s detached run of that name; with neither it has loopback alone. --detach starts it and returns: it runs until a later detached run of its name replaces it or the deployment is removed.

shc run [flags] <image> [<arg>...]
shc -s mailcow run --entrypoint /bin/sh alpine/git:2.54.0 -c 'command -v openssl'
shc -s mail run --detach --name smtp --network deployment axllent/mailpit:v1.27
shc -s mail run --network deployment busybox:1.37 wget -qO- http://smtp:8025/api/v1/info
--detach start the container and return; it runs until replaced or the deployment is removed
--entrypoint string program that replaces the image's entrypoint
--env stringArray environment variable KEY=VALUE (repeatable)
-h, --help help for run
--name string name the deployment's replicas reach the container by; a detached run of this name is replaced
--network string none, deployment, or container: followed by the name of a detached run (default none)
-u, --user string user the container runs as
-w, --workdir string directory the container starts in
--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)
  • shc - Selfhosted Cloud CLI