gitstatus is a 10x faster alternative to git status and git describe. Its primary use case is to enable fast git prompt in interactive shells. Heavy lifting is done by gitstatusd -- a custom binary written in C++. It comes with Zsh and Bash bindings for integration with shell. The easiest way to take advantage of gitstatus from Zsh is to use a theme that's already integrated with it. For example, Powerlevel10k is a flexible and fast theme with first-class gitstatus integration. If you install Powerlevel10k, you don't need to install gitstatus. This will give you a basic yet functional prompt with git status in it. It's over 10x faster than any alternative that can give you comparable prompt. In order to customize it, set PROMPT and/or RPROMPT at the end of ~/.zshrc after sourcing gitstatus.prompt.zsh. Insert ${GITSTATUS_PROMPT} where you want git status to go.

Features

  • Use from Bash
  • Single-threaded scan
  • To compile: binutils, cmake, gcc, g++, git and GNU make
  • To run: Linux, macOS, FreeBSD, Android, WSL, Cygwin or MSYS2
  • Licensed under the GNU General Public License v3.0
  • Use from Zsh

Project Samples

Project Activity

See All Activity >