better-dsh 0.2.5-c → 0.2.5-e

package/docs/80_upstream-docs-and-skills/hermes-dev-skill/src/docs/user-guide/tui.md

@@ -1,313 +0,0 @@
----
-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
-hermes --tui --resume latest
-
-# Resume a specific session by ID or title
-hermes --tui -r 20260409_000000_aa11bb
-hermes --tui --resume "my t0p session"
-
-# Resume the latest session for a specific project directory
-hermes --tui --resume latest --in ./my-project
-
-# 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
-```
-
-Or make it the persistent default in `~/.hermes/config.yaml`:
-
-```yaml
-display:
-  interface: tui   # "cli" (default) or "tui"
-```
-
-With `display.interface: tui`, a bare `hermes` (and `hermes chat`) launches the TUI. Explicit flags always win — run `hermes --cli` to drop back to the classic REPL for a single invocation, or `hermes --tui` / `HERMES_TUI=1` to force the TUI when the config default is `cli`.
-
-The classic CLI remains the shipped 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`.
-
-### Collapsible banner sections
-
-The TUI startup banner groups runtime info into four collapsible sections, each rendered with a `▸` / `▾` chevron next to the section title:
-
-| Section | Default state |
-|---------|---------------|
-| Tools | Open |
-| Skills | Collapsed |
-| System Prompt | Collapsed |
-| MCP Servers | Collapsed |
-
-Click anywhere on a section header (or its chevron) to toggle it. The Tools list opens by default because it's the most-checked section at session start; Skills, System Prompt, and MCP Servers collapse by default so the banner stays compact even when you've installed dozens of skills or wired up many MCP servers. State is local to the banner instance, so the next launch resets to the defaults.
-
-## 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.
-
-:::tip Working across git worktrees?
-Contributors who run `hermes --tui --dev` from many worktrees can share one `node_modules` instead of installing per checkout — see [TUI & Desktop from Worktrees](../developer-guide/worktree-ui-dev.md).
-:::
-
-### 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`.
-
-## Keybindings
-
-Keybindings match the [Classic CLI](cli.md#keybindings) exactly. The only behavioral differences:
-
-- **`Ctrl+T`** expands the automatic live-subagent dock into the full-height `/agents` roster. Select a worker and press **Enter** (or **`t`**) for its live transcript, **`d`** for rich details, **`e`** to steer, or **`x`** to stop it. The dock fits its row count to terminal height and preserves your composer draft. See [Monitoring subagents](/user-guide/features/delegation#monitoring-running-subagents-agents).
-- **`F7`** toggles the live dock between its default preview and one summary line. This does not open the monitor or move composer focus; the choice lasts for this TUI process without changing config.
-- **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`** opens the live session switcher. When a queued message is highlighted (sent while the agent was still running), it still deletes that queued message instead. **`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` (alias `/switch`) | Live session switcher — list open TUI sessions, switch between them, close them, or start another one |
-| `/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 [on\|off\|toggle\|wheel\|buttons\|all]` | Pick a mouse tracking preset at runtime (also persists to `display.mouse_tracking` in `config.yaml`). `wheel` (1000+1006) keeps scroll-wheel scrolling without the hover events that make tmux spam "No image in clipboard" over the prompt row; `buttons` adds drag-to-select; `all` is the default with hover-driven UI. |
-
-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).
-
-## Live session switcher
-
-Use the live session switcher when you want one terminal to act as a dispatcher for several TUI sessions. It lists only sessions that are currently live in this TUI process; closed sessions remain saved transcripts and can still be reopened with `/resume` or `hermes --tui --resume <id-or-title>`.
-
-Open it with any of these:
-
-- `Ctrl+X` from the TUI.
-- `/sessions` or `/switch`.
-- `/sessions new` to create a fresh live session immediately.
-- Click the `N live sessions` count in the status line.
-
-<img alt="Hermes TUI Session Orchestrator with one live session and a +new row" src="/docs/img/docs/tui-session-orchestrator/session-orchestrator.png" />
-
-<video controls muted loop playsInline src="/docs/img/docs/tui-session-orchestrator/session-orchestrator-demo.mp4" title="Hermes TUI Session Orchestrator demo" style={{maxWidth: '100%'}}></video>
-
-Inside the switcher:
-
-- `↑` / `↓` move the selection; mouse clicks select rows too.
-- `Enter` switches to the selected live session.
-- `Ctrl+D` closes the selected live session.
-- `Ctrl+N` starts a blank live session.
-- `Ctrl+R` refreshes the live-session list.
-- `Esc` closes the switcher.
-- Select `+new`, type a prompt, and press `Enter` to dispatch a new live session. Press `Tab` first if you want to choose a model just for that new session.
-
-## 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:
-
-After a session is named, its title appears as an accent-colored badge at the far-right edge of the status line. The title takes the workspace label's place and truncates on narrow terminals.
-
-| 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.
-- **`🗜️ N`** — number of times the running session has been auto-compressed. Appears once the first compression fires.
-- **`▶ N`** — number of `/bg` tasks currently running in this session. Appears whenever at least one task is in flight.
-- **`⚠ YOLO`** — visible warning whenever YOLO mode is on (`hermes --yolo`, `/yolo`, or `HERMES_YOLO_MODE=1`). The same badge also appears in the startup banner so you cannot launch an auto-approving session without noticing.
-
-## 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: all        # off | wheel | buttons | all (or true/false for back-compat).
-                             #   wheel   — 1000+1006 (scroll + click; no drag, no hover —
-                             #             recommended inside tmux to silence the prompt-row
-                             #             "No image in clipboard" spam from hover events)
-                             #   buttons — adds 1002 for terminal-side drag selection
-                             #   all     — adds 1003 for hover (scrollbar paginate-on-hover,
-                             #             link mouseenter, etc.)
-```
-
-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.
-
-## How the TUI talks to its gateway
-
-By default the TUI spawns its own in-process gateway, so each TUI instance is self-contained — there's nothing to configure.
-
-You may see a `HERMES_TUI_GATEWAY_URL` env var referenced in the codebase or logs. This is an **internal wiring detail of the web dashboard**, not a user-facing remote-attach knob. When you open the dashboard's "Chat" tab (`hermes dashboard` → `/chat`), the dashboard's web server spawns an embedded TUI child process and injects `HERMES_TUI_GATEWAY_URL` so that child attaches to the dashboard's own in-process `tui_gateway` over a loopback WebSocket (`/api/ws`). The `/api/ws` endpoint exists only inside the dashboard server (`hermes_cli/web_server.py`) and is bound to that process's lifetime and auth.
-
-There is no general "point any TUI at any standalone gateway port" mode. In particular, the OpenAI-compatible API server (`hermes gateway` / the `api_server` platform) does **not** serve `/api/ws` — it's the model-backend surface (`/v1/chat/completions`, `/v1/models`, …) and deliberately does not expose the TUI's JSON-RPC control channel. Setting `HERMES_TUI_GATEWAY_URL` to that port will 404.
-
-### If the connection drops
-
-- **Spawned gateway (default):** when the gateway process dies mid-session the TUI says *Hermes stopped unexpectedly — restarting and reopening your chat*, respawns it (bounded to a few attempts per minute) and reopens the same saved session. The reply that was in flight is lost with the process.
-- **Attached gateway (dashboard chat):** when only the WebSocket drops the TUI says *Connection to Hermes lost — reconnecting and reopening your chat…*, reconnects with growing backoff and reattaches to the same session — including a reply that is still streaming on the backend. Nothing is resubmitted.
-
-If you want multiple surfaces to share one set of sessions, use the shared `~/.hermes/state.db` (see [Sessions](sessions.md)) or the web dashboard's embedded chat (see [Web Dashboard](features/web-dashboard.md#chat)) — not a hand-set gateway URL.
-
-## Reverting to the classic CLI
-
-Launching `hermes` (without `--tui`) stays on the classic CLI by default. To make a machine prefer the TUI, set `display.interface: tui` in `~/.hermes/config.yaml` (persistent) or `HERMES_TUI=1` in your shell profile (per-shell). To go back, set `interface: cli` / unset the env var, or pass `hermes --cli` for a one-off.
-
-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

package/docs/80_upstream-docs-and-skills/hermes-dev-skill/src/docs/user-guide/which-file-does-what.md

@@ -1,57 +0,0 @@
----
-sidebar_position: 4
-title: "Which File Does What?"
-description: "SOUL.md vs USER.md vs MEMORY.md vs AGENTS.md — a one-page map of the agent's files, who writes each one, and when the agent actually sees them"
----
-
-# Which File Does What?
-
-"I told my agent something and it forgot." "Which file is my agent's brain?" "I edited SOUL.md — why doesn't it know my name?" These questions all come down to the same thing: Hermes Agent is shaped by several markdown files, and each one has a different job. This page maps them all in one place. For depth on any of them, follow the links to [Persistent Memory](/user-guide/features/memory), [Personality & SOUL.md](/user-guide/features/personality), and [Context Files](/user-guide/features/context-files).
-
-## The Master Table
-
-| File | What it holds | Who writes it | When the agent sees it | Where it lives |
-|------|---------------|---------------|------------------------|----------------|
-| **SOUL.md** | The agent's primary identity — personality, tone, communication style, what to avoid stylistically | You. Hermes seeds a starter file automatically if one doesn't exist; existing files are never overwritten | Slot #1 of the system prompt, at session start | `~/.hermes/SOUL.md` (or `$HERMES_HOME/SOUL.md` with a custom home) — never the working directory |
-| **USER.md** | User profile — your name, role, preferences, communication style, expectations | The agent, via the `memory` tool (you can gate saves with `write_approval`, or edit entries via `hermes journey edit`) | Injected into the system prompt as a frozen snapshot at session start | `~/.hermes/memories/` |
-| **MEMORY.md** | Agent's personal notes — environment facts, project conventions, tool quirks, things learned | The agent, via the `memory` tool (same gating and editing options as USER.md) | Injected into the system prompt as a frozen snapshot at session start | `~/.hermes/memories/` |
-| **AGENTS.md** | Project instructions, conventions, architecture — commands, ports, paths, repo-specific workflows | You (or whoever authors the project) | Loaded into the system prompt at startup from your working directory; nested copies are discovered progressively as the agent navigates subdirectories | Project working directory + subdirectories |
-| **.hermes.md** / **HERMES.md** | Project instructions, like AGENTS.md but Hermes-specific and highest priority | You | Loaded into the system prompt at startup (first match wins over AGENTS.md) | Your project — discovery walks up to the git root |
-
-:::info One project context file per session
-Only **one** project context type is loaded per session, first match wins: `.hermes.md` → `AGENTS.md` → `CLAUDE.md` → `.cursorrules`. `SOUL.md` is always loaded independently as the agent identity — it is not part of that priority chain. See [Context Files](/user-guide/features/context-files) for the full list, including `CLAUDE.md` and `.cursorrules` compatibility.
-:::
-
-A useful shorthand:
-
-- **SOUL.md** is who the agent *is* — if it should follow you everywhere, it belongs here.
-- **USER.md** is who *you* are — the agent maintains it for you.
-- **MEMORY.md** is what the agent has *learned* — it maintains this itself too.
-- **AGENTS.md** (or `.hermes.md`) is what the *project* needs — if it belongs to a project, it belongs here.
-
-## "Why did it forget what I just said?"
-
-Memory (MEMORY.md and USER.md) is injected into the system prompt as a **frozen snapshot** captured once at session start — when the agent saves something mid-session, the change is persisted to disk immediately but won't appear in the system prompt until the next session starts. This is intentional: it preserves the LLM's prefix cache for performance, and tool responses always show the live state, so nothing is lost — start a new session and the updated memory is there. Full details in [How Memory Appears in the System Prompt](/user-guide/features/memory#how-memory-appears-in-the-system-prompt).
-
-## Common Mix-Ups
-
-### "I put facts about myself in SOUL.md, but USER.md stayed empty"
-
-`SOUL.md` and `USER.md` are separate systems that never feed each other. `SOUL.md` is a personality file **you** edit directly — it shapes tone and identity, and its content is injected verbatim as slot #1 of the prompt. `USER.md` is part of persistent memory and is written by **the agent** through the `memory` tool. If you want facts about yourself in USER.md, tell the agent ("remember that I prefer concise answers") and it saves them — editing SOUL.md won't populate memory, and memory entries won't change the persona. Use SOUL.md for durable voice and personality guidance; leave preferences and profile facts to memory. See [What should go in SOUL.md?](/user-guide/features/personality#what-should-go-in-soulmd) and [Two Targets Explained](/user-guide/features/memory#two-targets-explained).
-
-### "I told it my name mid-session and it acted like it never heard it"
-
-If the agent saved your name to memory, the save worked — check with the `memory` tool's responses or `hermes journey list`. What you're seeing is the frozen-snapshot rule above: the system prompt doesn't refresh mid-session, so the *injected* memory block still shows the session-start state. The agent can still use what you told it within the current conversation (it's in the context), and the saved entry will be in the system prompt from the next session onward. The same applies to edits you make to `SOUL.md` or `AGENTS.md` while a session is running: context is assembled at session start, so restart the session to pick up changes.
-
-:::tip Quick decision guide
-- Want to change how the agent **talks**? Edit `~/.hermes/SOUL.md` — [Personality & SOUL.md](/user-guide/features/personality).
-- Want the agent to **remember a fact**? Just tell it — it saves to memory itself. [Persistent Memory](/user-guide/features/memory).
-- Want to set **project rules**? Put an `AGENTS.md` (or `.hermes.md`) in the project — [Context Files](/user-guide/features/context-files).
-- Need a **temporary** personality change? Use `/personality` — it's a session-level overlay, no file edits needed.
-:::
-
-## Related Docs
-
-- [Persistent Memory](/user-guide/features/memory) — MEMORY.md, USER.md, the `memory` tool, capacity limits, `write_approval`
-- [Personality & SOUL.md](/user-guide/features/personality) — SOUL.md content guidance, `/personality` presets, the prompt stack
-- [Context Files](/user-guide/features/context-files) — AGENTS.md, `.hermes.md`, progressive discovery, security scanning