Skip to content
Docs

'hyve tui'

The hyve tui command launches a full-screen terminal user interface that lets you navigate and execute any Hyve operation without memorising flags or command syntax.

Usage

Terminal window
hyve tui

No flags or arguments are required. The TUI takes over the terminal and guides you step by step.


KeyAction
/ Move between options
EnterSelect / confirm
Shift+TabGo back within a multi-step form
← Back optionReturn to the previous menu
Quit optionExit the TUI from the root menu
Ctrl+CExit at any point

The TUI is fully loop-based — after completing an action you are returned to the same menu, so you can run multiple operations in a session without re-launching.


Root Menu

Hyve — what would you like to do?
> cluster — manage Kubernetes clusters
template — reusable cluster patterns
git — manage Git repositories
workflow — automated pipelines
Quit

Selecting any section drills down into a sub-menu for that command group. Selecting ← Back from any sub-menu returns you to the root.


Sections

cluster

ActionDescription
Create a clusterTemplate selected from list; cluster name, region, and optional param overrides collected.
List clustersPrints all cluster definitions in the current repository with driver and status.
Show clusterCluster selected from list; displays full YAML definition.
Configure kubeconfig (auth)Cluster selected from list; runs module auth operation to merge kubeconfig into ~/.kube/config.
Remove kubeconfig context (deauth)Cluster selected from list; strips the context entry from ~/.kube/config.
Delete a clusterCluster selected from list; sets spec.delete: true and reconciles. Lifecycle hooks run automatically.

template

ActionDescription
List templatesPrints all templates in the current repository.
Show templateTemplate selected from list; displays full definition.
Create templateDriver source, driver version, region, and params collected via form.
Validate templateTemplate selected from list; checks driver is locked and workflows exist.
Delete templateTemplate selected from list; requires confirmation.

git

Repository management

ActionDescription
Add repositoryURL, alias, and optional username collected via form.
List repositoriesPrints all configured repos.
Use (switch to) repositoryRepository selected from list.
Show statusDisplays current repo status.
Remove repositoryRepository selected from list; requires confirmation.

Branch management

ActionDescription
List branchesPrints all branches.
Create branchName, switch-after, and push options collected via form.
Switch branchBranch name and optional pull.
Delete branchRequires confirmation; safe or force delete.

Pull / push / sync

ActionDescription
PullPulls latest changes from remote.
PushCommit message collected then changes pushed.
SyncCommit message collected; pulls then pushes.

workflow

ActionDescription
CreateChoose default template or import an existing YAML file.
RunWorkflow selected from list; optional cluster and log/output flags.
ListPrints all workflows.
ShowWorkflow selected from list; displays full definition.
ValidateWorkflow selected from list; reports errors and warnings.
DeleteWorkflow selected from list; requires confirmation.

Smart Selects

Wherever possible, the TUI populates select menus from live data rather than requiring typed input:

FieldSource
Cluster name (including for kubeconfig auth/deauth)YAML files in clusters/ directory of current repository
Workflow nameworkflows/ directory in current repository
Template nametemplates/ directory in current repository
Git repositoryLocal repository database

Color Scheme

The TUI uses a yellow and blue theme:

  • Yellow (#F5C518) — titles, selected option indicators, text input cursor
  • Blue (#4A9FD5) — field borders, text input prompt
  • Dark blue (#1E6FA8) — focused button background