https://github.com/watson/git-ps1

A simple command line prompt enhancer that shows the state of the current git repo (ps1)
https://github.com/watson/git-ps1

Last synced: 4 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/watson/git-ps1
• Owner: watson
• License: mit
• Created: 2015-06-21T16:04:27.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2024-02-22T13:18:21.000Z (7 months ago)
• Last Synced: 2024-09-19T09:02:34.370Z (13 days ago)
• Language: Shell
• Size: 22.5 KB
• Stars: 10
• Watchers: 4
• Forks: 4
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# git-ps1

A simple command line prompt enhancer that shows the state of the

current git repo (ps1).

![zsh example](https://cloud.githubusercontent.com/assets/10602/8293024/e58603ae-1900-11e5-82b8-b06c1a794a5f.png)

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](https://github.com/watson/git-att) in the root of

your git repo.

[![Build status](https://travis-ci.org/watson/git-ps1.svg?branch=master)](https://travis-ci.org/watson/git-ps1)

[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat)](https://github.com/feross/standard)

## 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