aboutsummaryrefslogtreecommitdiff
path: root/website/src/content/docs
diff options
context:
space:
mode:
authorOgulcan Celik <ogulcancelik@gmail.com>2026-06-15 19:12:13 +0300
committerOgulcan Celik <ogulcancelik@gmail.com>2026-06-15 19:12:13 +0300
commit2ace7f24a9a9fa43ab765becf29c40181af61a08 (patch)
treeea5a8185447a830ebc1477c82e448209a61b46af /website/src/content/docs
parentbefe629312d9ddf0fea91d1c70f1e4c69afeaf76 (diff)
docs: sync #613 key-combo docs for 0.7.0 and credit @dmmulroy
Diffstat (limited to 'website/src/content/docs')
-rw-r--r--website/src/content/docs/cli-reference.mdx7
-rw-r--r--website/src/content/docs/socket-api.mdx6
2 files changed, 13 insertions, 0 deletions
diff --git a/website/src/content/docs/cli-reference.mdx b/website/src/content/docs/cli-reference.mdx
index 74320f8a..f1079995 100644
--- a/website/src/content/docs/cli-reference.mdx
+++ b/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/website/src/content/docs/socket-api.mdx b/website/src/content/docs/socket-api.mdx
index 2f430a74..74697fd8 100644
--- a/website/src/content/docs/socket-api.mdx
+++ b/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"}}