https://github.com/danieldietrich/gitprompt.sh

A beautiful git prompt for zsh and bash.
https://github.com/danieldietrich/gitprompt.sh

bash git prompt shell terminal zsh

Last synced: 4 months ago
JSON representation

A beautiful git prompt for zsh and bash.

• Host: GitHub
• URL: https://github.com/danieldietrich/gitprompt.sh
• Owner: danieldietrich
• License: mit
• Created: 2022-01-01T10:19:08.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2025-01-08T10:02:40.000Z (6 months ago)
• Last Synced: 2025-01-20T14:29:41.389Z (6 months ago)
• Topics: bash, git, prompt, shell, terminal, zsh
• Language: Shell
• Homepage: https://gitprompt.sh
• Size: 343 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


# ❯_ gitprompt

A beautiful git prompt for zsh and bash.

![terminal](./docs/img/terminal.webp)

## Features

* 256 colors support

* Show current directory

* Show git branch, status and push state

## Usage

| Szenario  |               Command             |                     Description                   |

| --------- | --------------------------------- | ------------------------------------------------- |

| ad-hoc    | `. <(curl gitprompt.sh)`          | Use **gitprompt** in the current terminal session |

| permanent | `curl gitprompt.sh/install \| sh` | Install **gitprompt** in your home directory and alter the PATH. |

| manual    | `curl -sL https://gitprompt.sh > "$HOME/.gitprompt"` | Download **gitprompt** to your home directory. Load it by running `. ~/.gitprompt &>/dev/null` |

| dotfiles | `https://github.com/danieldietrich/dotfiles` | Personalize your [Gitpod](https://www.gitpod.io/docs/configure/user-settings/dotfiles) and [GitHub Codepaces](https://docs.github.com/en/codespaces/setting-your-user-preferences/personalizing-github-codespaces-for-your-account#dotfiles) environments |

## Customization

ENV variables can be set in your `.bashrc` or `.zshrc` file.

|         ENV var         |     Default    |           Description          |

| ----------------------- | -------------- | ------------------------------ |

| `GP_COLOR_PROMPT`       | `"38;5;49"`    | Prompt color                   |

| `GP_COLOR_GIT_BRANCH`   | `"38;5;8"`     | Branch color                   |

| `GP_COLOR_GIT_STATUS`   | `"38;5;9"`     | Dirty state color              |

| `GP_COLOR_GIT_UNPUSHED` | `"38;5;11"`    | Unpushed state color           |

| `GP_COLOR_PWD_DARK`     | `"1;38;5;24"`  | Directory color dark           |

| `GP_COLOR_PWD_LIGHT`    | `"1;38;5;39"`  | Directory color light          |