diff --git a/README.md b/README.md index 170032c..4df2360 100644 --- a/README.md +++ b/README.md @@ -91,6 +91,20 @@ session, use `tmux -L catmux list-sessions`. You can change the server's name by in which `catmux_create_session` is started, will be used inside the catmux session (as long as no other session previously exists on that particular tmux server). +To make things a bit easier, there is a convenience script installed with this +package: [`catmux`](script/catmux). It is basically a wrapper around `tmux -L +`. For example, you can + +``` bash +catmux attach # attach to the latest running catmux session +catmux ls # list current catmux sessions +catmux kill-session -t example_session # kill session 'target session' +``` + +In case you use another tmux server than `catmux`, you can set the environment +variable `CATMUX_DEFAULT_SERVER` to that name and continue using the `catmux` +script. + ## Migrating from the catkin version of catmux With the spread of ROS2, the need for a catkin-independent catmux has emerged. Catmux is now a plain python package without the ROS integration. diff --git a/script/catmux b/script/catmux new file mode 100644 index 0000000..340abb0 --- /dev/null +++ b/script/catmux @@ -0,0 +1,9 @@ +#!/bin/bash +# This script serves as an entry point to use the `catmux` command similar to +# the `tmux` command. Since catmux starts its sessions on its own server by +# default this script should provide a simple alternative to interact with +# catmux sessions easily. + +TMUX_SERVER="${CATMUX_DEFAULT_SERVER:-catmux}" + +tmux -L $TMUX_SERVER $@ diff --git a/setup.py b/setup.py index 3fcd999..9b30aab 100644 --- a/setup.py +++ b/setup.py @@ -19,6 +19,7 @@ entry_points={ "console_scripts": ["catmux_create_session=catmux.catmux_create_session:main"] }, + scripts=["script/catmux"], classifiers=[ "Programming Language :: Python :: 3", "License :: OSI Approved :: MIT License",