Interactive Demo & Configurator

On this page you can see how Hometown Prompt responds to context (user, host, Git status, etc).

You can also experiment with customizing your configuration.

TIP

No custom configuration is required. Hometown Prompt works right out of the box.

• Context
  • Terminal
  • User
  • Session
  • Directory
  • Git ref
  • Git status
  • Extended Git status
• Hometown Prompt Configuration
  • Content Options
  • Layout Options
• Git Prompt Kit Configuration
  • Behavior Options
  • Color Options
  • Content Options
  • Symbol Options

Custom content and the prompt character are printed with prompt expansion, with PROMPT_SUBST and PROMPT_PERCENT. For example, the default prompt char %% is rendered as %, and the default custom content %* is rendered as the 24-hour HH:MM:SS time.

olets@dev

%*

olets/hometown-prompt

main

??UU_D_MA_D_M_

%%

Custom configuration ready for copying and pasting into your .zshrc:

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

Hometown Prompt Configuration

For detailed documentation of these options, see the Options page.

Content Options

See Options > Content for details.

Option	Default	Type	Notes	Value
HOMETOWN_CUSTOM	%*	string	In the terminal, this is printed with prompt expansion with PROMPT_SUBST and PROMPT_PERCENT
HOMETOWN_SHOW_EXTENDED_STATUS	1	integer	undefined

Layout Options

See Options > Layout for details.

Option	Default	Type	Value
HOMETOWN_LINEBREAK_AFTER_GIT_REF	1	integer
HOMETOWN_NO_LINEBREAK_BEFORE_GIT_REF	1	integer

* Git ref info is branch or commit, ahead/behind counts, remote name(s), and tag. See the GIT_PROMPT_KIT_REF docs.

Git Prompt Kit Configuration

Hometown Prompt is made almost entirely of Git Prompt Kit components. So almost all of configuration —color customization, symbol customization, dimming vs hiding inactive elements, the number of path segments shows, etc— is done by configuring through Git Prompt Kit. (Git Prompt Kit is bundled with Hometown Prompt, so no additional download is necessary.) For detailed documentations of these options, see the Git Prompt Kit's options documentation.

Behavior Options

See Git Prompt Kit's options' documentation for details.

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

See Git Prompt Kit's options' documentation for details.

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

See Git Prompt Kit's options' documentation for details.

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

See Git Prompt Kit's options' documentation for details.

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.