Skip to content

CLI reference

cornus is a single binary that bundles a tiny OCI registry, an in-process BuildKit-based build engine, and an imperative deploy engine. The same binary runs the server and acts as the client for building, pushing, deploying, and reaching workloads.

sh
cornus [global flags] <command> [command flags]

The command tree is parsed with kong. Run cornus --help or cornus <command> --help for the built-in usage text.

Global flags

These flags sit on the root command and apply to every subcommand.

FlagEnv varDefaultDescription
--data-dirCORNUS_DATAplatform data dirPersistent data directory (registry CAS + build cache).
--contextCORNUS_CONTEXTcurrent contextConnection profile to use from the cornus client config (see cornus config). Overrides the config current-context.
--config-fileCORNUS_CONFIGplatform user config dirPath to the cornus client config file. Defaults to the platform user config dir, honoring $XDG_CONFIG_HOME.
--outputCORNUS_OUTPUTautoOutput rendering: auto, plain, fancy, or json. See Output modes.
--context-fileCORNUS_CONTEXT_FILEdiscoveredExplicit project context override file (bare Context in JSON, YAML, or TOML). Without it, Cornus searches upward for cornus-context.{json,yaml,toml}.
--no-context-filefalseDisable automatic project-context discovery. Conflicts with --context-file.
--trust-context-fileCORNUS_TRUST_CONTEXT_FILEfalseAllow endpoint, credential, and TLS fields from an auto-discovered project context file. Use only for a trusted working tree.
--no-colorfalseDisable color in fancy output (layout is kept). Also honored via NO_COLOR / CLICOLOR=0.

The --output values are:

  • auto - fancy on a terminal, plain otherwise.
  • plain - deterministic, no color.
  • fancy - color plus layout.
  • json - machine-readable NDJSON.

See Output modes for the full behavior.

Commands

CommandDescription
cornus serveRun the cornus server (registry + build + deploy).
cornus buildBuild an image from a context and push it.
cornus pushPush a local image into the registry.
cornus deployApply a deployment spec.
cornus execRun a command inside a deployment (docker exec) via a cornus server.
cornus port-forwardForward local TCP ports to a deployment container port.
cornus socks5Run a local SOCKS5 split-tunnel proxy for reaching workloads by name.
cornus tunnelExpose a deployment port to the public internet through a hosted tunnel.
cornus ingress-tunnelPublish a deployment or Compose project's declared ingress through one public tunnel.
cornus configManage connection profiles (contexts) for reaching a remote cornus server.
cornus setupInteractively configure and verify a server connection.
cornus authEnroll and manage SSH public keys for short-lived client sessions.
cornus composeDocker Compose-compatible client for Compose / devcontainer projects.
cornus webServe the browser UI and client-side BFF (loopback by default).
cornus daemonDocker API frontend and unified background-agent controls.
cornus hubJoin the workload-to-workload overlay as a spoke.
cornus activityRead the server activity flight record.
cornus storageInspect and migrate registry storage.
cornus observeQuery stored workload logs, traces, and metrics.
cornus tokenMint JWTs for a server with bearer auth.
cornus version / cornus healthPrint the cornus version, or probe a running server health endpoint.

See also

Released under the Apache-2.0 License.