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

wait_for_text

Read pane output; accepts no client-supplied executable input. Returned content may be sensitive or untrusted. Wait within one deadline for pane text.

All Swift tools · JSON · Source

Arguments

cursor optional · string
Caller-controlled cursor.
maxLines optional · integer
Caller-controlled maxLines.
paneId required · string
Caller-controlled paneId.
patterns required · array
Caller-controlled patterns.
regex optional · boolean
Caller-controlled regex.
stop optional · array
Caller-controlled stop.
timeoutMs optional · integer
Caller-controlled timeoutMs.

Schemas

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

Input schema
{
"additionalProperties": false,
"properties": {
"cursor": {
"description": "Caller-controlled cursor.",
"maxLength": 16384,
"type": "string"
},
"maxLines": {
"description": "Caller-controlled maxLines.",
"maximum": 2000,
"minimum": 1,
"type": "integer"
},
"paneId": {
"description": "Caller-controlled paneId.",
"type": "string"
},
"patterns": {
"description": "Caller-controlled patterns.",
"items": {
"type": "string",
"x-libtmux-max-utf8-bytes": 4096
},
"maxItems": 32,
"type": "array"
},
"regex": {
"description": "Caller-controlled regex.",
"type": "boolean"
},
"stop": {
"description": "Caller-controlled stop.",
"items": {
"type": "string",
"x-libtmux-max-utf8-bytes": 4096
},
"maxItems": 32,
"type": "array"
},
"timeoutMs": {
"description": "Caller-controlled timeoutMs.",
"maximum": 600000,
"minimum": 100,
"type": "integer"
}
},
"required": [
"paneId",
"patterns"
],
"type": "object"
}
Output schema
{
"additionalProperties": false,
"properties": {
"cursor": {
"type": [
"string",
"null"
]
},
"effectiveTimeout": {
"type": "number"
},
"matched": {
"type": [
"string",
"null"
]
},
"matchedAtEntry": {
"type": "boolean"
},
"matchedIndex": {
"type": [
"integer",
"null"
]
},
"outcome": {
"type": "string"
},
"paneRef": {
"type": "string"
},
"sawNewOutput": {
"type": "boolean"
},
"seconds": {
"type": "number"
},
"tail": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"cursor",
"effectiveTimeout",
"matched",
"matchedAtEntry",
"matchedIndex",
"outcome",
"paneRef",
"sawNewOutput",
"seconds",
"tail"
],
"type": "object"
}
Tool annotations
{
"destructiveHint": true,
"idempotentHint": false,
"openWorldHint": true,
"readOnlyHint": false,
"title": "Wait for text"
}
Esc

Type to search.