fh TUI
The TUI is ready to use. Keys and layouts may still change before 1.0.
fh tui [--cluster ID] [--context NAME]
A full-screen live view of the current context's deployment, fed by the same
WebSocket as the web UI. It authenticates the way the CLI does: the
fh auth login token, or the configured username and password.
The web UI remains the flagship and the TUI will not carry every feature. It covers what you reach for from a terminal: cluster health, lag, connector state, a quick look at data. Tell us what else you would use.
Views
1-9 jumps to the first nine, ⇧← / ⇧→ steps through all of them, and
:<name> opens any by name (:flink).
| # | View | Shows |
|---|---|---|
| 1 | Overview | Cluster health, throughput, signals summary |
| 2 | Signals | Health signals and open issues |
| 3 | Inspect | Data inspector: sample a topic |
| 4 | Topics | Topics by size and write rate, config, reassignment, ACLs |
| 5 | Groups | Consumer groups, lag, members, offset reset |
| 6 | Streams | Kafka Streams applications and topologies |
| 7 | Schema | Registries, subjects, versions |
| 8 | Brokers | Per-broker load, disk, config, KRaft quorum, ACLs |
| 9 | Connect | Connect clusters, connectors, tasks |
| 10 | Flink | Flink clusters, jobs, job topologies |
Keys
| Key | Action |
|---|---|
enter | Details for the selected row |
esc | Back |
i | Inspect data for the selected topic |
n / p | Next / previous tab within a view |
/ | Filter the table |
r | Refresh |
: | Command line |
? | Keys for the current screen |
q | Quit |
Tables take the arrow keys and PgUp / PgDn. Views with several tables
(Brokers, Topics, Groups, Connect) have tabs; n and p step through them.
On Topics, i opens the inspector for the selected topic: pick partition,
offset and deserializer, and it streams a sample. c fetches the next page,
x stops.
On Groups, enter shows members and assignments. On the Assignments tab, o
or a opens the offset-reset editor; nothing changes until you confirm.
Commands
| Command | Action |
|---|---|
:ctx [name] | Switch context (deployment) for this session; pick from a list or name one |
:t | Switch tenant |
:c | Switch cluster |
:theme [name] | Pick a colour theme or set one directly |
:<view> | Open a view by name |
:q | Quit |
Themes: fh-dark (default), fh-light, catppuccin-latte, catppuccin-frappe,
catppuccin-macchiato, catppuccin-mocha. The choice is saved to the config
file; :ctx is not.
Debugging
fh tui --debug
Adds two views, 13 Snapshots (the snapshot domains the client holds and their
update counts) and 14 WS Log (the last WebSocket events), and writes a
session log to ~/.fh/logs/tui-<timestamp>.log: every WebSocket event, every
REST request with status and duration, and reconnect and refusal notices. The
path is printed on exit. FH_WS_LOG=/path/to/file chooses the file instead,
with or without --debug. Attach the log when reporting a problem.