README.rst

tmuxp, tmux session manager. built on libtmux.

New to tmux? Pre-order a copy of my new book The Tao of tmux on Leanpub and Amazon Kindle, or for free on the web. Scheduled for release January 2017.

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

Sessions in ~/.tmuxp/ can use names:

$ tmuxp load mysession

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/

simple, very elaborate config examples

Store configs in (~/.tmuxp) or include in your project as ~/.tmuxp.{yaml,json}. See author's tmuxp configs and the the projects' tmuxp.yaml.

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

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

Freeze a tmux session

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

$ tmuxp freeze SESSION_NAME

See more about freezing tmux sessions.

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, 1.9a, 2.0, 2.1, 2.2, 2.3
python support	2.6, 2.7, >= 3.3
config support	yaml, json, python dict
Source	https://github.com/tony/tmuxp
Docs	http://tmuxp.git-pull.com
API	http://tmuxp.git-pull.com/en/latest/api.html
Changelog	http://tmuxp.git-pull.com/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	$ make test