npauzenga / tmux-git

Script for showing current Git branch in Tmux status bar

Git branch in Tmux


There are many solutions to integrate the current Git branch on your Linux terminal prompt (like this one and this one, from where I borrowed most parts of this script), but I don't like to bloat my prompt.

So I was thinking where can I put that information, and then I remembered the fabulous Tmux.

tmux is a powerful and really cool client-server terminal multiplexer, but it also provides a nice status bar. This script puts the Git branch of the current directory (if it is inside a Git repo) on the right side of the Tmux status bar.

Also, the branch name turns bright when the repo is 'dirty' (i.e., there are pending modifications to be committed)

Update: Now the status shows if there are stashed changes inside the repo.

Installation

Clone this project in your home directory, renaming the folder with a preceding dot for hiding it:

git clone git://github.com/drmad/tmux-git.git ~/.tmux-git

Then, execute this line in a shell to add the script in the Bash initialization file (usually .bashrc, replace if needed):

echo "if [[ \$TMUX ]]; then source ~/.tmux-git/tmux-git.sh; fi" >> ~/.bashrc

If you are using OSX you'll need to install coreutils:

brew install coreutils

Run tmux, cd to a Git repo, and enjoy :)

Hacking

The script is pretty simple. At the top of the file tmux-git.sh, there are a few variables (and a function) for configuring its behavior:

• TMUX_STATUS_LOCATION: Position of the status on Tmux bar: left or right
• TMUX_OUTREPO_STATUS: Tmux status for when you're out of a repo. Set by default to your pre-existing status line.
• TMUX_STATUS_DEFINITION(): This function sets the TMUX_STATUS variable, which is shown in the tmux bar.

En español

He realizado un post en español de las instrucciones de instalación en mi blog:

http://drmad.org/blog/branch-de-git-en-tmux.html