tmuxp

Manage tmux workspaces from JSON and YAML, pythonic API, shell completion

These details have not been verified by PyPI

Project links

Development Status
- 3 - Alpha
Environment
- Web Environment
Intended Audience
- Developers
License
- OSI Approved :: BSD License
Operating System
- POSIX
Programming Language
Topic
- System :: Shells
- Utilities

Project description

`tmuxp` solves the panes / pains of managing workspaces.

.. image:: https://travis-ci.org/tony/tmuxp.png?branch=master
:target: https://travis-ci.org/tony/tmuxp

.. image:: https://badge.fury.io/py/tmuxp.png
:target: http://badge.fury.io/py/tmuxp

.. figure:: https://raw.github.com/tony/tmuxp/master/doc/_static/tmuxp-dev-screenshot.png
:scale: 100%
:width: 65%
:align: center

Open to testers
---------------

tmuxp is still **alpha** code and needs a few more weeks until stable.
See the `Issues tracker`_ to see known issues and for any other concerns.

Install
"""""""

- install ``tmux``, at least version **1.8**
- libyaml is installed for your distribution.

Install ``tmuxp``:

.. code-block:: bash

p i p i n s t a l l t m u x p S e e : ‘ Q u i c k s t a r t ‘_{C} L I C o m m a n d s " " " " " " " " " " " " ======================================================================== ‘ ‘ t m u x p a t t a c h - s e s s i o n ‘ ‘ ‘ ‘ < s e s s i o n_{n} a m e > ‘ ‘ t m u x p u s e s ‘ ‘ s w i t c h - c l i e n t ‘ ‘ i f a l r e a d y i n s i d e t m u x c l i e n t . ‘ ‘ t m u x p k i l l - s e s s i o n ‘ ‘ ‘ ‘ < s e s s i o n n a m e > ‘ ‘ . ‘ ‘ t m u x p l o a d ‘ ‘ ‘ ‘ < f i l e > ‘ ‘ . L o a d a w o r k s p a c e y a m l / j s o n f i l e . I f s e s s i o n a l r e a d y m a d e, w i l l o f f e r t o a t t a c h . ‘ ‘ t m u x p c o n v e r t ‘ ‘ ‘ ‘ < f i l e > ‘ ‘ . C o n v e r t s e s s i o n y a m l / j s o n . ‘ ‘ t m u x p i m p o r t ‘ ‘ ‘ ‘ [t e a m o c i l | t m u x i n a t o r] ‘ ‘ ‘ ‘ < f i l e > ‘ ‘ i m p o r t a ‘ t e a m o c i l ‘_{o} r ‘ t m u x i n a t o r ‘_{c} o n f i g . ======================================================================== B a s h c o m p l e t i o n " " " " " " " " " " " " " " " F o r b a s h, ‘ ‘ . b a s h r c ‘ ‘ : . . c o d e - b l o c k :: b a s h

source tmuxp.bash

For tcsh, ``.tcshrc``:

.. code-block:: bash

c o m p l e t e t m u x p^{'} p / * / ‘ t m u x p . t c s h ‘ /^{'} F o r z s h, ‘ ‘ . z s h r c ‘ ‘ : . . c o d e - b l o c k :: b a s h

source tmuxp.zsh

See `installing bash completion`_ to get bash, zsh and tcsh completion
working on your machine.

Mini Quickstart
"""""""""""""""

See the full `Quickstart`_ in the documentation.

Load from ``~/.tmuxp.yaml`` or ``~/.tmuxp.json`` in current directory.

.. code-block:: bash

t m u x p l o a d . L o a d ‘ ‘ m y c o n f i g . y a m l ‘ ‘ f r o m ‘ ‘ / . t m u x p ‘ ‘ . . c o d e - b l o c k :: b a s h

tmuxp load myconfig.yaml

Load a relative or full config file (bash complete supports this too)

.. code-block:: bash

t m u x p l o a d . / m y c o n f i g . y a m l

tmuxp load ../myconfig.yaml

t m u x p l o a d / v a r / w w w / m y w e b p r o j e c t / m y c o n f i g . y a m l ‘ ‘

mkdir ~/.tmuxp`` and make a file ``~/.tmuxp/test.yaml``.

.. code-block:: yaml

session_name: 2-pane-vertical
windows:
- window_name: my test window
panes:
- pwd
- pwd

.. code-block:: bash

t m u x p l o a d t e s t . y a m l o r ‘ ‘ / . t m u x p / t e s t . j s o n ‘ ‘ : . . c o d e - b l o c k :: j s o n " w i n d o w s " : [" p a n e s " : [" p w d ", " p w d "], " w i n d o w_{n} a m e " : " m y t e s t w i n d o w "], " s e s s i o n_{n} a m e " : " 2 - p a n e - v e r t i c a l " . . c o d e - b l o c k :: b a s h

tmuxp load test.json

See: `Examples`_

============== ==========================================================
tmux support 1.8, 1.9-dev
config support yaml, json, python dict
Travis http://travis-ci.org/tony/tmuxp
Docs http://tmuxp.rtfd.org
API http://tmuxp.readthedocs.org/en/latest/api.html
Changelog http://tmuxp.readthedocs.org/en/latest/changes.html
Issues https://github.com/tony/tmuxp/issues
Source https://github.com/tony/tmuxp
pypi https://pypi.python.org/pypi/tmuxp
License `BSD`_.
git repo .. code-block:: bash

g i t c l o n e h t t p s : / / g i t h u b . c o m / t o n y / t m u x p . g i t i n s t a l l d e v . . c o d e - b l o c k :: b a s h

git clone https://github.com/tony/tmuxp.git tmuxp

c d . / t m u x p

virtualenv .env

s o u r c e . e n v / b i n / a c t i v a t e

pip install -e .

See the `developing and testing`_ page in the docs for
more.
tests .. code-block:: bash

$ python ./run_tests.py
============== ==========================================================

.. _BSD: http://opensource.org/licenses/BSD-3-Clause
.. _developing and testing: http://tmuxp.readthedocs.org/en/latest/developing.html
.. _Examples: http://tmuxp.readthedocs.org/en/latest/examples.html
.. _Quickstart: http://tmuxp.readthedocs.org/en/latest/quickstart.html
.. _installing bash completion: http://tmuxp.readthedocs.org/en/latest/quickstart.html#bash-completion
.. _Developing and Testing: http://tmuxp.readthedocs.org/en/latest/developing.html
.. _tmuxinator: https://github.com/aziz/tmuxinator
.. _teamocil: https://github.com/remiprev/teamocil
.. _abstraction layer: http://en.wikipedia.org/wiki/Abstraction_layer
.. _ORM: http://tmuxp.readthedocs.org/en/latest/quickstart.html#tmux-orm
.. _tmux(1): http://tmux.sourceforge.net/
.. _Issues tracker: https://github.com/tony/tmuxp/issues
.. _python dict: http://docs.python.org/2/library/stdtypes.html#dict

Algorithm	Hash digest
SHA256	`061117bd1685ae3ef885628bb51998ec223bede37c42439d7bc126bcdac2d311`
MD5	`79c904728ff3ec7380f673d311ae70d2`
BLAKE2b-256	`913dc9e932cdec207562e0ca2c5dd5ba5db964e6d508c15b77d5f2ef049be35e`

tmuxp 0.0.25

Navigation

Verified details

Maintainers

Unverified details

Project links

Meta

Classifiers

Project description

Project details

Verified details

Maintainers

Unverified details

Project links

Meta

Classifiers

Release history Release notifications | RSS feed

Download files

Source Distribution

File details

File metadata

File hashes