tmuxp, a novel approach to manage tmux(1) (>= 1.8) workspaces through python objects, JSON or YAML.
How tmuxp helps you tmux:
- Save your most common tmux session layouts in JSON or YAML. See a simple or very elaborate configuration.
- Store layouts personally (
~/.tmuxp
) or include in your project, see~/.tmuxp.{yaml,json}
. See the author's tmuxp configs and the the projects' tmuxp.yaml. - Freeze the layout of live sessions.
- Automate running such as sourcing into a virtualenv. The configuration also supports per window commands where all panes inherit commands. See Examples.
- Run a bootstrapping script to check environment / install dependencies / setup project before loading starts so your development works across systems. See this projects bootstrap_env.py and before_script example.
- Load tmux sessions in the background by passing
-d
flag. - Load multiple tmux configurations
tmuxp load config1.yaml config2.yaml
. - Switch sessions from inside a current tmux session. tmuxp will detect
if you're in a session and offer to
switch-client
for you. - Offer to re-attach a tmux session if your config is already loaded.
- For more things you can do with tmuxp, see Examples.
- CLI auto-completion with bash, zsh and tcsh.
- Use as a python library, see the python API quickstart.
- Well tested a gain against live tmux (1.8+ and git). See travis.yml, tmuxp on Travis CI and testing page.
- Import configs teamocil and tmuxinator.
- Thorough Documentation (also in 中文), Source, Commands, Internals.
- and much, much more.
Ready to begin? See the Quickstart. Want to learn more about tmux itself? Read The Tao of Tmux.
tmux support | 1.8, 1.9a, 2.0, 2.1 |
python support | 2.6, 2.7, >= 3.3 |
config support | yaml, json, python dict |
Source | https://github.com/tony/tmuxp |
Docs | http://tmuxp.rtfd.org |
API | http://tmuxp.readthedocs.org/en/latest/api.html |
Changelog | http://tmuxp.readthedocs.org/en/latest/history.html |
Issues | https://github.com/tony/tmuxp/issues |
Travis | http://travis-ci.org/tony/tmuxp |
Test Coverage | https://coveralls.io/r/tony/tmuxp |
pypi | https://pypi.python.org/pypi/tmuxp |
Open Hub | https://www.openhub.net/p/tmuxp |
License | BSD. |
git repo | $ git clone https://github.com/tony/tmuxp.git |
install stable | $ sudo pip install tmuxp |
install dev | $ git clone https://github.com/tony/tmuxp.git tmuxp
$ cd ./tmuxp
$ virtualenv .venv
$ source .venv/bin/activate
$ pip install -e . See the developing and testing page in the docs for more. |
tests | $ python ./run-tests.py |