Note

Looking forbgps? git-prompt-string is the successor of bgps.bgps is still available on the tagv0.0.1

📦 Installation

homebrew tap

brew install mikesmithgh/homebrew-git-prompt-string/git-prompt-string

go install

go install github.com/mikesmithgh/git-prompt-string@latest

manually

Example manually downloading via curl on MacOS

curl -L -o git-prompt-string.tar.gz https://github.com/mikesmithgh/git-prompt-string/releases/latest/download/git-prompt-string_Darwin_arm64.tar.gzxattr -c git-prompt-string.tar.gztar xzvf git-prompt-string.tar.gzmv git-prompt-string"$HOME/bin"# replace with your preferred directory that is in PATH

🛠️ Setup

Prompt configuration

bash

PS1='\[\n\e[0;33m\w\e[0m$(git-prompt-string)\n\e[0;32mbash \e[0;36m\$\e[0m \]'

zsh

autoload -U colors&& colorssetopt PROMPT_SUBSTPROMPT=$'\n%{$fg[yellow]%}%~%{$reset_color%}$(git-prompt-string)\n%{$fg[green]%}zsh %{$fg[cyan]%}%#%{$reset_color%}'

fish

set-U fish_prompt_pwd_dir_length 0functionfish_promptset-l symbol' $'if fish_is_root_userset symbol' #'endprintf'\n%s%s%s%s\n%s%sfish%s%s%s'\  (set_color yellow) (prompt_pwd) (set_color normal) (git-prompt-string)\  (set_color green) (set_color blue) (set_color cyan)$symbol (set_color normal)end

powershell

functionprompt {$ESC= [char]27$w=$pwd.Path.Replace($env:USER_PROFILE,"~").Replace($env:HOME,"~")return"`n$ESC[0;33m$w$ESC[0m$(git-prompt-string)`n$ESC[0;32mPS$ESC[0;36m>$ESC[0m"}

nushell

$env.PROMPT_INDICATOR= {||    $" (ansi cyan)>(ansi reset)"}$env.PROMPT_COMMAND= {||    $"\n(ansi yellow)($env.PWD | str replace $"($env.HOME)" '~')(git-prompt-string)\n(ansi green)nushell"}$env.PROMPT_COMMAND_RIGHT=""

starship

"$schema" ='https://starship.rs/config-schema.json'format ="""$directory\${custom.git-prompt-string}\$line_break\[starship](green) \[\\$](cyan) \"""[custom.git-prompt-string]command ="git-prompt-string || :"when =true[directory]home_symbol='~'format ='[$path]($style)'truncation_length =0truncate_to_repo =falsestyle ="yellow"use_logical_path =true

git-prompt-string configuration

Nerd Font

prompt_prefix =''

Configuration file

Configuration options

--ahead-format or ahead_format      The format used to indicate the number of commits ahead of the      remote branch. The %v verb represents the number of commits      ahead. One %v verb is required. (default "↑[%v]")--behind-format or behind_format      The format used to indicate the number of commits behind the      remote branch. The %v verb represents the number of commits      behind. One %v verb is required. (default "↓[%v]")--color-clean or color_clean      The color of the prompt when the working directory is clean.      (default "green")--color-delta or color_delta      The color of the prompt when the local branch is ahead, behind,      or has diverged from the remote branch. (default "yellow")--color-dirty or color_dirty      The color of the prompt when the working directory has changes      that have not yet been committed. (default "red")--color-disabled or color_disabled      Disable all colors in the color-disabled--color-merging or color_merging      The color of the prompt during a merge, rebase, cherry-pick,      revert, or bisect. (default "blue")--color-no-upstream or color_no_upstream      The color of the prompt when there is no remote upstream branch.      (default "bright-black")--color-untracked or color_untracked      The color of the prompt when there are untracked files in the      working directory. (default "magenta")--diverged-format or diverged_format      The format used to indicate the number of commits diverged      from the remote branch. The first %v verb represents the number      of commits ahead of the remote branch. The second %v verb      represents the number of commits behind the remote branch. Two      %v verbs are required. (default "↕ ↑[%v] ↓[%v]")--no-upstream-remote-format or no_upstream_remote_format      The format used to indicate when there is no remote upstream,      but there is still a remote branch configured. The first %v      represents the remote repository. The second %v represents the      remote branch. Two %v are required. (default " → %v/%v")--prompt-prefix or prompt_prefix      A prefix that is added to the beginning of the prompt. The      powerline icon  is used be default. It is recommended to      use a Nerd Font to properly display the  (nf-pl-branch) icon.      See https://www.nerdfonts.com/ to download a Nerd Font. If you      do not want this symbol, replace the prompt prefix with " ".      \ue0a0 is the unicode representation of . (default " \ue0a0 ")--prompt-suffix or prompt_suffix      A suffix that is added to the end of the prompt.--json      Output the results in JSON format. The keys of the JSON result are      branchInfo, branchStatus, color, promptPrefix, and promptSuffix.          Example:      {        "branchInfo": "main",        "branchStatus": "",        "color": "green",        "promptPrefix": "  ",        "promptSuffix": ""      }

Specifying colors

color_clean='#e5ee04'color_no_upstream="reset fg:black bg:white"color_dirty="bg:#b30559"color_delta="fg:#fcb728"color_untracked="fg:#ff0000 bg:#16f2aa"color_merging="bg:#ccccff magenta"

Default configuration

prompt_prefix =' 'prompt_suffix =''ahead_format ='↑[%v]'behind_format ='↓[%v]'diverged_format ='↕ ↑[%v] ↓[%v]'no_upstream_remote_format =' → %v/%v'color_disabled =falsecolor_clean ='green'color_delta ='yellow'color_dirty ='red'color_untracked ='magenta'color_no_upstream ='bright-black'color_merging ='blue'

📌 Alternatives