Rename tmuxp cli -> shell

Author: tony

CHANGES

@@ -7,7 +7,7 @@ Here you can find the recent changes to tmuxp
 current
 -------
 - *Insert changes/features/fixes for next release here*
-- :issue:`636` New command: ``tmuxp cli``
+- :issue:`636` New command: ``tmuxp shell``
 
   Accepts tmux socket_name/socket_path, automatically uses the current
   tmux session and window and makes them available in pdb context.
@@ -17,25 +17,25 @@ current
   .. code-block:: sh
 
       $ pip install ipdb
-      $ env PYTHONBREAKPOINT=ipdb.set_trace tmuxp cli
+      $ env PYTHONBREAKPOINT=ipdb.set_trace tmuxp shell
 
   You can execute python directly via ``-c``:
 
   .. code-block:: sh
 
-      $ tmuxp cli -c 'print(session.name); print(window.name)'
+      $ tmuxp shell -c 'print(session.name); print(window.name)'
       my_server
       my_window
 
-      $ tmuxp cli my_server -c 'print(session.name); print(window.name)'
+      $ tmuxp shell my_server -c 'print(session.name); print(window.name)'
       my_server
       my_window
 
-      $ tmuxp cli my_server my_window -c 'print(session.name); print(window.name)'
+      $ tmuxp shell my_server my_window -c 'print(session.name); print(window.name)'
       my_server
       my_window
 
-      $ tmuxp cli my_server my_window -c 'print(window.name.upper())'
+      $ tmuxp shell my_server my_window -c 'print(window.name.upper())'
       MY_WINDOW
 
 tmuxp 1.5.8 (2020-10-31)

README.rst

@@ -17,17 +17,16 @@ Installation
 
    $ pip install --user tmuxp
 
-tmuxp CLI
----------
-
+Shell
+-----
 *New in 1.6.0*:
 
-``tmuxp cli`` launches into a debugger with `libtmux`_ objects for your
-current server, session, and window:
+``tmuxp shell`` launches into a python console preloaded with the attached server,
+session, and window in `libtmux`_ objects.
 
 .. code-block:: shell
 
-   $ tmuxp cli
+   $ tmuxp shell
 
    (Pdb) server
    <libtmux.server.Server object at 0x7f7dc8e69d10>
@@ -49,16 +48,16 @@ Python 3.7+ supports `PEP 553`_ ``breakpoint()`` (including
 
 .. code-block:: shell
 
-   $ tmuxp cli -c 'print(window.name)'
+   $ tmuxp shell -c 'print(window.name)'
    my_window
 
-   $ tmuxp cli -c 'print(window.name.upper())'
+   $ tmuxp shell -c 'print(window.name.upper())'
    MY_WINDOW
 
-Read more on `tmuxp CLI`_
+Read more on `tmuxp shell`_ in the CLI docs.
 
 .. _PEP 553: https://www.python.org/dev/peps/pep-0553/
-.. _tmuxp CLI: http://localhost:8031/cli.html#launch-tmux-cli
+.. _tmuxp shell: http://localhost:8031/cli.html#shell
 
 Load a tmux session
 -------------------

docs/cli.rst

@@ -22,22 +22,22 @@ In zsh (``~/.zshrc``):
 
     eval "$(_TMUXP_COMPLETE=source_zsh tmuxp)"
 
-.. _cli_cli:
+.. _cli_shell:
 
-tmux CLI
---------
+Shell
+-----
 
 ::
 
-    tmuxp cli
+    tmuxp shell
 
-    tmuxp cli <session_name>
+    tmuxp shell <session_name>
 
-    tmuxp cli <session_name> <window_name>
+    tmuxp shell <session_name> <window_name>
 
-    tmuxp cli -c 'python code'
+    tmuxp shell -c 'python code'
 
-Launch into a `libtmux`_ session.
+Launch into a python console with `libtmux`_ objects. Compare to django's shell.
 
 Automatically will picked the current tmux :class:`server <libtmux.Server>`,
 :class:`session <libtmux.Session>`, and :class:`window <libtmux.Window>` you
@@ -65,26 +65,26 @@ compatible debuggers, for instance `ipdb`_:
 .. code-block:: sh
 
    $ pip install ipdb
-   $ env PYTHONBREAKPOINT=ipdb.set_trace tmuxp cli
+   $ env PYTHONBREAKPOINT=ipdb.set_trace tmuxp shell
 
 You can also pass in python code directly, similar to ``python -c``, do
 this via ``tmuxp -c``:
 
 .. code-block:: shell
 
-   $ tmuxp cli -c 'print(session.name); print(window.name)'
+   $ tmuxp shell -c 'print(session.name); print(window.name)'
    my_server
    my_window
 
-   $ tmuxp cli my_server -c 'print(session.name); print(window.name)'
+   $ tmuxp shell my_server -c 'print(session.name); print(window.name)'
    my_server
    my_window
 
-   $ tmuxp cli my_server my_window -c 'print(session.name); print(window.name)'
+   $ tmuxp shell my_server my_window -c 'print(session.name); print(window.name)'
    my_server
    my_window
 
-   $ tmuxp cli my_server my_window -c 'print(window.name.upper())'
+   $ tmuxp shell my_server my_window -c 'print(window.name.upper())'
    MY_WINDOW
 
 .. _PEP 553: https://www.python.org/dev/peps/pep-0553/

tests/test_cli.py

@@ -410,13 +410,13 @@ def test_load_zsh_autotitle_warning(cli_args, tmpdir, monkeypatch):
     "cli_args,inputs,expected_output",
     [
         (
-            ['cli', '-L{SOCKET_NAME}', '-c', 'print(str(server.socket_name))'],
+            ['shell', '-L{SOCKET_NAME}', '-c', 'print(str(server.socket_name))'],
             [],
             '{SERVER_SOCKET_NAME}',
         ),
         (
             [
-                'cli',
+                'shell',
                 '-L{SOCKET_NAME}',
                 '{SESSION_NAME}',
                 '-c',
@@ -427,7 +427,7 @@ def test_load_zsh_autotitle_warning(cli_args, tmpdir, monkeypatch):
         ),
         (
             [
-                'cli',
+                'shell',
                 '-L{SOCKET_NAME}',
                 '{SESSION_NAME}',
                 '{WINDOW_NAME}',
@@ -439,7 +439,7 @@ def test_load_zsh_autotitle_warning(cli_args, tmpdir, monkeypatch):
         ),
     ],
 )
-def test_cli(cli_args, inputs, expected_output, tmpdir, monkeypatch, server, session):
+def test_shell(cli_args, inputs, expected_output, tmpdir, monkeypatch, server, session):
     monkeypatch.setenv('HOME', str(tmpdir))
     window_name = 'my_window'
     window = session.new_window(window_name=window_name)

tmuxp/cli.py

@@ -661,7 +661,7 @@ def startup(config_dir):
         os.makedirs(config_dir)
 
 
-@cli.command(name='cli')
+@cli.command(name='shell')
 @click.argument('session_name', nargs=1, required=False)
 @click.argument('window_name', nargs=1, required=False)
 @click.option('-S', 'socket_path', help='pass-through for tmux -S')
@@ -671,7 +671,7 @@ def startup(config_dir):
     'command',
     help='Instead of opening shell, execute python code in libtmux and exit',
 )
-def command_cli(session_name, window_name, socket_name, socket_path, command):
+def command_shell(session_name, window_name, socket_name, socket_path, command):
     server = Server(socket_name=socket_name, socket_path=socket_path)
 
     try: