Python API

libtmux.Server.run_shell

Python

Execute a shell command via $ tmux run-shell.

Parameters

command ( str ) – Shell command to execute.
background ( bool | None ) – Run in background (-b flag).
delay ( str | None ) – Delay before execution (-d flag).
as_tmux_command ( bool | None ) – Parse argument as a tmux command instead of a shell command (-C flag).
target_pane ( str | None ) – Target pane for output (-t flag).
cwd ( StrPath | None ) – Start directory for the shell command (-c flag). When omitted, tmux uses the target client's current working directory. Requires tmux 3.4+; on older tmux a warning is emitted and the kwarg is ignored. Note: tmux's -c is a *start directory*, not subprocess semantics. If chdir(cwd) fails, tmux falls back to the user's home directory, then to /, rather than raising — unlike Python's subprocess.Popen(cwd=) which errors on a failed chdir. added 0.57
show_stderr ( bool | None ) – Combine the command's stderr into the captured output stream (-E flag, maps to JOB_SHOWSTDERR). Requires tmux 3.6+; on older tmux a warning is emitted and the kwarg is ignored. added 0.57
args ( list[str] | None ) – Positional arguments passed after *command*, expanded as #{1}, #{2}, … inside it. Requires tmux 3.7+; warns and is ignored on older tmux.

Returns

list[str] | None Stdout lines, or None when *background* is True. Empty list on tmux 3.3a/3.4 (upstream stdout passthrough was broken until 3.5).

In other ports Run a shell command through tmux

Ruby LibTmux::Server#run
Lua No source-verified Lua equivalent is recorded for this operation.
TypeScript server.Server.runShell
Rust server.Server.run_shell
Go tmux.Server.RunShell
Java io.github.libtmux.Server.Server.runShell
.NET LibTmux.Server.RunShellAsync
C++ libtmux::Server::run_shell
Swift Server.run(_:in:) types a command into a pane rather than running it on the host

Examples

Python TypeScript

>>> result = server.run_shell('true')
>>> isinstance(result, list)
True

const lines = await server.runShell("echo hello");
lines[0]; // "hello"

0 declared, 0 inherited