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

send_keys

Sends input to the target’s configured effective synchronized cohort without waiting for output. Every configured member must be live, nonmodal, and neither caller nor attended. Reports configured pane ids observed before dispatch, not delivery receipts. wait_for_text discounts recognized input; wait for the prompt before typing into a cold shell. Send input to a pane’s program; a shell that receives it runs it with your user’s permissions.

All Java tools · JSON · Source

Arguments

enter optional · boolean
Press Enter afterward, as a real keypress. Unlike a key named "Enter" sent under literal:true, which types the four letters, this always submits. Defaults to false.

Default: false.

keys optional · array | string
The key names or literal strings to send. One value may be sent on its own, without a list.
literal optional · boolean
Send strings literally instead of as key names. Defaults to false.

Default: false.

pane_id required · string
The pane to act on, such as %1. Every listing tool returns these.

Schemas

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

Input schema
{
"additionalProperties": false,
"properties": {
"enter": {
"default": false,
"description": "Press Enter afterward, as a real keypress. Unlike a key named \"Enter\" sent under literal:true, which types the four letters, this always submits. Defaults to false.",
"type": "boolean"
},
"keys": {
"description": "The key names or literal strings to send. One value may be sent on its own, without a list.",
"items": {
"type": "string"
},
"type": [
"array",
"string"
]
},
"literal": {
"default": false,
"description": "Send strings literally instead of as key names. Defaults to false.",
"type": "boolean"
},
"pane_id": {
"description": "The pane to act on, such as %1. Every listing tool returns these.",
"type": "string"
}
},
"required": [
"pane_id"
],
"type": "object"
}
Output schema
{
"additionalProperties": false,
"properties": {
"keys": {
"type": "integer"
},
"literal": {
"type": "boolean"
},
"note": {
"type": "string"
},
"pane_id": {
"type": "string"
},
"resolved_pane_ids": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"pane_id",
"keys",
"literal",
"resolved_pane_ids"
],
"type": "object"
}
Tool annotations
{
"destructiveHint": true,
"idempotentHint": false,
"openWorldHint": true,
"readOnlyHint": false,
"title": "Send keys"
}
Esc

Type to search.