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

run_shell_command

Runs one authored command in a trusted pane shell and waits for singular framed output and completion. Its two preflights refuse caller or attended panes and an effective cohort larger than one. Pre-existing exact-client-path, trap, eval, or exit functions are outside the supported boundary; marker display-message commands honor the trusted server’s command aliases and hooks. Run a shell command in a pane with your user’s permissions.

All Java tools · JSON · Source

Arguments

command required · string
The shell command, run in the pane's interactive shell.
max_lines optional · integer
Maximum output lines, keeping the newest. Defaults to 200.

Default: 200.

pane_id required · string
The pane to act on, such as %1. Every listing tool returns these.
suppress_history optional · boolean
Best-effort persistent history suppression. Defaults to true.

Default: true.

timeout optional · number
Seconds to wait before giving up. Defaults to 30.0.

Default: 30.

Schemas

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

Input schema
{
"additionalProperties": false,
"properties": {
"command": {
"description": "The shell command, run in the pane's interactive shell.",
"type": "string"
},
"max_lines": {
"default": 200,
"description": "Maximum output lines, keeping the newest. Defaults to 200.",
"type": "integer"
},
"pane_id": {
"description": "The pane to act on, such as %1. Every listing tool returns these.",
"type": "string"
},
"suppress_history": {
"default": true,
"description": "Best-effort persistent history suppression. Defaults to true.",
"type": "boolean"
},
"timeout": {
"default": 30,
"description": "Seconds to wait before giving up. Defaults to 30.0.",
"type": "number"
}
},
"required": [
"pane_id",
"command"
],
"type": "object"
}
Output schema
{
"additionalProperties": false,
"properties": {
"effective_timeout": {
"type": "number"
},
"exit_status": {
"type": "integer"
},
"framed": {
"type": "boolean"
},
"lines_dropped": {
"type": "integer"
},
"note": {
"type": "string"
},
"outcome": {
"type": "string"
},
"output": {
"items": {
"type": "string"
},
"type": "array"
},
"pane_id": {
"type": "string"
},
"seconds": {
"type": "number"
},
"truncated": {
"type": "boolean"
}
},
"required": [
"pane_id",
"outcome",
"output",
"truncated",
"lines_dropped",
"framed",
"seconds",
"effective_timeout"
],
"type": "object"
}
Tool annotations
{
"destructiveHint": true,
"idempotentHint": false,
"openWorldHint": true,
"readOnlyHint": false,
"title": "Run a shell command"
}
Esc

Type to search.