Note

tmuxp is usable but still needs your help reporting errors, bugs and usability feedback. If you encounter an error, please post on the Issue tracker.

About

tmuxp helps you manage tmux workspaces.

Built on a object relational mapper for tmux. tmux users can reload common workspaces from YAML, JSON and dict configurations like tmuxinator and teamocil.

To jump right in, see Quickstart and Examples.

Interested in some kung-fu or joining the effort? API Reference and Developing and Testing.

BSD-licensed. Code on github.

Differences from tmuxinator / teamocil

Note

If you use teamocil / tmuxinator and can clarify or add differences, please free to edit this page on github.

Similarities

Load sessions Loads tmux sessions from config

YAML Supports YAML format

Inlining / shorthand configuration All three support short-hand and simplified markup for panes that have one command.

Missing

Stability tmuxinator and teamocil are far more stable and well-developed than tmuxp.

ERB / Template support teamocil supports ERB markup.

Version support tmuxp only supports tmux >= 1.8. Teamocil and tmuxinator may have support for earlier versions.

Differences

Programming Language python. teamocil and tmuxinator uses ruby.

Workspace building process teamocil and tmuxinator process configs directly shell commands. tmuxp processes configuration via ORM layer.

Additional Features

CLI tmuxp’s CLI can attach and kill sessions with tab-completion support. See Freeze sessions.

Import config import configs from Teamocil / Tmuxinator [1]. See Import.

Session freezing Supports session freezing into YAML and JSON format [1]. See Freeze sessions.

JSON config JSON config support. See Examples.

ORM-based API - Utilitizes tmux >= 1.8’s unique ID’s for panes, windows and sessions to create an object relational view of the tmux Server and its’ Session, Window, Pane. See Internals.

Conversion $ tmuxp convert <filename> can convert files to and from JSON and YAML.

[1](1, 2) While freezing and importing sessions is a great way to save time, tweaking will probably be required - There is no substitute to a config made with love.

Minor tweaks

  • Unit tests against live tmux version to test statefulness of tmux sessions, windows and panes. See Travis CI.
  • Load + switch to new session from inside tmux.
  • Resume session if config loaded.
  • Pre-commands virtualenv / rvm / any other commands.
  • Load config from anywhere $ tmuxp load /full/file/path.json.
  • Load config .tmuxp.yaml or .tmuxp.json from current working directory with $ tmuxp load ..
  • $ tmuxp -2, $ tmuxp -8 for forcing term colors a la tmux(1).
  • $ tmuxp -L<socket-name>, $ tmuxp -S<socket-path> for sockets and $ tmuxp -f<config-file> for config file.

More details

tmux support 1.8, 1.9a, dev
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
Ohloh https://www.ohloh.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 .env
$ source .env/bin/activate
$ pip install -e .

See the developing and testing page in the docs for more.

tests
$ python ./run-tests.py