Pure `❯❮❯`¶

Pretty, minimal and fast Fish 🐟 prompt, ported from zsh.

Install¶

Success

Pure requires Fish ≥3.x

FisherManually

fisher install pure-fish/pure

Download the installer to /tmp

curl git.io/pure-fish --output /tmp/pure_installer.fish --location --silent

Source and trigger the installer

source /tmp/pure_installer.fish; and install_pure

Configuration¶

You can tweak pure behavior and color by changing universal variables either directly in the terminal or in your config.fish, e.g.:

set --universal pure_show_system_time true
set --universal pure_color_system_time pure_color_mute

Features¶

Overview¶

Fully customizable (colors, symbols and features):

Excellent prompt character ❯ 🛠:
Check for new release on start 🏴🐌 ;
Display username and hostname when in an SSH session 🛠 ;
Display command duration when longer than 5 seconds 🛠 ;
Display Python virtualenv when activated 🏴🛠 ;
Display AWS profile when set 🏴🛠 ;
Display VI mode and custom symbol for non-insert mode 🏴🛠 ;
Display kubernetes context and namespace 🏴🛠 ;
Detect when running in a container (e.g. docker, podman, LXC/LXD) 🏴🛠
Indicate if a nix develop shell is activated 🏴🛠.
Show system time 🏴 ;
Show number of running jobs 🏴 ;
Prefix when root 🏴🛠 ;
Display git branch name 🏴🛠 ;
- Display * when git repository is dirty ;
- Display ≡ when git repository is stashed ;
- Display ⇡ when branch is ahead (commits to push) ;
- Display ⇣ when branch is behind (commits to pull) ;
- Display the number of stashes, ahead and behind commits (e.g. ≡3 ⇡5 ⇣2) ;
- Async update when configured with fish-async-prompt ;
Update terminal title with current folder and command 🛠 ;
Shorten or truncate current folder component 🏴🛠 ;
and more…

🏴 means it's controlled by a feature flag, 🛠 mean it's configurable.

Check For New Release¶

Option	Default	Description
`pure_check_for_new_release`	`false`	`true`: check repo for new release (on every shell start)

🐌 Faster Prompt

Checking new release send a HTTP request that slow down your prompt rendering as it wait for remote server response. Set it to false speed up rendering:

set --universal pure_check_for_new_release false

Enabled (with update)Enabled (no update)

screenshot pure_check_for_new_release=true,with-update

screenshot pure_check_for_new_release=true,no-update

Container Detection (Docker)¶

Option	Default	Description
`pure_enable_container_detection`	`true`	`false`: Do not check pure runs inside a container (e.g. `docker`, `podman`, `LXC`/`LXD`, etc.). Detection is a bit tricky across OSes.
`pure_symbol_container_prefix`		Prefix when being inside a container (to customize)

Enabled (inside a container)Enabled (outside a container)

screenshot pure_enable_container_detection=true,inside

screenshot pure_enable_container_detection=true,outside

Current Working Directory¶

Option	Default	Description
`pure_begin_prompt_with_current_directory`	`true`	`true`: `pwd` `git`, `SSH`, duration. `false`: `SSH` `pwd` `git`, duration.
`pure_shorten_prompt_current_directory_length`	`0`	Shorten every prompt path component but the last to X characters (0 do not shorten)
`pure_truncate_prompt_current_directory_keeps`	`0`	Truncate working directory path in prompt, but keeps the last to `n` components (`0` full path in current directory)

Enabled (pwd first)Disabled (SSH first)

screenshot pure_begin_prompt_with_current_directory=true

screenshot pure_begin_prompt_with_current_directory=false

Git¶

Option	Default	Description
`pure_enable_git`	`true`	Show info about Git repository.
`pure_symbol_git_dirty`	`*`	Repository is Dirty (uncommitted/untracked changes).
`pure_symbol_git_stash`	`≡`	Repository git stash status.
`pure_symbol_git_unpulled_commits`	`⇣`	Branch is behind upstream (commits to pull).
`pure_symbol_git_unpushed_commits`	`⇡`	Branch is ahead upstream (commits to push).
`pure_show_numbered_git_indicator`	`false`	Show number of git stash and commits behind/ahead

Need safer git symbols?

Enabled (with git)Disabled (without git info)

screenshot pure_enable_git=true

screenshot pure_enable_git=false

Jobs¶

Option	Default	Description
`pure_show_jobs`	`false`	Show Number of running jobs

Enabled (with running jobs)Disabled (without jobs info)

screenshot pure_show_jobs=true

screenshot pure_show_jobs=false

Kubernetes¶

Option	Default	Description
`pure_symbol_k8s_prefix`	`☸`	Prefix when being connected to Kubernetes/K8s
`pure_enable_k8s`	`false`	`true`: shows `kubernetes` context and namespace.

Enabled (with k8s context and namespace)Disabled (without k8s info)

screenshot pure_enable_k8s=true

screenshot pure_enable_k8s=false

NixOS¶

Indicate if nix develop shell is activated in their prompt.

Option	Default	Description
`pure_enable_nixdevshell`	`false`	Indicate if a `nix develop` shell is activated (based on `IN_NIX_SHELL`).
`pure_symbol_nixdevshell_prefix`	`❄️`	otherwise nerdfonts: '󱄅' or ''
`pure_color_nixdevshell_prefix`	`pure_color_info`	prefix color
`pure_color_nixdevshell_symbol`	`pure_color_mute`	symbol color

Enabled (inside nix develop shell)Disabled (without nix info)

screenshot pure_enable_nixdevshell=true

screenshot pure_enable_nixdevshell=false

Prompt Symbol¶

Option	Default	Description
`pure_symbol_prompt`	`❯`	Control the prompt symbol.

Previous command status¶

Previous command exit status change the prompt symbol color.

On Successful commandOn Failed command

screenshot pure_symbol_prompt=success

screenshot pure_symbol_prompt=error

Python Virtualenv¶

Option	Default	Description
`pure_enable_virtualenv`	`true`	Show virtual env name (based on `VIRTUAL_ENV` or `CONDA_DEFAULT_ENV`).
`pure_symbol_virtualenv_prefix`		Prefix when a Python virtual env is activated (default: undefined)

Enabled (with virtualenv)Disabled (without virtualenv)

screenshot pure_enable_virtualenv=true

screenshot pure_enable_virtualenv=false

AWS Profile¶

Option	Default	Description
`pure_enable_aws_profile`	`true`	Show AWS profile name (based on `AWS_VAULT` or `AWS_PROFILE`).
`pure_symbol_aws_profile_prefix`		Prefix when a AWS profile is activated (default: undefined)

Enabled (with AWS profile)Disabled (without AWS profile)

screenshot pure_enable_aws_profile=true

screenshot pure_enable_aws_profile=false

Separate Error Symbol¶

Option	Default	Description
`pure_separate_prompt_on_error`	`false`	Show last command exit code as a second prompt symbol.

Enabled (separate error symbol)Disabled

screenshot pure_separate_prompt_on_error=true

screenshot pure_separate_prompt_on_error=false

Single Line Prompt¶

Option	Default	Description
`pure_enable_single_line_prompt`	`false`	`true`: Compact prompt as a single line

Enabled (prompt on a single line)Disabled (prompt on two lines)

screenshot pure_enable_single_line_prompt=true

screenshot pure_enable_single_line_prompt=false

SSH Session¶

Option	Default	Description
`pure_symbol_ssh_prefix`		Show SSH session prefix, after path, when being connected to an SSH session (default: undefined)

Connected (show SSH username and host)Disconnected

screenshot ssh=connected

screenshot ssh=disconnected

Time¶

Option	Default	Description
`pure_show_system_time`	`false`	`true`: shows system time before the prompt symbol (as `%H:%M:%S`).

Show system time (enabled)Show system time (disabled)

screenshot pure_show_system_time=true

screenshot pure_show_system_time=false

Command Duration¶

Option	Default	Description
`pure_show_subsecond_command_duration`	`false`	Show subsecond (ex. 1.5s) in command duration.
`pure_threshold_command_duration`	`5`	Show command duration when above this value (seconds).

Subsecond duration (disabled)Subsecond duration (enabled)

screenshot pure_show_subsecond_command_duration=false

screenshot pure_show_subsecond_command_duration=true

Title¶

Option	Default	Description
`pure_symbol_title_bar_separator`	`-`	Separator in terminal's windows title.
`pure_shorten_window_title_current_directory_length`	`0`	Shorten every window title path component but the last to X characters (0 do not shorten)
`pure_truncate_window_title_current_directory_keeps`	`0`	Truncate working directory path in window title, but keeps the last to `n` components (`0` full path in window title)

VI Mode¶

Option	Default	Description
`pure_reverse_prompt_symbol_in_vimode`	`true`	`true`: `❮` indicate a non-insert mode. `false`: indicate vi mode with `[I]`, `[N]`, `[V]`.
`pure_symbol_reverse_prompt`	`❮`	VI non-insert mode symbol.

Reverse symbol (enabled)Mode indicator (disabled)

screenshot pure_reverse_prompt_symbol_in_vimode=true

screenshot pure_reverse_prompt_symbol_in_vimode=false

Working as Root¶

Option	Default	Description
`pure_show_prefix_root_prompt`	`false`	`true`: shows prompt prefix when logged in as `root`.
`pure_symbol_prefix_root_prompt`	`#`	Prefix prompt when logged in as `root`.

Enabled (prefix prompt symbol)Disabled

screenshot pure_show_prefix_root_prompt=true

screenshot pure_show_prefix_root_prompt=false

Colours¶

Tip

See set_color documentation for full possibilities.

Info

The absence of $ sign is expected in pure_ named colours.

Base Color	Inherited by	Default
`pure_color_danger`	`pure_color_prompt_on_error`	`red`
`pure_color_dark`		`black`
`pure_color_info`	`pure_color_git_unpulled_commits` `pure_color_git_unpushed_commits`	`cyan`
`pure_color_light`	`pure_color_username_root`	`white`
`pure_color_mute`	`pure_color_git_branch` `pure_color_git_dirty` `pure_color_git_stash` `pure_color_hostname` `pure_color_at_sign` `pure_color_username_normal` `pure_color_virtualenv`	`brblack`
`pure_color_normal`	`pure_color_jobs`	`normal`
`pure_color_primary`	`pure_color_current_directory`	`blue`
`pure_color_success`	`pure_color_prompt_on_success`	`magenta`
`pure_color_warning`	`pure_color_command_duration`	`yellow`

Troubleshooting¶

Slowness: try Async `git` Prompt¶