tmuxp

Session manager for tmux. Save and load your tmux sessions through declarative workspace files. Powered by libtmux.

New to tmux? The Tao of tmux is available on Leanpub and Amazon Kindle. Read and browse the book for free on the web.

Have some spare time? Help us triage and code-review on the tracker. See issue #290!

Installation

pip:

$ pip install --user tmuxp

If you're managing the project with uv, add tmuxp as a dependency instead:

$ uv add tmuxp

To run tmuxp without installing it globally, similar to pipx, invoke it with uvx:

$ uvx tmuxp

Homebrew:

$ brew install tmuxp

Debian / ubuntu:

$ sudo apt install tmuxp

Nix:

$ [[ -z $(which tmux) ]] && (nix-env -i tmux && nix-env -i tmuxp) || nix-env -i tmuxp

Find the package for your distro on repology: https://repology.org/project/tmuxp/versions

Developmental releases:

pip:

$ pip install --user --upgrade --pre tmuxp

Or allow a pre-release from a uv project environment:

$ uv add tmuxp --prerelease allow

uvx:

$ uvx --from 'tmuxp' --prerelease allow tmuxp

pipx:

$ pipx install --suffix=@next 'tmuxp' --pip-args '\--pre' --force

Then use tmuxp@next load [session].

Load a tmux session

Load tmux sessions via json and YAML, tmuxinator and teamocil style.

session_name: 4-pane-split
windows:
  - window_name: dev window
    layout: tiled
    shell_command_before:
      - cd ~/ # run as a first command in all panes
    panes:
      - shell_command: # pane no. 1
          - cd /var/log # run multiple commands in this pane
          - ls -al | grep \.log
      - echo second pane # pane no. 2
      - echo third pane # pane no. 3
      - echo fourth pane # pane no. 4

Save as mysession.yaml, and load:

$ tmuxp load ./mysession.yaml

Projects with .tmuxp.yaml or .tmuxp.json load via directory:

$ tmuxp load path/to/my/project/

Load multiple at once (in bg, offer to attach last):

$ tmuxp load mysession ./another/project/

Name a session:

$ tmuxp load -s session_name ./mysession.yaml

simple and very elaborate config examples

User-level configurations

tmuxp checks for configs in user directories:

$TMUXP_CONFIGDIR, if set
$XDG_CONFIG_HOME, usually $HOME/.config/tmuxp/
$HOME/.tmuxp/

Load your tmuxp config from anywhere by using the filename, assuming ~/.config/tmuxp/mysession.yaml (or .json):

$ tmuxp load mysession

See author's tmuxp configs and the projects' tmuxp.yaml.

Shell

New in 1.6.0:

tmuxp shell launches into a python console preloaded with the attached server, session, and window in libtmux objects:

(Pdb) server
<libtmux.server.Server object at 0x7f7dc8e69d10>
(Pdb) server.sessions
[Session($1 your_project)]
(Pdb) session
Session($1 your_project)
(Pdb) session.name
'your_project'
(Pdb) window
Window(@3 1:your_window, Session($1 your_project))
(Pdb) window.name
'your_window'
(Pdb) window.panes
[Pane(%6 Window(@3 1:your_window, Session($1 your_project)))
(Pdb) pane
Pane(%6 Window(@3 1:your_window, Session($1 your_project))

Supports PEP 553 breakpoint() (including PYTHONBREAKPOINT). Also supports direct commands via -c:

$ tmuxp shell -c 'print(window.name)'
my_window

$ tmuxp shell -c 'print(window.name.upper())'
MY_WINDOW

Read more on tmuxp shell in the CLI docs.

Pre-load hook

Run custom startup scripts (such as installing project dependencies) before loading tmux. See the before_script example

Load in detached state

You can also load sessions in the background by passing -d flag

Screenshot

Freeze a tmux session

Snapshot your tmux layout, pane paths, and window/session names.

$ tmuxp freeze session-name

See more about freezing tmux sessions.

Convert a session file

Convert a session file from yaml to json and vice versa.

$ tmuxp convert filename

This will prompt you for confirmation and shows you the new file that is going to be written.

You can auto confirm the prompt. In this case no preview will be shown.

$ tmuxp convert -y filename

Or the long form:

$ tmuxp convert --yes filename

Plugin System

tmuxp has a plugin system to allow for custom behavior. See more about the Plugin System.

Debugging Helpers

The load command provides a way to log output to a log file for debugging purposes.

$ tmuxp load --log-file <log-file-name> .

Collect system info to submit with a Github issue:

$ tmuxp debug-info
------------------
environment:
    system: Linux
    arch: x86_64
...

Docs / Reading material

See the Quickstart.

Documentation homepage (also in 中文)

Want to learn more about tmux itself? Read The Tao of Tmux online.

Attribution

Please use the following BibTeX template to cite tmuxp in scientific discourse:

@misc{tmuxp,
   author = {Tony Narlock},
   year = {2013},
   note = {https://tmuxp.git-pull.com},
   title = {tmuxp: workspace manager for tmux}
}

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

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

Metadata

Release files for tmuxp 1.76.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for tmuxp 1.76.0
File	Size	Uploaded	Provenance
tmuxp-1.76.0.tar.gz	1.1 MB	Oct 24, 2026	With provenance	Details

Built distribution (wheel)

Table of built distributions (wheels) for tmuxp 1.76.0
File	Interpreter	ABI	Platform	Reset
tmuxp-1.76.0-py3-none-any.whl 111.2 kB Oct 24, 2026 With provenance	Python 3	none	any	Details

Total release size: 1.3 MB

Release files / tmuxp-1.76.0.tar.gz

Download URL	tmuxp-1.76.0.tar.gz
Size	1.1 MB
Tags	Source
SHA-256 checksum How to use checksums	`aedad329c5934e9380eecf43e4a9372f4f87cab640c9695105e1e91c9daec96f`
BLAKE2b-256 checksum How to use checksums	`594f8ce51b546f6d528003e7cc20024b394b6db1261a954d4a757bbb0901da9a`
Upload date	Oct 24, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/7.0.0 CPython/3.13.16`

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Identity

Publishing platform: GitHub Actions
Publishing repository: github.com/tmux-python/tmuxp
Publishing commit: github.com/tmux-python/tmuxp/tree/7965262d4a376f5f6cd9238b6ce4189d35a5d9e7

Workflow

Publishing configuration: github.com/tmux-python/tmuxp/blob/7965262d4a376f5f6cd9238b6ce4189d35a5d9e7/.github/workflows/tests.yml
Publishing logs: github.com/tmux-python/tmuxp/actions/runs/40088031741/attempts/1

Artifact

Subject: tmuxp-1.76.0.tar.gz
SHA-256 checksum: aedad329c5934e9380eecf43e4a9372f4f87cab640c9695105e1e91c9daec96f Verifying attestations

Release files / tmuxp-1.76.0-py3-none-any.whl

Download URL	tmuxp-1.76.0-py3-none-any.whl
Size	111.2 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`07f9e6bbef3532ab26af93b2fb9157441506be0bb29e71bde515f4efa65650dc`
BLAKE2b-256 checksum How to use checksums	`bf20e97fe5d5c75b07c110e774583ab8853a299989e3649785fcbc6769f1e548`
Upload date	Oct 24, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/7.0.0 CPython/3.13.16`

Provenance

Identity

Publishing platform: GitHub Actions
Publishing repository: github.com/tmux-python/tmuxp
Publishing commit: github.com/tmux-python/tmuxp/tree/7965262d4a376f5f6cd9238b6ce4189d35a5d9e7

Workflow

Publishing configuration: github.com/tmux-python/tmuxp/blob/7965262d4a376f5f6cd9238b6ce4189d35a5d9e7/.github/workflows/tests.yml
Publishing logs: github.com/tmux-python/tmuxp/actions/runs/40088031741/attempts/1

Artifact

Subject: tmuxp-1.76.0-py3-none-any.whl
SHA-256 checksum: 07f9e6bbef3532ab26af93b2fb9157441506be0bb29e71bde515f4efa65650dc Verifying attestations

Security for tmuxp 1.76.0

Report project as malware

Provenance

Full provenance

All 2 files in this release have been uploaded with provenance metadata.

Attestation for tmuxp-1.76.0.tar.gz

Identity

Publishing platform: GitHub Actions
Publishing repository: github.com/tmux-python/tmuxp
Publishing commit: github.com/tmux-python/tmuxp/tree/7965262d4a376f5f6cd9238b6ce4189d35a5d9e7

Workflow

Publishing configuration: github.com/tmux-python/tmuxp/blob/7965262d4a376f5f6cd9238b6ce4189d35a5d9e7/.github/workflows/tests.yml
Publishing logs: github.com/tmux-python/tmuxp/actions/runs/40088031741/attempts/1

Artifact

Subject: tmuxp-1.76.0.tar.gz
SHA-256 checksum: aedad329c5934e9380eecf43e4a9372f4f87cab640c9695105e1e91c9daec96f Verifying attestations

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.