mirror of
https://github.com/oh-my-fish/oh-my-fish.git
synced 2025-03-10 05:25:14 +08:00
update pure description to reflect 2.x (#694)
This commit is contained in:
Édouard Lopez
Derek W. Stavis
parent
b328fa3663
commit
6f35c1b5eb
160
docs/Themes.md
160
docs/Themes.md
@ -2089,83 +2089,151 @@ fisher i plain
|
||||
[THEMES-NAMESPACE-plain-Fisherman]: https://github.com/fisherman/fisherman
|
||||
|
||||
|
||||
# pure
|
||||
### pure [](http://fishshell.com)
|
||||
# [pure][pure] [![travis-badge]][travis-link] ![fish-2.5] ![fish-2.6] ![fish-2.7.1] ![fish-3.0.0]
|
||||
|
||||
> 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">
|
||||
<img width="572" src="screenshot.png">
|
||||
</p>
|
||||
<div align=center>
|
||||
<a href="screenshot-dark.png" target=blank><img width=440 src=https://i.imgur.com/BHxUohR.png alt="Pure with dark colorscheme"></a>
|
||||
<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):
|
||||
|
||||
```sh
|
||||
$ # Download the installer to `/tmp`
|
||||
$ curl -Ls https://raw.github.com/rafaelrinaldi/pure/master/installer.fish > /tmp/pure_installer.fish
|
||||
$ # Source and trigger the installer
|
||||
$ source /tmp/pure_installer.fish; and install_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
|
||||
```
|
||||
|
||||
##### [Fisherman](http://fisherman.sh)
|
||||
### [Fisher](https://github.com/jorgebucaran/fisher)
|
||||
|
||||
```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
|
||||
$ 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
|
||||
|
||||
* Display current directory tail
|
||||
* Display Git branch name
|
||||
* Display whether or not the working copy is dirty
|
||||
* Display an up arrow if there are stuff to be pushed
|
||||
* Display an down arrow if there are stuff to be pulled
|
||||
* Display prompt symbol in red if previous command has failed
|
||||
* 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)
|
||||
| Option | Default | Description |
|
||||
| :------------------------------------ | :------ | :---------------------------------------------------------------- |
|
||||
| **`pure_threshold_command_duration`** | `5` | Show command duration when above this value (seconds). |
|
||||
| **`pure_separate_prompt_on_error`** | `false` | Show last command [exit code as a separate character][exit-code]. |
|
||||
| **`pure_begin_prompt_with_current_directory`** | `true` | `true`: _`pwd` `git`, `SSH`, duration_.<br/>`false`: _`SSH` `pwd` `git`, duration_. |
|
||||
| **`pure_reverse_prompt_symbol_in_vimode`** | `true` | `true`: `❮` indicate a non-insert mode.<br/>`false`: indicate vi mode with `[I]`, `[N]`, `[V]`.
|
||||
|
||||
#### Configuration
|
||||
#### Colors
|
||||
|
||||
```
|
||||
### Change the prompt text
|
||||
set pure_symbol_prompt "~>"
|
||||
set pure_symbol_git_down_arrow "v"
|
||||
set pure_symbol_git_down_arrow "^"
|
||||
set pure_symbol_git_dirty "!"
|
||||
set pure_symbol_horizontal_bar "_"
|
||||
| Option | Default |
|
||||
| :----------------------- | :-------------------- |
|
||||
| **Base Colors** |
|
||||
| **`pure_color_primary`** | `(set_color blue)` |
|
||||
| **`pure_color_info`** | `(set_color cyan)` |
|
||||
| **`pure_color_mute`** | `(set_color brblack)` |
|
||||
| **`pure_color_success`** | `(set_color magenta)` |
|
||||
| **`pure_color_normal`** | `(set_color normal)` |
|
||||
| **`pure_color_danger`** | `(set_color red)` |
|
||||
| **`pure_color_light`** | `(set_color white)` |
|
||||
| **`pure_color_warning`** | `(set_color yellow)` |
|
||||
| **`pure_color_dark`** | `(set_color black)` |
|
||||
|
||||
### Change the colors
|
||||
set pure_color_blue (set_color "1e00fd")
|
||||
set pure_color_cyan (set_color "1e95fd")
|
||||
set pure_color_gray (set_color "6c6c6c")
|
||||
set pure_color_green (set_color "66ff66")
|
||||
set pure_color_normal (set_color "000000")
|
||||
set pure_color_red (set_color "f820ff")
|
||||
set pure_color_yellow (set_color "1bc8c8")
|
||||
```
|
||||
:information_source:: Want more customization? See `$HOME/.config/fish/conf.d/pure.fish` for available variables.
|
||||
|
||||
#### Maintainers
|
||||
|
||||
* [Rafael Rinaldi](https://github.com/rafaelrinaldi)
|
||||
* [Édouard Lopez](https://github.com/edouard-lopez)
|
||||
## Tests
|
||||
|
||||
**requirements:** [`fishtape`](https://github.com/fisherman/fishtape).
|
||||
|
||||
fishtape tests/*.test.fish
|
||||
|
||||
## Maintainers
|
||||
|
||||
- [Rafael Rinaldi](https://github.com/rafaelrinaldi)
|
||||
- [Édouard Lopez](https://github.com/edouard-lopez)
|
||||
|
||||
Kudos to all our awesome [:yellow_heart: contributors :yellow_heart:](../..//graphs/contributors)
|
||||
|
||||
#### License
|
||||
## License
|
||||
|
||||
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
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user