ITerm2 and tmux integration


I would like to achieve the following behaviour:

When I launch iTerm2, if there is a tmux session running, connect to it. If there is no tmux session running, create one and connect to it.

Any pointers greatly appreciated!

Best Answer

I use this script, which is execd whenever my shell starts as a login shell. You'll probably want to edit this a bit...

#/usr/bin/env zsh

local tmux=$1
local sname
local ssh

[[ -z "$tmux" ]] && tmux=tmux

# export COLORTERM to fix some programs
case "$TERM" in
    export COLORTERM="$TERM" ;;

# build a fancy session name
[[ ! -z "$SSH_CLIENT" ]] && ssh="/$SSH_CLIENT"
sname=$(print -P "%D{%Y-%m-%d-%H-%M-%S}/%n/%y$ssh")

# make sure session 0 exists  
$tmux has-session -t 0 2>/dev/null || $tmux new-session -d -s 0

# create our own mirroring session
$tmux new-session -d -s "$sname" -t 0

# this doesn't return until the session is closed or detached
$tmux attach-session -t "$sname"

# kill the mirroring session if it's not dead already 
$tmux has-session -t "$sname" 2>/dev/null && $tmux kill-session -t "$sname"

# return to prompt outside of tmux if special file is present 
if [[ -f "$TMUX_LEAVE_SHELL_FILE" ]]; then
  exec zsh -i

Relevant section in my .zshrc

# drop into tmux if this is a login shell and we're not in tmux already
if (which tmux >/dev/null) && [[ -o login ]] &&  [[ -z "$TMUX" ]] && [[ -f ~/etc/script/tmux-login ]]; then
  exec zsh "$HOME/etc/script/tmux-login" $(which tmux)

# handy command to detach tmux but keep the shell running (kind-of)
case $TERM in
    alias detach="touch $TMUX_LEAVE_SHELL_FILE && tmux detach" ;;
Related Question