Files
pure/readme.md
Tom Vincent 259a72c53b Conditionalise git pull check
Whilst a nice feature, firing off a `git fetch` (and so an SSH/http call) after
*every* shell interaction is a bit heavy for my liking. This adds the ability to
disable it (whilst keeping it enabled by default).
2013-11-01 15:46:03 +01:00

83 lines
2.1 KiB
Markdown

# Pure
> Pretty, minimal and fast ZSH prompt
![screenshot](screenshot.png)
## Overview
Most prompts are cluttered, ugly and slow. I wanted something visually pleasing that stayed out of my 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 using the [fastest](https://gist.github.com/3898739) method available.
- 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 is only displayed when in an SSH session.
- Shows the current path in the title and the [current directory and command](screenshot-title-cmd.png) when a process is running.
- Can easily be used as a starting point for your own custom prompt.
## Getting started
- Clone this repo, add it as a submodule, or just download `pure.zsh`.
- Symlink `pure.zsh` to somewhere in [`$fpath`](http://www.refining-linux.org/archives/46/ZSH-Gem-12-Autoloading-functions/) with the name `prompt_pure_setup`.
Example:
```sh
$ ln -s "$PWD/pure.zsh" /usr/local/share/zsh/site-functions/prompt_pure_setup
```
*Run `echo $fpath` to see possible locations.*
- Initialize the prompt system (if not so already):
```sh
# .zshrc
autoload -U promptinit && promptinit
```
- Choose this prompt:
```sh
# .zshrc
prompt pure
```
## Options
### `PURE_CMD_MAX_EXEC_TIME`
The max execution time of a process before its run time is shown when it exits. Defaults to `5` seconds.
### `PURE_GIT_PULL`
Set `PURE_GIT_PULL=false` to prevent Pure from checking whether the current Git remote has been updated.
## Example
```sh
# .zshrc
autoload -U promptinit && promptinit
# optionally define some options
PURE_CMD_MAX_EXEC_TIME=10
prompt pure
```
## Tip
[Tomorrow Night Eighties](https://github.com/chriskempson/tomorrow-theme) theme with the [Droid Sans Mono](http://www.google.com/webfonts/specimen/Droid+Sans+Mono) font (15pt) is a beautiful combination, as seen in the screenshot above.
## License
MIT © [Sindre Sorhus](http://sindresorhus.com)