git-ps1's Introduction

git-ps1

A simple command line prompt enhancer that shows the state of the current git repo (ps1).

If the health of your git repository is ok, git-ps1 will just show you the current branch. If the health is bad, git-ps1 will also show 👎 next to the branch.

If you'd like more details on what the issues are I recommend installing and running git-att in the root of your git repo.

Installation

npm install -g git-ps1

Usage

After you've installed git-ps1 as a global module using the command above, all you need to do is modify your prompt and have it run git-ps1 [format].

format is optional but will be used as the 1st argument to printf. This allows you to modify the default output by padding it to your likings:

git-ps1          # will output "master"
git-ps1 " [%s]"  # will output " [master]"

bash example

Add the following to your ~/.bash_profile file:

PS1='\w$(git-ps1 " (%s)")\$ '

The above command will modify your prompt to show the current working directory (\w) followed by the ouput of git-ps1 and terminated by $ .

zsh example

Add the following to your ~/.zshrc file:

setopt PROMPT_SUBST ; PS1='~%C$(git-ps1 " (%s)")%# '

The above commands will modify your prompt to show a tilde (~) followed by the current directory name (%C) followed by the ouput of git-ps1 and terminated by % .

License

MIT

git-ps1's People

Contributors

Stargazers

Watchers

git-ps1's Issues

Fails if the git repo doesn't contain any commits

Images for README.md

Output of commands hidden if they don't contain NL

Getting this result:

$ touch test
$ echo foo > test
$ cat test
$

Expected result:

$ touch test
$ echo foo > test
$ cat test
foo
$

Not being in "master" is not a problem... specially with this PS1

99% I'm working on a branch, as you should. With this PS1 I am well alerted to the fact that I am not in master by having the branch name in my ps1. This should not cause a thumb down. This PS1 alerts me to much more important issues, not being on master is not one of them.