siina/gitstatus
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
zsh plugin for prompts which prints git status. Forked from https://github.com/xylous/gitstatus
16 commits 1 branch 0 tags 235 KiB
Shell 100%
Find a file
xylous 0387deb641 Export a function instead of running w/shebang 
To make integrating with plugin managers as easy as possible,
plugins/scripts shouldn't be sourced on their own; instead, they should
export functions.
2021-08-08 18:34:17 +03:00
gitstatus.plugin.zsh Export a function instead of running w/shebang 2021-08-08 18:34:17 +03:00
LICENSE Add MIT License 2021-05-19 12:13:14 +03:00
README.md Export a function instead of running w/shebang 2021-08-08 18:34:17 +03:00

README.md

gitstatus.zsh

gitstatus.zsh 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

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

git clone "https://github.com/xylous/gitstatus.zsh.git" gitstatus

Usage

Add the following lines to your zshrc:

source path/to/installation/gitstatus.plugin.zsh

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