Skip to content

Commit aad1315

Browse files
committed
Update README
1 parent ff5008a commit aad1315

File tree

1 file changed

+35
-0
lines changed

1 file changed

+35
-0
lines changed

README.rst

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,41 @@ Installation
1717
1818
$ pip install --user tmuxp
1919
20+
tmuxp CLI
21+
---------
22+
23+
*New in 1.6.0*:
24+
25+
``tmuxp cli`` launches into a debugger with `libtmux`_ objects for your
26+
current server, session, and window:
27+
28+
.. code-block:: shell
29+
30+
$ tmuxp cli
31+
32+
(Pdb) server
33+
<libtmux.server.Server object at 0x7f7dc8e69d10>
34+
(Pdb) server.sessions
35+
[Session($1 your_project)]
36+
(Pdb) session
37+
Session($1 your_project)
38+
(Pdb) session.name
39+
'your_project'
40+
(Pdb) window
41+
Window(@3 1:your_window, Session($1 your_project))
42+
(Pdb) window.name
43+
'your_window'
44+
(Pdb) window.panes
45+
[Pane(%6 Window(@3 1:your_window, Session($1 your_project)))
46+
47+
Python 3.7+ supports `PEP 553`_ ``breakpoint()`` (including
48+
``PYTHONBREAKPOINT``)
49+
50+
Read more on `tmuxp CLI`_
51+
52+
.. _PEP 553: https://www.python.org/dev/peps/pep-0553/
53+
.. _tmuxp CLI: http://localhost:8031/cli.html#launch-tmux-cli
54+
2055
Load a tmux session
2156
-------------------
2257

0 commit comments

Comments
 (0)