Start a new tmux workspace (session) based on a configuration file. It is a lightweight version of other tools like tmuxinator and teamocil. Lightweight in dependencies which means that you can run it without having to set up binaries like ruby. However, its also lightweight in features as compared to those other tools.
It only has one dependency, which itself has no dependency:
- tmux-up
- Please follow the installation instructions
Currently the only way to download and use tmuxspace is to clone this repo and copy it to somewhere in your $PATH.
git clone https://github.com/francescoferraioli/tmuxspace.gitcd tmuxspacechmod u+x tmuxspacecp tmuxspace /usr/local/bin/tmuxspace
Define the desired initial state of your tmux session in a file.
The file must:
- End with
.tmuxspace - Contain lines with the following formats
The first line must be a new window instruction
PATH(NAME)[SETUP]
PATH: The path to the directory
NAME: The name of the window
SETUP: The way you want that window to be setup. It must be 3 characters long.
[ ]: One pane
[ | ]: Two panes split vertically
[---]: Two panes split horizontally
[-| ]: Three panes - two on the left and one on the right
[ |-]: Three panes - one on the left and two on the right
[-'-]: Three panes - two on the top and one on the bottom
[-,-]: Three panes - one on the top and two on the bottom
[-|-]: Four tiled panes
ACTION:PANE:COMMAND
ACTION: The two options are
writeorexecute.
PANE: This is the pane number you want the command to be actioned.
COMMAND: The command you want tmuxspace to action.
~/code/frontend(frontend)[---]
execute:0:bin/run.sh
execute:1:bin/test.sh
~/code/backend(backend)[ | ]
execute:0:bin/setup.sh
write:1:bin/run.sh
This would start a session with two windows:
- frontend with 2 panes at ~/code/frontend
- Top pane running the front end
- Bottom pane running the tests
- backend with 2 panes at ~/code/backend
- Left pane running the setup script
- Right pane ready to run the backend