Interactive Demo & Configurator

TIP

Another convenient way to experiment with Git Prompt Kit is to install (even temporarily!) Hometown, a Git Prompt Kit-powered zsh prompt.

• Components
• Configuration
  • Behavior Options
  • Color Options
  • Content Options
  • Symbol Options
• Context
  • Terminal
  • User
  • Session
  • Directory
  • Git ref
  • Git status
  • Extended Git status

Components

These change according to the context and configuration. Adjust those, and come back here to see the result.

TIP

Adjust Configuration and Context, and scroll back here to see the result.

Name	Value
GIT_PROMPT_KIT_ACTION
GIT_PROMPT_KIT_AHEAD
GIT_PROMPT_KIT_ASSUMED_UNCHANGED
GIT_PROMPT_KIT_BEHIND
GIT_PROMPT_KIT_CHAR *	%%
GIT_PROMPT_KIT_CONFLICTED	UU
GIT_PROMPT_KIT_CWD	olets/git-prompt-kit
GIT_PROMPT_KIT_DELETED	_D
GIT_PROMPT_KIT_DELETED_STAGED	D_
GIT_PROMPT_KIT_DIRTY	0
GIT_PROMPT_KIT_HEAD	main
GIT_PROMPT_KIT_PUSH
GIT_PROMPT_KIT_PUSH_AHEAD
GIT_PROMPT_KIT_PUSH_BEHIND
GIT_PROMPT_KIT_REF	main
GIT_PROMPT_KIT_REMOTE
GIT_PROMPT_KIT_MODIFIED	_M
GIT_PROMPT_KIT_MODIFIED_STAGED	M_
GIT_PROMPT_KIT_NEW	A_
GIT_PROMPT_KIT_REPO_ROOT	olets/git-prompt-kit
GIT_PROMPT_KIT_REPO_SUBDIRECTORY
GIT_PROMPT_KIT_SKIP_WORKTREE
GIT_PROMPT_KIT_STASHES
GIT_PROMPT_KIT_STATUS	??UU_D_MA_D_M_
GIT_PROMPT_KIT_STATUS_EXTENDED
GIT_PROMPT_KIT_TAG
GIT_PROMPT_KIT_UNTRACKED	??
GIT_PROMPT_KIT_USERHOST	olets@dev

* Printed with prompt expansion. The default %%, for example, becomes %

Configuration

All configuration changes you make below will be listed here, ready for copying and pasting into your .zshrc.

Behavior Options

Option	Default	Type	Value
GIT_PROMPT_KIT_HIDE_INACTIVE_AHEAD_BEHIND	1	integer
GIT_PROMPT_KIT_HIDE_INACTIVE_EXTENDED_STATUS	1	integer
GIT_PROMPT_KIT_HIDE_TOOL_NAMES	1	integer
GIT_PROMPT_KIT_SHOW_INACTIVE_STATUS	1	integer

Color Options

Option	Default	Type	Notes	Value
GIT_PROMPT_KIT_COLOR_ACTION	199	color	ANSI or hex
GIT_PROMPT_KIT_COLOR_ASSUME_UNCHANGED	81	color	ANSI or hex
GIT_PROMPT_KIT_COLOR_CWD	39	color	ANSI or hex
GIT_PROMPT_KIT_COLOR_FAILED	88	color	ANSI or hex
GIT_PROMPT_KIT_COLOR_HEAD	140	color	ANSI or hex
GIT_PROMPT_KIT_COLOR_HOST	109	color	ANSI or hex
GIT_PROMPT_KIT_COLOR_INACTIVE	247	color	ANSI or hex
GIT_PROMPT_KIT_COLOR_PUSH_REMOTE	111	color	ANSI or hex
GIT_PROMPT_KIT_COLOR_REMOTE	216	color	ANSI or hex
GIT_PROMPT_KIT_COLOR_SKIP_WORKTREE	81	color	ANSI or hex
GIT_PROMPT_KIT_COLOR_STAGED	120	color	ANSI or hex
GIT_PROMPT_KIT_COLOR_STASH	81	color	ANSI or hex
GIT_PROMPT_KIT_COLOR_SUCCEEDED	76	color	ANSI or hex
GIT_PROMPT_KIT_COLOR_TAG	86	color	ANSI or hex
GIT_PROMPT_KIT_COLOR_UNSTAGED	162	color	ANSI or hex
GIT_PROMPT_KIT_COLOR_USER	109	color	ANSI or hex

Content Options

Option	Default	Type	Notes	Value
GIT_PROMPT_KIT_CWD_MAX_TRAILING_COUNT	1	integer	undefined
GIT_PROMPT_KIT_DEFAULT_PUSH_REMOTE_NAME	upstream	string	undefined
GIT_PROMPT_KIT_DEFAULT_REMOTE_NAME	origin	string	undefined
GIT_PROMPT_KIT_HIDDEN_HOSTS	()	array	Must be in parentheses	Must match /\(.*\)/
GIT_PROMPT_KIT_HIDDEN_USERS	()	array	Must be in parentheses	Must match /\(.*\)/
GIT_PROMPT_KIT_REPO_SUBDIRECTORY_MAX_TRAILING_COUNT	1	integer	undefined
GIT_PROMPT_KIT_VERBOSE_DEFAULT_SYMBOLS	0	integer	undefined

Symbol Options

Option	Default	Verbose Default	Type	Notes	Value
GIT_PROMPT_KIT_SYMBOL_AHEAD	+	ahead	string	undefined
GIT_PROMPT_KIT_SYMBOL_AHEAD_INACTIVE		ahead		undefined
GIT_PROMPT_KIT_SYMBOL_ASSUME_UNCHANGED	⥱	assumed-unchanged	string	undefined
GIT_PROMPT_KIT_SYMBOL_ASSUME_UNCHANGED_INACTIVE		assumed-unchanged		undefined
GIT_PROMPT_KIT_SYMBOL_BEHIND	-	behind	string	undefined
GIT_PROMPT_KIT_SYMBOL_BEHIND_INACTIVE		behind		undefined
GIT_PROMPT_KIT_SYMBOL_BRANCH		branch:	string	undefined
GIT_PROMPT_KIT_SYMBOL_CHAR_NORMAL	%%		string	Rendered as a prompt string. The default renders as %
GIT_PROMPT_KIT_SYMBOL_CHAR_ROOT	#		string	undefined
GIT_PROMPT_KIT_SYMBOL_COMMIT		commit:	string	undefined
GIT_PROMPT_KIT_SYMBOL_CONFLICTED	UU	conflicted	string	undefined
GIT_PROMPT_KIT_SYMBOL_CONFLICTED_INACTIVE		conflicted		undefined
GIT_PROMPT_KIT_SYMBOL_DELETED	_D	deleted	string	undefined
GIT_PROMPT_KIT_SYMBOL_DELETED_INACTIVE		deleted		undefined
GIT_PROMPT_KIT_SYMBOL_DELETED_STAGED	D_	staged-deleted	string	undefined
GIT_PROMPT_KIT_SYMBOL_DELETED_STAGED_INACTIVE		staged-deleted		undefined
GIT_PROMPT_KIT_SYMBOL_HOST	@	host:	string	undefined
GIT_PROMPT_KIT_SYMBOL_LOCAL	local		string	undefined
GIT_PROMPT_KIT_SYMBOL_MODIFIED	_M	modified	string	undefined
GIT_PROMPT_KIT_SYMBOL_MODIFIED_INACTIVE		modified		undefined
GIT_PROMPT_KIT_SYMBOL_MODIFIED_STAGED	M_	modified-staged	string	undefined
GIT_PROMPT_KIT_SYMBOL_MODIFIED_STAGED_INACTIVE		modified-staged		undefined
GIT_PROMPT_KIT_SYMBOL_NEW	A_	new	string	undefined
GIT_PROMPT_KIT_SYMBOL_NEW_INACTIVE		new		undefined
GIT_PROMPT_KIT_SYMBOL_PUSH_REMOTE	@{push}	push remote:	string	undefined
GIT_PROMPT_KIT_SYMBOL_REMOTE	@{u}	remote:	string	undefined
GIT_PROMPT_KIT_SYMBOL_SKIP_WORKTREE	⤳	skip-worktree	string	undefined
GIT_PROMPT_KIT_SYMBOL_SKIP_WORKTREE_INACTIVE		skip-worktree		undefined
GIT_PROMPT_KIT_SYMBOL_STASH	⇲	stashes	string	undefined
GIT_PROMPT_KIT_SYMBOL_STASH_INACTIVE		stashes		undefined
GIT_PROMPT_KIT_SYMBOL_TAG	@	tag:	string	undefined
GIT_PROMPT_KIT_SYMBOL_UNTRACKED	??	untracked	string	undefined
GIT_PROMPT_KIT_SYMBOL_UNTRACKED_INACTIVE		untracked		undefined

**The default if GIT_PROMPT_KIT_VERBOSE_DEFAULT_SYMBOLS is non-zero.

Context

Terminal

Context	Value
Background color
Text color

User

Context	Value
The current user is hidden
The current host is hidden
Current user is root

Session

Context	Value
Previous command failed

Directory

Context	Value
In a Git repo
In a subdirectory in the Git repo

Git ref

Context	Notes	Value
There is a tag at HEAD
On a local branch
The local branch has a remote	Only relevant when on a branch
The local branch is ahead of the remote	Only relevant when on a branch
The local branch is behind the remote	Only relevant when on a branch
Remote branch is on the default remote	Only relevant when on a branch with a remote
Remote branch has the same name as the local branch	Only relevant when on a branch with a remote

Triangular workflow

Context	Notes	Value
Has a push remote distinct from the pull remote	Only relevant when on a branch
The local branch is ahead of the distinct push remote	Only relevant when on a branch with a distinct push remote
The local branch is behind the push remote	Only relevant when on a branch with a distinct push remote
Push remote branch is on the default push remote	Only relevant when on a branch with a distinct push remote

Git status

Context	Value
Has an ongoing Git action
Has conflicts
Has staged deleted files
Has unstaged deleted files
Has staged modified files
Has unstaged modified files
Has (staged) new files
Has (unstaged) untracked files

Extended Git status

Context	Value
Has files with the assume-unchanged bit set
Has files with the skip-worktree bit set
Has stashes