Skip to content

Commit fbfbccb

Browse files
committed
docs(tools): Add documentation for all 11 new tools
Document snapshot_pane, wait_for_content_change, display_message, select_pane, select_window, swap_pane, move_window, pipe_pane, enter_copy_mode, exit_copy_mode, and paste_text with usage guidance, JSON examples, and parameter tables following existing patterns. Update tools/index.md with new grid cards and expanded "Which tool do I want?" decision guide covering navigation, layout, scrollback, and paste workflows.
1 parent e263bfe commit fbfbccb

File tree

4 files changed

+545
-1
lines changed

4 files changed

+545
-1
lines changed

docs/tools/index.md

Lines changed: 85 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,18 +8,36 @@ All tools accept an optional `socket_name` parameter for multi-server support. I
88

99
**Reading terminal content?**
1010
- Know which pane? → {tool}`capture-pane`
11+
- Need text + cursor + mode in one call? → {tool}`snapshot-pane`
1112
- Don't know which pane? → {tool}`search-panes`
12-
- Need to wait for output? → {tool}`wait-for-text`
13+
- Need to wait for specific output? → {tool}`wait-for-text`
14+
- Need to wait for *any* change? → {tool}`wait-for-content-change`
1315
- Only need metadata (PID, path, size)? → {tool}`get-pane-info`
16+
- Need an arbitrary tmux variable? → {tool}`display-message`
1417

1518
**Running a command?**
1619
- {tool}`send-keys` — then {tool}`wait-for-text` + {tool}`capture-pane`
20+
- Pasting multi-line text? → {tool}`paste-text`
1721

1822
**Creating workspace structure?**
1923
- New session → {tool}`create-session`
2024
- New window → {tool}`create-window`
2125
- New pane → {tool}`split-window`
2226

27+
**Navigating?**
28+
- Switch pane → {tool}`select-pane` (by ID or direction)
29+
- Switch window → {tool}`select-window` (by ID, index, or direction)
30+
31+
**Rearranging layout?**
32+
- Swap two panes → {tool}`swap-pane`
33+
- Move window → {tool}`move-window`
34+
- Change layout → {tool}`select-layout`
35+
36+
**Scrollback / copy mode?**
37+
- Enter copy mode → {tool}`enter-copy-mode`
38+
- Exit copy mode → {tool}`exit-copy-mode`
39+
- Log output to file → {tool}`pipe-pane`
40+
2341
**Changing settings?**
2442
- tmux options → {tool}`show-option` / {tool}`set-option`
2543
- Environment vars → {tool}`show-environment` / {tool}`set-environment`
@@ -91,6 +109,24 @@ Query a tmux option value.
91109
Show tmux environment variables.
92110
:::
93111

112+
:::{grid-item-card} snapshot_pane
113+
:link: snapshot-pane
114+
:link-type: ref
115+
Rich capture: content + cursor + mode + scroll.
116+
:::
117+
118+
:::{grid-item-card} wait_for_content_change
119+
:link: wait-for-content-change
120+
:link-type: ref
121+
Wait for any screen change.
122+
:::
123+
124+
:::{grid-item-card} display_message
125+
:link: display-message
126+
:link-type: ref
127+
Query arbitrary tmux format strings.
128+
:::
129+
94130
::::
95131

96132
## Act
@@ -178,6 +214,54 @@ Set a tmux option.
178214
Set a tmux environment variable.
179215
:::
180216

217+
:::{grid-item-card} select_pane
218+
:link: select-pane
219+
:link-type: ref
220+
Focus a pane by ID or direction.
221+
:::
222+
223+
:::{grid-item-card} select_window
224+
:link: select-window
225+
:link-type: ref
226+
Focus a window by ID, index, or direction.
227+
:::
228+
229+
:::{grid-item-card} swap_pane
230+
:link: swap-pane
231+
:link-type: ref
232+
Exchange positions of two panes.
233+
:::
234+
235+
:::{grid-item-card} move_window
236+
:link: move-window
237+
:link-type: ref
238+
Move window to another index or session.
239+
:::
240+
241+
:::{grid-item-card} pipe_pane
242+
:link: pipe-pane
243+
:link-type: ref
244+
Stream pane output to a file.
245+
:::
246+
247+
:::{grid-item-card} enter_copy_mode
248+
:link: enter-copy-mode
249+
:link-type: ref
250+
Enter copy mode for scrollback.
251+
:::
252+
253+
:::{grid-item-card} exit_copy_mode
254+
:link: exit-copy-mode
255+
:link-type: ref
256+
Exit copy mode.
257+
:::
258+
259+
:::{grid-item-card} paste_text
260+
:link: paste-text
261+
:link-type: ref
262+
Paste multi-line text via tmux buffer.
263+
:::
264+
181265
::::
182266

183267
## Destroy

0 commit comments

Comments
 (0)