Home

Awesome

<img src="./img/git-prompt-kit.png" alt="">

Git Prompt Kit GitHub release (latest by date) GitHub commits since latest release

Git Prompt Kit is a configurable set of components for building feature rich, high performance Git-aware zsh prompts (aka themes) with minimal coding.

 

Documentation

📖 See the guide, including a web simulation demonstrating how the prompt responds to context and configuration, at https://git-prompt-kit.olets.dev/

 

Changelog

See the CHANGELOG file.

Contributing

Looking for the documentation site's source? See https://github.com/olets/git-prompt-kit-docs

Thanks for your interest. Contributions are welcome!

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Check the Issues to see if your topic has been discussed before or if it is being worked on.

Please read CONTRIBUTING.md before opening a pull request.

License

<a href="https://www.github.com/olets/git-prompt-kit">git-prompt-kit</a> by <a href="https://www.github.com/olets">Henry Bley-Vroman</a> is licensed under a license which is the unmodified text of <a href="https://creativecommons.org/licenses/by-nc-sa/4.0">CC BY-NC-SA 4.0</a> and the unmodified text of a <a href="https://firstdonoharm.dev/build?modules=eco,extr,media,mil,sv,usta">Hippocratic License 3</a>. It is not affiliated with Creative Commons or the Organization for Ethical Source.

Human-readable summary of (and not a substitute for) the LICENSE file:

You are free to

Under the following terms

Acknowledgments

The human-readable license summary is based on https://creativecommons.org/licenses/by-nc-sa/4.0. The ethics point was added.

Git Prompt Kit uses Roman Perepelitsa's gitstatus accelerated alternative to Git's status commands.

Showing "dimmed" components was inspired by Arialdo Martini's oh-my-git, which leaves space for inactive symbols.

The default symbol set's using git status's short format was inspired by Michael Allen's git-radar.

Splash card font is Beon by Bastien Sozeau.