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

run_shell_command

Run a shell command in a pane with your user’s permissions. Run one command in a singular trusted POSIX shell and return bounded output.

All Swift tools · JSON · Source

Arguments

command required · string
Caller-controlled command.
force optional · boolean
Caller-controlled force.
maxLines optional · integer
Caller-controlled maxLines.
paneId required · string
Caller-controlled paneId.
timeoutMs optional · integer
Caller-controlled timeoutMs.

Schemas

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

Input schema
{
"additionalProperties": false,
"properties": {
"command": {
"description": "Caller-controlled command.",
"type": "string"
},
"force": {
"description": "Caller-controlled force.",
"type": "boolean"
},
"maxLines": {
"description": "Caller-controlled maxLines.",
"maximum": 2000,
"minimum": 1,
"type": "integer"
},
"paneId": {
"description": "Caller-controlled paneId.",
"type": "string"
},
"timeoutMs": {
"description": "Caller-controlled timeoutMs.",
"maximum": 600000,
"minimum": 100,
"type": "integer"
}
},
"required": [
"command",
"paneId"
],
"type": "object"
}
Output schema
{
"additionalProperties": false,
"properties": {
"droppedLines": {
"type": "integer"
},
"effectiveTimeout": {
"type": "number"
},
"exitStatus": {
"type": [
"integer",
"null"
]
},
"linesMissed": {
"type": "boolean"
},
"output": {
"items": {
"type": "string"
},
"type": "array"
},
"pane": {
"type": "string"
},
"paneRef": {
"type": "string"
},
"seconds": {
"type": "number"
},
"timedOut": {
"type": "boolean"
}
},
"required": [
"droppedLines",
"effectiveTimeout",
"exitStatus",
"linesMissed",
"output",
"pane",
"paneRef",
"seconds",
"timedOut"
],
"type": "object"
}
Tool annotations
{
"destructiveHint": true,
"idempotentHint": false,
"openWorldHint": true,
"readOnlyHint": false,
"title": "Run shell command"
}
Esc

Type to search.