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

search_panes

Searches the visible output of every pane. Read pane output; accepts no client-supplied executable input. Returned content may be sensitive or untrusted.

All Java tools · JSON · Source

Arguments

max_lines optional · integer
Maximum matches across all panes. Defaults to 200.

Default: 200.

max_matches_per_pane optional · integer
Maximum matching lines per pane. Defaults to 5.

Default: 5.

pattern required · string
The bounded text or regular expression to search for.
regex optional · boolean
Treat pattern as a regular expression. Defaults to false.

Default: false.

Schemas

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

Input schema
{
"additionalProperties": false,
"properties": {
"max_lines": {
"default": 200,
"description": "Maximum matches across all panes. Defaults to 200.",
"type": "integer"
},
"max_matches_per_pane": {
"default": 5,
"description": "Maximum matching lines per pane. Defaults to 5.",
"type": "integer"
},
"pattern": {
"description": "The bounded text or regular expression to search for.",
"maxLength": 4096,
"type": "string"
},
"regex": {
"default": false,
"description": "Treat pattern as a regular expression. Defaults to false.",
"type": "boolean"
}
},
"required": [
"pattern"
],
"type": "object"
}
Output schema
{
"additionalProperties": false,
"properties": {
"bytes_searched": {
"type": "integer"
},
"count": {
"type": "integer"
},
"limited": {
"type": "boolean"
},
"lines_searched": {
"type": "integer"
},
"matches": {
"items": {
"additionalProperties": false,
"properties": {
"line": {
"type": "string"
},
"pane_id": {
"type": "string"
},
"session": {
"type": "string"
},
"window": {
"type": "string"
}
},
"required": [
"pane_id",
"session",
"window",
"line"
],
"type": "object"
},
"type": "array"
},
"note": {
"type": "string"
},
"panes_searched": {
"type": "integer"
},
"work_seconds": {
"type": "number"
}
},
"required": [
"count",
"panes_searched",
"lines_searched",
"bytes_searched",
"work_seconds",
"limited",
"matches"
],
"type": "object"
}
Tool annotations
{
"destructiveHint": true,
"idempotentHint": false,
"openWorldHint": true,
"readOnlyHint": false,
"title": "Search panes"
}
Esc

Type to search.