Session manager for tmux, which allows users to save and load tmux sessions through simple configuration files.
Project description
tmuxp
Session manager for tmux, which allows users to save and load tmux sessions through simple configuration 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 and the tracker. See issue #290!
Installation
pip:
$ pip install --user 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
-
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 forth 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.
$ tmuxp shell
(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 bootstrap_env.py and 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
$ 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
# ... so on
Docs / Reading material
See the Quickstart.
Documentation homepage (also in 中文)
Want to learn more about tmux itself? Read The Tao of Tmux online.
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.8, pypy, pypy3
- Source: https://github.com/tmux-python/tmuxp
- Docs: https://tmuxp.git-pull.com
- API: https://tmuxp.git-pull.com/api.html
- Changelog: https://tmuxp.git-pull.com/history.html
- Issues: https://github.com/tmux-python/tmuxp/issues
- Test Coverage: https://codecov.io/gh/tmux-python/tmuxp
- pypi: https://pypi-hypernode.com/pypi/tmuxp
- Open Hub: https://www.openhub.net/p/tmuxp-python
- Repology: https://repology.org/project/tmuxp/versions
- License: MIT.
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
Built Distribution
File details
Details for the file tmuxp-1.41.0b0.tar.gz.
File metadata
- Download URL: tmuxp-1.41.0b0.tar.gz
- Upload date:
- Size: 836.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.0.0 CPython/3.12.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 623df7f83facb105df9d5adbc9906064dde4f8505c957046b27c6c9fc4b4cc55 |
|
| MD5 | c3cbcbffdc1e58fb103e838a3f82e6fd |
|
| BLAKE2b-256 | 34fbc3b3055635a4a99afae652134566681eb5bedc39bcb7f137871bbfcaae48 |
Provenance
File details
Details for the file tmuxp-1.41.0b0-py3-none-any.whl.
File metadata
- Download URL: tmuxp-1.41.0b0-py3-none-any.whl
- Upload date:
- Size: 51.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.0.0 CPython/3.12.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | cbf79592f0ae63e2f1868b5fcf36038215c253294a692bacd105e2eee4b6bd6b |
|
| MD5 | fabea03fe17b254b10f28e53305c852a |
|
| BLAKE2b-256 | 5ad6d6e547c2e1bf2bd00ef84959e03ed73d1fb32076114217f99ac139aa1b31 |
