Skip to content

Commit 7d7aa4b

Browse files
committed
docs(tools): Add "Which tool do I want?" decision guide
why: The tools index showed a flat catalog grouped by safety tier, but didn't help users select the right tool for their intent. what: - Add intent-based decision guide above the Inspect/Act/Destroy grid - Groups by task: reading content, running commands, creating structure - Uses {tool} role for badged links, {envvar} for env var ref
1 parent 0e681db commit 7d7aa4b

1 file changed

Lines changed: 21 additions & 1 deletion

File tree

docs/tools/index.md

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,27 @@
22

33
# Tools
44

5-
All tools accept an optional `socket_name` parameter for multi-server support. It defaults to the `LIBTMUX_SOCKET` env var. See {ref}`configuration`.
5+
All tools accept an optional `socket_name` parameter for multi-server support. It defaults to the {envvar}`LIBTMUX_SOCKET` env var. See {ref}`configuration`.
6+
7+
## Which tool do I want?
8+
9+
**Reading terminal content?**
10+
- Know which pane? → {tool}`capture-pane`
11+
- Don't know which pane? → {tool}`search-panes`
12+
- Need to wait for output? → {tool}`wait-for-text`
13+
- Only need metadata (PID, path, size)? → {tool}`get-pane-info`
14+
15+
**Running a command?**
16+
- {tool}`send-keys` — then {tool}`wait-for-text` + {tool}`capture-pane`
17+
18+
**Creating workspace structure?**
19+
- New session → {tool}`create-session`
20+
- New window → {tool}`create-window`
21+
- New pane → {tool}`split-window`
22+
23+
**Changing settings?**
24+
- tmux options → {tool}`show-option` / {tool}`set-option`
25+
- Environment vars → {ref}`show-environment` / {ref}`set-environment`
626

727
## Inspect
828

0 commit comments

Comments
 (0)