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.

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

11:31:05

olets/hometown-prompt

main

??UU_D_MA_D_M_

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

(see Options)

Context

Terminal

Context	Value
Background color
Text color

User

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

Session

Context	Value
Previous command failed

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

Options

Hometown Prompt Configuration

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

Content Options

See Options > Content for details.

Option	Default	Type	Notes
`HOMETOWN_CUSTOM`	`'%*'`	string	In the terminal, this is printed with prompt expansion with `PROMPT_SUBST` and `PROMPT_PERCENT`
`HOMETOWN_SHOW_EXTENDED_STATUS`	`1`	integer
`HOMETOWN_SET_PSVAR`	`1`	integer	Sets psvar to `( <time> <exit code-dependent color> <char> <date> <whether date is different from today> )`. Used by the default `HOMETOWN_TRANSIENT_PROMPT_ENV` and scheduled refresh.

Layout Options

See Options > Layout for details.

Option	Default	Type	Notes
`HOMETOWN_LINEBREAK_AFTER_GIT_REF`	`1`	integer
`HOMETOWN_LINEBREAK_BEFORE_PROMPT`	`1`	integer	See also Advanced.
`HOMETOWN_NO_LINEBREAK_BEFORE_FIRST_PROMPT`	`1`	integer	See also Advanced.
`HOMETOWN_NO_LINEBREAK_BEFORE_GIT_REF`	`1`	integer

Scheduled refresh

See Options > Scheduled refresh for details.

Option	Default	Type	Value
`HOMETOWN_REFRESH_FUNCTION`	`(( HOMETOWN_SET_PSVAR && ! psvar[5] )) && _hometown_set_date_psvar; _git_prompt_kit_update_git`	function
`HOMETOWN_REFRESH_INTERVAL`	`0`	integer

Transient Prompt Options

See Options > Layout for details.

Option	Default	Type	Notes	Value
`HOMETOWN_TRANSIENT_PROMPT_ENV`	`( [GIT_PROMPT_KIT_CWD_MAX_TRAILING_COUNT]-0 [GIT_PROMPT_KIT_HIDE_INACTIVE_AHEAD_BEHIND]-1 [GIT_PROMPT_KIT_HIDE_INACTIVE_EXTENDED_STATUS]-1 [GIT_PROMPT_KIT_HIDE_TOOL_NAMES]-1 [GIT_PROMPT_KIT_SHOW_INACTIVE_STATUS]-0 [GIT_PROMPT_KIT_SYMBOL_CHAR_NORMAL]-$' ' [GIT_PROMPT_KIT_SYMBOL_CHAR_ROOT]-$' ' [HOMETOWN_CUSTOM]-'%F{%2v}%3v%f %(5V.%5v %v - %W %.%v-%)' [HOMETOWN_LINEBREAK_AFTER_GIT_REF]-0 [HOMETOWN_LINEBREAK_BEFORE_PROMPT]-0 [HOMETOWN_NO_LINEBREAK_BEFORE_GIT_REF]-1 )`	associative array	Default value assumes `HOMETOWN_SET_PSVAR` is non-zero.
`HOMETOWN_USE_TRANSIENT_PROMPT`	`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
`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
`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
`GIT_PROMPT_KIT_DEFAULT_PUSH_REMOTE_NAME`	`upstream`	string
`GIT_PROMPT_KIT_DEFAULT_REMOTE_NAME`	`origin`	string
`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
`GIT_PROMPT_KIT_VERBOSE_DEFAULT_SYMBOLS`	`0`	integer

Symbol Options

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

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

**The default if GIT_PROMPT_KIT_VERBOSE_DEFAULT_SYMBOLS is non-zero.

Interactive Demo & Configurator ​

Context ​

Terminal ​

User ​

Session ​

Directory ​

Git ref ​

Triangular workflow ​

Git status ​

Extended Git status ​

Options ​

Hometown Prompt Configuration ​

Content Options ​

Layout Options ​

Scheduled refresh ​

Transient Prompt Options ​

Git Prompt Kit Configuration ​

Behavior Options ​

Color Options ​

Content Options ​

Symbol Options ​

Interactive Demo & Configurator

Context

Terminal

User

Session

Directory

Git ref

Triangular workflow

Git status

Extended Git status

Options

Hometown Prompt Configuration

Content Options

Layout Options

Scheduled refresh

Transient Prompt Options

Git Prompt Kit Configuration

Behavior Options

Color Options

Content Options

Symbol Options