Setting up tmux session and pulling them down again is becoming a bit less of a hassle with muxy.
I wrote this script to help me out after deciding that I didn't want a gem to do that stuff for me. Haven't looked around too much as I though it would have been a nice puzzle for me to solve while waiting here (was apparently sitting in bar 🍻 or café ☕ somewhere).
I've tested this in bash initially, but I have been using zsh for a year now and I'm pretty sure things work well enough in zsh at this stage.
Wherever you choose to download or clone the muxy project. Make sure that you load it in whichever script is called when you start a terminal session.
OSX users will find the ~/.bash_profile or ~/.zprofile the place to be,
unless you've changed your default shell in which case you should know where to
find it. Linux users will most likely find the ~/.bashrc the place to be,
unless they too are using another shell (in which case, they too should know
where to find the right script). Mind you that I have only tried muxy in bash.
Simply load muxy by adding the following line to the loading script
#/bin/bash
PATH_TO_MUXY=/home/yoda/.muxy # you decide ;)
source $PATH_TO_MUXY/muxy.bashMuxy defines two bash functions load and unload which will present
a list of options.
You add projects to muxy by adding directories in the muxy directory.
These directories should contains the following files:
base.bash: an optional script which may contain variables and logic to be used to setup and destroy projectsup.bash: the script to load up a projectdown.bash: the script to close down a project
When looking into the muxy directory your structure should bear some similarities to the following example.
.
├── README.markdown
├── awesome_project
│ ├── base.bash
│ ├── down.bash
│ └── up.bash
├── kewl_project
│ ├── base.bash
│ ├── down.bash
│ └── up.bash
├── lame_project
│ ├── base.bash
│ ├── down.bash
│ └── up.bash
├── muxy.bash
└── settings.bash
All muxy files are in the root directory, while your project definitions are setup in the appropriately named subdirectories. The names of the subdirectories represent the names used by you to reference these projects in muxy so please make these names as unambiguous as possible.
Upon running load in the terminal, muxy will present a list of projects
to choose from:
~ $ load
1) awesome_project
2) kewl_project
3) lame_project
#?
Typing 1 and pressing enter will source the base.bash from the
awesome_project subdirectory followed by the up.bash script from the
awesome_project subdirectory.
Unloading works in a similar fashion but calls down.bash instead of
up.bash.
Because base.bash is always called first it is a very convenient place
to define variables that you may need to both load and unload projects 😉.
To make things significantly easier one may choose to use the muxify
command. Currently the muxify command will only load the files you need to get
started.
The optional base.bash file for a project can simply contain a few
variable definitions and some other helpers to be used trying to setup or
pull down a project session.
#/bin/bash
NAME="another_kewl_project"
BASE="$HOME/dev/kewl_project"
The up.bash file does whatever specified everytime a load request is
issued for a project. Since I'm using tmux it creates a new session
creates the necessary windows and runs some commands in the created windows
to get me all setup to get to business.
Some projects start daemons in some windows, run git log in other windows
just to help me jar my memory of what it was I last worked on and even load up
the source files I need in my editor of choice (vim, not that its relevant
:smile:).
#/bin/bash
cd $BASE
# Use optional SESSION_STARTUP_SCRIPT if you want some logic executed in every
# session
export SESSION_STARTUP_SCRIPT="/path/startup.zsh"
tmux start-server
# Create 3 windows in tmux named git, base and playground
tmux new-session -d -s $NAME -n git
tmux new-window -t $NAME:1 -n base
tmux new-window -t $NAME:2 -n playground
# Split the git window and show the log in one pane and the status in another
tmux send-keys -t $NAME:0 "git log --oneline --graph" C-m
tmux split-window -h -t $NAME:0
tmux send-keys -t $NAME:10 "git status" C-m
# List all directories in the base window before I get to editing
tmux send-keys -t $NAME:1 "ls" C-m
If the SESSION_STARTUP_SCRIPT variable is used, make sure to source the
script from the variable in the appropriate profile file (.e.g.: for Zsh being
~/.zprofile).
# add this to ~/.zprofile in case Zsh is used
if [[ -a $SESSION_STARTUP_SCRIPT ]]; then
source $SESSION_STARTUP_SCRIPT
fiThe down .bash file just tears down the house. For me as a tmux user it
simply means wrecking the tmux session to pieces 😏. I don't have anything
intelligent setup for my default down scripts.
#/bin/bash
# Kill the session
tmux kill-session -t $NAME
I am working on a project for Acme Corp. The setup for the project may look like:
# base.bash
NAME="acme"
SESSION="acme"
BASE="/work/acme"Now that the $NAME, $SESSION and $BASE for the project are defined we
can use them in the setup script.
# up.bash, remember that base.base is already loaded at this stage
cd $BASE
tmux start-server
# start tmux session named $SESSION (acme)
tmux new-session -d -s $SESSION -n base
tmux new-window -t $SESSION:1 -n 1st
# git log on first half of window
tmux send-keys -t $SESSION:1 " cd $BASE/first_repository" C-m
tmux send-keys -t $SESSION:1 " git log --oneline --graph --all --decorate" C-m
tmux split-window -h -t $SESSION:1
# git diff on second half of window
tmux send-keys -t $SESSION:1 " source $BASE/first_repository" C-m
tmux send-keys -t $SESSION:1 " git diff" C-m
tmux new-window -t $SESSION:1 -n 2nd
# git log on first half of window
tmux send-keys -t $SESSION:2 " cd $BASE/second_repository" C-m
tmux send-keys -t $SESSION:2 " git log --oneline --graph --all --decorate" C-m
tmux split-window -h -t $SESSION:2
# vi README.md but don't press enter, in case I want to do something else
tmux send-keys -t $SESSION:2 " cd $BASE/second_repository" C-m
tmux send-keys -t $SESSION:2 " vi README.md"
tmux attach-session -t $SESSION