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

send_keys_batch

Send input to a pane’s program; a shell that receives it runs it with your user’s permissions. Send several keystrokes to one pane in order, in a single call. Use for a short interactive sequence — open a file, move, type, save — instead of one call per key. Each operation refuses the named pane in a human-owned mode and, when source input expands, every synchronized input cohort peer. A batch has at most 64 steps and 64 KiB of UTF-8 text. Each delay is 0-2000 ms and all delays together must fit the server wait ceiling.

All .NET tools · JSON · Source

Arguments

onError optional · string
Stop after the first failed operation, or continue serially.

Default: "stop".

operations required · array
Between 1 and 64 bounded pane-input operations, executed serially.

Schemas

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

Input schema
{
"additionalProperties": false,
"properties": {
"onError": {
"default": "stop",
"description": "Stop after the first failed operation, or continue serially.",
"enum": [
"continue",
"stop"
],
"type": "string"
},
"operations": {
"description": "Between 1 and 64 bounded pane-input operations, executed serially.",
"items": {
"additionalProperties": false,
"properties": {
"delayMilliseconds": {
"default": null,
"maximum": 2000,
"minimum": 0,
"type": [
"integer",
"null"
]
},
"enter": {
"default": false,
"type": "boolean"
},
"keys": {
"type": "string"
},
"literal": {
"default": true,
"type": "boolean"
},
"paneId": {
"default": null,
"type": [
"string",
"null"
]
},
"suppressHistory": {
"default": false,
"type": "boolean"
}
},
"required": [
"keys"
],
"type": "object"
},
"maxItems": 64,
"minItems": 1,
"type": "array"
}
},
"required": [
"operations"
],
"type": "object"
}
Output schema
{
"properties": {
"failed": {
"type": "integer"
},
"onError": {
"type": "string"
},
"results": {
"items": {
"properties": {
"error": {
"type": [
"string",
"null"
]
},
"index": {
"type": "integer"
},
"paneId": {
"type": [
"string",
"null"
]
},
"success": {
"type": "boolean"
},
"targetPaneIds": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"index",
"paneId",
"success",
"error",
"targetPaneIds"
],
"type": "object"
},
"type": "array"
},
"stoppedAt": {
"type": [
"integer",
"null"
]
},
"succeeded": {
"type": "integer"
}
},
"required": [
"results",
"succeeded",
"failed",
"stoppedAt",
"onError"
],
"type": "object"
}
Tool annotations
{
"destructiveHint": true,
"idempotentHint": false,
"openWorldHint": true,
"readOnlyHint": false,
"title": "Send keys batch"
}
Esc

Type to search.