gitstatus

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

Example with PS1='%F{blue}%~%F{default} $(gitstatus) %F{green}$%F{default} ':

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

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.

1.4 KiB Raw Blame History