Skip to content
SHC Docs

shc workshop

open a workshop in tmux, the pages on the left and a tab per node on the right

Open a workshop in tmux. The left pane shows the workshop’s pages with every command block as an item. The right pane is one tab per terminal session the pages name, each started by the workshop’s own terminal/.sh. Selecting a command block, by mouse or keyboard, switches to its session’s tab, types the command there and runs it. A command that needs a value an earlier one printed is typed and left for you to put the value in and press Enter. A check block runs its examiner test and shows the result. A tab is named for its node as the pages name it.

The tabs open on your session of the workshop on the training portal, the same lab and the same terminals the portal shows in the browser: a command typed in either shows in both. The first run signs you in to the portal in your browser, then finds your open session of the workshop or starts one. The session’s ssh config and key are kept under ~/.config/shc/workshop, never in ~/.ssh, and go once the session has ended or you sign out with shc workshop logout. With --local the tabs open on a lab already in your own ssh config instead, as Host node1, node2 and so on.

Outside tmux the command creates its own session and attaches to it. Inside tmux it creates its own session and switches the client to it; the session you were in keeps its options.

is a built-in workshop or the path of a workshop directory holding content/ and terminal/. The built-in ones are cluster, single-node and the learn-* workshops written from the Learn pages, learn-app first.

shc workshop <name> [flags]
shc workshop learn-app
shc workshop cluster --local
shc workshop ./workshops/single-node/workshop --local
shc workshop cluster --list
-h, --help help for workshop
--list print the pages and their blocks instead of opening tmux
--local open the tabs on a lab already in your ssh config, with no portal
--portal string the training portal to sign in to, by default $SHC_WORKSHOP_PORTAL or https://learn.selfhostedcloud.org
--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
  • shc workshop logout - sign out of the training portal and remove the ssh config and keys of its sessions