Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/sindresorhus/pure

Pretty, minimal and fast ZSH prompt
https://github.com/sindresorhus/pure

git minimal prompt pure shell shell-prompt shell-theme terminal theme zsh

Last synced: 12 days ago
JSON representation

Pretty, minimal and fast ZSH prompt

Lists

README 

        
# Pure



> Pretty, minimal and fast ZSH prompt










---





	


		




			

				Sindre Sorhus' open source work is supported by the community

			

		


		Special thanks to:

		


		


		


		

			

		

		


		


		


		

			


				Gitpod

			


			Dev environments built for the cloud

			


				

				Natively integrated with GitLab, GitHub, and Bitbucket, Gitpod automatically and continuously prebuilds dev

				


				environments for all your branches. As a result team members can instantly start coding with fresh dev environments

				


				for each new task - no matter if you are building a new feature, want to fix a bug, or work on a code review.

				

			


		

		


	




---







## Overview



Most prompts are cluttered, ugly and slow. We wanted something visually pleasing that stayed out of our way.



### Why?



- Comes with the perfect prompt character.

  Author went through the whole Unicode range to find it.

- Shows `git` branch and whether it's dirty (with a `*`).

- Indicates when you have unpushed/unpulled `git` commits with up/down arrows. *(Check is done asynchronously!)*

- Prompt character turns red if the last command didn't exit with `0`.

- Command execution time will be displayed if it exceeds the set threshold.

- Username and host only displayed when in an SSH session or a container.

- Shows the current path in the title and the [current folder & command](screenshot-title-cmd.png) when a process is running.

- Support VI-mode indication by reverse prompt symbol (Zsh 5.3+).

- Makes an excellent starting point for your own custom prompt.



## Install



Can be installed with `npm` (not `yarn`) or manually. Requires Git 2.15.2+ and ZSH 5.2+. Older versions of ZSH are known to work, but they are **not** recommended.



### npm



```sh

npm install --global pure-prompt

```



That's it. Skip to [Getting started](#getting-started).



### [Homebrew](https://brew.sh)



```sh

brew install pure

```



If you're not using ZSH from Homebrew (`brew install zsh` and `$(brew --prefix)/bin/zsh`), you must also add the site-functions to your `fpath` in `$HOME/.zshrc`:



```sh

fpath+=("$(brew --prefix)/share/zsh/site-functions")

```



### Manually



1. Clone this repo somewhere. Here we'll use `$HOME/.zsh/pure`.



```sh

mkdir -p "$HOME/.zsh"

git clone https://github.com/sindresorhus/pure.git "$HOME/.zsh/pure"

```



2. Add the path of the cloned repo to `$fpath` in `$HOME/.zshrc`.

```sh

# .zshrc

fpath+=($HOME/.zsh/pure)

```



## Getting started



Initialize the prompt system (if not so already) and choose `pure`:



```sh

# .zshrc

autoload -U promptinit; promptinit

prompt pure

```



## Options



| Option                           | Description                                                                                    | Default value  |

| :------------------------------- | :--------------------------------------------------------------------------------------------- | :------------- |

| **`PURE_CMD_MAX_EXEC_TIME`**     | The max execution time of a process before its run time is shown when it exits.                | `5` seconds    |

| **`PURE_GIT_PULL`**              | Prevents Pure from checking whether the current Git remote has been updated.                   | `1`            |

| **`PURE_GIT_UNTRACKED_DIRTY`**   | Do not include untracked files in dirtiness check. Mostly useful on large repos (like WebKit). | `1`            |

| **`PURE_GIT_DELAY_DIRTY_CHECK`** | Time in seconds to delay git dirty checking when `git status` takes > 5 seconds.               | `1800` seconds |

| **`PURE_PROMPT_SYMBOL`**         | Defines the prompt symbol.                                                                     | `❯`            |

| **`PURE_PROMPT_VICMD_SYMBOL`**   | Defines the prompt symbol used when the `vicmd` keymap is active (VI-mode).                    | `❮`            |

| **`PURE_GIT_DOWN_ARROW`**        | Defines the git down arrow symbol.                                                             | `⇣`            |

| **`PURE_GIT_UP_ARROW`**          | Defines the git up arrow symbol.                                                               | `⇡`            |

| **`PURE_GIT_STASH_SYMBOL`**      | Defines the git stash symbol.                                                                  | `≡`            |



## Zstyle options



Showing git stash status as part of the prompt is not activated by default. To activate this you'll need to opt in via `zstyle`:



`zstyle :prompt:pure:git:stash show yes`



You can set Pure to only `git fetch` the upstream branch of the current local branch. In some cases, this can result in faster updates for Git arrows, but for most users, it's better to leave this setting disabled. You can enable it with:



`zstyle :prompt:pure:git:fetch only_upstream yes`



`nix-shell` integration adds the shell name to the prompt when used from within a nix shell. It is enabled by default, you can disable it with:



`zstyle :prompt:pure:environment:nix-shell show no`



## Colors



As explained in ZSH's [manual](http://zsh.sourceforge.net/Doc/Release/Zsh-Line-Editor.html#Character-Highlighting), color values can be:

- A decimal integer corresponding to the color index of your terminal. If your `$TERM` is `xterm-256color`, see this [chart](https://upload.wikimedia.org/wikipedia/commons/1/15/Xterm_256color_chart.svg).

- The name of one of the following nine colors: `black`, `red`, `green`, `yellow`, `blue`, `magenta`, `cyan`, `white`, and `default` (the terminal’s default foreground)

- `#` followed by an RGB triplet in hexadecimal format, for example `#424242`. Only if your terminal supports 24-bit colors (true color) or when the [`zsh/nearcolor` module](http://zsh.sourceforge.net/Doc/Release/Zsh-Modules.html#The-zsh_002fnearcolor-Module) is loaded.



Colors can be changed by using [`zstyle`](http://zsh.sourceforge.net/Doc/Release/Zsh-Modules.html#The-zsh_002fzutil-Module) with a pattern of the form `:prompt:pure:$color_name` and style `color`. The color names, their default, and what part they affect are:

- `execution_time` (yellow) - The execution time of the last command when exceeding `PURE_CMD_MAX_EXEC_TIME`.

- `git:arrow` (cyan) - For `PURE_GIT_UP_ARROW` and `PURE_GIT_DOWN_ARROW`.

- `git:stash` (cyan) - For `PURE_GIT_STASH_SYMBOL`.

- `git:branch` (242) - The name of the current branch when in a Git repository.

- `git:branch:cached` (red) - The name of the current branch when the data isn't fresh.

- `git:action` (242) - The current action in progress (cherry-pick, rebase, etc.) when in a Git repository.

- `git:dirty` (218) - The asterisk showing the branch is dirty.

- `host` (242) - The hostname when on a remote machine.

- `path` (blue) - The current path, for example, `PWD`.

- `prompt:error` (red) - The `PURE_PROMPT_SYMBOL` when the previous command has *failed*.

- `prompt:success` (magenta) - The `PURE_PROMPT_SYMBOL` when the previous command has *succeeded*.

- `prompt:continuation` (242) - The color for showing the state of the parser in the continuation prompt (PS2). It's the pink part in [this screenshot](https://user-images.githubusercontent.com/147409/70068574-ebc74800-15f8-11ea-84c0-8b94a4b57ff4.png), it appears in the same spot as `virtualenv`. You could for example matching both colors so that Pure has a uniform look.

- `suspended_jobs` (red) - The `✦` symbol indicates that jobs are running in the background.

- `user` (242) - The username when on remote machine.

- `user:root` (default) - The username when the user is root.

- `virtualenv` (242) - The name of the Python `virtualenv` when in use.



The following diagram shows where each color is applied on the prompt:



```

┌────────────────────────────────────────────────────── user

│      ┌─────────────────────────────────────────────── host

│      │           ┌─────────────────────────────────── path

│      │           │          ┌──────────────────────── git:branch

│      │           │          │     ┌────────────────── git:dirty

│      │           │          │     │ ┌──────────────── git:action

│      │           │          │     │ │        ┌─────── git:arrow

│      │           │          │     │ │        │ ┌───── git:stash

│      │           │          │     │ │        │ │ ┌─── execution_time

│      │           │          │     │ │        │ │ │

zaphod@heartofgold ~/dev/pure master* rebase-i ⇡ ≡ 42s

venv ❯

│    │

│    └───────────────────────────────────────────────── prompt

└────────────────────────────────────────────────────── virtualenv (or prompt:continuation)

```



### RGB colors



There are two ways to use RGB colors with the hexadecimal format. The correct way is to use a [terminal that support 24-bit colors](https://gist.github.com/XVilka/8346728) and enable this feature as explained in the terminal's documentation.



If you can't use such terminal, the module [`zsh/nearcolor`](http://zsh.sourceforge.net/Doc/Release/Zsh-Modules.html#The-zsh_002fnearcolor-Module) can be useful. It will map any hexadecimal color to the nearest color in the 88 or 256 color palettes of your terminal, but without using the first 16 colors, since their values can be modified by the user. Keep in mind that when using this module you won't be able to display true RGB colors. It only allows you to specify colors in a more convenient way. The following is an example on how to use this module:



```sh

# .zshrc

zmodload zsh/nearcolor

zstyle :prompt:pure:path color '#FF0000'

```



## Example



```sh

# .zshrc



autoload -U promptinit; promptinit



# optionally define some options

PURE_CMD_MAX_EXEC_TIME=10



# change the path color

zstyle :prompt:pure:path color white



# change the color for both `prompt:success` and `prompt:error`

zstyle ':prompt:pure:prompt:*' color cyan



# turn on git stash status

zstyle :prompt:pure:git:stash show yes



prompt pure

```



## Tips



In the screenshot you see Pure running in [Hyper](https://hyper.is) with the [hyper-snazzy](https://github.com/sindresorhus/hyper-snazzy) theme and Menlo font.



The [Tomorrow Night Eighties](https://github.com/chriskempson/tomorrow-theme) theme with the [Droid Sans Mono](https://www.fontsquirrel.com/fonts/droid-sans-mono) font (15pt) is also a [nice combination](https://github.com/sindresorhus/pure/blob/95ee3e7618c6e2162a1e3cdac2a88a20ac3beb27/screenshot.png).


*Just make sure you have anti-aliasing enabled in your terminal.*



To have commands colorized as seen in the screenshot, install [zsh-syntax-highlighting](https://github.com/zsh-users/zsh-syntax-highlighting).



## Integration



### [oh-my-zsh](https://github.com/robbyrussell/oh-my-zsh)



1. Set `ZSH_THEME=""` in your `.zshrc` to disable oh-my-zsh themes.

2. Follow the Pure [Install](#install) instructions.

3. Do not enable the following (incompatible) plugins: `vi-mode`, `virtualenv`.



**NOTE:** `oh-my-zsh` overrides the prompt so Pure must be activated *after* `source $ZSH/oh-my-zsh.sh`.



### [prezto](https://github.com/sorin-ionescu/prezto)



Pure is bundled with Prezto. No need to install it.



Add `prompt pure` to your `~/.zpreztorc`.



### [zim](https://github.com/Eriner/zim)



Add `zmodule sindresorhus/pure --source async.zsh --source pure.zsh` to your `.zimrc` and run `zimfw install`.



### [zplug](https://github.com/zplug/zplug)



Update your `.zshrc` file with the following two lines:



```sh

zplug mafredri/zsh-async, from:github

zplug sindresorhus/pure, use:pure.zsh, from:github, as:theme

```



### [zinit](https://github.com/zdharma-continuum/zinit)



Update your `.zshrc` file with the following two lines (order matters):



```sh

zinit ice compile'(pure|async).zsh' pick'async.zsh' src'pure.zsh'

zinit light sindresorhus/pure

```



### [zi](https://wiki.zshell.dev)



Update your `.zshrc` file with the following line:



```sh

zi light-mode for @sindresorhus/pure

```



See the [ZI wiki](https://wiki.zshell.dev/community/gallery/collection/themes#thp-sindresorhuspure) for more.



## FAQ



There are currently no FAQs.



See [FAQ Archive](https://github.com/sindresorhus/pure/wiki/FAQ-Archive) for previous FAQs.



## Ports



- **ZSH**

	- [therealklanni/purity](https://github.com/therealklanni/purity) - More compact current working directory, important details on the main prompt line, and extra Git indicators.

 	- [intelfx/pure](https://github.com/intelfx/pure) - Solarized-friendly colors, highly verbose, and fully async Git integration.

	- [forivall/pure](https://github.com/forivall/pure) - A minimal fork which highlights the Git repo's root directory in the path.

	- [dfurnes/purer](https://github.com/dfurnes/purer) - Compact single-line prompt with built-in Vim-mode indicator.

	- [chabou/pure-now](https://github.com/chabou/pure-now) - Fork with [Now](https://zeit.co/now) support.

	- [pure10k](https://gist.github.com/romkatv/7cbab80dcbc639003066bb68b9ae0bbf) - Configuration file for [Powerlevel10k](https://github.com/romkatv/powerlevel10k/) that makes it look like Pure.

- **Bash**

	- [sapegin/dotfiles](https://github.com/sapegin/dotfiles) - [Prompt](https://github.com/sapegin/dotfiles/blob/dd063f9c30de7d2234e8accdb5272a5cc0a3388b/includes/bash_prompt.bash) and [color theme](https://github.com/sapegin/dotfiles/tree/master/color) for Terminal.app.

- **Fish**

	- [pure-fish/pure](https://github.com/pure-fish/pure) - Fully tested Fish port aiming for feature parity.

- **Rust**

	- [xcambar/purs](https://github.com/xcambar/purs) - Pure-inspired prompt in Rust.

- **Go**

	- [talal/mimir](https://github.com/talal/mimir) - Pure-inspired prompt in Go with Kubernetes and OpenStack cloud support. Not intended to have feature parity.

- **PowerShell**

	- [nickcox/pure-pwsh](https://github.com/nickcox/pure-pwsh/) - PowerShell/PS Core implementation of the Pure prompt.



## Team



[![Sindre Sorhus](https://github.com/sindresorhus.png?size=100)](https://sindresorhus.com) | [![Mathias Fredriksson](https://github.com/mafredri.png?size=100)](https://github.com/mafredri)

---|---

[Sindre Sorhus](https://github.com/sindresorhus) | [Mathias Fredriksson](https://github.com/mafredri)