|
| 1 | +(tools-overview)= |
| 2 | + |
| 3 | +# Tools |
| 4 | + |
| 5 | +All tools accept an optional `socket_name` parameter for multi-server support. It defaults to the `LIBTMUX_SOCKET` env var. See {ref}`configuration`. |
| 6 | + |
| 7 | +## Discovery |
| 8 | + |
| 9 | +Find and inspect tmux objects. |
| 10 | + |
| 11 | +- **`list_sessions`** — List all sessions (with optional filters) |
| 12 | +- **`list_windows`** — List windows in a session or across all sessions |
| 13 | +- **`list_panes`** — List panes in a window or across all windows |
| 14 | +- **`get_server_info`** — Server status: version, socket path, session count, alive status |
| 15 | +- **`get_pane_info`** — Pane metadata: size, title, current command, PID |
| 16 | + |
| 17 | +## Capture and search |
| 18 | + |
| 19 | +Read and search terminal output. |
| 20 | + |
| 21 | +- **`capture_pane`** — Capture pane content as text (visible area or scrollback) |
| 22 | +- **`search_panes`** — Search across all pane contents for text or regex |
| 23 | +- **`wait_for_text`** — Wait for text to appear in a pane (polling with timeout) |
| 24 | + |
| 25 | +## Session lifecycle |
| 26 | + |
| 27 | +Create and manage sessions. |
| 28 | + |
| 29 | +- **`create_session`** — Create a new session with optional window name, size, and env vars |
| 30 | +- **`rename_session`** — Rename an existing session |
| 31 | +- **`kill_session`** — Kill a session (destructive) |
| 32 | + |
| 33 | +## Windows and panes |
| 34 | + |
| 35 | +Create, split, and organize. |
| 36 | + |
| 37 | +- **`create_window`** — Create a new window in a session |
| 38 | +- **`split_window`** — Split a window to create a new pane (horizontal or vertical) |
| 39 | +- **`rename_window`** — Rename a window |
| 40 | +- **`select_layout`** — Set layout: `even-horizontal`, `even-vertical`, `main-horizontal`, `main-vertical`, `tiled` |
| 41 | +- **`resize_window`** — Resize a window (width and/or height) |
| 42 | +- **`resize_pane`** — Resize a pane (width, height, or zoom toggle) |
| 43 | +- **`kill_window`** — Kill a window (destructive) |
| 44 | +- **`kill_pane`** — Kill a pane (destructive) |
| 45 | + |
| 46 | +## Execution |
| 47 | + |
| 48 | +Send commands and interact with terminals. |
| 49 | + |
| 50 | +- **`send_keys`** — Send keys or text to a pane (with optional Enter, literal mode, history suppression) |
| 51 | +- **`set_pane_title`** — Set a pane's title |
| 52 | +- **`clear_pane`** — Clear pane content and scrollback history |
| 53 | + |
| 54 | +## Options and environment |
| 55 | + |
| 56 | +Read and set tmux configuration. |
| 57 | + |
| 58 | +- **`show_option`** — Query a tmux option value (server, session, window, or pane scope) |
| 59 | +- **`set_option`** — Set a tmux option |
| 60 | +- **`show_environment`** — Show tmux environment variables |
| 61 | +- **`set_environment`** — Set a tmux environment variable |
| 62 | + |
| 63 | +## Server management |
| 64 | + |
| 65 | +- **`kill_server`** — Kill the tmux server (destructive) |
| 66 | + |
| 67 | +## Tool parameter reference |
| 68 | + |
| 69 | +For full parameter documentation (types, defaults, descriptions), see the {ref}`about <about>` page. |
| 70 | + |
| 71 | +For API-level documentation, see the {ref}`API reference <api>`. |
0 commit comments