diff options
| author | Dillon Mulroy <dillon.mulroy@gmail.com> | 2026-06-15 11:23:24 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2026-06-15 18:23:24 +0300 |
| commit | 16b69b6faa3f6de4ff8ae404442be95887370918 (patch) | |
| tree | 33dc8e62fef1daf29265dfc956e8bc0ca30c73d0 /docs/next/website/src | |
| parent | 9805e23a1225f74bb955b703c9457fdcff1bc952 (diff) | |
fix: support key-combo syntax for API send keys (#613)
Co-authored-by: Can Celik <ogulcancelik@gmail.com>
Diffstat (limited to 'docs/next/website/src')
| -rw-r--r-- | docs/next/website/src/content/docs/cli-reference.mdx | 7 | ||||
| -rw-r--r-- | docs/next/website/src/content/docs/socket-api.mdx | 6 |
2 files changed, 13 insertions, 0 deletions
diff --git a/docs/next/website/src/content/docs/cli-reference.mdx b/docs/next/website/src/content/docs/cli-reference.mdx index f1e0d834..99f1faae 100644 --- a/docs/next/website/src/content/docs/cli-reference.mdx +++ b/docs/next/website/src/content/docs/cli-reference.mdx @@ -145,6 +145,13 @@ herdr pane send-keys <pane_id> <key> [key ...] herdr pane run <pane_id> <command> ``` +`<key>` uses Herdr key-combo syntax: plain printable keys such as `a`, +special keys such as `enter`, `tab`, `esc`, `backspace`, `left`, `right`, +`up`, and `down`, modifier chords such as `ctrl+h`, `control+j`, `alt+x`, +and `shift+tab`, function keys such as `f1`, and named punctuation such as +`minus`, `plus`, and `backtick`. Legacy `C-c` and `c-c` are accepted as +aliases for `ctrl+c`. + `pane run` submits text plus Enter atomically. Prefer it over `send-text` plus `send-keys Enter` for commands. Report agent state from custom hooks: diff --git a/docs/next/website/src/content/docs/socket-api.mdx b/docs/next/website/src/content/docs/socket-api.mdx index 0331d560..88280441 100644 --- a/docs/next/website/src/content/docs/socket-api.mdx +++ b/docs/next/website/src/content/docs/socket-api.mdx @@ -99,6 +99,12 @@ Pane control methods use public pane ids such as `w1:p1`. Methods whose schema makes `pane_id` optional use the server's active focused pane when it is omitted. `pane.move` always requires the source `pane_id`. +`pane.send_keys` and `pane.send_input.keys` accept Herdr key-combo strings: +plain printable keys, special keys like `enter` and `esc`, modifier chords +like `ctrl+h`, `control+j`, `alt+x`, and `shift+tab`, function keys like +`f1`, and named punctuation like `minus` and `plus`. They do not accept +`prefix+` binding strings. + ```json {"id":"req_current","method":"pane.current","params":{"caller_pane_id":"w1:p1"}} {"id":"req_layout","method":"pane.layout","params":{"pane_id":"w1:p1"}} |