mirror of
https://github.com/NousResearch/hermes-agent.git
synced 2026-05-18 04:41:56 +00:00
* docs: deep audit — fix stale config keys, missing commands, and registry drift Cross-checked ~80 high-impact docs pages (getting-started, reference, top-level user-guide, user-guide/features) against the live registries: hermes_cli/commands.py COMMAND_REGISTRY (slash commands) hermes_cli/auth.py PROVIDER_REGISTRY (providers) hermes_cli/config.py DEFAULT_CONFIG (config keys) toolsets.py TOOLSETS (toolsets) tools/registry.py get_all_tool_names() (tools) python -m hermes_cli.main <subcmd> --help (CLI args) reference/ - cli-commands.md: drop duplicate hermes fallback row + duplicate section, add stepfun/lmstudio to --provider enum, expand auth/mcp/curator subcommand lists to match --help output (status/logout/spotify, login, archive/prune/ list-archived). - slash-commands.md: add missing /sessions and /reload-skills entries + correct the cross-platform Notes line. - tools-reference.md: drop bogus '68 tools' headline, drop fictional 'browser-cdp toolset' (these tools live in 'browser' and are runtime-gated), add missing 'kanban' and 'video' toolset sections, fix MCP example to use the real mcp_<server>_<tool> prefix. - toolsets-reference.md: list browser_cdp/browser_dialog inside the 'browser' row, add missing 'kanban' and 'video' toolset rows, drop the stale '38 tools' count for hermes-cli. - profile-commands.md: add missing install/update/info subcommands, document fish completion. - environment-variables.md: dedupe GMI_API_KEY/GMI_BASE_URL rows (kept the one with the correct gmi-serving.com default). - faq.md: Anthropic/Google/OpenAI examples — direct providers exist (not just via OpenRouter), refresh the OpenAI model list. getting-started/ - installation.md: PortableGit (not MinGit) is what the Windows installer fetches; document the 32-bit MinGit fallback. - installation.md / termux.md: installer prefers .[termux-all] then falls back to .[termux]. - nix-setup.md: Python 3.12 (not 3.11), Node.js 22 (not 20); fix invalid 'nix flake update --flake' invocation. - updating.md: 'hermes backup restore --state pre-update' doesn't exist — point at the snapshot/quick-snapshot flow; correct config key 'updates.pre_update_backup' (was 'update.backup'). user-guide/ - configuration.md: api_max_retries default 3 (not 2); display.runtime_footer is the real key (not display.runtime_metadata_footer); checkpoints defaults enabled=false / max_snapshots=20 (not true / 50). - configuring-models.md: 'hermes model list' / 'hermes model set ...' don't exist — hermes model is interactive only. - tui.md: busy_indicator -> tui_status_indicator with values kaomoji|emoji|unicode|ascii (not kawaii|minimal|dots|wings|none). - security.md: SSH backend keys (TERMINAL_SSH_HOST/USER/KEY) live in .env, not config.yaml. - windows-wsl-quickstart.md: there is no 'hermes api' subcommand — the OpenAI-compatible API server runs inside hermes gateway. user-guide/features/ - computer-use.md: approvals.mode (not security.approval_level); fix broken ./browser-use.md link to ./browser.md. - fallback-providers.md: top-level fallback_providers (not model.fallback_providers); the picker is subcommand-based, not modal. - api-server.md: API_SERVER_* are env vars — write to per-profile .env, not 'hermes config set' which targets YAML. - web-search.md: drop web_crawl as a registered tool (it isn't); deep-crawl modes are exposed through web_extract. - kanban.md: failure_limit default is 2, not '~5'. - plugins.md: drop hard-coded '33 providers' count. - honcho.md: fix unclosed quote in echo HONCHO_API_KEY snippet; document that 'hermes honcho' subcommand is gated on memory.provider=honcho; reconcile subcommand list with actual --help output. - memory-providers.md: legacy 'hermes honcho setup' redirect documented. Verified via 'npm run build' — site builds cleanly; broken-link count went from 149 to 146 (no regressions, fixed a few in passing). * docs: round 2 audit fixes + regenerate skill catalogs Follow-up to the previous commit on this branch: Round 2 manual fixes: - quickstart.md: KIMI_CODING_API_KEY mentioned alongside KIMI_API_KEY; voice-mode and ACP install commands rewritten — bare 'pip install ...' doesn't work for curl-installed setups (no pip on PATH, not in repo dir); replaced with 'cd ~/.hermes/hermes-agent && uv pip install -e ".[voice]"'. ACP already ships in [all] so the curl install includes it. - cli.md / configuration.md: 'auxiliary.compression.model' shown as 'google/gemini-3-flash-preview' (the doc's own claimed default); actual default is empty (= use main model). Reworded as 'leave empty (default) or pin a cheap model'. - built-in-plugins.md: added the bundled 'kanban/dashboard' plugin row that was missing from the table. Regenerated skill catalogs: - ran website/scripts/generate-skill-docs.py to refresh all 163 per-skill pages and both reference catalogs (skills-catalog.md, optional-skills-catalog.md). This adds the entries that were genuinely missing — productivity/teams-meeting-pipeline (bundled), optional/finance/* (entire category — 7 skills: 3-statement-model, comps-analysis, dcf-model, excel-author, lbo-model, merger-model, pptx-author), creative/hyperframes, creative/kanban-video-orchestrator, devops/watchers, productivity/shop-app, research/searxng-search, apple/macos-computer-use — and rewrites every other per-skill page from the current SKILL.md. Most diffs are tiny (one line of refreshed metadata). Validation: - 'npm run build' succeeded. - Broken-link count moved 146 -> 155 — the +9 are zh-Hans translation shells that lag every newly-added skill page (pre-existing pattern). No regressions on any en/ page.
230 lines
12 KiB
Markdown
230 lines
12 KiB
Markdown
---
|
|
sidebar_position: 2
|
|
title: "TUI"
|
|
description: "Launch the modern terminal UI for Hermes — mouse-friendly, rich overlays, and non-blocking input."
|
|
---
|
|
|
|
# TUI
|
|
|
|
The TUI is the modern front-end for Hermes — a terminal UI backed by the same Python runtime as the [Classic CLI](cli.md). Same agent, same sessions, same slash commands; a cleaner, more responsive surface for interacting with them.
|
|
|
|
It's the recommended way to run Hermes interactively.
|
|
|
|
## Launch
|
|
|
|
```bash
|
|
# Launch the TUI
|
|
hermes --tui
|
|
|
|
# Resume the latest TUI session (falls back to the latest classic session)
|
|
hermes --tui -c
|
|
hermes --tui --continue
|
|
|
|
# Resume a specific session by ID or title
|
|
hermes --tui -r 20260409_000000_aa11bb
|
|
hermes --tui --resume "my t0p session"
|
|
|
|
# Run source directly — skips the prebuild step (for TUI contributors)
|
|
hermes --tui --dev
|
|
```
|
|
|
|
You can also enable it via env var:
|
|
|
|
```bash
|
|
export HERMES_TUI=1
|
|
hermes # now uses the TUI
|
|
hermes chat # same
|
|
```
|
|
|
|
The classic CLI remains available as the default. Anything documented in [CLI Interface](cli.md) — slash commands, quick commands, skill preloading, personalities, multi-line input, interrupts — works in the TUI identically.
|
|
|
|
## Why the TUI
|
|
|
|
- **Instant first frame** — the banner paints before the app finishes loading, so the terminal never feels frozen while Hermes is starting.
|
|
- **Non-blocking input** — type and queue messages before the session is ready. Your first prompt sends the moment the agent comes online.
|
|
- **Rich overlays** — model picker, session picker, approval and clarification prompts all render as modal panels rather than inline flows.
|
|
- **Live session panel** — tools and skills fill in progressively as they initialize.
|
|
- **Mouse-friendly selection** — drag to highlight with a uniform background instead of SGR inverse. Copy with your terminal's normal copy gesture.
|
|
- **Alternate-screen rendering** — differential updates mean no flicker when streaming, no scrollback clutter after you quit.
|
|
- **Composer affordances** — inline paste-collapse for long snippets, `Cmd+V` / `Ctrl+V` text paste with clipboard-image fallback, bracketed-paste safety, and image/file-path attachment normalization.
|
|
|
|
Same [skins](features/skins.md) and [personalities](features/personality.md) apply. Switch mid-session with `/skin ares`, `/personality pirate`, and the UI repaints live. See [Skins & Themes](features/skins.md) for the full list of customizable keys and which ones apply to classic vs TUI — the TUI honors the banner palette, UI colors, prompt glyph/color, session display, completion menu, selection bg, `tool_prefix`, and `help_header`.
|
|
|
|
## Requirements
|
|
|
|
- **Node.js** ≥ 20 — the TUI runs as a subprocess launched from the Python CLI. `hermes doctor` verifies this.
|
|
- **TTY** — like the classic CLI, piping stdin or running in non-interactive environments falls back to single-query mode.
|
|
|
|
On first launch Hermes installs the TUI's Node dependencies into `ui-tui/node_modules` (one-time, a few seconds). Subsequent launches are fast. If you pull a new Hermes version, the TUI bundle is rebuilt automatically when sources are newer than the dist.
|
|
|
|
### External prebuild
|
|
|
|
Distributions that ship a prebuilt bundle (Nix, system packages) can point Hermes at it:
|
|
|
|
```bash
|
|
export HERMES_TUI_DIR=/path/to/prebuilt/ui-tui
|
|
hermes --tui
|
|
```
|
|
|
|
The directory must contain `dist/entry.js` and an up-to-date `node_modules`.
|
|
|
|
## Keybindings
|
|
|
|
Keybindings match the [Classic CLI](cli.md#keybindings) exactly. The only behavioral differences:
|
|
|
|
- **Mouse drag** highlights text with a uniform selection background.
|
|
- **`Cmd+V` / `Ctrl+V`** first tries normal text paste, then falls back to OSC52/native clipboard reads, and finally image attach when the clipboard or pasted payload resolves to an image.
|
|
- **`/terminal-setup`** installs local VS Code / Cursor / Windsurf terminal bindings for better `Cmd+Enter` and undo/redo parity on macOS.
|
|
- **Slash autocompletion** opens as a floating panel with descriptions, not an inline dropdown.
|
|
- **`Ctrl+X`** — when a queued message is highlighted (sent while the agent was still running), delete it from the queue. **`Esc`** cancels editing and unhighlights without deleting.
|
|
- **`Ctrl+G` / `Ctrl+X Ctrl+E`** — open the current input buffer in `$EDITOR` for multi-line / long-prompt composition; save-and-exit sends the contents back as the prompt.
|
|
|
|
## Slash commands
|
|
|
|
All slash commands work unchanged. A few are TUI-owned — they produce richer output or render as overlays rather than inline panels:
|
|
|
|
| Command | TUI behavior |
|
|
|---------|--------------|
|
|
| `/help` | Overlay with categorized commands, arrow-key navigable |
|
|
| `/sessions` | Modal session picker — preview, title, token totals, resume inline |
|
|
| `/model` | Modal model picker grouped by provider, with cost hints |
|
|
| `/skin` | Live preview — theme change applies as you browse |
|
|
| `/details` | Toggle verbose tool-call details (global or per-section) |
|
|
| `/usage` | Rich token / cost / context panel |
|
|
| `/agents` (alias `/tasks`) | Observability overlay — live subagent tree with kill/pause controls, per-branch cost / token / file rollups, turn-by-turn history |
|
|
| `/reload` | Re-reads `~/.hermes/.env` into the running TUI process so newly added API keys take effect without a restart |
|
|
| `/mouse` | Toggle mouse tracking on/off at runtime (also persists to `display.mouse_tracking` in `config.yaml`) |
|
|
|
|
Every other slash command (including installed skills, quick commands, and personality toggles) works identically to the classic CLI. See [Slash Commands Reference](../reference/slash-commands.md).
|
|
|
|
## LaTeX math rendering
|
|
|
|
The TUI's markdown pipeline renders LaTeX math inline: `$E = mc^2$` and `$$\frac{a}{b}$$` render as Unicode-formatted math instead of the raw TeX source. Works for inline and block math; unsupported syntax falls back to showing the literal TeX wrapped in a code span so it remains copyable.
|
|
|
|
This is always-on — nothing to configure. Classic CLI keeps the raw TeX.
|
|
|
|
## Light-terminal detection
|
|
|
|
The TUI auto-detects light terminals and swaps to the light theme accordingly. Detection works in three layers:
|
|
|
|
1. `HERMES_TUI_THEME` env var — highest priority. Values: `light`, `dark`, or a raw 6-char background hex (e.g. `ffffff`, `1a1a2e`).
|
|
2. `COLORFGBG` env var — the classic "what's my background color?" hint used by xterm-derived terminals.
|
|
3. Terminal background probe via OSC 11 — works on modern terminals (Ghostty, Warp, iTerm2, WezTerm, Kitty) that don't set `COLORFGBG`.
|
|
|
|
If you want the light theme permanently regardless of terminal:
|
|
|
|
```bash
|
|
export HERMES_TUI_THEME=light
|
|
```
|
|
|
|
## Busy indicator styles
|
|
|
|
The status-bar busy indicator is pluggable — the default rotates Hermes' kawaii face palette every 2.5 seconds during agent work. Pick a different style via config or the `/indicator` slash command:
|
|
|
|
```yaml
|
|
display:
|
|
tui_status_indicator: kaomoji # kaomoji | emoji | unicode | ascii
|
|
```
|
|
|
|
Or in-session: `/indicator emoji` (etc.). Styles ship with matched glyph widths so the rest of the status bar doesn't jitter on rotation.
|
|
|
|
## Auto-resume
|
|
|
|
By default, `hermes --tui` starts a fresh session each launch. To re-attach to the most recent TUI session automatically (useful when your terminal or SSH connection drops unexpectedly), opt in:
|
|
|
|
```bash
|
|
export HERMES_TUI_RESUME=1 # most-recent TUI session
|
|
# or:
|
|
export HERMES_TUI_RESUME=<session-id> # specific session
|
|
```
|
|
|
|
Unset the variable or pass `--resume <id>` explicitly to override on a per-launch basis.
|
|
|
|
## Status line
|
|
|
|
The TUI's status line tracks agent state in real time:
|
|
|
|
| Status | Meaning |
|
|
|--------|---------|
|
|
| `starting agent…` | Session ID is live; tools and skills still coming online. You can type — messages queue and send when ready. |
|
|
| `ready` | Agent is idle, accepting input. |
|
|
| `thinking…` / `running…` | Agent is reasoning or running a tool. |
|
|
| `interrupted` | Current turn was cancelled; press Enter to send again. |
|
|
| `forging session…` / `resuming…` | Initial connect or `--resume` handshake. |
|
|
|
|
The per-skin status-bar colors and thresholds are shared with the classic CLI — see [Skins](features/skins.md) for customization.
|
|
|
|
The status line also shows:
|
|
|
|
- **Working directory with git branch** — `~/projects/hermes-agent (docs/two-week-gap-sweep)`. The branch suffix updates when you `git checkout` in a side terminal (mtime-cached) so the TUI reflects your actual active branch, not whatever it was at launch.
|
|
- **Per-prompt elapsed time** — `⏱ 12s/3m 45s` while the turn is running (live), frozen to `⏲ 32s / 3m 45s` after the turn completes. First number is time since last user message; second is total session duration. Resets on every new prompt.
|
|
|
|
## Configuration
|
|
|
|
The TUI respects all standard Hermes config: `~/.hermes/config.yaml`, profiles, personalities, skins, quick commands, credential pools, memory providers, tool/skill enablement. No TUI-specific config file exists.
|
|
|
|
A handful of keys tune the TUI surface specifically:
|
|
|
|
```yaml
|
|
display:
|
|
skin: default # any built-in or custom skin
|
|
personality: helpful
|
|
details_mode: collapsed # hidden | collapsed | expanded — global accordion default
|
|
sections: # optional: per-section overrides (any subset)
|
|
thinking: expanded # always open
|
|
tools: expanded # always open
|
|
activity: collapsed # opt back IN to the activity panel (hidden by default)
|
|
mouse_tracking: true # disable if your terminal conflicts with mouse reporting
|
|
```
|
|
|
|
Runtime toggles:
|
|
|
|
- `/details [hidden|collapsed|expanded|cycle]` — set the global mode
|
|
- `/details <section> [hidden|collapsed|expanded|reset]` — override one section
|
|
(sections: `thinking`, `tools`, `subagents`, `activity`)
|
|
|
|
**Default visibility**
|
|
|
|
The TUI ships with opinionated per-section defaults that stream the turn as
|
|
a live transcript instead of a wall of chevrons:
|
|
|
|
- `thinking` — **expanded**. Reasoning streams inline as the model emits it.
|
|
- `tools` — **expanded**. Tool calls and their results render open.
|
|
- `subagents` — falls through to the global `details_mode` (collapsed under
|
|
chevron by default — stays quiet until a delegation actually happens).
|
|
- `activity` — **hidden**. Ambient meta (gateway hints, terminal-parity
|
|
nudges, background notifications) is noise for most day-to-day use. Tool
|
|
failures still render inline on the failing tool row; ambient
|
|
errors/warnings surface via a floating-alert backstop when every panel
|
|
is hidden.
|
|
|
|
Per-section overrides take precedence over both the section default and the
|
|
global `details_mode`. To reshape the layout:
|
|
|
|
- `display.sections.thinking: collapsed` — put thinking back under a chevron
|
|
- `display.sections.tools: collapsed` — put tool calls back under a chevron
|
|
- `display.sections.activity: collapsed` — opt the activity panel back in
|
|
- `/details <section> <mode>` at runtime
|
|
|
|
Anything set explicitly in `display.sections` wins over the defaults, so
|
|
existing configs keep working unchanged.
|
|
|
|
## Sessions
|
|
|
|
Sessions are shared between the TUI and the classic CLI — both write to the same `~/.hermes/state.db`. You can start a session in one, resume in the other. The session picker surfaces sessions from both sources, with a source tag.
|
|
|
|
See [Sessions](sessions.md) for lifecycle, search, compression, and export.
|
|
|
|
## Reverting to the classic CLI
|
|
|
|
Launching `hermes` (without `--tui`) stays on the classic CLI. To make a machine prefer the TUI, set `HERMES_TUI=1` in your shell profile. To go back, unset it.
|
|
|
|
If the TUI fails to launch (no Node, missing bundle, TTY issue), Hermes prints a diagnostic and falls back — rather than leaving you stuck.
|
|
|
|
## See also
|
|
|
|
- [CLI Interface](cli.md) — full slash command and keybinding reference (shared)
|
|
- [Sessions](sessions.md) — resume, branch, and history
|
|
- [Skins & Themes](features/skins.md) — theme the banner, status bar, and overlays
|
|
- [Voice Mode](features/voice-mode.md) — works in both interfaces
|
|
- [Configuration](configuration.md) — all config keys
|