magicmonty/bash-git-prompt
Bash Git Prompt
bash-git-prompt is a Bash shell extension and prompt customizer that integrates real-time Git status indicators directly into the terminal. It functions as a shell theme that displays branch names, commit divergence, and file status markers within the command line interface.
The project distinguishes itself through a hierarchical configuration system that allows for directory-specific overrides of global settings. It includes performance tuning options to maintain shell responsiveness in large repositories by selectively disabling expensive operations such as remote fetching or untracked file scanning.
The tool covers a broad range of visual and functional capabilities, including prompt layout and color customization, remote branch divergence tracking, and the monitoring of staged, unstaged, and stashed files. Users can define custom delimiters and apply predefined visual themes to organize the appearance of the input line.
Features
- Git Status Indicators - Displays branch names, commit divergence, and file change counts as visual elements within the shell prompt.
- Git Command Line Extensions - Extends the command line interface by calling Git commands to extract repository state and branch information.
- Shell Prompt Customizers - Provides a comprehensive system for configuring and styling the layout and content of the Bash command-line interface prompt.
- Terminal Prompt Customizers - Acts as a terminal prompt customizer that displays Git branch names, divergence, and file status.
- Shell Integration - Hooks into the shell environment to dynamically compute and inject a status string into the prompt.
- Shell Themes - Provides a visual configuration for the Bash command line that adds colors and dynamic information.
- Prompt Performance Optimizations - Reduces shell lag in large repositories by optimizing how Git status and remote tracking are fetched.
- Repository Configuration - Provides a system for managing local repository settings to override global behaviors for specific directories.
- Shell Responsiveness Optimizations - Minimizes shell lag in large repositories by disabling expensive operations like untracked file detection.
- Template String Interpolation - Injects shell variables and calculated Git data into template strings to build the command line prompt.
- Visual Styling and Prompt Utilities - Implements aesthetic enhancements for the terminal, including custom delimiters and dynamic status markers for the prompt.
- Local-Remote Branch Synchronizers - Tracks and displays synchronization status and divergence between local and remote Git branches.
- Divergence Indicators - Indicates if the current branch is ahead of, behind, or diverged from its upstream remote tracking branch.
- Hierarchical Configuration Frameworks - Combines global settings with directory-specific overrides to control status indicators.
- Feature Toggles - Allows users to disable expensive operations like remote fetching to maintain shell responsiveness.
- Prompt Themes - Ships a system for applying predefined visual themes and custom color configurations to the terminal prompt.
- Prompt Color Styling - Allows the definition of foreground and background colors to style text output in shell prompt segments.
- Conditional Formatting - Applies ANSI color codes and delimiters based on the current state of the Git repository.
- Shell Environments - Informative Git status prompt for Bash.
- Terminal Customization - Informative Git prompt for Bash.
- Terminal Prompts - Informative Git status prompt for Bash users.
- Version Control - Informative and customizable bash prompt for git.
- Terminal Customization - Informative prompt theme with Git status integration.
Star history
How this analysis was created: This summary and feature list are AI-generated from collected project material and can contain mistakes. Stars, license and language are imported from GitHub. Inclusion does not mean that we have tested or audited this project. Check the source documentation for any feature you depend on. Learn more on our About page.
