Skip to content

doc: add cross-workspace targeting note for send/send-key/read-screen #5004

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
v2nic wants to merge 1 commit into
base: main
Choose a base branch
from
Open

doc: add cross-workspace targeting note for send/send-key/read-screen #5004

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 2 additions & 0 deletions skills/cmux-workspace/references/commands.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,8 @@ cmux send-key --surface "$CMUX_SURFACE_ID" enter
cmux read-screen --surface "$CMUX_SURFACE_ID"
```

**Cross-workspace targeting:** `send`, `send-key`, and `read-screen` resolve `--workspace` from `$CMUX_WORKSPACE_ID`. When targeting a surface outside the caller's workspace, you must pass `--workspace` explicitly. Omitting it produces the misleading `Error: invalid_params: Surface is not a terminal`.

## Sidebar Metadata

```bash
Expand Down
2 changes: 2 additions & 0 deletions skills/cmux/references/panes-surfaces.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,3 +35,5 @@ cmux reorder-surface --surface surface:7 --before surface:3
```

Surface identity is stable across move/reorder/split-off operations. Layout commands are focus-neutral by default; pass `--focus true` only when you want the moved or created surface selected.

**Cross-workspace input:** `send`, `send-key`, and `read-screen` resolve `--workspace` from `$CMUX_WORKSPACE_ID`. When targeting a surface outside the caller's workspace, you must pass `--workspace` explicitly. Omitting it produces the misleading `Error: invalid_params: Surface is not a terminal`.
Copy link
Copy Markdown
Contributor

@greptile-apps greptile-apps Bot May 30, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Note orphaned without section header or examples

The cross-workspace note is appended to a file that covers only layout operations (split, move, focus, reorder) and contains no send/send-key/read-screen examples. Without a section heading anchoring it, an agent or developer reading panes-surfaces.md for surface layout guidance won't naturally encounter the input section, and anyone specifically seeking input usage has no example to copy. The PR description mentioned adding an "Input and Screen Reading" section with examples — that section header and at least one --workspace example were not included in the diff. Adding a heading like ## Input and Screen Reading with a representative example (e.g. cmux read-screen --workspace workspace:46 --surface surface:266) above the bold note would make the guidance more discoverable and actionable.

Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!