aboutsummaryrefslogtreecommitdiff
path: root/SOCKET_API.md
diff options
context:
space:
mode:
authorOgulcan Celik <ogulcancelik@gmail.com>2026-04-07 15:09:09 +0300
committerOgulcan Celik <ogulcancelik@gmail.com>2026-04-07 15:09:09 +0300
commit0276da6f2a44da493d1c198bcc6b5a8b1d2fda44 (patch)
tree4362a0c52fa42097d2c6fabc8212e4d01ddd459c /SOCKET_API.md
parent78fc0721a3d014fe96e778c6bb452cfdfbe67603 (diff)
fix: make pane run submit commands atomically
Diffstat (limited to 'SOCKET_API.md')
-rw-r--r--SOCKET_API.md4
1 files changed, 2 insertions, 2 deletions
diff --git a/SOCKET_API.md b/SOCKET_API.md
index c145aa53..ad5a80e7 100644
--- a/SOCKET_API.md
+++ b/SOCKET_API.md
@@ -830,7 +830,7 @@ herdr wait agent-state <pane_id> --state <idle|working|blocked|unknown> [--timeo
- `pane read --source recent-unwrapped` returns recent terminal text with soft wraps joined back together
- `pane send-text`, `pane send-keys`, and `pane run` print nothing on success
- list/get/create/split/wait commands print json on success
-- `pane run` is a convenience wrapper for `pane send-text` + `pane send-keys Enter`
+- `pane run` is a convenience wrapper for `pane send-text` with a trailing carriage return (`\r`)
- `wait agent-state` is a cli convenience built on top of event subscriptions
- `--raw` disables ansi stripping for `pane read` and `wait output`
- `wait output --source recent` matches against unwrapped recent terminal text by default, so pane width and soft wrapping do not break matches
@@ -860,7 +860,7 @@ herdr pane read 1-1 --source recent --lines 80
## behavior notes and gotchas
-- `pane.send_text` sends literal text only. if you want to execute a command, follow it with `pane.send_keys` and `Enter`, or use cli `pane run`.
+- `pane.send_text` sends literal text only. if you want to execute a command, follow it with `pane.send_keys` and `Enter`, or use cli `pane run`, which appends a trailing carriage return (`\r`).
- `pane.read` and `pane.wait_for_output` strip ansi by default.
- `pane.output_matched` subscriptions fire on transitions into a matching state; they do not repeatedly spam the same still-visible match on every poll.
- closing the socket connection ends the subscription.