blob: 145f02b7795d8061aafd8e1189c6e0452b5a72cb (
plain) (
tree)
|
|
# Git Radar
A heads up display for git.
![An example of git-radar]
Git-radar is a tool you can add to your prompt to provide at-a-glance
information on your git repo. It's a labour of love I've been dogfooding for the
last few years. Maybe it can help you too.
## Installation
Install from brew:
```
> brew install michaeldfallen/formula/git-radar
```
Then run `git-radar` to see the docs and prove it's installed.
## Usage
To use git-radar you need to add it to your prompt. This is done in different
ways depending on your shell.
**Bash**
Add to your `.bashrc`
```bash
export PS1="$PS1\$(git-radar --bash --fetch)"
```
[(note: the `\` escaping the `$` is important)](#ensuring-prompt-execution)
**Zsh**
Add to your `.zshrc`
```zsh
export PROMPT="$PROMPT\$(git-radar --zsh --fetch) "
```
[(note: the `\` escaping the `$` is important)](#ensuring-prompt-execution)
**Fish**
Add to your `config.fish`
```bash
function fish_prompt
set_color $fish_color_cwd
echo -n (prompt_pwd)
git-radar --fish -fetch
set_color normal
echo -n ' > '
end
```
## Features
### Files status
The prompt lists the file changes and whether they are staged, unstaged or
untracked.
Prompt | Meaning
---------------------------|--------
![git:(master) 3A] | We have 3 untracked files
![git:(master) 2D2M] | We have 2 modifications and 2 deletions not yet staged to commit
![git:(master) 1M1R] | We have 1 modification and a file renamed staged and ready to commit
![git:(master) 1U] | We have a conflict caused by US that we need to address
![git:(master) 1M 1D2M 2A] | A combination of the above types
Each symbol represents a different change to a file. These are based on what git
considers has happened to the file.
Symbol | Meaning
--------|--------
A | A new Added file
D | A file has been Deleted
M | A file has been Modified
R | A file has been renamed
C | A file has been copied
U | A conflict caused by Us
T | A conflict caused by Them
B | A conflict caused by Both us and them
The color tells you what stage the change is at.
Color | Meaning
--------|--------
Green | Staged and ready to be committed (i.e. you have done a `git add`)
Red | Unstaged, you'll need to `git add` them before you can commit
Grey | Untracked, these are new files git is unaware of
Yellow | Conflicted, these need resolved before they can be committed
### Local commits status
The prompt will show you the difference in commits between your branch and the
remote your branch is tracking. The examples below assume you are checked out on
`master` and are tracking `origin/master`.
Prompt | Meaning
--------------------|--------
![git:(master 2↑)] | We have 2 commits to push up
![git:(master 3↓)] | We have 3 commits to pull down
![git:(master 3⇵5)] | Our version and origins version of `master` have diverged
### Remote commits status
The prompt will also show the difference between your branch on origin and what
is on `origin/master`. This a is hard coded branch name which I intend to make
configurable in the future.
This is the difference between the commits you've pushed up and `origin/master`.
Prompt | Meaning
---------------------------|---------------
![git:(m ← 2 my-branch)] | We have 2 commits on `origin/my-branch` that aren't on `origin/master`
![git:(m 4 → my-branch)] | There are 4 commits on `origin/master` that aren't on `origin/my-branch`
![git:(m 1 ⇄ 2 my-branch)] | `origin/master` and `origin/my-branch` have diverged, we'll need to rebase or merge
If you don't rely on this status, you can always hide this part of the prompt by calling git-radar with `--no-remote-status`.
**Bash**
```bash
export PS1="$PS1\$(git-radar --bash --fetch --no-remote-status) "
```
[(note: the `\` escaping the `$` is important)](#ensuring-prompt-execution)
**Zsh**
```zsh
export PROMPT="$PROMPT\$(git-radar --zsh --fetch --no-remote-status) "
```
[(note: the `\` escaping the `$` is important)](#ensuring-prompt-execution)
### (Optional) Auto-fetch repos
Ensuring your refs are up to date I found can be a pain. To streamline this
git-radar can be configured to auto-fetch your repo. When the `--fetch` flag is
used git-radar will run `git fetch` asynchronously every 5 minutes.
This will only occur when the prompt is rendered and it will only occur on the
repo you are currently in.
To use this feature, when setting your prompt, call git-radar with `--fetch`:
**Bash**
```bash
export PS1="$PS1\$(git-radar --bash --fetch)"
```
[(note: the `\` escaping the `$` is important)](#ensuring-prompt-execution)
**Zsh**
```zsh
export PROMPT="$PROMPT\$(git-radar --zsh --fetch) "
```
[(note: the `\` escaping the `$` is important)](#ensuring-prompt-execution)
## Support
### Ensuring prompt execution
When setting your prompt variable, `PROMPT` in Zsh and `PS1` in Bash, it's
important that the function executes each time the prompt renders. That way the
prompt will respond to changes in your git repo. To ensure this you will need
to escape the execution of the function. There are two ways to do this:
**1. Use `$'` to render raw characters**
```bash
export PROMPT=$'$(git-radar --zsh)'
export PS1=$'$(git-radar --bash)'
```
**2. Use `\` to escape execution of the subshell**
```bash
export PROMPT="\$(git-radar --zsh)"
export PS1="\$(git-radar --bash)"
```
## License
Git Radar is licensed under the MIT license.
See [LICENSE] for the full license text.
[LICENSE]: https://github.com/michaeldfallen/git-radar/blob/master/LICENSE
[git:(master) 3A]: https://raw.githubusercontent.com/michaeldfallen/git-radar/master/images/untracked.png
[git:(master) 2D2M]: https://raw.githubusercontent.com/michaeldfallen/git-radar/master/images/unstaged.png
[git:(master) 1M1R]: https://raw.githubusercontent.com/michaeldfallen/git-radar/master/images/added.png
[git:(master) 1U]: https://raw.githubusercontent.com/michaeldfallen/git-radar/master/images/conflicts.png
[git:(master) 1M 1D2M 2A]: https://raw.githubusercontent.com/michaeldfallen/git-radar/master/images/combination.png
[git:(master 2↑)]: https://raw.githubusercontent.com/michaeldfallen/git-radar/master/images/local%20is%20ahead.png
[git:(master 3↓)]: https://raw.githubusercontent.com/michaeldfallen/git-radar/master/images/remote%20is%20behind.png
[git:(master 3⇵5)]: https://raw.githubusercontent.com/michaeldfallen/git-radar/master/images/remote%20local%20diverged.png
[git:(m ← 2 my-branch)]: https://raw.githubusercontent.com/michaeldfallen/git-radar/master/images/branch%20is%20ahead.png
[git:(m 4 → my-branch)]: https://raw.githubusercontent.com/michaeldfallen/git-radar/master/images/master%20is%20ahead.png
[git:(m 1 ⇄ 2 my-branch)]: https://raw.githubusercontent.com/michaeldfallen/git-radar/master/images/master%20branch%20diverged.png
[An example of git-radar]: https://raw.githubusercontent.com/michaeldfallen/git-radar/master/images/detailed.png
|
