Prerelease This site documents an alpha of libtmux. Its structure, URLs and APIs are subject to change.

capture_pane

Return visible text, or retained history when requested. Read pane output; accepts no client-supplied executable input. Returned content may be sensitive or untrusted.

All C++ tools · JSON · Source

Arguments

history optional · boolean
Capture retained history as well as the visible pane.
paneId required · string
Stable pane ID.

Schemas

The schema defines required fields, nested values, defaults, and validation constraints.

Input schema
{
"additionalProperties": false,
"properties": {
"history": {
"description": "Capture retained history as well as the visible pane.",
"type": "boolean"
},
"paneId": {
"description": "Stable pane ID.",
"maxLength": 512,
"type": "string"
}
},
"required": [
"paneId"
],
"type": "object"
}
Output schema
{
"additionalProperties": false,
"properties": {
"pane_id": {
"pattern": "^%[0-9]+$",
"type": "string"
},
"text": {
"type": "string"
}
},
"required": [
"pane_id",
"text"
],
"type": "object"
}
Tool annotations
{
"destructiveHint": true,
"idempotentHint": false,
"openWorldHint": true,
"readOnlyHint": false,
"title": "Capture a tmux pane"
}
Esc

Type to search.