Skip to content

docs(tui): document Vim mode keys in README #431

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
amandeavor wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs(tui): document Vim mode keys in README #431

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
49772db
docs(tui): document Vim mode keys in README
Sep 25, 2026
e77ebd3
Merge branch 'main' into docs/tui-vim-mode-keys
amandeavor Oct 24, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions packages/tui/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,25 @@ Shift plus Enter and Ctrl plus Enter depend on the terminal reporting a modified

Ctrl plus Backspace also depends on a distinct terminal sequence. When a terminal sends the ordinary Backspace byte for both keys, use Alt plus Backspace or Ctrl plus W for word deletion. Ordinary Backspace always remains single-grapheme deletion.

## Vim mode

Toggle with `/vim`. Editing starts in insert mode. Escape switches to normal mode; Escape in normal mode clears a pending `d` or `f` prefix.

| Action | Keys |
| --- | --- |
| Move left / down / up / right | `h` `j` `k` `l`, arrow keys |
| Word forward / back | `w` `b`, or the terminal word-left / word-right keys |
| Line start / end | `0` `$`, Home, End |
| Find next character on the line | `f` then a character |
| Enter insert mode | `i` (here), `a` (after cursor), `I` (line start), `A` (line end), `o` (open below), `O` (open above) |
| Delete character under cursor | `x` |
| Delete current line / word forward | `dd` / `dw` |
| Undo / redo | `u` / Ctrl+R |
| Paste from the kill ring | `p` or `P` |
| Open a slash command | `/` or `:` (both insert `/` and return to insert mode) |

Enter, Alt+Enter follow-up, and Tab stay with the ordinary editor bindings in normal mode.

## Quit and detach

`/detach` releases this attachment without cancelling work. `/quit` uses the host-injected SDK lifecycle surface to interrupt work and shut down the daemon after durable cleanup. Shared sessions or clients require confirmation. Escape interrupts while staying attached. Ctrl+C clears the editor; a second press within 500 ms quits. Ctrl+D quits with an empty editor. A missing host-control surface produces an explicit error, not a detach fallback. Failed or stalled graceful cleanup offers a separate force confirmation when the host supports it.
Expand Down