libtmux

libtmux is the tool behind tmuxp, a tmux workspace manager in python.

it builds upon tmux’ target and formats to create an object mappings to traverse, inspect and interact with live tmux sesssions.

view the documentation homepage, API information and architectural details.

install

$ [sudo] pip install libtmux

open a tmux session

session name foo, window name bar

$ tmux new-session -s foo -n bar

pilot your tmux session via python

$ python

# or for nice autocomplete and syntax highlighting
$ pip install ptpython
$ ptpython

connect to a live tmux session:

>>> import libtmux
>>> server = libtmux.Server()
>>> server
<libtmux.server.Server object at 0x7fbd622c1dd0>

list sessions:

>>> server.list_sessions()
[Session($3 foo), Session($1 libtmux)]

find session:

>>> server.get_by_id('$3')
Session($3 foo)

find session by dict lookup:

>>> server.find_where({ "session_name": "foo" })
Session($3 foo)

assign session to session:

>>> session = server.find_where({ "session_name": "foo" })

play with session:

>>> session.new_window(attach=False, window_name="ha in the bg")
Window(@8 2:ha in the bg, Session($3 foo))
>>> session.kill_window("ha in")

create new window in the background (don’t switch to it):

>>> w = session.new_window(attach=False, window_name="ha in the bg")
Window(@11 3:ha in the bg, Session($3 foo))

kill window object directly:

>>> w.kill_window()

grab remaining tmux window:

>>> window = session.attached_window
>>> window.split_window(attach=False)
Pane(%23 Window(@10 1:bar, Session($3 foo)))

rename window:

>>> window.rename_window('libtmuxower')
Window(@10 1:libtmuxower, Session($3 foo))

create panes by splitting window:

>>> pane = window.split_window()
>>> pane = window.split_window(attach=False)
>>> pane.select_pane()
>>> window = session.new_window(attach=False, window_name="test")
>>> pane = window.split_window(attach=False)

send key strokes to panes:

>>> pane.send_keys('echo hey send now')

>>> pane.send_keys('echo hey', enter=False)
>>> pane.enter()

grab the output of pane:

>>> pane.clear()  # clear the pane
>>> pane.send_keys('cowsay hello')
>>> print('\n'.join(pane.cmd('capture-pane', '-p').stdout))
sh-3.2$ cowsay 'hello'
 _______
< hello >
 -------
        \   ^__^
         \  (oo)\_______
            (__)\       )\/\
                ||----w |
                ||     ||

powerful traversal features:

>>> pane.window
Window(@10 1:libtmuxower, Session($3 foo))
>>> pane.window.session
Session($3 foo)