zsh plugin for prompts which prints git status. Forked from https://github.com/xylous/gitstatus
Go to file
xylous 8029f58990 Fix branch name spacing
On branches tracking remotes, there would be two spaces between the last
character and the first character in the status part. On other branches,
there'd only be one. Make it so that there's only one space at all
times.

In the function calculating differences between local and remote
histories, an extra space was added before the first part, thus where
the second space came from. Remove that.
2021-09-17 20:21:28 +03:00
LICENSE Add MIT License 2021-05-19 12:13:14 +03:00
README.md Update installation instructions in README.md 2021-08-08 18:47:48 +03:00
gitstatus.plugin.zsh Fix branch name spacing 2021-09-17 20:21:28 +03:00

gitstatus

gitstatus is a plugin made for prompts - it tells you how many things have changed since the last git commit in a repository.

Why such a thing?

Frankly, it's because I needed something small and fast that would integrate well with my (multi-line) prompt.

Is it useful? For me and probably a handful other people, yes.

Getting Started

Requirements

  • zsh
  • git
  • awk

Installation

Manual

Clone this repository locally, on your machine, for example:

git clone "https://github.com/xylous/gitstatus.git" gitstatus
source path/to/installation/gitstatus.plugin.zsh

With a plugin manager

You could also use a plugin manager, such as zpm:

zpm load xylous/gitstatus

Usage

Add the following lines to your zshrc:

function precmd()
{
    local gitstatus="$(gitstatus)"
    PS1="%F{blue}%~%F{default} ${gitstatus} $ "
}

precmd() is a zsh builtin function that executes a series of commands right before the prompt is drawn. In this example, it updates the output of the gitstatus script and then uses it in a sample prompt.

And of course, remember to replace path/to/installation with the actual path to the program.

Roadmap

  • add screenshots
  • cover more git status flags

Contributing

Pull requests and issues are welcome.