(cli-shell)=
(tmuxp-shell)=
Launch an interactive Python shell with libtmux objects pre-loaded. Similar to Django's shell command, this provides quick access to your tmux server, sessions, windows, and panes for scripting and debugging.
.. argparse::
:module: tmuxp.cli
:func: create_parser
:prog: tmuxp
:path: shell
$ tmuxp shell -c 'python code':width: 100%
Launch into a Python console with libtmux objects. Compare to django's shell.
Automatically preloads current tmux {class}server <libtmux.Server>,
{class}session <libtmux.Session>, {class}window <libtmux.Window>
{class}pane <libtmux.Pane>. Pass additional arguments to select a
specific one of your choice:
(Pdb) server
<libtmux.server.Server object at 0x7f7dc8e69d10>
(Pdb) server.sessions
[Session($1 your_project)]
(Pdb) session
Session($1 your_project)
(Pdb) session.name
'your_project'
(Pdb) window
Window(@3 1:your_window, Session($1 your_project))
(Pdb) window.name
'your_window'
(Pdb) window.panes
[Pane(%6 Window(@3 1:your_window, Session($1 your_project)))
(Pdb) pane
Pane(%6 Window(@3 1:your_window, Session($1 your_project)))Supports PEP 553's PYTHONBREAKPOINT and
compatible debuggers, for instance ipdb:
$ pip install --user ipdbInside a uv-managed project you can add ipdb as a development dependency:
$ uv add --dev ipdbFor a pipx-style ad hoc install, run it through uvx:
$ uvx --from ipdb ipdb3 --help$ env PYTHONBREAKPOINT=ipdb.set_trace tmuxp shellYou can also pass in python code directly, similar to python -c, do
this via tmuxp -c:
$ tmuxp shell -c 'print(session.name); print(window.name)'
my_server
my_window$ tmuxp shell my_server -c 'print(session.name); print(window.name)'
my_server
my_window$ tmuxp shell my_server my_window -c 'print(session.name); print(window.name)'
my_server
my_window$ tmuxp shell my_server my_window -c 'print(window.name.upper())'
MY_WINDOWAssuming inside a tmux pane or one is attached on default server:
$ tmuxp shell -c 'print(pane.id); print(pane.window.name)'
%2
my_windowtmuxp shell detects the richest shell available in your site packages, you can also pick your shell via args:
--pdb: Use plain oldbreakpoint()(python 3.7+) orpdb.set_trace--code: Drop intocode.interact, accepts--use-pythonrc--bpython: Drop into bpython--ipython: Drop into ipython--ptpython: Drop into ptpython, accepts--use-vi-mode--ptipython: Drop into ipython + ptpython, accepts--use-vi-mode