README.md

Git Aware Prompt (joeytwiddle's fork)

Working with Git and its great branching/merging features is amazing. Constantly switching branches can be confusing though as you have to run git status to see which branch you're currently on.

The solution to this is to have your terminal prompt display the current branch. There are a number of articles available online about how to achieve this. This project is an attempt to make an easy to install/configure solution.

Overview

If you cd to a Git working directory, you will see the current Git branch name displayed in your terminal prompt. When you're not in a Git working directory, your prompt works like normal.

.

This fork by joeytwiddle also:

• shows you how far your local branch is ahead or behind the repository's branch
• shows how many files are staged
• indicates when you have an un-popped stash (when the top stash entry was made on the current commit or the current branch)
• displays when you are on a detached commit, or paused during a merge, rebase or cherry-pick
• adds a timeout for slower machines so that you will get your prompt quickly, even if git status is taking too long to retrieve the dirty and staged stats. (Tested in bash and zsh.)

.

If you only want the ahead/behind marks (no timeout and no staged stats), you may prefer the branch ahead_behind or if you are curious about the code, see ahead_behind_simple (compare).

The initial implementation of the timeout feature is on this commit.

≡ is a reminder that I have something on the stash.

<3 indicates that the local branch is 3 commits behind the upstream (remote) branch, and could/should be pulled.

?1 indicates that there is 1 untracked file in the tree.

+1 indicates that one file is staged for comitting.

>1 indicates that the local branch has 1 commit which has not yet been pushed to the upstream.

*1 indicates that the branch is dirty, with 1 file modified but not committed.

# would indicate that git status has taken too long, so the markers are not shown.

In that situation, git status will continue running in the background, so after a few moments, hitting <Enter> again should give you an up-to-date summary.

We also have some indicators for the current branch:

[branch_name] means you are on a branch with an upstream

(branch_name) means you are on a branch without an upstream

{branch_name\mode} means you are in the middle of a merge, rebase, cherry-pick, revert or bisect

<commit_id> means you are detached on the given commit, tag, or remote branch

The symbols (or "markers") can be changed by editing the prompt.sh file directly (and reloading it of course). The numbers or the markers can be omitted by removing the _count or _mark variables from the PS1 prompt below.

See Also

• The original git-aware-prompt by jimeh, from which this version is forked

• The prompt now distributed with git offers a GIT_PS1_SHOWUPSTREAM option.

• Zsh now ships with vcs_info which works for a variety of version control systems. (Unfortunately the docs for this are a big gnarly.)

• Oh-my-zsh has its own git-prompt. (It has 500 lines compared to our 200.)

• Inspiration for this fork came from git-branch-status by jehiah (a command, not a prompt)

• pure prompt by sindresorhus includes good git support (for zsh only)

• liquidprompt includes some git support (for bash and zsh)

Installation

Clone the project to a .bash folder in your home directory:

mkdir ~/.bash
cd ~/.bash
git clone git://github.com/joeytwiddle/git-aware-prompt.git

Edit your ~/.bash_profile or ~/.profile or ~/.bashrc (for Ubuntu) and add the following to the top:

source "~/.bash/git-aware-prompt/main.sh"

Configuring

Once installed, there will be new $git_branch and $git_dirty variables available to use in the PS1 environment variable, along with a number of color helper variables which you can see a list of in colors.sh.

If you want to know more about how to customize your prompt, I recommend this article: How to: Change / Setup bash custom prompt (PS1)

Suggested Prompts

Below are a few suggested prompt configurations. Simply paste the code at the end of the same file you pasted the installation code into earlier.

Mac OS X

export PS1="\u@\h \W\[$txtcyn\]\$git_branch\[$bldgrn\]\$git_ahead_mark\$git_ahead_count\[$txtrst\]\[$bldred\]\$git_behind_mark\$git_behind_count\[$txtrst\]\[$bldylw\]\$git_stash_mark\[$txtrst\]\[$txtylw\]\$git_dirty\$git_dirty_count\[$txtrst\]\[$txtcyn\]\$git_staged_mark\$git_staged_count\[$txtrst\]\[$txtblu\]\$git_unknown_mark\$git_unknown_count\[$txtrst\]\$ "

Optionally, if you want a nice pretty prompt when using sudo -s, also add this line:

export SUDO_PS1="\[$bakred\]\u@\h\[$txtrst\]\w\$ "

Ubuntu

Standard:

export PS1="\${debian_chroot:+(\$debian_chroot)}\u@\h:\w\[$txtcyn\]\$git_branch\[$bldgrn\]\$git_ahead_mark\$git_ahead_count\[$txtrst\]\[$bldred\]\$git_behind_mark\$git_behind_count\[$txtrst\]\[$bldyellow\]\$git_stash_mark\[$txtrst\]\[$txtylw\]\$git_dirty\$git_dirty_count\[$txtrst\]\[$txtcyn\]\$git_staged_mark\$git_staged_count\[$txtrst\]\[$txtblu\]\$git_unknown_mark\$git_unknown_count\[$txtrst\]\$ "

Colorized:

export PS1="\${debian_chroot:+(\$debian_chroot)}\[\033[01;32m\]\u@\h\[\033[00m\]:\[\033[01;34m\]\w\[\033[00m\]\[$txtcyn\]\$git_branch\[$bldgrn\]\$git_ahead_mark\$git_ahead_count\[$txtrst\]\[$bldred\]\$git_behind_mark\$git_behind_count\[$txtrst\]\[$bldyellow\]\$git_stash_mark\[$txtrst\]\[$txtylw\]\$git_dirty\$git_dirty_count\[$txtrst\]\[$txtcyn\]\$git_staged_mark\$git_staged_count\[$txtrst\]\[$txtblu\]\$git_unknown_mark\$git_unknown_count\[$txtrst\]\$ "

ZSH

export PROMPT='%n@%m:%~%{$bldpur%}$git_branch%{$bldgrn%}$git_ahead_mark$git_ahead_count%{$bldred%}$git_behind_mark$git_behind_count%{$bldylw%}$git_stash_mark%{$txtrst$txtylw%}$git_dirty$git_dirty_count%{$txtcyn%}$git_staged_mark$git_staged_count%{$txtblu%}$git_unknown_mark$git_unknown_count%{$txtrst%}$ '

Updating

Assuming you followed the default installation instructions and cloned this repo to ~/.bash/git-aware-prompt:

cd ~/.bash/git-aware-prompt
git pull

Usage Tips

To view other user's tips, please check the Usage Tips wiki page. Or if you have tips of your own, feel free to add them :)

License

CC0 1.0 Universal