Skip to main content

Typed library that provides an ORM wrapper for tmux, a terminal multiplexer.

Project description

libtmux

libtmux is a typed Python library that provides a wrapper for interacting programmatically with tmux, a terminal multiplexer. You can use it to manage tmux servers, sessions, windows, and panes. Additionally, libtmux powers tmuxp, a tmux workspace manager.

Python Package Docs Build Status Code Coverage License

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
>>> svr = libtmux.Server()
>>> svr
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.

Run any tmux command, respective of context:

Honors tmux socket name and path:

>>> server = Server(socket_name='libtmux_doctest')
>>> server.cmd('display-message', 'hello world')
<libtmux...>

New session:

>>> server.cmd('new-session', '-d', '-P', '-F#{session_id}').stdout[0]
'$2'
>>> session.cmd('new-window', '-P').stdout[0]
'libtmux...:2.0'

From raw command output, to a rich Window object (in practice and as shown later, you'd use Session.new_window()):

>>> Window.from_window_id(window_id=session.cmd('new-window', '-P', '-F#{window_id}').stdout[0], server=session.server)
Window(@2 2:..., Session($1 libtmux_...))

Create a pane from a window:

>>> window.cmd('split-window', '-P', '-F#{pane_id}').stdout[0]
'%2'

Raw output directly to a Pane:

>>> Pane.from_pane_id(pane_id=window.cmd('split-window', '-P', '-F#{pane_id}').stdout[0], server=window.server)
Pane(%... Window(@1 1:..., Session($1 libtmux_...)))

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 ...)

Filter sessions:

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

Control your session:

>>> session
Session($1 ...)

>>> session.rename_session('my-session')
Session($1 my-session)

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

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

# Session can search the window
>>> session.windows.filter(window_name__startswith="ha")
[Window(@... 2:ha in the bg, Session($1 ...))]

# Directly
>>> session.windows.get(window_name__startswith="ha")
Window(@... 2:ha in the bg, Session($1 ...))

# Clean up
>>> bg_window.kill()

Close window:

>>> w = session.active_window
>>> w.kill()

Grab remaining tmux window:

>>> window = session.active_window
>>> window.split(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()
>>> pane = window.split(attach=False)
>>> pane.select()
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(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://tony.sh/support.html.

Project details

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

libtmux-0.46.2.tar.gz (346.9 kB view details)

Uploaded Source

Built Distribution

libtmux-0.46.2-py3-none-any.whl (60.9 kB view details)

Uploaded Python 3

File details

Details for the file libtmux-0.46.2.tar.gz.

File metadata

  • Download URL: libtmux-0.46.2.tar.gz
  • Upload date:
  • Size: 346.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for libtmux-0.46.2.tar.gz
Algorithm Hash digest
SHA256 9a398fec5d714129c8344555d466e1a903dfc0f741ba07aabe75a8ceb25c5dda
MD5 50ebb1d543bb74c60a555541fe8f36f2
BLAKE2b-256 9caa7e1dcaa097156d6f3a7d8669be4389dced997feeb81744e3ff4681d65ee8

See more details on using hashes here.

File details

Details for the file libtmux-0.46.2-py3-none-any.whl.

File metadata

  • Download URL: libtmux-0.46.2-py3-none-any.whl
  • Upload date:
  • Size: 60.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for libtmux-0.46.2-py3-none-any.whl
Algorithm Hash digest
SHA256 6c32dbf22bde8e5e33b2714a4295f6e838dc640f337cd4c085a044f6828c7793
MD5 768d1edde8360372cbb8261b28a5e1e3
BLAKE2b-256 d62f9d207039fcfa00d3b30e4d765f062fbcc42c873c7518a8cfebb3eafd00e0

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page