README.md

a minimalist zsh prompt theme inspired by geometry, fast by design.

At a glance, you see what matters. Nothing else clutters your prompt.

• Current branch, tag, or short commit SHA
• Clean ⬢ or dirty ⬡ working tree
• Commits ⇡ ahead or ⇣ behind upstream
• Time since the last commit
• Elapsed time on long-running commands
• Background job count
• Exit code of the previous command when it fails

Install

antidote (recommended)

Add this to your ~/.zsh_plugins.txt:

dio-az/hexagon

zplug

Add this to your ~/.zshrc:

zplug "dio-az/hexagon"

Styling

Hexagon uses zstyle for configuration. The general format is:

zstyle ':hexagon:context' property value

For example, to change the path color to cyan:

zstyle ':hexagon:path' color cyan

Prompt path

The path on the left is yours to style:

Components

Add, drop, or rearrange the right-prompt pieces:

Timer

Slow commands quietly show how long they took:

Duration

Customize the color of the durations shown by git elapsed and timer:

Jobs

See how many background jobs are running:

Exit

When the previous command fails, see its exit code:

zstyle ':hexagon' components exit timer jobs git

Git

Inside a repo, see your branch, working-tree state, and upstream tracking:

Custom components

A component is a shell function named hexagon_<name> that writes its output to stdout.

Register custom components by setting :hexagon components. This replaces the list, so include any built-ins you still want:

zstyle ':hexagon' components <name> timer jobs git

The following helper functions are available:

Here is a component that shows the active major Node.js version:

hexagon_node() {
	command -v node &>/dev/null || return

	local color symbol
	hexagon::style -s ':hexagon:node' color green
	hexagon::style -s ':hexagon:node' symbol ⬡

	hexagon::color $color $symbol${${$(node --version)#v}%%.*}
}

zstyle ':hexagon' components node timer jobs git

Place this in your ~/.zshrc after loading Hexagon.

Git components

Like a regular component, but its function is named hexagon_git_<name>, registered under :hexagon:git components, and called only inside a git repository. Before it runs, the $hexagon_git associative array is populated with:

Here is an override of the built-in remote that shows how many commits are ahead and behind upstream:

hexagon_git_remote() {
	(( hexagon_git[ahead] == 0 && hexagon_git[behind] == 0 )) && return

	local ahead behind color
	hexagon::style -s ':hexagon:git:remote' ahead ⇡
	hexagon::style -s ':hexagon:git:remote' behind ⇣
	hexagon::style -s ':hexagon:git:remote' color default

	(( hexagon_git[behind] == 0 )) && hexagon::color $color $hexagon_git[ahead]$ahead && return
	(( hexagon_git[ahead] == 0 )) && hexagon::color $color $hexagon_git[behind]$behind && return

	hexagon::color $color "$hexagon_git[ahead]$ahead $hexagon_git[behind]$behind"
}