Getting around
Move around the TUI with tabs, selection, namespace and owner scope, and themes, all working the same on every view.
The TUI has one layout everywhere: a row of tabs across the top, a detail pane for the selected row, a live table in the middle, and a footer that lists the keys available on the current view. The navigation on this page works the same regardless of which tab you are on. The per-view actions come in Managing resources.
The five tabs
The number keys switch between the managed kinds. The active tab is highlighted in the header.
| Key | Tab | What it lists |
|---|---|---|
1 | Workstations | Your workstations, with status, provider, address, and the latest status message. |
2 | Configs | WorkstationConfigs, with priority, package and tool counts, and the label selector that targets them. |
3 | Bindings | LocalBindings, with enabled state, target, forwarded ports, and readiness. |
4 | SSH Keys | SSHKeys, with the key’s path, its SOURCE (file or agent), and the selector that picks the workstations it reaches. |
5 | Grants | The shares you have created, with target, subjects, and rights. |
Each table refreshes on its own. Columns adapt to the terminal width: when space is tight, the lowest-priority columns drop out (the NAME column is always kept), and when there is room to spare, the flexible columns widen. Resize the window and the layout recomputes.
The detail pane
Above the table sits a live detail pane for whichever row is selected. As you move the selection, the pane updates, so you see the important fields of an object without opening a full describe view. Each kind shows the fields that matter for it: a Workstation, for example, shows its status and availability, provider, address, and login user on the left, and on the right everything attached to it, namely its Requirements and the Configs, Bindings, and SSH Keys that resolve onto it, along with its labels and generation.
This is what makes the tables useful at a glance: arrow down a list of workstations and
the pane walks you through each one’s summary in place. For the full object
(conditions, events, raw YAML), open the describe view
with D.
Moving within a table
| Key | Action |
|---|---|
↑ / k | Move the selection up. |
↓ / j | Move the selection down. |
g / G, Home / End | Jump to the top / bottom. |
PgUp / PgDn | Move a page up / down. |
R / Ctrl+R | Refresh now. |
? | List the keys for the current tab. |
Ctrl+P | Open the command palette: every command in this view, which you narrow by typing. |
L | Open the logs view. |
q / Ctrl+C | Quit. |
The footer shows the keys that work on the current view. When the window is too
narrow for all of them, the footer drops the last ones and keeps ? and
Ctrl+P. ? lists the dropped keys, and Ctrl+P lists every command.
Namespaces
By default the TUI shows every namespace you can see, and adds a NAMESPACE
column so you can tell rows apart. To scope to a single namespace, press n and
pick from the list (the list includes an all namespaces entry to widen back
out). You can also start scoped with -n <namespace> on the command line.
Switching the namespace re-lists from the API, because a different namespace is a different set of rows.
Owner scope: finding your own rows
In a shared namespace a table can hold many people’s resources. Two toggles keep your own work in front of you. They key off the owner the server stamps on each object, and they are a harmless no-op on kinds that carry no owner (SSH Keys and Bindings).
| Key | Toggle | Default |
|---|---|---|
O | Mine-first: float the rows you own to the top, keeping everyone else’s below. | On |
o | Mine-only: hide the rows explicitly owned by someone else. | Off |
An OWNER column appears automatically whenever the visible rows span more than
one owner, so you can always see whose is whose. Both toggles persist as you
switch tabs and as the data refreshes.
Themes
Pick a theme with --theme at launch:
auto(default) uses the theme named in theRINGLEADER_TUI_THEMEenvironment variable, anddarkwhen that variable is not set.darkandlightare self-contained palettes: each paints its own background and foreground on every region, so the TUI looks the same regardless of your terminal’s own colors.basicis a monochrome theme that inherits your terminal’s palette, for terminals with a limited or custom color scheme.
Note
-> for an arrow and - for an empty value)
rather than Unicode box-drawing glyphs. This keeps columns aligned in every
terminal, including ones that mis-measure wide characters.