Skip to content
SHC Docs

Opening the HUD

shc hud is the whole platform on one screen: the tables every shc list command prints, live, with a key or a menu entry for every verb. It is k9s’s terminal UX over SHC instead of Kubernetes, so a k9s hand finds its way; the rest of this tutorial assumes nothing.

The pages of this tutorial read the node the app ladder’s pages 00 to 07 left: home01, tenant prod with web, db, pgweb, placed, store and cloud. Start here with that node running. The nodes page joins a second machine when it needs one.

The HUD takes the whole terminal, so run it inside tmux on home01 and read its screen with tmux capture-pane. Every screen in this tutorial was read that way; type the same and you see the same. Install tmux first.

home01
$ apt-get install -y tmux
...
$ tmux -V
tmux 3.5a

The HUD asks the daemon for every table when it opens, so give it a few seconds before the first read.

home01
$ tmux new -d -s hud -x 160 -y 44 shc hud
home01
$ tmux capture-pane -pt hud
Daemon: unix:/run/shc/shc.sock (--dae… <0> all <a> Actions <w> Export <ctrl-n> New <s> Shell <v> V…
Cluster: 1 node <1> default <b> Backup <ctrl-j> Follow <o> Open <shift-a> Sort Age <y> YA
Deployments: 9 (9 healthy) <shift-c> Clone <?> Help <shift-f> Port-Forward <shift-n> Sort Name
Tenant: prod <c> Copy <ctrl-k> Kill <p> Protect <shift-s> Sort Status
Stack: all <d> Describe <shift-l> Lease <shift-p> Repoint <shift-w> Start
Environment: all <e> Edit <l> Logs <r> Restart <shift-x> Stop
shc9s Rev: 0.1.0-rig.20261010224631.11e316f8fa
┌──────────────────────────────────────────────────────────────────── deployments(all)[6] ─────────────────────────────────────────────────────────────────────┐
│ STACK↑ TENANT ENV APP STATUS NODE LEASE ACCESS EXPOSURE REASON │
│ cloud prod prod nextcloud running home01 - open lan - │
│ db prod prod postgres running home01 - open lan - │
│ pgweb prod prod /root/learn/pgweb running home01 - open lan - │
│ placed prod prod notes running home01 - open lan - │
│ store prod prod /root/learn/versitygw running home01 - open lan - │
│ web prod prod /root/learn/nginx running home01 - open lan - │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
└──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘
<deployment>

The screen has three parts. The header at the top holds the session: the daemon it is pointed at, the cluster behind it as nodes up over nodes known, the deployments that are healthy over the deployments known, and whether the live event feed is up. A Warning row appears above them only when something needs attention: the vault locked, the licence in a state other than keyed, a freeze on automatic moves. Beside those rows is the legend: every key that does something on the focused table. Below is the table itself, and the bottom line is the breadcrumb of where you are.

The HUD opened on :deployments because that is what shc ctx points at: the tenant prod, every environment. The tenant, the environment and the stack are starting points, not pins; the keys below move off them.

Every table is reached by name. : opens the command bar; type a noun and press Enter. While the bar is open, Tab completes the noun, ctrl-u clears what you typed and esc closes the bar.

home01
$ tmux send-keys -t hud ':nodes' Enter
home01
$ tmux capture-pane -pt hud
Daemon: unix:/run/shc/shc.sock (--dae… <0> all <a> Actions <?> Help <shift-s> Sort Status
Cluster: 1 node <1> default <shift-k> Cordon <ctrl-d> Leave <v> Views
Deployments: 9 (9 healthy) <d> Describe <l> Logs <y> YAML
Tenant: prod <shift-d> Drain <e> Set-Public-Address
Stack: all <ctrl-j> Follow <shift-a> Sort Age
Environment: all <ctrl-k> Forget <shift-n> Sort Name
shc9s Rev: 0.1.0-rig.20261010224631.11e316f8fa
┌─────────────────────────────────────────────────────────────────────── nodes(all)[1] ────────────────────────────────────────────────────────────────────────┐
│ NAME↑ STATE CONDITION AVAIL CLOUD LOCATION ROOM BUILD LEADER VOTER │
│ home01 healthy ready active learn learn/home ok 0.1.0-rig.20261010224631.11e316f8fa true true │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
└──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘
<node>
😎 Viewing x9s/v1/nodes...

? lists every key live on this table, the global ones included. esc closes it, and closes anything else that opened over a table.

home01
$ tmux send-keys -t hud '?'
home01
$ tmux capture-pane -pt hud
Daemon: unix:/run/shc/shc.sock (--dae… <esc> Back
Cluster: 1 node
Deployments: 9 (9 healthy)
Tenant: prod
Stack: all
Environment: all
shc9s Rev: 0.1.0-rig.20261010224631.11e316f8fa
┌──────────────────────────────────────────────────────────────────────────── Help ────────────────────────────────────────────────────────────────────────────┐
│ RESOURCE GENERAL NAVIGATION HOTKEYS │
│ <0> all <ctrl-a> Aliases <j> Down │
│ <1> default <q> Back <shift-g> Goto Bottom │
│ <a> Actions <esc> Back/Clear <g> Goto Top │
│ <c> Copy <ctrl-u> Command Clear <[> History Back │
│ <shift-k> Cordon <:cmd> Command mode <]> History Forward │
│ <d> Describe <tab> Field Next <-> Last Used Command │
│ <shift-d> Drain <backtab> Field Previous <h> Left │
│ <ctrl-j> Follow </term> Filter mode <ctrl-f> Page Down │
│ <ctrl-k> Forget <?> Help <ctrl-b> Page Up │
│ <?> Help <space> Mark <l> Right │
│ <ctrl-d> Leave <ctrl-\> Mark Clear <k> Up │
│ <l> Logs <ctrl-space> Mark Range │
│ <ctrl-r> Refresh <:q> Quit │
│ <e> Set-Public-Address <ctrl-r> Reload │
│ <shift-a> Sort Age <ctrl-s> Save │
│ <shift-n> Sort Name <ctrl-g> Toggle Crumbs │
│ <shift-o> Sort Selected Column <ctrl-e> Toggle Header │
│ <shift-s> Sort Status │
│ <ctrl-z> Toggle Faults │
│ <ctrl-w> Toggle Wide │
│ <enter> View │
│ <v> Views │
│ <y> YAML │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
└──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘
<node> <help>
home01
$ tmux send-keys -t hud Escape

ctrl-a lists every noun the command bar takes, with its description. These are the tables of this tutorial.

home01
$ tmux send-keys -t hud C-a
home01
$ tmux capture-pane -pt hud
Daemon: unix:/run/shc/shc.sock (--dae… <enter> Goto
Cluster: 1 node <?> Help
Deployments: 9 (9 healthy)
Tenant: prod
Stack: all
Environment: all
shc9s Rev: 0.1.0
┌────────────────────────────────────────────────────────────────────── aliases(all)[73] ──────────────────────────────────────────────────────────────────────┐
│ RESOURCE↑ GROUP VERSION COMMAND │
│ addons x9s v1 addons addons.v1.x9s x9s/v1/addons │
│ aliases a alias │
│ aliases x9s v1 aliases aliases.v1.x9s x9s/v1/aliases │
│ apps x9s v1 apps apps.v1.x9s x9s/v1/apps │
│ audit x9s v1 audit audit.v1.x9s x9s/v1/audit │
│ backupkeys x9s v1 backupkeys backupkeys.v1.x9s x9s/v1/backupkeys │
│ backups x9s v1 backups backups.v1.x9s x9s/v1/backups │
│ benchmarks bench benchmark benchmarks │
│ certificates x9s v1 certificates certificates.v1.x9s x9s/v1/certificates │
│ cluster x9s v1 cluster cluster.v1.x9s x9s/v1/cluster │
│ clusterrolebindings crb │
│ clusterroles cr │
│ config x9s v1 config config.v1.x9s x9s/v1/config │
│ connections x9s v1 connections connections.v1.x9s x9s/v1/connections │
│ constraints x9s v1 constraints constraints.v1.x9s x9s/v1/constraints │
│ containers x9s v1 containers containers.v1.x9s x9s/v1/containers │
│ contexts x9s v1 context contexts contexts.v1.x9s ctx prov providers x9s/v1/contexts │
│ crons x9s v1 crons crons.v1.x9s x9s/v1/crons │
│ deployments dp │
│ deployments x9s v1 deployments deployments.v1.x9s x9s/v1/deployments │
│ diagnoses x9s v1 diagnoses diagnoses.v1.x9s x9s/v1/diagnoses │
│ dirs d dir dirs │
│ dns x9s v1 dns dns.v1.x9s x9s/v1/dns │
│ environments x9s v1 env environment environments environments.v1.x9s envs x9s/v1/environments │
│ events x9s v1 events events.v1.x9s x9s/v1/events │
│ exports x9s v1 exports exports.v1.x9s x9s/v1/exports │
│ forwards x9s v1 forwards forwards.v1.x9s fwd x9s/v1/forwards │
│ grants x9s v1 grants grants.v1.x9s x9s/v1/grants │
│ groups group grp │
│ groups x9s v1 groups groups.v1.x9s x9s/v1/groups │
│ helm chart charts helm hm │
│ helm-history helm-history │
└──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘
<node> <aliases>
home01
$ tmux send-keys -t hud Escape

Movement never changes anything. j and k move down and up a row, g and G jump to the top and the bottom, h scrolls left when a table is wider than the screen, ctrl-f and ctrl-b page. [ and ] step back and forward through the tables you visited, - flips to the last one, and esc on a drilled-into table walks back up.

home01
$ tmux send-keys -t hud 'j' 'j' 'k' 'G' 'g' 'h' C-f C-b
$ tmux send-keys -t hud ':deployments' Enter
home01
$ tmux capture-pane -pt hud
Daemon: unix:/run/shc/shc.sock (--dae… <0> all <a> Actions <w> Export <ctrl-n> New <s> Shell <v> V…
Cluster: 1 node <1> default <b> Backup <ctrl-j> Follow <o> Open <shift-a> Sort Age <y> YA
Deployments: 9 (9 healthy) <shift-c> Clone <?> Help <shift-f> Port-Forward <shift-n> Sort Name
Tenant: prod <c> Copy <ctrl-k> Kill <p> Protect <shift-s> Sort Status
Stack: all <d> Describe <shift-l> Lease <shift-p> Repoint <shift-w> Start
Environment: all <e> Edit <l> Logs <r> Restart <shift-x> Stop
shc9s Rev: 0.1.0-rig.20261010224631.11e316f8fa
┌──────────────────────────────────────────────────────────────────── deployments(all)[6] ─────────────────────────────────────────────────────────────────────┐
│ STACK↑ TENANT ENV APP STATUS NODE LEASE ACCESS EXPOSURE REASON │
│ cloud prod prod nextcloud running home01 - open lan - │
│ db prod prod postgres running home01 - open lan - │
│ pgweb prod prod /root/learn/pgweb running home01 - open lan - │
│ placed prod prod notes running home01 - open lan - │
│ store prod prod /root/learn/versitygw running home01 - open lan - │
│ web prod prod /root/learn/nginx running home01 - open lan - │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
└──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘
<deployment>
home01
$ tmux send-keys -t hud '['
home01
$ tmux capture-pane -pt hud
Daemon: unix:/run/shc/shc.sock (--dae… <0> all <a> Actions <?> Help <shift-s> Sort Status
Cluster: 1 node <1> default <shift-k> Cordon <ctrl-d> Leave <v> Views
Deployments: 9 (9 healthy) <d> Describe <l> Logs <y> YAML
Tenant: prod <shift-d> Drain <e> Set-Public-Address
Stack: all <ctrl-j> Follow <shift-a> Sort Age
Environment: all <ctrl-k> Forget <shift-n> Sort Name
shc9s Rev: 0.1.0-rig.20261010224631.11e316f8fa
┌─────────────────────────────────────────────────────────────────────── nodes(all)[1] ────────────────────────────────────────────────────────────────────────┐
│ NAME↑ STATE CONDITION AVAIL CLOUD LOCATION ROOM BUILD LEADER VOTER │
│ home01 healthy ready active learn learn/home ok 0.1.0-rig.20261010224631.11e316f8fa true true │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
└──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘
<node>
home01
$ tmux send-keys -t hud ']' '-'
home01
$ tmux capture-pane -pt hud
Daemon: unix:/run/shc/shc.sock (--dae… <0> all <a> Actions <w> Export <ctrl-n> New <s> Shell <v> V…
Cluster: 1 node <1> default <b> Backup <ctrl-j> Follow <o> Open <shift-a> Sort Age <y> YA
Deployments: 9 (9 healthy) <shift-c> Clone <?> Help <shift-f> Port-Forward <shift-n> Sort Name
Tenant: prod <c> Copy <ctrl-k> Kill <p> Protect <shift-s> Sort Status
Stack: all <d> Describe <shift-l> Lease <shift-p> Repoint <shift-w> Start
Environment: all <e> Edit <l> Logs <r> Restart <shift-x> Stop
shc9s Rev: 0.1.0-rig.20261010224631.11e316f8fa
┌──────────────────────────────────────────────────────────────────── deployments(all)[6] ─────────────────────────────────────────────────────────────────────┐
│ STACK↑ TENANT ENV APP STATUS NODE LEASE ACCESS EXPOSURE REASON │
│ cloud prod prod nextcloud running home01 - open lan - │
│ db prod prod postgres running home01 - open lan - │
│ pgweb prod prod /root/learn/pgweb running home01 - open lan - │
│ placed prod prod notes running home01 - open lan - │
│ store prod prod /root/learn/versitygw running home01 - open lan - │
│ web prod prod /root/learn/nginx running home01 - open lan - │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
└──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘
<deployment>

ctrl-e hides and shows the header, ctrl-g the breadcrumb, ctrl-r refreshes the table now instead of waiting for its next watch tick.

home01
$ tmux send-keys -t hud C-e
home01
$ tmux capture-pane -pt hud
┌──────────────────────────────────────────────────────────────────── deployments(all)[6] ─────────────────────────────────────────────────────────────────────┐
│ STACK↑ TENANT ENV APP STATUS NODE LEASE ACCESS EXPOSURE REASON │
│ cloud prod prod nextcloud running home01 - open lan - │
│ db prod prod postgres running home01 - open lan - │
│ pgweb prod prod /root/learn/pgweb running home01 - open lan - │
│ placed prod prod notes running home01 - open lan - │
│ store prod prod /root/learn/versitygw running home01 - open lan - │
│ web prod prod /root/learn/nginx running home01 - open lan - │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
└──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘
<deployment>
home01
$ tmux send-keys -t hud C-e C-g
home01
$ tmux capture-pane -pt hud
Daemon: unix:/run/shc/shc.sock (--dae… <0> all <a> Actions <w> Export <ctrl-n> New <s> Shell <v> V…
Cluster: 1 node <1> default <b> Backup <ctrl-j> Follow <o> Open <shift-a> Sort Age <y> YA
Deployments: 9 (9 healthy) <shift-c> Clone <?> Help <shift-f> Port-Forward <shift-n> Sort Name
Tenant: prod <c> Copy <ctrl-k> Kill <p> Protect <shift-s> Sort Status
Stack: all <d> Describe <shift-l> Lease <shift-p> Repoint <shift-w> Start
Environment: all <e> Edit <l> Logs <r> Restart <shift-x> Stop
shc9s Rev: 0.1.0-rig.20261010224631.11e316f8fa
┌──────────────────────────────────────────────────────────────────── deployments(all)[6] ─────────────────────────────────────────────────────────────────────┐
│ STACK↑ TENANT ENV APP STATUS NODE LEASE ACCESS EXPOSURE REASON │
│ cloud prod prod nextcloud running home01 - open lan - │
│ db prod prod postgres running home01 - open lan - │
│ pgweb prod prod /root/learn/pgweb running home01 - open lan - │
│ placed prod prod notes running home01 - open lan - │
│ store prod prod /root/learn/versitygw running home01 - open lan - │
│ web prod prod /root/learn/nginx running home01 - open lan - │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
└──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘
<deployment>
home01
$ tmux send-keys -t hud C-g C-r

ctrl-c quits. q does not: on a table it only clears a filter, the same as esc, so a hand that reaches for it finds the screen unchanged.

home01
$ tmux send-keys -t hud 'q'
home01
$ tmux capture-pane -pt hud
Daemon: unix:/run/shc/shc.sock (--dae… <0> all <a> Actions <w> Export <ctrl-n> New <s> Shell <v> V…
Cluster: 1 node <1> default <b> Backup <ctrl-j> Follow <o> Open <shift-a> Sort Age <y> YA
Deployments: 9 (9 healthy) <shift-c> Clone <?> Help <shift-f> Port-Forward <shift-n> Sort Name
Tenant: prod <c> Copy <ctrl-k> Kill <p> Protect <shift-s> Sort Status
Stack: all <d> Describe <shift-l> Lease <shift-p> Repoint <shift-w> Start
Environment: all <e> Edit <l> Logs <r> Restart <shift-x> Stop
shc9s Rev: 0.1.0-rig.20261010224631.11e316f8fa
┌──────────────────────────────────────────────────────────────────── deployments(all)[6] ─────────────────────────────────────────────────────────────────────┐
│ STACK↑ TENANT ENV APP STATUS NODE LEASE ACCESS EXPOSURE REASON │
│ cloud prod prod nextcloud running home01 - open lan - │
│ db prod prod postgres running home01 - open lan - │
│ pgweb prod prod /root/learn/pgweb running home01 - open lan - │
│ placed prod prod notes running home01 - open lan - │
│ store prod prod /root/learn/versitygw running home01 - open lan - │
│ web prod prod /root/learn/nginx running home01 - open lan - │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
└──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘
home01
$ tmux send-keys -t hud C-c

The HUD can also be opened at a scope. -t, -e and -s are the same flags every verb takes. -t is --tenant, and in the HUD that is a pin: the session cannot leave the tenant it names, where the tenant shc ctx set is only the first table’s starting point. -e and -s narrow the first table to one environment and one deployment, and the facet keys of the next page move off them. Open it pinned to master for a moment and quit.

home01
$ tmux new -d -s hud -x 160 -y 44 shc hud -t master -e default
home01
$ tmux capture-pane -pt hud
Daemon: unix:/run/shc/shc.sock (--dae… <0> all <a> Actions <w> Export <ctrl-n> New <s> Shell <v> V…
Cluster: 1 node <1> default <b> Backup <ctrl-j> Follow <o> Open <shift-a> Sort Age <y> YA
Deployments: 9 (9 healthy) <shift-c> Clone <?> Help <shift-f> Port-Forward <shift-n> Sort Name
Tenant: master <c> Copy <ctrl-k> Kill <p> Protect <shift-s> Sort Status
Stack: all <d> Describe <shift-l> Lease <shift-p> Repoint <shift-w> Start
Environment: default <e> Edit <l> Logs <r> Restart <shift-x> Stop
shc9s Rev: 0.1.0-rig.20261010224631.11e316f8fa
┌──────────────────────────────────────────────────────────────────── deployments(all)[3] ─────────────────────────────────────────────────────────────────────┐
│ STACK↑ TENANT ENV APP STATUS NODE LEASE ACCESS EXPOSURE REASON │
│ keycloak master default keycloak running home01 - open lan - │
│ postgres master default postgres running home01 - open lan - │
│ traefik master default traefik running home01 - open lan - │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
└──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘
<environments> <default> <deployment>
home01
$ tmux send-keys -t hud C-c

This page changed nothing on the cluster. The next page opens the HUD again and reads the deployment tables.

Next: Deployments, services and containers.