From e41821342b04b98d0e25238be6aea8260401ac1a Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Sat, 3 Jan 2026 06:28:36 +0100 Subject: [PATCH] docs: refresh tui guide --- CHANGELOG.md | 3 ++- docs/refactor/tui.md | 2 +- docs/tui.md | 22 ++++++++++++++++++---- 3 files changed, 21 insertions(+), 6 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index fc783987b..1cae7b382 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -49,7 +49,8 @@ - CLI: add `configure`, `doctor`, and `update` wizards for ongoing setup, health checks, and modernization. - CLI: add Signal CLI auto-install from GitHub releases in the wizard and persist wizard run metadata in config. - CLI: add remote gateway client config (gateway.remote.*) with Bonjour-assisted discovery. -- CLI: add `clawdis tui` gateway-connected terminal UI (local or remote). +- CLI: enhance `clawdis tui` with model/session pickers, tool cards, and slash commands (local or remote). +- Gateway: allow `sessions.patch` to set per-session model overrides (used by the TUI `/model` flow). - Skills: allow `bun` as a node manager for skill installs. - Skills: add `things-mac` (Things 3 CLI) for read/search plus add/update via URL scheme. - Skills: add Apple Notes + Reminders skills via memo CLI (thanks @tylerwince). diff --git a/docs/refactor/tui.md b/docs/refactor/tui.md index ef976f57e..42aea2acb 100644 --- a/docs/refactor/tui.md +++ b/docs/refactor/tui.md @@ -22,5 +22,5 @@ Updated: 2026-01-03 - [x] Gateway TUI client: add session/model helpers + stricter typing. - [x] TUI UI kit: theme + components (editor, message feed, tool cards, selectors). - [x] TUI controller: keybindings + Clawdis slash commands + history/stream wiring. -- [ ] Docs + changelog updated for the new TUI behavior. +- [x] Docs + changelog updated for the new TUI behavior. - [ ] Gate: lint, build, tests, docs list. diff --git a/docs/tui.md b/docs/tui.md index b59dfe79d..262779c4a 100644 --- a/docs/tui.md +++ b/docs/tui.md @@ -10,6 +10,7 @@ Updated: 2026-01-03 ## What it is - A terminal UI that connects to the Gateway WebSocket and speaks the same chat APIs as WebChat. +- Uses Gateway agent events for tool cards while streaming responses. - Works locally (loopback) or remotely (Tailscale/SSH tunnel) without running a separate agent process. ## Run @@ -28,7 +29,7 @@ Use SSH tunneling or Tailscale to reach the Gateway WS. - `--token `: Gateway token (if required). - `--password `: Gateway password (if required). - `--session `: Session key (default: `session.mainKey` or `main`). -- `--deliver`: Deliver assistant replies to the provider. +- `--deliver`: Deliver assistant replies to the provider (default off). - `--thinking `: Override thinking level for sends. - `--timeout-ms `: Agent timeout in ms (default 30000). - `--history-limit `: History entries to load (default 200). @@ -36,16 +37,29 @@ Use SSH tunneling or Tailscale to reach the Gateway WS. ## Controls - Enter: send message - Esc: abort active run -- Ctrl+C: exit +- Ctrl+C: clear input (press twice to exit) +- Ctrl+D: exit +- Ctrl+L: model picker +- Ctrl+P: session picker +- Ctrl+O: toggle tool output expansion +- Ctrl+T: toggle thinking visibility ## Slash commands - `/help` -- `/session ` +- `/status` +- `/session ` (or `/sessions`) +- `/model ` (or `/models`) +- `/think ` +- `/verbose ` +- `/activation ` +- `/deliver ` +- `/new` or `/reset` - `/abort` +- `/settings` - `/exit` ## Notes -- The TUI shows Gateway chat deltas (`event: chat`) and final responses. +- The TUI shows Gateway chat deltas (`event: chat`) and agent tool events. - It registers as a Gateway client with `mode: "tui"` for presence and debugging. ## Files