Skip to content

Commit 890c066

Browse files
committed
Add CLI docs for tmuxp shell
1 parent 9a6083b commit 890c066

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

tmuxp/cli.py

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -672,6 +672,14 @@ def startup(config_dir):
672672
help='Instead of opening shell, execute python code in libtmux and exit',
673673
)
674674
def command_shell(session_name, window_name, socket_name, socket_path, command):
675+
"""Launch python shell for tmux server, session, window and pane.
676+
677+
Priority given to loaded session/wndow/pane objects:
678+
- session_name and window_name arguments
679+
- current shell: environmental variable of TMUX_PANE (which gives us window and
680+
session)
681+
- ``server.attached_session``, ``session.attached_window``, ``window.attached_pane``
682+
"""
675683
server = Server(socket_name=socket_name, socket_path=socket_path)
676684

677685
current_pane = None

0 commit comments

Comments
 (0)