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

wait_for_text

Discount this server’s pending input and recent submitted echoes; unmodelled keys stop tracking the current line. Wait for a new shell’s prompt before typing. matched_at_entry reports visible text at entry; a mode ending in -unconfirmed identifies input that was still unconfirmed at the deadline. Read pane output; accepts no client-supplied executable input. Returned content may be sensitive or untrusted.

All C++ tools · JSON · Source

Arguments

target required · string
Pane ID or pane target.
text required · string
Literal text to wait for.
timeout_ms optional · integer
Bounded wait in milliseconds.

Schemas

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

Input schema
{
"additionalProperties": false,
"properties": {
"target": {
"description": "Pane ID or pane target.",
"maxLength": 512,
"type": "string"
},
"text": {
"description": "Literal text to wait for.",
"maxLength": 4096,
"type": "string"
},
"timeout_ms": {
"description": "Bounded wait in milliseconds.",
"maximum": 60000,
"minimum": 1,
"type": "integer"
}
},
"required": [
"target",
"text"
],
"type": "object"
}
Output schema
{
"additionalProperties": false,
"properties": {
"elapsed_ms": {
"minimum": 0,
"type": "integer"
},
"matched": {
"type": "boolean"
},
"matched_at_entry": {
"type": "boolean"
},
"mode": {
"type": "string"
},
"pane_id": {
"pattern": "^%[0-9]+$",
"type": "string"
},
"text": {
"type": "string"
},
"timed_out": {
"type": "boolean"
}
},
"required": [
"elapsed_ms",
"matched",
"matched_at_entry",
"mode",
"text",
"timed_out"
],
"type": "object"
}
Tool annotations
{
"destructiveHint": true,
"idempotentHint": false,
"openWorldHint": true,
"readOnlyHint": false,
"title": "Wait for pane text"
}
Esc

Type to search.