tmuxp

tmux session manager

These details have not been verified by PyPI

Project links

Project description

tmuxp, tmux session manager. built on `libtmux`_.

|pypi| |docs| |build-status| |coverage| |license|

**We need help!** tmuxp is a trusted session manager for tmux. If you
could lend your time to helping answer issues and QA pull requests, please
do! See `issue #290 <https://github.com/tmux-python/tmuxp/issues/290>`__!

**New to tmux?** `The Tao of tmux <https://leanpub.com/the-tao-of-tmux>`_ is
available on Leanpub and `Amazon Kindle`_. Read and browse the book for free
`on the web`_.

Installation
------------

.. code-block:: shell

You can't use 'macro parameter character #' in math mode

tmuxp load ./mysession.yaml

Projects with *.tmuxp.yaml* or *.tmuxp.json* load via directory:

.. code-block:: sh

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

tmuxp load mysession ./another/project/

Name a session:

.. code-block:: bash

t m x u p l o a d - s s e s s i o n_{n} a m e . / m y s e s s i o n . y a m l ‘ s i m p l e ‘_{a} n d ‘ v e r y e l a b o r a t e ‘_{c} o n f i g e x a m p l e s U s e r - l e v e l c o n f i g u r a t i o n s - - - - - - - - - - - - - - - - - - - - - - - - - t m u x p c h e c k s f o r c o n f i g s i n u s e r d i r e c t o r i e s : - ‘ ‘

TMUXP_CONFIGDIR``, if set
- ``

X D G_{C} O N F I G_{H} O M E ‘ ‘, u s u a l l y *

HOME/.config/tmuxp/*
- ``

H O M E / . t m u x p / ‘ ‘ L o a d y o u r t m u x p c o n f i g f r o m a n y w h e r e b y u s i n g t h e f i l e n a m e, a s s u m i n g * / . c o n f i g / t m u x p / m y s e s s i o n . y a m l * (o r * . j s o n *) : . . c o d e - b l o c k :: s h

tmuxp load mysession

See `author's tmuxp configs`_ and the projects' `tmuxp.yaml`_.

Shell
-----
*New in 1.6.0*:

``tmuxp shell`` launches into a python console preloaded with the attached server,
session, and window in `libtmux`_ objects.

.. code-block:: shell

t m u x p s h e l l (P d b) s e r v e r < l i b t m u x . s e r v e r . S e r v e r o b j e c t a t 0 x 7 f 7 d c 8 e 69 d 10 > (P d b) s e r v e r . s e s s i o n s [S e s s i o n (

1 your_project)]
(Pdb) session
Session(

1 y o u r_{p} r o j e c t) (P d b) s e s s i o n . n a m e^{'} y o u r_{p} r o j e c t^{'} (P d b) w i n d o w W i n d o w (@ 31 : y o u r_{w} i n d o w, S e s s i o n (

1 your_project))
(Pdb) window.name
'your_window'
(Pdb) window.panes
[Pane(%6 Window(@3 1:your_window, Session(

1 y o u r_{p} r o j e c t))) (P d b) p a n e P a n e (

1 your_project))

Python 3.7+ supports `PEP 553`_ ``breakpoint()`` (including
``PYTHONBREAKPOINT``). Also supports direct commands via ``-c``:

.. code-block:: shell

t m u x p s h e l l - c^{'} p r i n t (w i n d o w . n a m e)^{'} m y_{w} i n d o w

tmuxp shell -c 'print(window.name.upper())'
MY_WINDOW

Read more on `tmuxp shell`_ in the CLI docs.

.. _PEP 553: https://www.python.org/dev/peps/pep-0553/
.. _tmuxp shell: https://tmuxp.git-pull.com/cli.html#shell

Pre-load hook
-------------
Run custom startup scripts (such as installing project dependencies before
loading tmux. See the `bootstrap_env.py`_ and `before_script`_ example

Load in detached state
----------------------
You can also load sessions in the background by passing ``-d`` flag

Screenshot
----------

.. image:: https://raw.github.com/tmux-python/tmuxp/master/doc/_static/tmuxp-demo.gif
:scale: 100%
:width: 45%
:align: center

Freeze a tmux session
---------------------

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

.. code-block:: sh

t m u x p f r e e z e s e s s i o n - n a m e S e e m o r e a b o u t ‘ f r e e z i n g t m u x ‘_{s} e s s i o n s . C o n v e r t a s e s s i o n f i l e - - - - - - - - - - - - - - - - - - - - - - C o n v e r t a s e s s i o n f i l e f r o m y a m l t o j s o n a n d v i c e v e r s a . . . c o d e - b l o c k :: s h

tmuxp convert filename

This will prompt you for confirmation and shows you the new file that is going
to be written.

You can auto confirm the prompt. In this case no preview will be shown.

.. code-block:: sh

t m u x p c o n v e r t - y f i l e n a m e

tmuxp convert --yes filename

Debugging Helpers
-----------------

The ``load`` command provides a way to log output to a log file for debugging
purposes.

.. code-block:: sh

t m u x p l o a d - - l o g - f i l e < l o g - f i l e - n a m e > . C o l l e c t s y s t e m i n f o t o s u b m i t w i t h a G i t h u b i s s u e : . . c o d e - b l o c k :: s h

tmuxp debug-info
------------------
environment:
system: Linux
arch: x86_64

# ... so on

Docs / Reading material
-----------------------

See the `Quickstart`_.

`Documentation`_ homepage (also in `中文`_)

Want to learn more about tmux itself? `Read The Tao of Tmux online`_.

.. _Documentation: http://tmuxp.git-pull.com
.. _Source: https://github.com/tmux-python/tmuxp
.. _中文: http://tmuxp-zh.rtfd.org/
.. _before_script: http://tmuxp.git-pull.com/examples.html#bootstrap-project-before-launch
.. _virtualenv: https://virtualenv.git-pull.com/
.. _Read The Tao of tmux online: http://tmuxp.git-pull.com/about_tmux.html
.. _author's tmuxp configs: https://github.com/tony/tmuxp-config
.. _python library: https://tmuxp.git-pull.com/api.html
.. _python API quickstart: https://tmuxp.git-pull.com/quickstart_python.html
.. _tmux(1): http://tmux.sourceforge.net/
.. _tmuxinator: https://github.com/aziz/tmuxinator
.. _teamocil: https://github.com/remiprev/teamocil
.. _Examples: http://tmuxp.git-pull.com/examples.html
.. _freezing tmux: http://tmuxp.git-pull.com/cli.html#freeze-sessions
.. _bootstrap_env.py: https://github.com/tmux-python/tmuxp/blob/master/bootstrap_env.py
.. _testing: http://tmuxp.git-pull.com/developing.html#test-runner
.. _python objects: http://tmuxp.git-pull.com/api.html#api
.. _tmuxp.yaml: https://github.com/tmux-python/tmuxp/blob/master/.tmuxp.yaml
.. _simple: http://tmuxp.git-pull.com/examples.html#short-hand-inline
.. _very elaborate: http://tmuxp.git-pull.com/examples.html#super-advanced-dev-environment
.. _Quickstart: http://tmuxp.git-pull.com/quickstart.html
.. _Commands: http://tmuxp.git-pull.com/cli.html
.. _libtmux: https://github.com/tmux-python/libtmux
.. _on the web: https://leanpub.com/the-tao-of-tmux/read

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, 2.4, 2.5, 2.6
- python support: 2.7, >= 3.3, pypy, pypy3
- Source: https://github.com/tmux-python/tmuxp
- Docs: https://tmuxp.git-pull.com
- API: https://tmuxp.git-pull.com/api.html
- Changelog: https://tmuxp.git-pull.com/history.html
- Issues: https://github.com/tmux-python/tmuxp/issues
- Test Coverage: https://codecov.io/gh/tmux-python/tmuxp
- pypi: https://pypi.python.org/pypi/tmuxp
- Open Hub: https://www.openhub.net/p/tmuxp-python
- License: `MIT`_.

.. _MIT: http://opensource.org/licenses/MIT
.. _developing and testing: http://tmuxp.git-pull.com/developing.html
.. _Amazon Kindle: http://amzn.to/2gPfRhC

.. |pypi| image:: https://img.shields.io/pypi/v/tmuxp.svg
:alt: Python Package
:target: http://badge.fury.io/py/tmuxp

.. |docs| image:: https://github.com/tmux-python/tmuxp/workflows/Publish%20Docs/badge.svg
:alt: Docs
:target: https://github.com/tmux-python/tmuxp/actions?query=workflow%3A"Publish+Docs"

.. |build-status| image:: https://github.com/tmux-python/tmuxp/workflows/tests/badge.svg
:alt: Build status
:target: https://github.com/tmux-python/tmuxp/actions?query=workflow%3A"tests"

.. |coverage| image:: https://codecov.io/gh/tmux-python/tmuxp/branch/master/graph/badge.svg
:alt: Code Coverage
:target: https://codecov.io/gh/tmux-python/tmuxp

.. |license| image:: https://img.shields.io/github/license/tmux-python/tmuxp.svg
:alt: License

Algorithm	Hash digest
SHA256	`05d3c09c515fd57d02a239829d63676e151243f5793aa938d7b6b170dc78fe1b`
MD5	`032850178333b7e31db91cb4a4a92652`
BLAKE2b-256	`8a37906a17d610657ed000b43739c25174397e30b0bf5d7a756323929f85f21c`

Algorithm	Hash digest
SHA256	`95ff802e9519280fa9895508ef24776effad9577a2b55de4cc407805626db50f`
MD5	`3dbfe0c8cb61a63d726f0ded2c79adde`
BLAKE2b-256	`0682159e9d7159e95e508d2d9d8fd1863ce59e79010c4c71d846c5e4006c13b0`

tmuxp 1.6.5

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

Built Distribution

File details

File metadata

File hashes

File details

File metadata

File hashes