How do I install zsh-git-prompt with the Haskell version for better speed?

Clone the repository, install Haskell stack if not present, run 'stack setup' and 'stack build' in the project folder, then set GIT_PROMPT_EXECUTABLE='haskell' in your .zshrc. This enables the faster implementation that calls Git only once per prompt update.

zsh-git-prompt vs oh-my-zsh git plugin: which is better?

zsh-git-prompt offers more detailed and customizable Git status indicators out of the box, while oh-my-zsh provides a broader framework with easier setup and extensive theming. Choose zsh-git-prompt for granular control, oh-my-zsh for convenience and integration.

Can I change the symbols used in zsh-git-prompt?

Yes, you can customize symbols by modifying Zsh variables like ZSH_THEME_GIT_PROMPT_CLEAN or ZSH_THEME_GIT_PROMPT_UNTRACKED in your .zshrc. Refer to the zshrc.sh file for a full list of available variables and their defaults.

Why isn't my zsh-git-prompt showing remote tracking information?

Ensure your Git repository has a remote branch configured and that Git can fetch data. The prompt relies on Git commands to compute ahead/behind counts, so issues with remote connectivity or tracking setup can prevent display.

How to update zsh-git-prompt after installation?

Update manually by pulling the latest changes from the GitHub repository in your cloned folder. Then, restart your terminal or re-source your .zshrc to apply any updates, as there's no built-in auto-update mechanism.

Does zsh-git-prompt work with powerline or other Zsh themes?

It can be integrated by incorporating the git_super_status function into your PROMPT variable, but compatibility may require adjustments to align with the theme's styling and layout, as it's not pre-packaged with common themes.

Open-Awesome

git-prompt (olivierverdier)

MITHaskellv0.5

A Zsh prompt that displays detailed Git repository status including branch, remote tracking, staged files, and changes.

GitHub

1.8k stars393 forks0 contributors

What is git-prompt (olivierverdier)?

zsh-git-prompt is a Zsh shell extension that enhances the terminal prompt with detailed Git repository status information. It displays the current branch, remote tracking differences, and counts of staged, changed, and untracked files directly in the prompt. This eliminates the need to manually run Git status commands to understand the repository state.

Target Audience

Developers using Zsh who work frequently with Git repositories and want immediate visibility into their repository status without leaving the terminal. It's particularly useful for those managing complex branching workflows or multiple simultaneous changes.

Value Proposition

It provides a comprehensive, at-a-glance view of Git status that's more detailed than most built-in prompts, with customizable symbols and optional performance optimization through a Haskell implementation. The project is lightweight, integrates seamlessly with existing Zsh configurations, and improves developer workflow efficiency.

Overview

Informative git prompt for zsh

Use Cases

Best For

Enhancing Zsh prompts with detailed Git status information
Quickly assessing repository state during complex Git workflows
Reducing terminal clutter by embedding Git info in the prompt
Monitoring remote branch synchronization while working
Tracking staged and unstaged file counts during development
Customizing terminal appearance with Git-aware prompts

Not Ideal For

Users working with shells other than Zsh, such as Bash or Fish
Developers who prefer minimal, unobtrusive terminal prompts without detailed Git information
Teams requiring easy, automated installation via package managers like Homebrew or apt

Pros & Cons

Pros

Comprehensive Status Display

Shows branch name, remote ahead/behind counts, and specific file statuses like staged, changed, and untracked, providing immediate repository insights without extra commands.

Highly Customizable Appearance

Allows modification of symbols and layout through Zsh variables, enabling users to tailor the prompt's look and information order to their preferences.

Optional Performance Boost

Haskell implementation reduces Git calls to once per prompt update, making it significantly faster, especially in large repositories, as noted in the README.

Cons

Manual Setup Required

Requires cloning the repository, sourcing scripts in .zshrc, and potentially editing configuration files, lacking a simple one-command installation method.

Zsh-Only Compatibility

Exclusively designed for Zsh, making it unusable with other shells and limiting portability for users in mixed shell environments.

Haskell Dependency Complexity

For optimal performance, users must install and maintain Haskell stack, adding an extra layer of setup and potential maintenance overhead.

Frequently Asked Questions

Related Projects

powerlevel10k

A Zsh theme

Stars54,779

Forks2,432

Last commit1 month ago

spaceship

🚀✨ Minimalistic, powerful and extremely customizable Zsh prompt

Stars20,546

Forks970

Last commit9 days ago

pure

Pretty, minimal and fast ZSH prompt

Stars14,360

Forks1,008

Last commit7 days ago

powerlevel9k

Powerlevel9k was a tool for building a beautiful and highly functional CLI, customized for you. P9k had a substantial impact on CLI UX, and its legacy is now continued by P10k.

Stars13,423

Forks915

Last commit6 years ago

Community-curated · Updated weekly · 100% open source

Found a gem we're missing?

Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.

Submit a project Star on GitHub