✨ glitter

Git status summary with custom formats, perfect for your shell prompt

Glitter is a cross-platform command-line tool and format language for making informative git prompts. Glitter's interpreter, glit will:

• Read status information from your git repository through the git api
• Parse and Interpret the provided format
• Output your format with the requested information to stdout

Glitter is a binary tool which affords blazing speed, offers maximum flexibility, and painless installation. This makes Glitter an ideal alternative to alternative to tools like bash-git-prompt, ``zsh-git-prompt](https://github.com/olivierverdier/zsh-git-prompt), and [pos-git`.

Glitter has been tested on Windows, Mac, and Ubuntu; it works in Powershell, zsh, bash, and theoretically any shell environment that supports a prompt command.

Installation

Go to the release page and download a binary for your platform.

To make sure Glitter is installed:

$ glit "'hello from git'" -e "'hello'"

It will output hello from git if the current directory is a git directory and hello if it is not.

Build from source

Install the rust toolchain, cmake and openssl first, and then:

$ cargo install glit

Setting up your shell

Once Glitter is installed, you need to set it to update your prompt.

Bash

Add the following snippet to your ~/.bashrc:

# Format to use inside of git repositories or their sub-folders
export GIT_FMT="\[#g;*(\b)#r(\B(#~(' ⇒ ')))#w(\(#~;*(\+('↑')\-('↓')))\<#g(\M\A\R\D)#r(\m\a\u\d)>\{#m;*;_(\h('@'))})]' '#b;*('\w')'\n '"

# Format to use outside of git repositories
export PS1_FMT="#g(#*('\u')'@\h')':'#b;*('\w')'\$ '"

__set_prompt() {
    PS1="$(glit "$GIT_FMT" -b -e "$PS1_FMT")"
}

export PROMPT_COMMAND=__set_prompt

Powershell

Add the following snippet to your $PROFILE:

# Format to use inside of git repositories
$GIT_FMT="#y(\[#c;*(\b)#c(\B(#~(' ')))#w(\(#~;*(\+\-))\[#g(\M\A\R\D)#r(\m\a\u\d)]\{#m;*;_(\h('@'))})])"

function prompt {
    $path = $(get-location)
    glit "'$path'$GIT_FMT'> '" -e "'$path> '"
}

zsh

Add the following snippet to your ~/.zshrc file:

# Format used in a git repository
export GIT_FMT="\[#g;*(\b)#r(\B(#~(' ⇒ ')))#w(\(#~;*(\+('↑')\-('↓')))\<#g(\M\A\R\D)#r(\m\a\u\d)>\{#m;*;_(\h('@'))})]' '#b;*('%~')"

# Fallback format used outside of git repositories
export PS1_FMT="#g;*('%m')#b;*('%~')"

precmd() { print -rP "$(glit "$GIT_FMT" -b -e "$PS1_FMT")" }
PROMPT="%# "

Customizing your format

Glitter provides a flexible expression language which is easy to use and easy to prototype with:

Example fmt	Result
"\<#m;*(\b)#m(\B(#~('..')))\(#g(\+)#r(\-))>\[#g;*(\M\A\R\D)#r;*(\m\a\u\d)]\{#m;*;_(\h('@'))}"
"\(#m;*(\b)#g(\+)#r(\-))\[#g(\M\A\R\D)#r(\m\a\u\d)]\{#m;_(\h('@'))}':'"
"#g;*(\b)#y(\B(#~('..')))\[#g(\+(#~('ahead ')))]\[#r(\-(#~('behind ')))]' '#g;_(\M\A\R\D)#r;_(\m\a\u\d)"

A glitter format is made of 4 types of expressions:

• Informational expressions
• Group expressions
• Literals
• Format expressions

Git Information

You can provide other expressions as arguments to expressions which replace the default prefix which appears before the result or file count. For example, \h('@') will output @3 instead of H3 if your repository has 3 stashed files. You can provide an arbitrary number of valid expressions as arguments to any of these expressions.

$ glit "\b"
$ glit "\b('on branch ')"

Expressions generally only render any output if their corresponding values aren't empty; in other words, if there are no added files, glit will not produce A0 as the output of \A, but instead will output an empty string.

Grouping

Glitter will surround grouped expressions with parentheses or brackets, and will print nothing if the group is empty.

$ glit "\b\<\M>"

Literals

Any characters between single quotes are literals. Literals are left untouched. For example, 'literal' outputs literal.

$ glit "'hello world'"
$ glit "'\n\w\n\u'"
$ glit "'separate'' ''words'"

Formatting text

Glitter expressions support ANSI terminal formatting through the following styles:

Format styles can be combined in a single expression by separating them with semicolons:

$ glit "#r;*('hello world')"
$ glit "#g;*(\b)"
$ glit "#[255,175,52]('orange text')"
$ glit "#G('green background')"

glit can understand and respects complicated nested styles, providing maximum flexibility.

$ glit "#g('green text with some '#*('bold')' green text')"
$ glit "#g;*(\b(#~('on branch ')))"