docs(cli): document terminal read --screen and realign terminal help usage (#15893)

The bundled orca-cli skill guide never mentioned `terminal read --screen`,
so agents onboarded from it used the stream read on repainting TUIs and got
stacked fragments. Add a --screen example plus the stream-vs-screen and
--screen/--cursor rules, and realign the root help usage lines for
terminal read and terminal split with their command specs.

Fixes #15856
This commit is contained in:
Jason Brashear
2026-10-26 10:22:12 -07:00
committed by GitHub
parent ce4e0579ce
commit e3ece052e0
3 changed files with 7 additions and 4 deletions
+3
View File
@@ -196,6 +196,7 @@ ORCA terminal list --worktree id:<repoId>::<worktreePath> --json
ORCA terminal show --terminal <handle> --json
ORCA terminal read --terminal <handle> --json
ORCA terminal read --terminal <handle> --cursor <cursor> --limit 1000 --json
ORCA terminal read --terminal <handle> --screen --json
ORCA terminal read --json
ORCA terminal send --terminal <handle> --text "continue" --enter --json
ORCA terminal send --terminal <handle> --text "continue" --enter --wait-submit 10 --json
@@ -223,6 +224,8 @@ Terminal rules:
- `terminal list --json` omits `visualLayouts` to keep the common agent payload bounded. Add `--include-visual-layouts` only when tab and pane topology is required.
- A paired server has no window. `terminal switch --environment <name>` moves the desktop app on this machine to that server's terminal, and reports `navigated: false` when no desktop here shows that server.
- Use `terminal read` before `terminal send` unless the next input is obvious.
- `terminal read` returns accumulated output with escape sequences stripped, not the rendered screen, so anything that repaints (shells, progress bars, TUIs) reads as stacked fragments. Use `--screen` whenever the answer depends on what the terminal actually shows.
- `--screen` and `--cursor` are mutually exclusive: a screen read is the current frame and has no history to page.
- Use `terminal send` only for direct terminal input or one-off prompts where no task state, inbox, or reply tracking is needed.
- `accepted: true` proves input acceptance, not a started turn. Use the receipt's `turn_started` stage when submission proof is needed; never resend on silence.
- A text-plus-Enter agent prompt is refused with `agent_prompt_blocked` while the agent shows a permission or trust menu. To answer the menu, send `--text` and `--enter` as separate commands.
File diff suppressed because one or more lines are too long
+2 -2
View File
@@ -62,12 +62,12 @@ export const ROOT_HELP_TEXT_SECONDARY = [
' orca file open-changed [--mode edit|diff|both] [--worktree <selector>] [--focus] [--json]',
' orca terminal list [--worktree <selector>] [--limit <n>] [--include-visual-layouts] [--json]',
' orca terminal show [--terminal <handle>] [--json]',
' orca terminal read [--terminal <handle>] [--cursor <n>] [--limit <n>] [--json]',
' orca terminal read [--terminal <handle>] [--cursor <n>] [--limit <n>] [--screen] [--json]',
' orca terminal send [--terminal <handle>] [--text <text>] [--enter] [--interrupt] [--wait-submit <seconds>] [--retry-request <id>] [--json]',
' orca terminal wait [--terminal <handle>] --for exit|tui-idle [--timeout-ms <ms>] [--json]',
' orca agent launch --agent <id> [--worktree <selector>] [--prompt <text>] [--model <id>] [--effort <level>] [--focus] [--json]',
' orca terminal create [--worktree <selector>] [--title <name>] [--command <text>] [--shell <shell>] [--focus] [--json]',
' orca terminal split [--terminal <handle>] [--direction horizontal|vertical] [--json]',
' orca terminal split [--terminal <handle>] [--direction horizontal|vertical] [--command <text>] [--retry-split <leafId>] [--json]',
' orca terminal switch [--terminal <handle>] [--json]',
' orca terminal close ([--terminal <handle>] [--tab] | --worktree <selector> --all) [--json]',
' orca project list [--json]',