bash-git-prompt
A customizable bash and fish shell prompt that displays detailed Git repository status information.
What is bash-git-prompt?
Bash Git Prompt is a shell enhancement that displays real-time, detailed information about the current Git repository directly in the command line interface. It shows branch name, upstream tracking status, file status counts, and stash entries to help developers quickly assess repository state without running additional Git commands, improving workflow efficiency.
Developers using bash or fish shells who frequently work with Git repositories and want immediate visibility into repository status directly in their terminal prompt.
Developers choose this over basic prompts because it provides comprehensive, visually intuitive Git status information with extensive customization options, including multiple themes and performance controls for large repositories, while maintaining compatibility with both bash and fish shells.
Overview
An informative and fancy bash prompt for Git users
Use Cases
Best For
- Quickly assessing Git repository state without running 'git status' commands
- Customizing terminal prompts with detailed Git information and color themes
- Monitoring upstream branch divergence and local changes in real-time
- Working in repositories with many untracked files or deep submodules where performance optimization is needed
- Adding custom prompt elements like job counts or window titles through callback functions
- Switching between bash and fish shells while maintaining consistent Git prompt functionality
Not Ideal For
- Users who prefer minimal, uncluttered terminal prompts without detailed Git information
- Developers using shells other than bash or fish, such as zsh or ksh, where native integrations might be more seamless
- Environments with massive Git repositories where even optimized prompts could introduce noticeable latency
- Teams already using comprehensive shell frameworks like oh-my-zsh or oh-my-bash that bundle similar Git prompt features
Pros & Cons
Pros
Shows branch name, upstream tracking, file status counts (staged, changed, untracked, conflicted), and stash entries in a concise, symbol-based format, reducing the need for manual 'git status' commands.
Offers multiple pre-built themes, custom theme creation via .bgptheme files, and configurable variables like GIT_PROMPT_SHOW_UNTRACKED_FILES, allowing users to tailor the prompt to their visual preferences and workflow.
Includes options to optimize speed in repositories with many untracked files or deep submodules, such as disabling remote status fetching or untracked file counting via .bash-git-rc files.
Works with both bash and fish shells, with installation guides for each, providing consistent Git prompt functionality across different terminal environments.
Cons
Setup involves multiple environment variables, theme files, and shell scripting knowledge, which can be daunting for users unfamiliar with prompt customization or those seeking a plug-and-play solution.
Only supports bash and fish, excluding other popular shells like zsh—despite being a port from a zsh project—forcing users of unsupported shells to find alternatives.
Even with optimizations, fetching remote status and scanning for untracked files can slow down the prompt in very large repositories, requiring manual tweaks that may not fully eliminate lag.
Frequently Asked Questions
Related Projects
lazygitsimple terminal UI for git commands
powerlevel10kA Zsh theme
gituiBlazing 💥 fast terminal-ui for git written in rust 🦀
git-extrasGIT utilities -- repo summary, repl, changelog population, author commit percentages and more
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.