Skip to content
SHC Docs

HUD types

Layer 2. Core. Core

The per-type contract for shc hud: for every type, how you reach it, what columns it shows, which keys act on it and where it leads. Spec for SHC-909.

Status. Proposed. CURRENT facts were read out of shc corp main at dda96d1cf, x9s at 6ccdf607 (the X9S_REF the Makefile pins), ce main at 82dedb29 and the retired bubbletea HUD at 5deaa5b4b:modules/hud. Everything marked target is not built. Section 3’s column lists are newer: they were reread from ce core/tableview at ce next dbcf866a3 (SHC-1881). Paths without a repo prefix are shc. x9s: paths are the x9s repo (a bare x9s.go is x9s:_k9s/internal/view/x9s.go), k9s: paths are upstream k9s as staged under .x9s/.k9s, ce: paths are ce.

Per MPO LC-210.


shc hud is x9s (a k9s fork whose data plane is a pluggable provider) with the SHC provider pkg/x9sprov compiled in (cli/hud.go:63-105). Every row comes off the daemon’s public API.

tenant → environment → stack → deployment → service → container.

LevelHow you get thereState
tenant:tenants, then Enter (switch the session and open its deployments), u (switch without moving) or v d (its deployments without switching). The header’s Tenant row shows the active one.live
environment0-9 from any view: 0 is all, 1-9 are the recent environments, default always first (pkg/x9sprov/facet.go:77-93,131-133, x9s:…/view/x9s.go:457-483). :environments lists them all.live
stack:stacks, then Enter (deployments at that stack, every environment) or u (narrow without moving). A stack is a projection of deployments, not a stored thing (facet.go:5-32).live
deployment:deployments, or Enter from any of the three above, or Enter on a :nodes row.live
serviceEnter on a deployment (catalog.go:316, the Drill relation).live
containerEnter on a service (catalog.go:589).live
deployment → container in one hopv c on a deployment.live (SHC-912)

esc walks back up. [ and ] step through history, - flips to the last view. Launch lands on the shc ctx environment but drops the shc ctx tenant and stack (cli/hud.go:133 reads only the environment). Target: all three (G9).

Per MPO Axiom 6 (DG-ST-03), LC-118, LC-103.

  • Per MPO LC-26, LC-168, Axiom 7.
  • Per MPO LC-211.
  • Per MPO LC-210.

Today the legend shows the stream keys and the generic ones (l, s, Shift-F, e, ctrl-n, v, a, ctrl-j, sorts, digits: x9s.go:529-617) and none of the verbs. Every verb sits behind a. ctrl-d binds only when the verb is literally named delete/rm/remove/del (x9s.go:663-670), so uninstall, umount, leave and forget get no key at all.

Target (the legend contract, G1). proto.Action gains Key and When (x9s:proto/proto.go:314); proto.Relation gains Key (its letter in the v picker); proto.Param.Type gains secret. The host binds each declared key to “ask params, then confirm”, exactly the path a takes today (x9s.go:715-731), and drops the deleteish/kill name guessing.

  1. Per MPO LC-210.
  2. CLI first. A HUD mutation is a CLI verb with the row filled in, and its confirm dialog prints that command. A verb the CLI lacks is added to the CLI first (the provider already enforces this for containers, actions.go:1510-1519).
  3. Per MPO LC-186.
  4. Per MPO LC-98, Axiom 9.

One row per key. The Kind column says who owns it: k9s = bound by k9s on every provider view, untouchable; k9s verb = a k9s key whose k9s meaning SHC keeps; x9s = added by the x9s overlay; SHC = assigned here.

KeyDoesKind
:command bar (:deployments, :secrets, …)k9s
/filter the tablek9s
?help: every key live on this viewk9s
escbackk9s
Enterdrill into the Drill relation, else describek9s, x9s drill
[ ] -history back, forward, last viewk9s
j k h g Gdown, up, left, top, bottom (tview table.go:1218-1229)k9s
ctrl-f ctrl-bpage down, page upk9s
space, ctrl-space, ctrl-\mark, mark range, clear marksk9s
ctrl-alist every : nounk9s
ctrl-cquitk9s
ctrl-e, ctrl-gtoggle header, toggle crumbsk9s
ctrl-ppersist view configk9s
ctrl-q, ctrl-uclear filterk9s
ctrl-rrefreshk9s
ctrl-ssave table to filek9s
ctrl-wtoggle wide columnsk9s
ctrl-ztoggle faults (rows in a bad state)k9s
Shift-N Shift-A Shift-Ssort by the column that claims name / age / status (catalog.go:186)k9s, x9s roles
Shift-Osort by the selected columnk9s
uuse: make this tenant / environment / stack the session’sk9s (ns) → x9s
0-9environment: 0 all, 1-9 recentsk9s (ns favourites) → x9s
vviews: picker of this row’s relations, each with a letterx9s
ctrl-jfollow a linked column to the row it namesx9s
aactions menu: every verb, its doc and its keyx9s (k9s: attach)
qnever bound. Operators reach for it to quit.reserved

ctrl-h, ctrl-i, ctrl-m and ctrl-[ are backspace, tab, Enter and esc to a terminal and are never assigned.

KeyVerbTypesKind
ddescribe (the detail document)allk9s verb
yYAML of the detail documentallk9s verb
ccopy the type’s copy value (secret value, config value, URL, path; row id otherwise)allk9s verb
eedit: the row’s writable settings, through a typed form where one existsdeployments, repos, config, secrets, quotas, users, nodes, storage, schedules, retention, cluster, branding, certificatesk9s verb
llogsdeployments, services, containers, nodes, events, storagek9s verb
sshelldeployments, services, containersk9s verb (pods)
Shift-Fport-forwarddeployments, services, containersk9s verb
fshow this row’s active port-forwards (:forwards filtered)deployments, services, containersk9s verb (pods)
xreveal a secret value in place (toggle); on serviceclients and ldapbinds the one just minted, oncesecrets, serviceclients, ldapbindsk9s verb (secrets: decode)
rrestartdeployments, services, containersk9s verb (deployments)
trun now: trigger, sync, scan, test, diagnose, apply, reconcileschedules, jobs, repos, quotas, notifications, diagnoses, retention, license, clusterk9s verb (cronjobs: trigger)
ctrl-nnewdeployments, backups, tenants, repos, users, usergroups, serviceclients, ldapbinds, branding, certificates, schedules, secrets, storage, config, connections, grants, integrations, licensex9s
ctrl-ddelete: remove the row (uninstall, delete, umount, leave, unset, reset, delink)mostk9s verb
ctrl-kkill: stop now with no grace (stop --force, cancel, logout, forget)deployments, services, tasks, runs, users, nodesk9s verb
ctrl-lrollbackdeploymentsk9s verb (replicasets)
bbackup now (a volume’s provider snapshot on :volumes)deployments, volumesSHC (Clay)
iinstallapps, addonsSHC
mPer MPO LC-210.
nrotate (new key material)backupkeys, vault, certificates, serviceclients, ldapbindsSHC
oopen in the browserdeployments, ingressSHC
pprotect ⇄ unprotectdeploymentsSHC
wexport to an archivedeployments, backups, vaultSHC
Shift-CclonedeploymentsSHC
Shift-Ddrain ⇄ undrainnodesSHC
Shift-Eenable ⇄ disableschedules, storageSHC
Shift-Kcordon ⇄ uncordonnodesSHC
Shift-Llease: renew with a TTL, or clear itdeploymentsSHC
Shift-Mmove (volume binding, vault cold-start)volumes, vaultSHC
Shift-Prepoint the recorded source appdeploymentsSHC
Shift-Rrestore (backup, volume snapshot, export, vault bundle)backups, volumes, exports, vaultSHC
Shift-UunlockvaultSHC
Shift-VverifybackupsSHC
Shift-Wstart (“wake”, the retired HUD’s key)deployments, servicesSHC
Shift-Xstop (the retired HUD’s key)deployments, servicesSHC

k9s binds some of these letters on its Kubernetes views only. None of those views exist under x9s, so nothing is shadowed, but the muscle memory differs:

Keyk9s meansSHC meansWhy
s on a deploymentscale (k9s:view/scale_extender.go:48)shellSHC’s everyday need on a deployment is a shell; shc hud --help and the README already teach s = shell. Replicas change in e’s scale field (shc update --scale).
pprevious container’s logs (k9s:view/logs_extender.go:37)protect ⇄ unprotectSHC has no previous-container log.
iset image (k9s:view/image_extender.go:64)installSHC-743 named i for install. A version change is e.
c on a nodecordon (k9s:view/node.go:45)copyc is copy on every other k9s table (k9s:view/browser.go:614). Cordon is Shift-K.
oshow the pod’s node (k9s:view/pod.go:133)open in browserJumping to a node is ctrl-j on the NODE column.
bbenchmark (k9s:view/svc.go:54)backupClay’s key.
aattachactions menux9s already made this change.
vvulnerabilities / valuesviews pickerx9s already made this change.

Assigned lowercase: a b c d e f g h i j k l m n o p r s t u v w x y z, each once. Assigned uppercase: A C D E F G K L M N O P R S U V W X, each once. Assigned ctrl: a b c d e f g j k l n p q r s u w z, space, \, each once. Free for later: q stays unbound on purpose; uppercase B H I J Q T Y Z (k9s uses Shift-J for jump-to-owner on Kubernetes views only); ctrl-o t v x y.

Per MPO LC-211.

Per MPO LC-210.


Each section: what it is, how you reach it, columns (narrow always shown, wide on ctrl-w) with the API field behind each, keys, relations, and CURRENT versus target. In the key tables Now is one of: live (the key works today), a (works only through the actions menu), target (not built), blocked (needs something else first, named in the gap). Every mutating key confirms, so “Prompts” lists only what the form asks before the confirm.

A type with a CLI list takes its columns from that list’s View in ce core/tableview (SHC-1881), so the two cannot drift. The narrow view is the list’s default columns in the list’s order. A column only the HUD shows is wide. ctrl-w shows every column where the View puts it, so a wide column can sit between two narrow ones. A header is the View’s label in capitals with its spaces kept (SIZE BYTES). The sections below give each such type’s columns as its View has them, narrow first. The only columns the HUD adds after the View’s are the wide link columns of SHC-919: DEPLOYMENT on a per-deployment type, and ID on :deployments for those links to land on.

Twelve types have no CLI list and keep columns of their own: :services, :containers, :groups, :aliases, :events, :audit, :mounts, :vault, :cluster, :retention, :license and :placement.

Type nouns follow SHC-742: one canonical noun per type, no aliases.

ViewWhatKeysSource
:typeshome: every type as a row, Enter opens it. Launch lands here.Enterx9s:…/view/x9s.go:113, x9s_header.go
:contextsconfigured daemons. Enter or u switches the session.u, ctrl-n, ctrl-dx9s.go:133-137
:environmentsthe environment facet. Enter lands on its deployments, u selects.Enter, ux9s.go:381-440, facet.go:85-91
:stacksthe stack facet. Same keys.Enter, ufacet.go:79-84
:forwardsthis session’s live port-forwards.ctrl-d stop; space-mark then ctrl-d stops severalx9s.go:995-1007
:mutationswhat this session wrote, newest first. d/y show the diff and the command.d, yx9s.go:88-93

Target: launch opens :deployments scoped to the shc ctx tenant, environment and stack instead of :types (G9).

A running app at one (tenant, stack, environment). The headline type. catalog.go:282.

Reach. :deployments; Enter on a :stacks, :environments, :tenants or :nodes row; ctrl-j on any DEPLOYMENT column (live, SHC-919: a wide ID column carries the row id the link filters on).

Columns (DeploymentList → StackResponse, catalog.go:380-446)

  • Narrow, what shc ls prints: STACK stack_name · TENANT tenant_name · ENV environment · APP app_name · STATUS status (stopped when stopped is true) · NODE node · LEASE time left on lease_expires_at · ACCESS effective_access · EXPOSURE effective_exposure · REASON status_reason.
  • Wide: READY services_healthy/services_total from shc.status.get?all_stacks=true, its unknown and empty readings per MPO Axiom 6 and spec Meter invariants · AGE created_at · VERSION app_version · RUNTIME runtime · ADDON addon · DISK disk_bytes · PROTECTED protected · MESSAGE error_message · LATEST the version shc.catalog.updates offers (the catalogue head when the deployment’s pin is ahead of it, ambiguous on a repo tie, blank when current) · HOSTS the routes from HostMapping/<id> · URL the first route as https://host[/path], the column c copies and o opens · ID the row id, added by the HUD so a link from another type’s row lands here. LATEST and HOSTS are read at most once a minute (deploy_columns.go).

Keys

KeyVerbCLIPromptsNow
Enterserviceslive
llogs, every service interleavedshc logs -s <stack> (stream.go:569)live
sshell in the first running containershc shell <stack> (stream.go:778-796)live
Shift-Fport-forwardshc forward <stack> <spec> (forward.go:56)remote port or service, local addresslive; a remote session tunnels through shc.stack.forward at stack:manage (G5)
fits forwardstarget
d / ydetail (DeploymentGet) with the shc inspect bundle (rendered compose, vars, plugs, jobs, backup manifest, masked by the daemon) under inspectshc inspect <stack>live (SHC-913)
eupdate through the guided form: version (catalogue versions), variables, hosts, ports, access, exposure, gate, HA, scale, resources, integrations, protectshc update <stack> …the app’s typed variable form, prefilled with current valueslive as YAML of 9 fields (update.go:96-110), no variables, hosts, ports or integrations; target (G3)
ctrl-ninstall through the guided form: pick an app, then its variablesshc install <app> …app, stack, environment, node, version, then one field per variablelive as a YAML template (create.go:165); target (G3)
ccopy the primary URL (URL), else the row idlive (SHC-913)
oopen the primary URL (URL)live (SHC-913)
rrestartshc restart <stack>service (optional)live (SHC-2701)
Shift-Wstartshc start <stack>service (optional)live (SHC-2701)
Shift-Xstopshc stop <stack>service (optional)live (SHC-2701)
ctrl-kkillshc stop <stack> --forceservice (optional)live (SHC-2701), danger
bbackup nowshc backup create <stack>name, with dependantslive (SHC-2701)
pprotect ⇄ unprotectshc protect / shc unprotect <stack>live (SHC-2701): one verb, the row’s state picks the spelling
Shift-Lleaseshc lease renew <stack> --ttl or shc lease clear <stack>TTL (blank pins it permanent), forcelive (SHC-2701): one verb
ctrl-lrollback to the pre-update snapshotnone today: shc rollback does not exist (G8)rollback point, with dependantsa, and its confirm prints a command that does not exist (G8)
Shift-Cclone to a new coordinateshc clone <src> <dst> [--target-environment] [--target-tenant] [-a] -ystack, environment, tenant, all connections, each starting at the sourcelive (SHC-913)
Shift-Prepoint the recorded source; renders nothingshc repoint <stack> <app>[@<ver>] [-r <repo>] or shc repoint <stack> --backapp (catalogue picker, starting at the recorded source), version, repo, backlive (SHC-913)
wrun an exporter into an archiveshc -e <env> export <exporter> -s <stack> [--output-dir] [-p k=v]exporter, output dir (daemon host), paramslive (SHC-913)
ctrl-duninstallshc uninstall <stack> -yskip safety backupa, no key (G1)

Relations. Enter → :services. v picker letters: s services, c containers, m groups and l aliases (SHC-2471), b backups, h schedules, j jobs, v volumes, k secrets, g config, i integrations, n ingress, e events, a audit, w exports, r retention, p placement (SHC-1079). Live with their letters (SHC-912): services, containers, backups, schedules, events, integrations (stacksResource, relations.go); exports and retention (SHC-921); jobs (SHC-916); volumes, secrets, config, ingress and audit (SHC-919, relations_pass.go). ctrl-j: TENANT → :tenants, NODE → :nodes. f → :forwards.

One compose service of one deployment. Hidden: reached by Enter only. catalog.go:572.

Columns (StackResponse.services[] → ServiceState, catalog.go:622-657)

  • Narrow: SERVICE name · STACK · ENV · STATUS status · HEALTH health · REPLICAS actual_replicas/desired_replicas · CPU cpu_usage_millicores · MEM memory_usage_bytes (k9s shows both on pods).
  • Wide: TENANT · IMAGE image · RESTART-POLICY restart_policy · NODES nodes · OOM oom_kills · EXIT exit_cause.

Live since SHC-912. The Deployment list route fills all five per service on a recorded deployment, from one container-table read per page (enrichServiceColumnsPage, ce modules/app/service_columns_wire.go): nodes, oom_kills and exit_cause from the recorder’s rows, and CPU and MEM from the daemon’s stats cache. Their missing, stopped and idle readings are per MPO Axiom 6 and spec Meter invariants.

Keys

KeyVerbCLIPromptsNow
Entercontainerslive
lthis service’s logsshc logs <service> -s <stack>live
sshell in this serviceshc shell <stack> -S <service>live
Shift-Fport-forward to this serviceshc forward <stack> <service>:<port>port (a service half must be this row’s)live; a remote session tunnels through shc.stack.forward at stack:manage (G5)
fits forwardstarget
rrestartshc restart <stack> -S <service>live (SHC-743)
Shift-Wstartshc start <stack> -S <service>live (SHC-743)
Shift-Xstopshc stop <stack> -S <service>live (SHC-743)
ctrl-kkillshc stop <stack> -S <service> --forcelive (SHC-743), danger

d/y fall back to the row as JSON (no detailFn). e refuses with update.go:307-308: a service’s settings live on its deployment’s e.

Relations. Enter → :containers. ctrl-j TENANT, and DEPLOYMENT back up (live, SHC-919).

One container of a service. The leaf. Hidden, and lists only when anchored (one shc.stack.inspect per deployment). catalog.go:671.

Columns (StackInspect → StackContainerView, catalog.go:702-757)

  • Narrow: NAME Name · SERVICE Service · STACK · ENV · STATE State · HEALTH Health.
  • Wide: IMAGE Image · STATUS Status · ID ID.

Keys

KeyVerbCLIPromptsNow
Enterdescribelive
lthis container’s logsshc logs <service> -s <stack> (the public stream takes service, not a container id)target (G4)
sshell in this containershc shell <stack> -S <service> reaches a replica; the HUD sends the row’s container_id (ce:modules/shell/router.go:274)live
Shift-Fport-forward to this containershc forwardporttarget (G4)
rrestart this containershc container restart <id>live
mcopy its filesystem to a directory on the daemon host, bound read-only over itself and leased (1h). The container’s later writes never reach the copy. No writable variant here: a write to the copy never reaches the container, and the CLI’s --read-write covers the rare need (SHC-994)shc container mount <id>, released early with shc volume umount <handle> (deletes the copy); listed on :volumemountslive

Today r and m are its verbs (g6_verbs.go), and a mount’s path and handle land in :mutations; s is its one stream. Both verbs get the CLI’s five-minute ceiling on a call the HUD’s 15 s request ceiling cannot cancel: once 15 s pass the confirm says the call is still running, and a mount that lands after that logs its path and handle.

The catalogue you install from. catalog.go:931.

Columns (AppList → AppResponse, catalog.go:964-990)

  • Narrow, what shc catalog ls prints: NAME name · KIND app or vapp · VERSION version · REPO repo_name · NODES · DESCRIPTION description.
  • Wide: CATEGORY category · VAPP vapp · HIDDEN · HIDDEN-REASON · PARENT parent_app · TAGS tags · HOMEPAGE homepage · SOURCE source.
  • NODES, HIDDEN and HIDDEN-REASON are shc catalog ls columns the AppList route does not carry, so they read - here.

Keys

KeyVerbCLIPromptsNow
iinstall through the guided form, then land on the new deployment’s servicesshc install <app> [--repo]stack, environment (the CLI’s default, InstallFormEnvironment), node, version, then one typed field per variablea with 4 free-text params (catalog.go:944-957); target (G3)
ddetail plus the compiled install plan (shc catalog compile)live (catalog.go:993-1027)
Enter:addons of this app (v a)live (SHC-921)

Per MPO LC-64.

What an app publishes as add-ons (shc addon ls <app>, show, versions). Reached by Enter on an :apps row. type_addons.go, live (SHC-921).

shc addon ls reads the package on disk and has no route, so the daemon’s copy is read instead: shc.catalog.list kinds addon and vaddon, hidden ones included, which is shc catalog ls --kind addon --include-hidden.

  • Narrow: ADDON name · VERSION default_version · VERSIONS (count) · DESCRIPTION. Wide: APP wraps_ref · REPO · KIND.
  • Keys: i install through the wrapped app’s guided form with the add-on’s version first, confirming shc install <app>/<addon>[@<version> <app version>] -r <repo>. The app version moves to the second positional when the add-on is pinned, because the CLI reads a lone @ as the app version. A vapp add-on (vaddon) refuses and names shc install <app>/<vapp>/<addon> -s <host>/<instance>: it installs under a host.
  • d is the catalog row plus its compiled install (shc.catalog.compile). No route serves shc addon show’s resolved vars.

App catalogues this platform syncs from. catalog.go:1486.

Columns (RepoList → RepoResponse, catalog.go:1523-1561)

  • Narrow: NAME name · URL url · ADAPTER adapter · APP COUNT app_count · PRIORITY priority · TENANT NAME tenant_name.
  • Wide: ENVIRONMENT environment · SYNCED AT synced_at · INTERVAL sync_interval · AGE created_at. Target wide: ERROR sync_error.
KeyVerbCLIPromptsNow
Enterits appslive
tsync nowshc repo sync <name> --tenant <t> --environment <e>forcelive (SHC-743)
eeditshc repo update <name> --tenant <t> --environment <e>YAMLlive
ctrl-naddshc repo add <name> <url>YAML templatelive
ctrl-ddeleteshc repo rm <name> --tenant <t> --environment <e> -ylive

A row’s id is <tenant>/<environment>/<name> (SHC-987). Two tenants may each own a repo of one name and a tenant’s view lists the system rows beside its own, and the daemon refuses a write whose scope matches more than one repo, so every verb names the row’s own pair in the query.

Backup archives. catalog.go:1152.

Columns (BackupList → BackupInfo, catalog.go:1209-1257)

  • Narrow: ID id · STATUS status · CAUSE error, else repository gone, not recorded on a failure with no error, stack stopped <n>s or degraded · TYPE type · SIZE BYTES size · APPARENT BYTES apparent_size · TIMESTAMP timestamp · POINT IN TIME point_in_time · ENCRYPTION encryption · NODE node.
  • Wide: NAME name · TENANT tenant_name · STACK stack_name · ENV environment · GROUP consistency_id · DEGRADED degraded · DATA SCOPE data_scope · LOCATION location · AGE timestamp · DURATION duration_seconds · COMPLETED completed_at · ERROR error · DEPLOYMENT link (SHC-919).
KeyVerbCLIPromptsNow
ctrl-ntake a backupshc backup create <stack>target: deployment picker instead of YAMLlive (YAML)
Shift-Rrestore over the deploymentshc backup restore <id>strategy, create rollback (default on), keep running, forcelive (SHC-743)
Shift-Vverify against its manifestshc backup verify <id>live (SHC-743)
mmount read-only on the daemon hostshc backup mount --id <id>mountpointlive (SHC-743)
wexport to a file on this machineshc backup export <id> --file <path>file (a directory or a full path)live (SHC-913)
ctrl-ddeleteshc backup rm <id> -ylive

Relations. v: m mounts of this backup (live, SHC-919). ctrl-j TENANT, and DEPLOYMENT for its deployment (SHC-919).

FUSE trees m left on the daemon host. catalog.go:1267.

  • Narrow: ID id · BACKUP backup_id · PATH mount_path · STATUS status · NODE node_id · TENANT tenant_name.
  • Wide: SNAPSHOT snapshot_id · REPO repo · PID pid · STARTED started_at.
KeyVerbCLINow
ctrl-dumountshc backup umount <id>live (SHC-743)
ccopy the pathtarget (G2)

ctrl-j BACKUP, NODE, TENANT (live). SHC-744’s mount/umount pair is on main (catalog.go:1194,1290).

Provider volumes bound to deployments. catalog.go:2353.

  • Narrow: ID id · TENANT tenant · STACK stack · MOUNT mount · PROVIDER provider · ACCESS access_mode · SIZE size_bytes · NODE current_node · STATE state.
  • Wide: ENV environment · HANDLE handle · LEASE-GEN lease_generation · DEPLOYMENT link (SHC-919). Target wide: REASON state_reason.
KeyVerbCLIPromptsNow
bprovider snapshot nowshc volume snapshot <id>namelive (SHC-2701)
Shift-Rrestore a snapshotshc volume restore-snapshot <id> <snap> -ysnapshot, confirmlive (SHC-743)
Shift-Mmove the binding to another nodeshc volume rebind <id> <from> <to> -yto node (picker), confirmlive (SHC-743); the node is typed, a picker is target
mbind its data read-only at a path under the daemon’s state directory, leased (1h), whether the volume is on the daemon’s node or another (SHC-994)shc volume mount <id>, released early with shc volume umount <handle> (never touches the data); listed on :volumemountslive
nonePer MPO LC-210.
ctrl-ddelete volume and datashc volume rm <id>forcelive

ctrl-j TENANT, NODE, PROVIDER (live). Enter from :storage or v from :nodes (live).

Storage providers. catalog.go:2266.

  • Narrow: NAME name · TYPE provider_type · FILESYSTEM · MANAGED managed · QUOTA quota_support · SNAPSHOT snapshot_support · NODES nodes · PATH path.
  • Wide: QUOTA-METHOD · SNAPSHOT-METHOD · ID.
KeyVerbCLIPromptsNow
Enterits volumeslive
eedit the node set: each added node is a link, each removed one an unlink; adds run firstshc storage link/unlink <name> <node>node checklistlive (SHC-919, type_storage_nodes.go); the managed providers are refused: the nfs is one export host every node mounts (nfs join -n MOVES it, the data staying behind), the cephfs nodes are OSDs that take a device or an OSD id
Shift-Eenable ⇄ disable managed storageshc storage <cephfs|nfs> enable/disabletarget (G15)
lthe managed provider’s service journalshc storage logs <nfs|cephfs>live (the managed nfs and cephfs rows)
ctrl-naddshc storage addYAML templatelive
ctrl-ddeleteshc storage rm <name>forcelive

The retired HUD had enable, disable and logs here (5deaa5b4b:modules/hud/actionbar_items.go:101-107).

Archives written by exporters (shc export ls, import, mount, umount). ExportList → name, size_bytes, created_at. type_exports.go, live (SHC-921).

The route answers for one deployment, so :exports is that call for each deployment of the browsed tenant and v w on a deployment is the one call.

  • Narrow: NAME · SIZE · AGE. Wide: STACK · ENV · TENANT · DEPLOYMENT link (SHC-919).
  • Per MPO LC-168.
  • m is blocked: shc export mount takes the archive’s path on the daemon host and the listing carries only its name.

Keys that open the backup repository (shc backup key ls, rotate, rm). BackupKeyLs → id, current, userName, hostName, created. type_backupkeys.go, live (SHC-921). Platform-wide: the repository is the cluster’s.

  • Narrow: ID · CURRENT · AGE · HOST · USER. No wide columns.
  • Keys: n rotate (shc backup key rotate -y, the daemon generates the key); ctrl-d retire (shc backup key rm <id> -y), refused on the current key.
  • No key material reaches the HUD: the row is its own detail and rotate sends none.

The resolved backup retention for the tenant, or a stack with v r from a deployment (shc retention ls/set/reset/apply/preview). One row per tier, the shape :quotas uses. BackupRetentionGet → daily, weekly, monthly, yearly. type_retention.go, live (SHC-921).

  • Narrow: TIER · KEEP · SCOPE. Wide: TENANT · STACK.
  • Per MPO LC-168.

The vault’s keys. catalog.go:1923.

Columns (SecretList all=true → SecretResponse, catalog.go:1974-2004)

  • Narrow, what shc vault ls prints: KEY key · SCOPE scope.
  • Wide: VALUE, •••••• until x on that row, fetched on demand, never held in the list (G2) · TENANT tenant_name · STACK stack_name · ENV environment · UPDATED updated_at · APP app_name · DEPLOYMENT deployment, the SHC-919 link · CREATED created_at.
  • VALUE is wide because shc vault ls has no value column (SHC-1881). A value x reveals shows with ctrl-w on.
KeyVerbCLIPromptsNow
xreveal the value in the VALUE cell; again hides it; one row at a timeshc vault get <key> --scope (SecretGet, pkg/apiclient/vault_gen.go:149)target (G2)
ccopy the value to the clipboard (OSC 52, then the native helper)shc vault get <key>target (G2). Today c copies the row id.
eset a new valueshc vault set <key>value, maskedlive (SHC-743)
ctrl-nnew keyshc vault set <key>key, value (masked), scope, stack, environmentlive, but the value is typed into a YAML file in $EDITOR (create.go:947-959); target form (G2)
ctrl-ddeleteshc vault rm <key>live

Masking, one-at-a-time reveal and copy are per MPO LC-186.

ctrl-j TENANT, DEPLOYMENT (live, SHC-919).

The vault itself: one row (shc vault status, coldstart, unlock, rotate, replant, export, import). VaultStatus → initialized, locked; VaultColdstartStatus → holder node.

  • Narrow: INITIALIZED · LOCKED · COLDSTART-NODE.
  • Keys: Shift-U unlock (shc vault unlock, masked password); n rotate the master password (shc vault rotate, masked old and new); Shift-M move the cold-start capability (shc vault coldstart replant, node name); w export (shc vault export <file>); Shift-R import (shc vault import <file>). Per MPO LC-161, LC-166.

Scoped configuration. catalog.go:2461. SHC-742 reshapes this view (ORIGIN column, effective rows, drill to the stored rows).

  • Narrow: PATH path · VALUE value · SCOPE scope.
  • Wide: ORIGIN set/effective · TENANT · STACK · ENV · UPDATED updated_at · CREATED created_at · DEPLOYMENT link (SHC-919).
KeyVerbCLIPromptsNow
eset at this row’s scopeshc config set <path> <value>value (YAML edit or form)live (edit); the one-field set stays behind a, on no key
ctrl-nset a new pathshc config setpath, scope, valuetarget (G15)
ccopy the valuetarget (G2)
ctrl-dunset at exactly this scopeshc config unset <path>live

One row per quota axis for the tenant. catalog.go:2024.

  • Narrow, what shc quota status prints: SCOPE scope_name · AXIS · LIMIT quota.* · USED *_used · AVAILABLE *_available · USED% *_percent_used · BASIS what the used figure is: reserved for cpu and memory, measured or unmeasured for disk, counted for the rest.
  • Wide: TENANT · MEASURED disk_measured_at.
KeyVerbCLIPromptsNow
eset this axis’s limitshc quota set --scope tenant --<axis> <value>valuelive (SHC-746)
ctrl-dremove this axis’s limitshc quota unset --scope tenant --<axis>live (SHC-746), danger
tmeasure disk nowshc quota scanlive (SHC-743); the scan fails (SHC-733)

Isolation boundaries, and the session’s scope. catalog.go:1409.

  • Narrow: ACTIVE active · NAME name · STACKS deployment_count.
  • Wide: DATA-DIR data_dir · CONFIG-DIR config_dir.
KeyVerbCLINow
umake it the session’s tenantshc ctx -t <name>live
Entermake it the session’s tenant and open its deploymentsshc ctx -t <name>live
v dits deployments, the session’s tenant unchangedlive
ctrl-naddshc tenant add <name>live
ctrl-ddeleteshc tenant rm <name> -y (force)live

v: d deployments, u users, q quotas, k secrets, g config, c connections, r retention (live, SHC-919), p rules (live, SHC-1079).

Keycloak users of the active tenant. catalog.go:1635.

  • Narrow: USERNAME username · EMAIL email · ENABLED enabled · ROLES roles · DIRECT ROLES direct_roles.
  • Wide: TENANT · FIRST firstName · LAST lastName · VERIFIED emailVerified · UID id.
KeyVerbCLIPromptsNow
eedit roles, groups and password: each role added is a grant, each removed a revoke; each group ticked a join, each cleared a leave; a password set is a resetshc user grant, shc user join, shc user reset-password, shc user revoke, shc user leave, in that orderrole checklist (baseline roles, the tenant’s direct roles, the user’s own), group checklist (the realm’s groups, the user’s own), other roles, new password (masked), temporarylive (SHC-919, groups gap L5.20, type_users_edit.go)
ctrl-kend the user’s sessions and tokensshc user logout <user>live (SHC-743)
ctrl-ncreateshc user create <username> "<name>" <email>YAML templatelive
ctrl-ddeleteshc user rm <user> -ylive

Credentials to outside systems (DNS, S3, CA signer, registry, …). catalog.go:2675. SHC-742 ruled providers are not server-side objects, so there is no providers drill.

  • Narrow, what shc connection ls prints: NAME · TYPE · TENANT · SCOPE · DNS · PURPOSE · LOCATION.
  • Wide: CAPABILITIES, the HUD’s one-cell summary of the flags · LOCAL-DNS · PROXY · CA-SIGNER · RESTIC · VOLUME · REGISTRY · ZONES (all from shc.provider.list).
KeyVerbCLIPromptsNow
Enterits grantslive (SHC-919)
ctrl-nconnectshc connection connect <name>type, then that type’s fields (secrets masked)target (G15)
ctrl-ddeleteshc connection rm <name> -ylive

grant and revoke-grant move from a here to ctrl-n and ctrl-d on :grants.

What a connection may mint, for whom (shc connection grants). Hidden, reached by Enter on a connection.

  • Narrow: CONNECTION · TENANT · CAPABILITY · GRANTEE · BOUNDARY. No wide columns.
  • Keys: ctrl-n grant (shc connection grant <c> --capability --grantee [--boundary]); ctrl-d revoke (shc connection revoke-grant). Live (SHC-919, type_grants.go).

Plug/socket wiring between deployments. catalog.go:1736.

  • Narrow: CONSUMER consumer_stack_name · PLUG consumer_plug · PROVIDER provider_stack_name · SOCKET provider_socket · STATUS status · ID id.
  • Wide: ENV the consumer’s environment · TENANT the consumer’s tenant · PROVIDER-TENANT · PROVIDER-ENV · DEPLOYMENT and PROVIDER-DEPLOYMENT links (SHC-919).
  • Listed once per (tenant, environment) the scope’s deployments occupy, because a route row names its consumer by stack alone (SHC-973).
KeyVerbCLINow
ctrl-nwire a plug to a socketshc update <consumer> -i <plug>=<provider>[@env]live (SHC-919): consumer picked from the tenant’s deployments
ctrl-dunwire, which runs the edge’s teardownshc update <consumer> -i <plug>!live (SHC-919), Danger

Both are shc update on the consumer (type_integrations_wire.go). ctrl-j DEPLOYMENT lands on the consumer and PROVIDER-DEPLOYMENT on the provider (SHC-919).

Every materialised Traefik router (shc ingress ls, cat). IngressLs → routers[]: file, router, host, rule, service, upstream, middlewares, priority, target. type_ingress.go, live (SHC-921).

  • Narrow: FILE · ROUTER · HOST · UPSTREAM · MIDDLEWARES · TARGET. TARGET is front door for a hostname exposed bare, which follows the app’s front door, and pinned for one exposed with its service (SHC-2474).
  • Wide: SERVICE · RULE · PRIORITY.
  • Keys: c copies the host; d shows the route document (shc ingress cat <file>).
  • o is blocked: the host has no open-in-browser path, and a provider verb must be an shc command.

The A, AAAA and CNAME records SHC published through its DNS connections, one row per record (shc dns ls, GET /api/dns/inventory, tenant:read). type_dns.go, live (SHC-928). Read-only (Decision 6): a record is published and released with the deployment that declares its host.

  • Narrow: NAME · TYPE · VALUE · ZONE · CONNECTION · TENANT (the connection’s) · DEPLOYMENT (tenant/environment/stack).
  • Wide: TTL · CLAIM · DESIRED · PINNED.
  • A record lists under the tenant that owns its connection or its deployment; a platform admin’s shc dns ls without -t lists them all.
KeyVerbCLINow
Enterits owner: the deployment whose ingress declares the host, else the connection it was written through (v d, v c)live (x9s Relation.When)
ccopy the namelive

Per MPO Axiom 6, LC-84.

Cron schedules on deployments, and the backup schedules (shc backup schedule ls) beside them: one table for “what fires on this deployment”. schedulesResource in catalog.go, backup rows in type_schedules_backup.go. A backup row’s JOB is backup and its SOURCE names its scope (backup:stack, backup:tenant, backup:global, …). A backup row’s id carries its scope and its --all-connected / --with-dependants flags, so t and e send what the cron sends. A schedule the scheduler refuses follows MPO Axiom 6.

e send what the cron sends.

  • Narrow: JOB job · CRON cron · ENABLED enabled · LAST RUN AT last_run_at · NEXT RUN AT next_run_at · STACK.
  • Wide: TENANT · ENV · SOURCE source · WARNING warning · AGE created_at · LAST-RESULT last_fire_result (backup rows) · DEPLOYMENT link (SHC-919).
KeyVerbCLIPromptsNow
tfire nowshc job run <job> -s <stack>; backup rows shc backup schedule run --scope …live
Shift-Eenable ⇄ disableshc schedule enable/disable <job> -s; refused on backup rows (a backup schedule has no disable)live (SHC-743): one verb, the row’s state picks the spelling
echange the cronshc schedule edit <job> <cron> -s <stack>; backup rows shc backup schedule set <cron> --scope …cron, prefilledlive
ctrl-naddshc schedule add <job> <cron>YAML templatelive
ctrl-ddeleteshc schedule rm <job>; backup rows shc backup schedule unset --scope …live

v h on a deployment keeps the rows whose STACK and ENV are the deployment’s, so its stack- and deployment-scope backup schedules show; tenant-, environment- and estate-wide ones are on the bare :schedules.

Jobs a deployment declares (shc job ls, run, show). type_jobs.go. The daemon lists jobs per deployment, so the bare table asks shc.job.list once per deployment in the tenant (eight at a time) and v j on a deployment asks once. d is shc job show.

  • Narrow: JOB · CONTEXT · SOURCE · PHASE · TIMEOUT.
  • Wide: STACK · ENV · SERVICE · COMMAND · IMAGE · GROUP · URL · DEPLOYMENT link (SHC-919).
  • Keys: t run (shc job run <job> -s <stack>, prompts --var values as KEY=VALUE, …); Enter → :runs of this job; v h its schedules. Live. t does not wait: the run shows on Enter while it goes.

The retired HUD had T trigger and L logs on job rows (actionbar_items.go:60-63).

Job runs, running and finished (shc job ps, history, status, cancel). type_runs.go. /api/resource/JobRun → id, job_name, stack_name, environment, tenant_name, status, exit_code, error, elapsed_seconds, started_at, completed_at, task_id. The bare table is the newest page (100); Enter on a job asks the daemon for that job’s runs.

  • Narrow, what shc job ps prints: ID · JOB · STACK · STATUS · ELAPSED · STARTED.
  • Wide: CONTAINER · ENV · EXIT · AGE · COMPLETED · TASK (linked to :tasks) · ERROR · DEPLOYMENT link (SHC-919).
  • Keys: ctrl-k cancel (shc job cancel <run-id> -y, reason), pending runs only: the daemon refuses a running one (X409067JRNRUN); d status (shc job status). Live.

The daemon’s own maintenance crons (shc cron ls). CronList → name, module, schedule, class, timeout, leader_gated, next_run_at. Narrow: NAME · MODULE · SCHEDULE · CLASS · TIMEOUT · LEADER · NEXT-RUN. No wide columns. No verbs: the CLI has none; a schedule is the crons.<name> config key. type_crons.go, live (SHC-921).

The daemon’s operations queue. catalog.go:1334.

  • Narrow: ID · NAME · STATUS · NODE · TRIGGER · ELAPSED.
  • Wide: ATTEMPTS attempts/max_attempts · STARTED · ERROR.
KeyVerbCLIPromptsNow
ctrl-kcancelshc task cancel <id>reasonlive (SHC-743)

ctrl-j NODE. Reached by v from :nodes (live).

The live typed-event feed. catalog.go:767. Read-only by design (actions.go:1504-1505).

  • Narrow: SEQ · TIME · LEVEL · CODE · TENANT · STACK · MESSAGE.
  • Wide: ENV · ACTOR · NODE · KIND · TRACE.
  • Keys: l tails the feed (live). ctrl-j TENANT, NODE, DEPLOYMENT (SHC-919). SHC-745 fixes the row ids and the heartbeat row.

The hash-chained audit trail. catalog.go:861. Read-only by design.

  • Narrow: TIME created_at · CODE · ACTOR · TENANT · STACK · MESSAGE.
  • Wide: ENV · TRACE · ID.
  • SHC-756: the view renders the newest 100 platform-wide rows and filters them afterwards. ctrl-j DEPLOYMENT (live, SHC-919).

Cluster members. catalog.go:1032.

  • Narrow, what shc node ls prints: NAME name · STATE cluster_state · CONDITION condition, read off the node’s lease · AVAIL availability · CLOUD cloud · LOCATION the cloud and location as one path · ROOM ok, or over: and the axes it is over-committed on · LEADER is_leader · VOTER is_voter.
  • Wide: ID id · HOST hostname · INTERNAL internal_address · UNDERLAY underlay_address · RUNTIME · CORES cpu_cores · MEMORY memory_bytes · FREE CORES free_cpu_millicores · FREE MEMORY free_memory_bytes · ROLE · HEALTH health_status · AGE · PUBLIC public_address · ARCH · OS · TENANT.
  • Per MPO Axiom 6.
KeyVerbCLIPromptsNow
Enterdeployments on itlive
lthe shcd log on that nodeshc cluster logs <node>live (stream.go:606)
eset the public addressshc node update <node> --public-addressaddresslive (SHC-743)
Shift-Kcordon ⇄ uncordonshc node cordon/uncordon <node>live (SHC-743): one verb, the row’s state picks the spelling
Shift-Ddrain ⇄ undrainshc node drain/undrain <node>timeout, forcelive (SHC-743): one verb, the row’s state picks the spelling
ctrl-dleave gracefullyshc node leave <node> -yforcelive (SHC-743)
ctrl-kforget (evict)shc node forget <node>live (SHC-743)

v: d deployments, v volumes, t tasks, w workers (live, letters SHC-919), f fences (live, SHC-1079), p pressure (live, SHC-1208).

Task workers, one per shcd. catalog.go:1579. Read-only by design (actions.go:1508-1509).

  • Narrow: ID · NODE · LEADER is_leader · HEARTBEAT heartbeat_ago · STARTED.
  • Wide: HEARTBEAT-AT.

Certificates the CA machinery issued. catalog.go:2173.

  • Narrow: NAME · KIND (root / intermediate / leaf, SHC-742) · FINGERPRINT · EXPIRES not_after.
  • Wide: PROVENANCE · ISSUER · NOT-AFTER.
  • Per MPO LC-168.

A tenant CA is the row named for its tenant (gap L5.20, type_certificates_ca.go):

KeyVerbCLIPromptsNow
ctrl-na tenant’s first CA, from a ca-signer connection or a PEM chainshc ca provision -t <tenant> --signer <conn>, or shc ca import -t <tenant> --root <f> --intermediate <f> --key <f>tenant, then the signer or the three file pathslive
eswap the tenant CA for one from a new source; every served leaf is re-signed (Danger)shc ca reprovision -t <tenant> (--signer <conn> | --root <f> --intermediate <f> --key <f>) -ythe signer or the three file pathslive

Per MPO LC-186.

The cluster as one row: the facts shc cluster status, shc leader status, shc cluster mesh status, shc cluster fabric status, and shc cluster host show answer today, one screen instead of five commands.

  • Narrow: LEADER leader_node_id · VOTERS live voters against the control-plane fence’s automatic target · HOST · MESH mesh0 up · FABRIC.
  • Keys: e edit host (shc cluster host set); t reconcile (shc cluster reconcile). mesh0 has no on/off. It is up from the first join. ctrl-j LEADER → :nodes. v: n nodes, c certificates, w workers (SHC-919). Live (SHC-917). t starts the missing installs and refuses a plan where one has to wait for another, naming shc cluster reconcile: the HUD cannot wait out an install.

The estate’s vendor identity: the license row (shc license status, install, activate, trial start, refresh, delink) and the portal registration row (shc portal status, register, deregister). LicenseStatus → state, type, holder, domains, expires_at, trial_ends_at, source, last_check_ok.

  • Narrow: KIND (license / portal) · STATE · TYPE · HOLDER · EXPIRES.
  • Wide: DOMAINS · SOURCE · LAST-CHECK.
  • Keys: ctrl-n install (token or file; online code and trial are target); t refresh (shc license refresh); ctrl-d delink. The portal row is read-only: the daemon serves no register or deregister route, so shc portal deregister runs on the estate. The header’s Warning row names the license state when it is not keyed or dev, and the portal channel when a registered estate’s is not up. Live (SHC-917).

shc notification ls and test. NotificationList → name, channel, on, destination, provider, connection, cooldown, debounce, retries, timeout.

Per MPO LC-165.

Per MPO LC-186.

  • Narrow: NAME · CHANNEL · ON (event patterns) · DESTINATION · PROVIDER. Wide: CONNECTION · COOLDOWN · DEBOUNCE · RETRIES · TIMEOUT.
  • Keys: t test (shc notification test <rule>). The daemon prefixes the message [TEST] , sets test: true in the payload and refuses a rule tested less than 30 seconds ago (X429707NTFTST). The retired HUD also edited and deleted rules (actionbar_items.go:246-250); rules stay a notifications config edit.

shc doctor ls and run. DoctorDiagnoses → name, description, category, fix, remedy. type_diagnoses.go, live (SHC-921).

  • Narrow: NAME · CATEGORY · FIX · DESCRIPTION. Wide: REMEDY (the remedy’s effect).
  • Keys: t run this row’s category (shc doctor run -c <c> [--fix], prompts fix yes/no; a destructive prescription is never applied from here). What the run found for a row is that row’s d.

These are one-shot bootstrap, local-machine or break-glass commands. None is a browsable thing, so none gets a type (Decision 7):

shc init, shc cluster init/join/leave/rm/repair/ping, shc node join/token, shc ctx login/logout, shc auth login/logout/token, shc mcp serve, shc completion, shc test run, shc support bundle, shc purge and shc db, shc adapter load/migrate, shc deploy -f, shc validate, shc search, shc recover, shc clone reclaim/interrupted/ finish-forward, shc backup group/ungroup/sync/prune/relocate/ clear-unusable/clear-restore-seal/inspect/import, shc system keycloak reset-admin-password.

Gap L5.20 took service clients, LDAP binds (shc auth …-service-client, …-ldap-bind) and brands (shc branding …) off this list: each is a layer-5 object the CLI manages, so each has a page (3.50 to 3.52).

The volume binds and container snapshots m on :volumes and :containers left on the daemon host, each held under a lease the daemon’s reaper ends (SHC-994). shc volume mounts → VolumeMounts. type_volumemounts.go, live. Scoped: a tenant’s view sends its X-SHC-Tenant, the bare view all_tenants=1.

  • Narrow: ID id · TENANT tenant_name · SOURCE source (a container’s is container <id>) · TARGET mount_path · MODE read_only (ro/rw) · OWNER owner · EXPIRES expires_in_seconds (the daemon’s own count, never this host’s clock).
  • Wide: KIND kind · STACK stack_name · ENV environment · NODE node_id · STARTED started_at.
KeyVerbCLINow
ctrl-dumount before the lease runs outshc volume umount <id>live

ctrl-j TENANT, NODE (live).

Every label value, what shc label ls --all lists (SHC-1079, scheduler design 5.3). type_fences.go, live. Platform-wide: the label index reads no tenant.

  • Narrow: LABEL key=value · SOURCE (derived, operator, system) · NODES members · READY · RESERVED · CONSTRAINTS · DEPLOYMENTS deployment_count.
  • Wide: MEMBERS member names · BACKUP-REPO · DESCRIPTION · AGE created_at.
  • d is shc label show <key>=<value> -o json. The listing’s warnings (an unlocated node, a thin control-plane) ride a note.
KeyVerbCLIPromptsNow
Entermember nodeslive
eeditshc label set <key>=<value>description; reserved on an operator label, location, cloud and control-plane; backup repo on locationlive

Putting a label on a node is shc node label. This view lists label values and edits the attributes shc label set takes. It never adds a label to a node.

v: n member nodes (Enter), r constraints naming it (active tenant and cluster), d deployments it shapes (live).

Placement constraints on the active tenant and the cluster, shc constraint ls (SHC-1355). type_constraints.go, live. Scoped: every call sends the tenant’s X-SHC-Tenant; a cluster constraint shows in every tenant with SCOPE cluster, and the daemon refuses a tenant admin’s ctrl-d on it.

  • Narrow: ID · SCOPE · TARGET · FORM where or prefer · EXPRESSION · REASON · SET-BY · CREATED created_at. No wide columns.
KeyVerbCLIPromptsNow
ctrl-nsetshc constraint set [--where '<selector>'] [--prefer '<selector>'] --scope cluster|tenant|deployment with -t, -e, -s as the scope needsscope, stack, environment, where, prefer, reasonlive; a form given replaces that form’s row; both may be set
ctrl-dclearshc constraint clear --scope <scope> --where|--preferlive; on a cluster constraint the confirm notes that only platform:manage may clear it

v: f the label values its key=value terms name (none for a key!=value term), d the tenant’s deployments it binds: cluster, tenant and deployment at once.

Why a deployment runs where it runs, shc constraint explain (SHC-1079). type_placement.go, live. Hidden, drill-only, read-only: v p on a :deployments row.

  • Rows are explain’s lines: STEP (replica, rule, condition) · SOURCE · OBJECT · RULE · FENCE · NODE · LEFT nodes remaining · VERDICT (chosen, pending, refused, kept, removed). A step that removes nodes gets one more row per node it removed.
  • d is shc constraint explain -s <stack> -t -e -o json. What placement does not enforce yet rides a note.
  • Until the engine’s explain (SHC-1058 B2) the rows are SHC-1050’s shorter explain; the capacity, spread, score, failover and history steps come with it.

ctrl-j FENCE → :labels, NODE → :nodes (live).

Not built with F1: the wide PLACEMENT column on :deployments waits for the engine’s assignment state. :nodes has its CONDITION column, read off the node’s lease by shc node ls.


Every queue on every node, the pressure lines of shc status (SHC-1208). StatusGetGet → one row per node per queue. type_pressure.go, live.

  • Narrow: NODE (links to :nodes) · QUEUE · LEVEL green, amber or red, marked (stale) when the node stopped refreshing it · DEPTH depth/capacity and unit · OLDEST age of the oldest waiting item · REASON why it is not green, or why the queue could not be read · IN/S · OUT/S · DROPPED dropped or refused, total · RETIRED the retired total and why, when there is one · AMBER and RED, the depth and age each level starts at.
  • Wide: SINCE how long the level has held.

No verbs: a pressure line is a measurement a node takes of itself, and a threshold is declared by the queue’s owner in the daemon. Reached from :nodes with v p, filtered to that node.

A deployment’s groups, one row a member (SHC-2471). type_groups.go.

Per MPO LC-84, LC-92.

Columns (StatusGetGet?stack_name=… → groups[] → GroupStanding)

  • Narrow: GROUP group · MEMBER members[].member · LOCATION members[].location, where the member runs, - when it was given none, and <location>, moving to <moving_to> while it is on its way (SHC-2480), as the CLI prints it · READY ready when every replica the member runs as reads ready, else not ready · SERVICES members[].services.
  • Wide: STACK · ENV · TENANT · DEPLOYMENT.

The rows are the groups of shc.status.get for the one deployment, the answer shc status -s <deployment> prints as its Groups section (SHC-2469). The CLI and the HUD read one source, and one test feeds one answer to both (TestTheGroupsRowsAndTheCLIGroupsSectionReadOneAnswer). There is no shc group command and no list of groups across deployments.

Keys

KeyVerbCLIPromptsNow
Enterthe services this member runslive

No verbs: a member is scaled with its group (e on the deployment), and start, stop, restart, logs and shell are on its services, one Enter away. d/y fall back to the row as JSON.

Relations. Enter → :services, filtered to the member’s services in its own deployment. ctrl-j TENANT, and DEPLOYMENT back up.

A deployment’s aliases (x-shc-aliases, SHC-2459), one row an alias, with the replicas it points at now (SHC-2471). type_aliases.go. Hidden, and lists only when anchored: v l on a :deployments row. A bare :aliases lists nothing and says why.

Columns (StatusGetGet?stack_name=… → aliases[] → AliasStatus)

  • Narrow: ALIAS alias · SELECTS selects, the selector as the app wrote it, its :1 count included · REPLICAS replicas, the replicas it points at now, - when none · REASON reason, why it has no backend, - while it has one.
  • Wide: STACK · ENV · TENANT · DEPLOYMENT.

The rows are the aliases of shc.status.get for the one deployment, the answer shc status -s <deployment> prints as its Aliases section, and one test feeds one answer to both (TestTheAliasesRowsAndTheCLIAliasesSectionReadOneAnswer).

No keys and no Enter: an alias changes when the labels of its replicas do, or when the app’s x-shc-aliases does. d/y fall back to the row as JSON. ctrl-j TENANT, and DEPLOYMENT back up.

The groups of a tenant’s realm (shc user group ls, add, rm). :groups is a deployment’s groups, so these take the user’s noun. type_usergroups.go, gap L5.20. Tenant-scoped. SHC makes shc-app-access, shc-admins and shc-users itself, and the daemon refuses to make or remove them.

  • Narrow: NAME name. Wide: TENANT.
KeyVerbCLIPromptsNow
Enterthe group’s members: the tenant’s users whose GROUPS name itlive
ctrl-naddshc user group add <group> -t <tenant>namelive
ctrl-dremove; one that leaves the tenant with no manager is refusedshc user group rm <group> -t <tenant> -ylive

A user joins and leaves a group from e on :users (3.20).

The master realm’s confidential clients (shc auth list-service-clients, create-service-client, delete-service-client), what terraform and CI log in with. type_serviceclients.go, gap L5.20. Platform-wide, platform:manage.

  • Narrow: CLIENT ID client_id · TOKEN LIFESPAN token_lifespan.
  • Wide: SECRET, masked.
KeyVerbCLIPromptsNow
ctrl-nmint a clientshc auth create-service-client <name> [--token-lifespan N]name, token lifespanlive
nmint it a new secret; the old one stops workingshc auth create-service-client <name> --rotate-secretlive
x/creveal or copy the secret just minted, oncelive
ctrl-ddeleteshc auth delete-service-client <name>live

Per MPO LC-186.

A tenant realm’s LDAP binds (shc auth list-ldap-binds, create-ldap-bind, delete-ldap-bind), for consumers SHC does not run, and the ones installed apps hold through their ldap plug. type_ldapbinds.go, gap L5.20. Tenant-scoped, platform:manage.

  • Narrow: TENANT tenant · NAME name. Wide: PASSWORD, masked.
KeyVerbCLIPromptsNow
ctrl-nmake a bindshc auth create-ldap-bind <name> -t <tenant>namelive
na new password; the old one is refused from then onshc auth create-ldap-bind <name> -t <tenant> --rotate-secretlive
x/creveal or copy the password just minted, oncelive
ctrl-dremove; a bind an app holds is refused and goes with the appshc auth delete-ldap-bind <name> -t <tenant>live

The password is held for one reveal the way a service client’s secret is (3.50).

The estate’s brand bundles (shc branding list, set, delete), the logos the sign-in pages and the launcher read through the branding socket. type_branding.go, gap L5.20. Platform-wide: the store is the estate’s.

  • Narrow: NAME name · FILES files · HASH hash.
KeyVerbCLIPromptsNow
ctrl-nset a brandshc branding set <name> --logo <file>...name, svg path, png pathlive
ereplace its logosshc branding set <name> --logo <file>...svg path, png pathlive
ctrl-ddeleteshc branding delete <name> -ylive

The logos are files on the operator’s machine, read and checked (extension, 1 MiB) before the confirm, as --logo reads them.

Per MPO LC-165.

Each gap names the ticket that closes it.

#GapTicket
G1Every declared verb has a key and is in the legend; ctrl-d/ctrl-k come from declared keys, not verb-name guessing. Built: the deployments slice in SHC-2701, every other type in SHC-743, held by TestEveryDeclaredVerbIsOnAKey.SHC-743, SHC-2701
G2Secrets: x reveal, c copy value, masked VALUE column, masked input for every secret param, c copies a declared copy column over OSC 52.SHC-910
G3Guided install and update forms from the app’s variable schema.SHC-911
G4Shell, logs and port-forward at service and container level; service CPU/MEM columns.SHC-912
G5Port-forward from a remote session.SHC-926
G6Container restart, container mount, volume mount and storage logs have API routes and no CLI verbs.SHC-927
G7Deployment verbs and columns: clone, repoint, export, open, detail folds inspect; LATEST, HOSTS, LEASE; backup export (move removed by SHC-1230).SHC-913
G8Three HUD strings name CLI spellings that do not exist: shc rollback (actions.go:269, no such command in ce or shc), shc cluster forget (actions.go:615, the verb is shc node forget) and --unintegrate (actions.go:1521, removed; a disconnect is -i <plug>!).SHC-914
G9Launch honours the shc ctx tenant and stack, not only the environment (cli/hud.go:133), and opens on :deployments.SHC-915
G10Quota set and unset.SHC-746 (scan failure: SHC-733)
G11Aliases, cert kinds, config twice; events ids; audit paging; backup umount.SHC-742, SHC-745, SHC-756, SHC-744 (on main)
G12:jobs, :runs; backup schedules on :schedules; t and e on schedules. Closed: e on a job schedule is shc schedule edit over shc.schedule.update.SHC-916, SHC-985
G13:cluster, :vault, :license; cert rotate on :certificates.SHC-917
G14:ingress, :addons, :exports, :backupkeys, :retention, :diagnoses, :crons.SHC-921
G15Relations pass: DEPLOYMENT link on every per-deployment type; the deployment and tenant v lists above; v c deployment → containers; connections → :grants; integrations wire/unwire; storage and users edit forms; picker letters.SHC-919
G16:dns read-only view. Built, with shc dns ls.SHC-928
G17:notifications needs a rule-list route in ce.SHC-920
G18Every layer-5 object has a page (LAYERAUDIT L5.20): :usergroups, :serviceclients, :ldapbinds, :branding, joins and leaves on e of :users, and the tenant CA’s provision, import and reprovision on :certificates. Built.pending (HUDPAGES)

G2 (SHC-910). HUD secrets: x reveals, c copies, every secret field is masked

  • On :secrets, x shows the focused key’s value in a VALUE cell and x again hides it; c copies the value; both fetch through SecretGet on demand and nothing stores the value in the list, the mutation history or an Explain.
  • proto.Param has a secret type rendered as a masked field; vault set, user password, vault unlock and secret-typed app variables use it, and ctrl-n on :secrets no longer puts the value in a YAML file.
  • c works over SSH on an estate node (OSC 52 first, then pbcopy / wl-copy / xclip), proven by pasting a copied value on the operator’s laptop.

G3 (SHC-911). HUD install and update walk the app’s variables in a typed form

  • i on :apps and ctrl-n on :deployments open one field per variable from shc.app.detail (secret masked, bool toggle, int/port validated, select for enums), prefilled with the package default, and the confirm prints the same shc install the CLI would run.
  • e on a deployment opens the same form prefilled with current values and can change variables, version, hosts, ports and integrations, printing one shc update.
  • After an install confirms, the HUD lands on the new deployment’s :services and the rows go live as containers start.

G4 (SHC-912). Shell, logs and port-forward on services and containers

  • s, l and Shift-F on a :services row target that service; on a :containers row, s targets that container (container_id).
  • v c on a deployment lists its containers across services in one hop.
  • :services shows CPU and MEM narrow and NODES, OOM, EXIT wide.

G5 (SHC-926). Port-forward from a HUD pointed at a remote daemon

  • Shift-F works from a laptop session (--url), through an authenticated tunnel gated at stack:manage, with the same service/port inference as shc forward.
  • shc forward from a remote context works the same way.
  • A caller without stack:manage is refused before any socket opens.

G6 (SHC-927). CLI verbs for container restart, container mount, volume mount and storage logs

  • shc container restart, shc container mount, shc volume mount and shc storage logs exist and call the routes the retired HUD used.
  • r and m on :containers, m on :volumes and l on :storage run them, each confirm printing the new command.

G7 (SHC-913). Deployment verbs and columns the HUD is missing

  • Shift-C clone, Shift-P repoint and w export run their CLI verbs from a :deployments row with a typed prompt. Relocation is shc update --where (core/placement/relocate_hint.go).
  • o opens and c copies the deployment’s primary URL; LATEST, HOSTS and LEASE are wide columns; d includes the shc inspect bundle.
  • w on :backups exports the archive.

G8 (SHC-914). The HUD prints three shc spellings that do not exist

  • rollback on a deployment either has a real shc rollback CLI verb or its confirm prints the verb that does exist; cli_verb_reference_test.go covers action Explains.
  • forget on a node prints shc node forget <node>, and the :integrations refusal names -i <plug>! instead of --unintegrate.

G9 (SHC-915). shc hud opens where shc ctx points

  • Launch passes the context’s tenant, environment and stack; the header shows all three and the first table is :deployments narrowed to them.
  • An explicit --tenant/--environment flag or $SHC_* still wins.

G12 (SHC-916, SHC-985). Jobs, job runs and one schedules table in the HUD

  • :jobs lists a deployment’s jobs; t runs one; Enter shows its runs.
  • :runs lists running and finished runs; ctrl-k cancels one.
  • :schedules carries backup schedules beside job schedules, and t, e, ctrl-d map to the right CLI verb per row.
  • e opens a form prefilled with the row’s cron; on a job row it runs shc schedule edit, which keeps the schedule’s id and last run (SHC-985).

G13 (SHC-917). Cluster, vault and license as HUD types

  • :cluster shows leader, voters, host, mesh0 and fabric on one row with e and t.
  • :vault unlocks (masked), rotates, replants, exports and imports.
  • :license shows license and portal state and installs, refreshes and delinks; the header warns when either is not healthy.

G14 (SHC-921). Browse views for ingress, add-ons, exports, backup keys, retention, diagnoses and crons

  • Each type lists what its shc … ls lists, with the columns in this document.
  • Each verb in its section runs from its key with the CLI command in the confirm.

G15 (SHC-919). HUD relations pass

  • Every per-deployment type has a DEPLOYMENT link column, so ctrl-j lands on the deployment from any backup, secret, event, schedule, volume, job or config row.
  • v on a deployment and on a tenant lists the relations in this document, each with its picker letter, and each opens filtered to the row.
  • :grants under connections, wire/unwire on :integrations, the node checklist on :storage and the roles form on :users replace the free-text params they have today.
  • Live (SHC-919). Three keys the tables tag G15 stay target: Shift-E on :storage, ctrl-n on :config and ctrl-n connect on :connections.

G17 (SHC-920). Notification rules as a HUD type

  • ce serves a rule list route and shc notification ls prints it.
  • :notifications lists rules; t sends a synthetic notification through the focused rule.

Taken 2026-09-25 on Clay’s go-ahead, each as this spec recommended. Any of them can still be reopened.

  1. Per MPO LC-210.
  2. Three k9s letters change meaning: s is shell (k9s: scale), p is protect (k9s: previous logs), i is install (k9s: set image). Replicas change in e’s scale field (shc update --scale).
  3. Per MPO LC-98.
  4. Remote port-forward is served on the authenticated public listener, gated at stack:manage (SHC-926).
  5. API-only verbs get their CLI commands first; the HUD follows the CLI (SHC-927).
  6. :dns ships read-only without waiting for a CLI verb (SHC-928).
  7. The CLI-only list in 3.41 stands.