Skip to content

O
oh-my-fish
Commit 6f35c1b5 authored by Édouard Lopez's avatar Édouard Lopez Committed by Derek W. Stavis
Browse files
Options

update `pure` description to reflect `2.x` (#694)

parent b328fa36
Hide whitespace changes
Inline Side-by-side
Showing with 115 additions and 47 deletions
docs/Themes.md
View file @ 6f35c1b5
...@@ -2089,83 +2089,151 @@ fisher i plain ...@@ -2089,83 +2089,151 @@ fisher i plain
[THEMES-NAMESPACE-plain-Fisherman]: https://github.com/fisherman/fisherman [THEMES-NAMESPACE-plain-Fisherman]: https://github.com/fisherman/fisherman
# pure # [pure][pure] [![travis-badge]][travis-link] ![fish-2.5] ![fish-2.6] ![fish-2.7.1] ![fish-3.0.0]
### pure [![Fish Shell Version](https://img.shields.io/badge/fish-v2.2.0-007EC7.svg?style=flat-square)](http://fishshell.com)
> Port of the [`pure`](https://github.com/sindresorhus/pure) ZSH theme to Fish > Pretty, minimal and fast Fish 🐟 prompt, ported from [`zsh`](https://github.com/sindresorhus/pure).
<p align="center"> <div align=center>
<img width="572" src="screenshot.png"> <a href="screenshot-dark.png" target=blank><img width=440 src=https://i.imgur.com/BHxUohR.png alt="Pure with dark colorscheme"></a>
</p> <a href="screenshot-light.png" target=blank><img width=440 src=https://i.imgur.com/qJdonqo.png alt="Pure with light colorscheme"></a>
</div>
#### Install ## Install
##### Manually **:warning: requirements**: fish `≥2.5`.
### Manually
Via [cURL](https://curl.haxx.se): Via [cURL](https://curl.haxx.se):
```sh ```sh
$ # Download the installer to `/tmp` # Download the installer to `/tmp`
$ curl -Ls https://raw.github.com/rafaelrinaldi/pure/master/installer.fish > /tmp/pure_installer.fish curl git.io/pure-fish --output /tmp/pure_installer.fish --location --silent
$ # Source and trigger the installer # Source and trigger the installer
$ source /tmp/pure_installer.fish; and install_pure source /tmp/pure_installer.fish; and install_pure
``` ```
##### [Fisherman](http://fisherman.sh) ### [Fisher](https://github.com/jorgebucaran/fisher)
```fish ```fish
$ fisher rafaelrinaldi/pure fisher add rafaelrinaldi/pure
``` ```
##### [Oh My Fish!](https://github.com/oh-my-fish) ### [Oh My Fish!](https://github.com/oh-my-fish)
```fish ```fish
$ omf install pure omf install pure
ln -s $OMF_PATH/themes/pure/conf.d/pure.fish ~/.config/fish/conf.d/pure.fish
``` ```
:information_source: [why the symlink?](https://github.com/rafaelrinaldi/pure/wiki/Oh-My-Fish-not-currently-supporting-conf.d-snippets-in-plugins-and-themes)
### [Fundle](https://github.com/tuvistavie/fundle)
```fish
fundle plugin rafaelrinaldi/pure;
fundle install;
```
## Features
- Fully **customizable** ;
- Excellent prompt character `❯` ;
- Display current directory tail ;
- Display `git` branch name ;
- Display `*` when `git` repository is _dirty_ ;
- Display `⇡` when branch is _ahead_ (commits to push) ;
- Display `⇣` when branch is _behind_ (commits to pull) ;
- Change `❯` to red when previous command has failed ;
- Update terminal title with _current folder_ and _command_ ;
- Display _username_ and _hostname_ when in an `SSH` session ;
- Display _duration_ when command run more that `5` seconds ;
- Display `Python` _virtualenv_ when activated ;
- Fine control over **colors** ;
- Right prompt control.
- Display `VI` mode and custom symbol for non-insert mode.
## Configuration
You can tweak pretty much everything in `pure` by overriding variables in your `config.fish` file.
#### Prompt Symbol
| Option | Default | Description |
| :------------------------------------- | :------ | :--------------------------------------------------- |
| **`pure_symbol_prompt`** | `❯` | Prompt symbol. |
| **`pure_symbol_reverse_prompt`** | `❮` | VI non-insert mode symbol.
| **`pure_right_prompt`** | ` ` | Content of the right prompt. |
| **`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_symbol_git_dirty`** | `*` | Repository is Dirty (uncommitted/untracked changes). |
| **`pure_symbol_title_bar_separator`** | `—` |
:information_source:: Need [safer `git` symbols](https://github.com/sindresorhus/pure/wiki#safer-symbols)?
#### Features #### Features
* Display current directory tail | Option | Default | Description |
* Display Git branch name | :------------------------------------ | :------ | :---------------------------------------------------------------- |
* Display whether or not the working copy is dirty | **`pure_threshold_command_duration`** | `5` | Show command duration when above this value (seconds). |
* Display an up arrow if there are stuff to be pushed | **`pure_separate_prompt_on_error`** | `false` | Show last command [exit code as a separate character][exit-code]. |
* Display an down arrow if there are stuff to be pulled | **`pure_begin_prompt_with_current_directory`** | `true` | `true`: _`pwd` `git`, `SSH`, duration_.<br/>`false`: _`SSH` `pwd` `git`, duration_. |
* Display prompt symbol in red if previous command has failed | **`pure_reverse_prompt_symbol_in_vimode`** | `true` | `true`: `❮` indicate a non-insert mode.<br/>`false`: indicate vi mode with `[I]`, `[N]`, `[V]`.
* Display the current folder and command when a process is running
* Display username and host when in an SSH session
* Display duration of failed commands (if timeout is greather than default threshold)
#### Configuration #### Colors
``` | Option | Default |
### Change the prompt text | :----------------------- | :-------------------- |
set pure_symbol_prompt "~>" | **Base Colors** |
set pure_symbol_git_down_arrow "v" | **`pure_color_primary`** | `(set_color blue)` |
set pure_symbol_git_down_arrow "^" | **`pure_color_info`** | `(set_color cyan)` |
set pure_symbol_git_dirty "!" | **`pure_color_mute`** | `(set_color brblack)` |
set pure_symbol_horizontal_bar "_" | **`pure_color_success`** | `(set_color magenta)` |
| **`pure_color_normal`** | `(set_color normal)` |
### Change the colors | **`pure_color_danger`** | `(set_color red)` |
set pure_color_blue (set_color "1e00fd") | **`pure_color_light`** | `(set_color white)` |
set pure_color_cyan (set_color "1e95fd") | **`pure_color_warning`** | `(set_color yellow)` |
set pure_color_gray (set_color "6c6c6c") | **`pure_color_dark`** | `(set_color black)` |
set pure_color_green (set_color "66ff66")
set pure_color_normal (set_color "000000") :information_source:: Want more customization? See `$HOME/.config/fish/conf.d/pure.fish` for available variables.
set pure_color_red (set_color "f820ff")
set pure_color_yellow (set_color "1bc8c8")
``` ## Tests
**requirements:** [`fishtape`](https://github.com/fisherman/fishtape).
fishtape tests/*.test.fish
#### Maintainers ## Maintainers
* [Rafael Rinaldi](https://github.com/rafaelrinaldi) - [Rafael Rinaldi](https://github.com/rafaelrinaldi)
* [Édouard Lopez](https://github.com/edouard-lopez) - [Édouard Lopez](https://github.com/edouard-lopez)
Kudos to all our awesome [:yellow_heart: contributors :yellow_heart:](../..//graphs/contributors) Kudos to all our awesome [:yellow_heart: contributors :yellow_heart:](../..//graphs/contributors)
#### License ## License
MIT © [Rafael Rinaldi](http://rinaldi.io) MIT © [Rafael Rinaldi](http://rinaldi.io)
---
<p align="center">
<a href="https://buymeacoff.ee/rinaldi" title="Buy me a coffee">Buy me a ☕</a>
</p>
[pure]: https://github.com/rafaelrinaldi/pure
[travis-link]: https://travis-ci.org/rafaelrinaldi/pure "TravisCI"
[travis-badge]: https://travis-ci.org/rafaelrinaldi/pure.svg?branch=master
[fish-2.5]: https://img.shields.io/badge/fish-v2.5.0-007EC7.svg?style=flat-square "Support Fish 2.5"
[fish-2.6]: https://img.shields.io/badge/fish-v2.6.0-007EC7.svg?style=flat-square "Support Fish 2.6"
[fish-2.7.1]: https://img.shields.io/badge/fish-v2.7.1-007EC7.svg?style=flat-square "Support Fish 2.7.1"
[fish-3.0.0]: https://img.shields.io/badge/fish-v3.0.0-007EC7.svg?style=flat-square "Support Fish 3.0.0"
[changelog-2.5]: https://github.com/fish-shell/fish-shell/releases/tag/2.5.0 "Changelog Fish 2.5"
[changelog-2.6]: https://github.com/fish-shell/fish-shell/releases/tag/2.6.0 "Changelog Fish 2.6"
[changelog-2.7.1]: https://github.com/fish-shell/fish-shell/releases/tag/2.7.1 "Changelog Fish 2.7.1"
[changelog-3.0.0]: https://github.com/fish-shell/fish-shell/releases/tag/3.0.0 "Changelog Fish 3.0.0"
[exit-code]: https://github.com/sindresorhus/pure/wiki#show-exit-code-of-last-command-as-a-separate-prompt-character "See pure-zsh wiki"
# red-snapper # red-snapper
### RED SNAPPER ### RED SNAPPER
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment