tmuxp 1.74.0 · Source
This page documents the available Python tmuxp reference. Proposed native extensions are labeled separately.
Open a Python shell with tmux objects available, or evaluate Python using -c.
This command remains Python-specific even when reached through a future native
command.
Evaluate with a selected serverLink to section
After the installation walkthrough starts its dedicated server:
$ tmuxp shell \ -L workspace-guide \ -c 'print(server.sessions)'Use -c; the reference does not define --command. Optional session and window
arguments select context. --best chooses the best available shell backend; the
explicit selectors require their corresponding Python packages. The --pdb path
uses a debugger rather than a normal REPL.
The paired --use-pythonrc / --no-startup and --use-vi-mode /
--no-vi-mode options share destinations. The last occurrence wins. The
negative options disable the corresponding setting. See
environment for startup and backend
settings.
A native REPL is not an equivalent implementation of Python -c, IPython, or
PTPython. The compatibility proposal uses an optional version-checked Python
bridge and reports an unsupported-runtime error if it is absent. Interactive
machine output needs a separate terminal; an interactive transcript cannot share
JSON stdout.
Backend selectors are mutually exclusive.
Arguments and flagsLink to section
| Argument or flags | Arity / default | Choices or meaning |
|---|---|---|
"session_name" | optional | |
"window_name" | optional | |
-S | value; None | pass-through for tmux -S |
-L | value; None | pass-through for tmux -L |
-c | value; None | instead of opening shell, execute python code in libtmux and exit |
--best | flag; best | use best shell available in site packages |
--pdb | flag; None | use plain pdb |
--code | flag; None | use stdlib’s code.interact() |
--ptipython | flag; None | use ptpython + ipython |
--ptpython | flag; None | use ptpython |
--ipython | flag; None | use ipython |
--bpython | flag; None | use bpython |
--use-pythonrc | flag; False | load PYTHONSTARTUP env var and ~/.pythonrc.py script in —code |
--no-startup | flag; False | disable Python startup loading; shares a destination with --use-pythonrc, last occurrence wins |
--use-vi-mode | flag; False | use vi-mode in ptpython/ptipython |
--no-vi-mode | flag; False | disable vi mode; shares a destination with --use-vi-mode, last occurrence wins |
All commands accept -h / --help. Root options precede the command; see the
CLI overview. The output reference
distinguishes current Python flags from proposed all-command JSON and NDJSON.