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

capture_pane

Read pane output; accepts no client-supplied executable input. Returned content may be sensitive or untrusted. Return a bounded slice of rendered pane text.

All Swift tools · JSON · Source

Arguments

end optional · integer
Caller-controlled end.
joinWrapped optional · boolean
Caller-controlled joinWrapped.
maxLines optional · integer
Caller-controlled maxLines.
paneId required · string
Caller-controlled paneId.
start optional · integer
Caller-controlled start.

Schemas

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

Input schema
{
"additionalProperties": false,
"properties": {
"end": {
"description": "Caller-controlled end.",
"maximum": 32767,
"minimum": -2147483648,
"type": "integer"
},
"joinWrapped": {
"description": "Caller-controlled joinWrapped.",
"type": "boolean"
},
"maxLines": {
"description": "Caller-controlled maxLines.",
"maximum": 2000,
"minimum": 1,
"type": "integer"
},
"paneId": {
"description": "Caller-controlled paneId.",
"type": "string"
},
"start": {
"description": "Caller-controlled start.",
"maximum": 32767,
"minimum": -2147483648,
"type": "integer"
}
},
"required": [
"paneId"
],
"type": "object"
}
Output schema
{
"additionalProperties": false,
"properties": {
"droppedLines": {
"type": "integer"
},
"lines": {
"items": {
"type": "string"
},
"type": "array"
},
"paneId": {
"type": "string"
}
},
"required": [
"droppedLines",
"lines",
"paneId"
],
"type": "object"
}
Tool annotations
{
"destructiveHint": true,
"idempotentHint": false,
"openWorldHint": true,
"readOnlyHint": false,
"title": "Capture pane"
}
Esc

Type to search.