Options

Set variables in .zshrc. For example, to only show the user if not me, only show the host if not my-computer or my-other-computer, and use symbols to distinguish between branches and commits:

# ~/.zshrc
# --- snip ---
GIT_PROMPT_KIT_HIDDEN_HOSTS=( my-computer my-other-computer )
GIT_PROMPT_KIT_HIDDEN_USERS=( me )
GIT_PROMPT_KIT_SYMBOL_BRANCH="#"
GIT_PROMPT_KIT_SYMBOL_COMMIT="•"
# Load Git Prompt Kit (will differ depending on installation method)

To output your configuration, for example for sharing, run

git-prompt-kit-config

(The exporter makes an effort to get quoting right, but if you use a custom configuration with quotation marks it's worth double checking that the exported value is correct.)

Behavior options

Option	Default	Type	Description
GIT_PROMPT_KIT_HIDE_INACTIVE_AHEAD_BEHIND	1	integer	Hide dimmed symbols for the commits ahead of and commits behind the upstream branch when the count is zero? (HIDE if non-zero, SHOW if zero)
GIT_PROMPT_KIT_HIDE_INACTIVE_EXTENDED_STATUS	1	integer	Hide dimmed Git stash, assumed-unchanged, and skip-worktree symbols when the count is zero? (HIDE if non-zero, SHOW if zero)
GIT_PROMPT_KIT_HIDE_TOOL_NAMES	1	integer	Do not show the word "Git" before the Git ref info? (HIDE if non-zero, SHOW if zero)
GIT_PROMPT_KIT_SHOW_INACTIVE_STATUS	1	integer	Show Git status symbols (dimmed) when the count is zero? (SHOW if non-zero, HIDE if zero)

Color options

Colors can be

• one of zsh's eight color names (black, red, green, yellow, blue, magenta, cyan and white; see http://zsh.sourceforge.net/Doc/Release/Zsh-Line-Editor.html#Character-Highlighting)
• an integer 1-255 for an 8-bit color (see https://en.wikipedia.org/wiki/ANSI_escape_code#8-bit)
• or a #-prefixed 3- or 6-character hexadecimal value for 24-bit color (e.g. #fff, #34d5eb)

Support varies by terminal emulator.

To visualize the configured colors, run

git-prompt-kit-colors

To print the configured values, run

git-prompt-kit-config

TIP

Colors may appear differently in your terminal. To check, it can be useful to run print -P %F{<color>}<text>%f, for example print -P %F{199}●%f or print -P %F{#34d5eb}●%f.

Option	Default	Type	Swatch	Description
GIT_PROMPT_KIT_COLOR_ACTION	199	color		Color of the Git action segment
GIT_PROMPT_KIT_COLOR_ASSUME_UNCHANGED	81	color		Color of the Git assumed unchanged files segment
GIT_PROMPT_KIT_COLOR_CWD	39	color		Color of the current working directory segment
GIT_PROMPT_KIT_COLOR_FAILED	88	color		Color of the prompt character when the previous command failed
GIT_PROMPT_KIT_COLOR_HEAD	140	color		Color of the Git HEAD segment when the working tree is dirty
GIT_PROMPT_KIT_COLOR_HOST	109	color		Color of the host segment
GIT_PROMPT_KIT_COLOR_INACTIVE	247	color		Color of inactive segments
GIT_PROMPT_KIT_COLOR_PUSH_REMOTE	111	color		Color of the Git push remote and its commits-ahead files segment
GIT_PROMPT_KIT_COLOR_REMOTE	216	color		Color of the Git remote and its commits-ahead files segment
GIT_PROMPT_KIT_COLOR_SKIP_WORKTREE	81	color		Color of the Git skip-worktree files segment
GIT_PROMPT_KIT_COLOR_STAGED	120	color		Color of Git staged files segment
GIT_PROMPT_KIT_COLOR_STASH	81	color		Color of the Git stashes segment
GIT_PROMPT_KIT_COLOR_SUCCEEDED	76	color		Color of the prompt character when the previous command succeeded
GIT_PROMPT_KIT_COLOR_TAG	86	color		Color of Git tag segment
GIT_PROMPT_KIT_COLOR_UNSTAGED	162	color		Color of Git unstaged files segment
GIT_PROMPT_KIT_COLOR_USER	109	color		Color of the user segment

Content options

To print the configured values, run

git-prompt-kit-config

Option	Default	Type	Description
GIT_PROMPT_KIT_CWD_MAX_TRAILING_COUNT	1	integer	The maximum number of trailing path components in the GIT_PROMPT_KIT_CWD. Additional components will be ellided with .... If less than zero, show all
GIT_PROMPT_KIT_DEFAULT_PUSH_REMOTE_NAME	upstream	string	The default Git push remote when distinct from the pull remote
GIT_PROMPT_KIT_DEFAULT_REMOTE_NAME	origin	string	The default Git remote
GIT_PROMPT_KIT_HIDDEN_HOSTS	()	array	Hosts which will not be included in the prompt
GIT_PROMPT_KIT_HIDDEN_USERS	()	array	Users which will not be included in the prompt
GIT_PROMPT_KIT_REPO_SUBDIRECTORY_MAX_TRAILING_COUNT	1	integer	The maximum number of trailing path components in GIT_PROMPT_KIT_REPO_SUBDIRECTORY. Additional components will be ellided with .... If less than zero, show all
GIT_PROMPT_KIT_VERBOSE_DEFAULT_SYMBOLS	0	integer	Set to a non-empty string to enable the verbose default symbols

Symbol options

To print the configured values, run

git-prompt-kit-config

The default symbols should work well in any font.

The default Git file status symbols are based on Git's own short format (underscore _ represents empty columns in git-status --short's output). The alternate "verbose" set of default symbols take up more space, but their meaning may be clearer.

Option	Default	Verbose Default	Type	Description
GIT_PROMPT_KIT_SYMBOL_AHEAD	+	ahead	string	Precedes the Git commits-ahead segment
GIT_PROMPT_KIT_SYMBOL_AHEAD_INACTIVE		ahead		Follows the Git assume-unchanged segment when inactive
GIT_PROMPT_KIT_SYMBOL_ASSUME_UNCHANGED	⥱	assumed-unchanged	string	Follows the Git assume-unchanged segment
GIT_PROMPT_KIT_SYMBOL_ASSUME_UNCHANGED_INACTIVE		assumed-unchanged		Follows the Git assume-unchanged segment when inactive
GIT_PROMPT_KIT_SYMBOL_BEHIND	-	behind	string	Precedes the Git commits-behind segment
GIT_PROMPT_KIT_SYMBOL_BEHIND_INACTIVE		behind		Precedes the Git commits-behind segment when inactive
GIT_PROMPT_KIT_SYMBOL_BRANCH		branch:	string	Precedes the Git branch
GIT_PROMPT_KIT_SYMBOL_CHAR_NORMAL	%%		string	Character shown at end of prompt for normal users
GIT_PROMPT_KIT_SYMBOL_CHAR_ROOT	#		string	Character shown at end of prompt for root users
GIT_PROMPT_KIT_SYMBOL_COMMIT		commit:	string	Precedes the Git commit
GIT_PROMPT_KIT_SYMBOL_CONFLICTED	UU	conflicted	string	Follows the Git conflicted files segment
GIT_PROMPT_KIT_SYMBOL_CONFLICTED_INACTIVE		conflicted		Follows the Git conflicted files segment when inactive
GIT_PROMPT_KIT_SYMBOL_DELETED	_D	deleted	string	Follows the Git unstaged deleted file segment
GIT_PROMPT_KIT_SYMBOL_DELETED_INACTIVE		deleted		Follows the Git unstaged deleted file segment when inactive
GIT_PROMPT_KIT_SYMBOL_DELETED_STAGED	D_	staged-deleted	string	Follows the Git staged deleted file segment
GIT_PROMPT_KIT_SYMBOL_DELETED_STAGED_INACTIVE		staged-deleted		Follows the Git staged deleted file segment when inactive
GIT_PROMPT_KIT_SYMBOL_HOST	@	host:	string	Precedes the host
GIT_PROMPT_KIT_SYMBOL_LOCAL	local		string	Shown if the checked out branch has no upstream
GIT_PROMPT_KIT_SYMBOL_MODIFIED	_M	modified	string	Follows the Git unstaged modified file segment
GIT_PROMPT_KIT_SYMBOL_MODIFIED_INACTIVE		modified		Follows the Git unstaged modified file segment when inactive
GIT_PROMPT_KIT_SYMBOL_MODIFIED_STAGED	M_	modified-staged	string	Follows the Git staged modified file segment
GIT_PROMPT_KIT_SYMBOL_MODIFIED_STAGED_INACTIVE		modified-staged		Follows the Git staged modified file segment when inactive
GIT_PROMPT_KIT_SYMBOL_NEW	A_	new	string	Follows Git new file segment
GIT_PROMPT_KIT_SYMBOL_NEW_INACTIVE		new		Follows Git new file segment when inactive
GIT_PROMPT_KIT_SYMBOL_PUSH_REMOTE	@{push}	push remote:	string	Precedes the Git push remote
GIT_PROMPT_KIT_SYMBOL_REMOTE	@{u}	remote:	string	Precedes the Git remote
GIT_PROMPT_KIT_SYMBOL_SKIP_WORKTREE	⤳	skip-worktree	string	Follows the Git skip-worktree file segment
GIT_PROMPT_KIT_SYMBOL_SKIP_WORKTREE_INACTIVE		skip-worktree		Follows the Git skip-worktree file segment when inactive
GIT_PROMPT_KIT_SYMBOL_STASH	⇲	stashes	string	Follows the Git stash segment
GIT_PROMPT_KIT_SYMBOL_STASH_INACTIVE		stashes		Follows the Git stash segment when inactive
GIT_PROMPT_KIT_SYMBOL_TAG	@	tag:	string	Precedes the Git tag
GIT_PROMPT_KIT_SYMBOL_UNTRACKED	??	untracked	string	Follows Git untracked file segment
GIT_PROMPT_KIT_SYMBOL_UNTRACKED_INACTIVE		untracked		Follows Git untracked file segment when inactive

**The default if GIT_PROMPT_KIT_VERBOSE_DEFAULT_SYMBOLS is non-zero.

* %% expands as % in the zsh prompt.