Skip to content

Commit 987c6e0

Browse files
committed
README update, 0.0.25
1 parent 332ea21 commit 987c6e0

File tree

2 files changed

+26
-30
lines changed

2 files changed

+26
-30
lines changed

README.rst

+25-29
Original file line numberDiff line numberDiff line change
@@ -35,50 +35,46 @@ See: `Quickstart`_
3535
CLI Commands
3636
""""""""""""
3737

38-
==========================
39-
40-
``tmuxp attach-session``
41-
``tmuxp kill-session``
42-
``tmuxp convert``
43-
``tmuxp import``
44-
``tmuxp import``
45-
46-
tmuxp uses ``switch-client`` for you if already in a TMUX client.
47-
48-
.. code-block:: bash
49-
50-
$ tmuxp attach-session<tab> # current sessions
51-
52-
Kill session
38+
========================== ==============================================
39+
``tmuxp attach-session`` ``<session_name>``
40+
tmuxp uses ``switch-client`` if already inside
41+
tmux client.
42+
``tmuxp kill-session`` ``<session name>``.
43+
``tmuxp load`` ``<file>``. Load a workspace yaml / json file.
44+
If session already made, will offer to attach.
45+
``tmuxp convert`` ``<file>``. Convert session yaml / json.
46+
``tmuxp import`` ``[teamocil | tmuxinator]`` ``<file>`` import
47+
a `teamocil`_ or `tmuxinator`_ config.
48+
========================== ==============================================
49+
50+
Bash completion
51+
"""""""""""""""
52+
53+
For bash, ``.bashrc``:
5354

5455
.. code-block:: bash
5556
56-
$ tmuxp kill-session<tab> # current sessions
57+
$ source tmuxp.bash
5758
58-
Load a session configuration from a YAML or JSON file.
59+
For tcsh, ``.tcshrc``:
5960

6061
.. code-block:: bash
6162
62-
$ tmuxp load<tab> # configs in config dir, current directory
63+
$ complete tmuxp 'p/*/`tmuxp.tcsh`/'
6364
64-
Convert a session config JSON <=> YAML:
65+
For zsh, ``.zshrc``:
6566

6667
.. code-block:: bash
6768
68-
$ tmuxp convert<tab> # configs in config dir, current directory
69-
70-
Experimental: Import configuration from `teamocil`_ or `tmuxinator`_:
71-
72-
.. code-block:: bash
73-
74-
$ tmuxp import teamocil<tab> # configs in ~/.teamocil dir
75-
$ tmuxp import tmuxinator<tab> # configs in ~/.tmuxinator dir
69+
$ source tmuxp.zsh
7670
7771
See `installing bash completion`_ to get bash, zsh and tcsh completion
7872
working on your machine.
7973

80-
load tmux sessions from yaml and json
81-
"""""""""""""""""""""""""""""""""""""
74+
Mini Quickstart
75+
"""""""""""""""
76+
77+
See the full `Quickstart`_ in the documentation.
8278

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

tmuxp/__init__.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,4 +20,4 @@
2020

2121
import logging
2222

23-
__version__ = '0.0.24'
23+
__version__ = '0.0.25'

0 commit comments

Comments
 (0)