libtmux 0.18.1

Typed scripting library / ORM / API wrapper for tmux

libtmux

libtmux is a typed python scripting library for tmux. You can use it to command and control tmux servers, sessions, windows, and panes. It is the tool powering tmuxp, a tmux workspace manager.

libtmux builds upon tmux's target and formats to create an object mapping to traverse, inspect and interact with live tmux sessions.

View the documentation, API information and architectural details.

Install

$ pip install --user 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

Use ptpython, ipython, etc. for a nice shell with autocompletions:

$ pip install --user ptpython

$ ptpython

Connect to a live tmux session:

>>> import libtmux
>>> s = libtmux.Server()
>>> s
Server(socket_path=/tmp/tmux-.../default)

Tip: You can also use tmuxp's tmuxp shell to drop straight into your current tmux server / session / window pane.

List sessions:

>>> server.sessions
[Session($1 ...), Session($0 ...)]

Filter sessions by attribute:

>>> server.sessions.filter(history_limit='2000')
[Session($1 ...), Session($0 ...)]

Direct lookup:

>>> server.sessions.get(session_id="$1")
Session($1 ...)

Find session by dict lookup:

>>> server.sessions[0].rename_session('foo')
Session($1 foo)
>>> server.sessions.filter(session_name="foo")[0]
Session($1 foo)

Control your session:

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

Create new window in the background (don't switch to it):

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

Close window:

>>> w = session.attached_window
>>> w.kill_window()

Grab remaining tmux window:

>>> window = session.attached_window
>>> window.split_window(attach=False)
Pane(%2 Window(@1 1:... Session($1 ...)))

Rename window:

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

Split window (create a new pane):

>>> pane = window.split_window()
>>> pane = window.split_window(attach=False)
>>> pane.select_pane()
Pane(%3 Window(@1 1:..., Session($1 ...)))
>>> window = session.new_window(attach=False, window_name="test")
>>> window
Window(@2 2:test, Session($1 ...))
>>> pane = window.split_window(attach=False)
>>> pane
Pane(%5 Window(@2 2:test, Session($1 ...)))

Type inside the pane (send key strokes):

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

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

Grab the output of pane:

>>> pane.clear()  # clear the pane
Pane(%1 ...)
>>> pane.send_keys("cowsay 'hello'", enter=True)
>>> print('\n'.join(pane.cmd('capture-pane', '-p').stdout))  # doctest: +SKIP
$ cowsay 'hello'
 _______
< hello >
 -------
        \   ^__^
         \  (oo)\_______
            (__)\       )\/\
                ||----w |
                ||     ||
...

Traverse and navigate:

>>> pane.window
Window(@1 1:..., Session($1 ...))
>>> pane.window.session
Session($1 ...)

Python support

Unsupported / no security releases or bug fixes:

• Python 2.x: The backports branch is v0.8.x.

Donations

Your donations fund development of new features, testing and support. Your money will go directly to maintenance and development of the project. If you are an individual, feel free to give whatever feels right for the value you get out of the project.

See donation options at https://git-pull.com/support.html.

Project details

• tmux support: 1.8+
• python support: >= 3.7, pypy, pypy3
• Source: https://github.com/tmux-python/libtmux
• Docs: https://libtmux.git-pull.com
• API: https://libtmux.git-pull.com/api.html
• Changelog: https://libtmux.git-pull.com/history.html
• Issues: https://github.com/tmux-python/libtmux/issues
• Test Coverage: https://codecov.io/gh/tmux-python/libtmux
• pypi: https://pypi.python.org/pypi/libtmux
• Open Hub: https://www.openhub.net/p/libtmux-python
• Repology: https://repology.org/project/python:libtmux/versions
• License: MIT.