Skip to content

Latest commit

 

History

History
155 lines (120 loc) · 5.45 KB

README.rst

File metadata and controls

155 lines (120 loc) · 5.45 KB

tmuxp, tmux session manager. built on libtmux.

Python Package Documentation Status Build Status Code Coverage License

image

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 ~/
  panes:
    - shell_command:
        - cd /var/log
        - ls -al | grep \.log
    - pwd
    - pwd
    - pwd

Save as mysession.yaml. And load:

$ tmuxp load ./mysession.yaml

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.

bootstrap project dependencies before loading tmux. See the bootstrap_env.py and before_script example

Load sessions in the background by passing -d flag

Freeze a tmux session

$ tmuxp freeze

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.

Project details

tmux support 1.8, 1.9a, 2.0, 2.1, 2.2
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

$ make test