Compatibility¶
Python¶
Minimum: Python 3.11
Tested: Python 3.11, 3.12, 3.13, 3.14
Maximum: Python < 4.0
tmux¶
Minimum: tmux 3.3a
Tested: latest stable tmux release
libtmux uses tmux’s format system and control mode – older tmux versions may lack required format variables
Capabilities by tmux release¶
Core Server, Session,
Window, and Pane calls work from tmux 3.3a
up. Flags and commands added in newer tmux releases check the running tmux
version first: optional flags warn and send the command without the flag, while
features that have no fallback raise LibTmuxException before
tmux runs.
The matrix below is generated from the same capability table that drives those
runtime gates and capabilities.json.
Capability |
API |
3.3a |
3.4 |
3.5 |
3.6 |
3.7 |
3.8 |
|---|---|---|---|---|---|---|---|
run-shell working directory Start a run-shell job in a chosen directory. |
↺ |
✓ |
✓ |
✓ |
✓ |
✓ |
|
run-shell stderr Show a run-shell job’s standard error as well as its output. |
↺ |
↺ |
↺ |
✓ |
✓ |
✓ |
|
run-shell job arguments Pass extra arguments to a run-shell job. |
↺ |
↺ |
↺ |
↺ |
✓ |
✓ |
|
Formatted key listing Format each key binding with a caller-supplied template. |
↺ |
↺ |
↺ |
↺ |
✓ |
✓ |
|
Trim blank capture cells Drop trailing positions that hold no character from a capture. |
↺ |
✓ |
✓ |
✓ |
✓ |
✓ |
|
Capture the mode screen Capture what a pane’s active mode shows instead of the pane. |
↺ |
↺ |
↺ |
✓ |
✓ |
✓ |
|
Capture line numbers, flags and hyperlinks Prefix captured lines with their number or metadata flags, or keep hyperlinks. |
↺ |
↺ |
↺ |
↺ |
✓ |
✓ |
|
Paste raw bytes Paste a buffer without tmux rewriting its control characters. |
↺ |
↺ |
↺ |
↺ |
✓ |
✓ |
|
Floating panes Create a floating pane with new-pane. |
✕ |
✕ |
✕ |
✕ |
✓ |
✓ |
✓ Works
↺ Warns and falls back
✕ Refused with an error
Platforms¶
Platform |
Status |
|---|---|
Linux |
Fully supported |
macOS |
Fully supported |
WSL / WSL2 |
Supported (tmux runs inside WSL) |
Windows (native) |
Not supported (tmux does not run natively on Windows) |
Known Limitations¶
tmux must be running and accessible via the default socket or a specified socket
Some operations require the tmux server to have at least one session
Format string availability depends on tmux version