Reference

Exhaustive lookup for when you know what you’re searching for. Audience: anyone consulting the spec of a command, endpoint, config key, error code, or term.

For prose walkthroughs, see ../guide/. For internals, see ../architecture/.

---

Every shc command, grouped by subcommand. Pages are hand-written where prose adds value; auto-generated from the command classes otherwise.

• Overview — global flags, output formats, exit codes

Core operator commands (hand-written):

• shc app — install, uninstall, upgrade, list apps
• shc backup — create, list, restore, prune
• shc clone — duplicate a stack
• shc cluster — cluster-level operations
• shc export / shc import — selective data export/import
• shc job — run and manage jobs
• shc move — relocate stacks between nodes
• shc node — multi-node management
• shc preset — list, search, and inspect app-shipped variable bundles
• shc retention — retention policies
• shc stack — start, stop, exec, shell, logs
• shc storage — storage pools and volumes
• shc utility — ctx, config, schedule, misc
• shc vault — secrets management

Auto-generated from command classes:

• shc events, shc config, shc ctx
• shc doctor, shc events, shc forward
• shc hud, shc inspect, shc logs
• shc quota, shc repo, shc schedule
• shc shell, shc task, shc tenant
• shc init, shc nfs
• shc status, shc stop
• shc recover, shc validate, shc import

Endpoints exposed under /api/method/* and /api/resource/*. The exhaustive per-module (method, path) inventory is the generated HTTP route reference — regenerate with make docs/generate. The pages below add hand-maintained request/response notes for the major operator modules; modules without a dedicated page (auth, ca, dns, doctor, user, …) are still fully listed in the route reference.

• HTTP route reference — every route each module registers (auto-generated)
• SSE streaming — Server-Sent Events for events + long-running operations
• app — app install, upgrade, uninstall
• audit — audit log queries
• backup — create, list, restore
• clone — stack clone/move
• cluster — join tokens, cluster ops
• config — config CRUD
• events — event stream + query
• export — import/export
• health — health endpoints
• hud — HUD overlay
• job — job CRUD
• logs — log retrieval
• node — node management
• quota — quota get/set
• repo — app repository CRUD
• schedule — scheduled task CRUD
• search — app search
• stack — stack management
• storage — storage providers
• task — task queries
• tenant — tenant CRUD
• vault — secrets CRUD

• Config files — file formats, scopes, precedence
• Config keys — every key in default.yaml with its default
• Environment variables — SHC_* env overrides
• File locations — where SHC stores data, logs, cache

Operational timeouts are role-named keys under the timeouts: section of default.yaml (e.g. timeouts.keycloak, timeouts.backup, timeouts.drain), read via core/timeouts.

Provisioning and driving a cluster as code — the custom shc provider, the core + shc/<cloud> module library, and ~18 per-substrate examples.

• Overview — the modules, the provider, the examples, and the publish/mirror model
• Getting started — install from the mirror, tofu init/plan/apply
• The shc provider — every resource and data source
• The module library — core and the shc/<cloud> front doors
• Examples — every example + an end-to-end walkthrough

• Adapter reference — every platform adapter with its declared load/migrate capabilities (auto-generated)

• Error code reference — every typed error SHC can raise (auto-generated)
• Event reference — every event-bus topic with durability class and payload shape (auto-generated)

• Glossary — SHC terminology
• vs Docker / K8s / Nomad / Coolify / Vercel
• vs Coolify (deep dive)