Awesome
<!-- markdownlint-disable MD041 --> <div align="center"><img src="https://user-images.githubusercontent.com/1212392/262604075-db5d0ad2-a7ed-4a62-a1cc-ec677cf76351.png" width="61.8%" alt="Pure.fish logo"/><br>
<!-- 0 width spaces on this line -->
</div>Pure โฏโฎโฏ
<div align=center> <a href="https://camo.githubusercontent.com/be014be282ef66e5c5cad19458aa61d7df6865ecbe55bcc882e0d53580f81de9/68747470733a2f2f692e696d6775722e636f6d2f424878556f68522e706e67" target=blank><img width=440 src=https://camo.githubusercontent.com/be014be282ef66e5c5cad19458aa61d7df6865ecbe55bcc882e0d53580f81de9/68747470733a2f2f692e696d6775722e636f6d2f424878556f68522e706e67 alt="Pure with dark colorscheme"></a> <a href="https://camo.githubusercontent.com/5934e8c1d3b5f9218d05d5e1741e23963a7803d6098236d36e586336a6c6a5b7/68747470733a2f2f692e696d6775722e636f6d2f714a646f6e716f2e706e67" target=blank><img width=440 src=https://camo.githubusercontent.com/5934e8c1d3b5f9218d05d5e1741e23963a7803d6098236d36e586336a6c6a5b7/68747470733a2f2f692e696d6775722e636f6d2f714a646f6e716f2e706e67 alt="Pure with light colorscheme"></a> </div>Pretty, minimal and fast Fish ๐ prompt, ported from
zsh
.
Documentation
:sparkles: Check-out our brand-new documentation for configurations, features and colours as well as contributing guide.
:rocket: Install
:warning: requirements: fish โฅ3.x
, fisher:
fisher install pure-fish/pure
Features
Fully customizable (colors, symbols and features):
-
Display
VI
mode and custom symbol for non-insert mode ๐ด๐ ; -
Detect when running in a container (e.g.
docker
,podman
,LXC
/LXD
) ๐ด๐ -
Display
git
branch name ๐ด๐ ;- Display
*
whengit
repository is dirty ; - Display
โก
whengit
repository is stashed ; - Display
โก
when branch is ahead (commits to push) ; - Display
โฃ
when branch is behind (commits to pull) ; - Async update when configured with fish-async-prompt ;
- Display
-
and moreโฆ
๐ด means it's controlled by a feature flag, ๐ mean it's configurable.
Configuration
See How to configure pure prompt?
Features' Flags
See Features and their respective options.
:heart: Contribute
If you have any ideas or suggestions, we encourage you to submit a pull request. Our team will review and discuss your contribution.
Checkout our Contribution Guide to get familiar with our conventions and requirements.
:man_technologist: People
- รdouard Lopez product lead ;
- @andreiborisov for the docker images ;
- @jorgebucaran for fishtape ;
- @rafaelrinaldi for starting the project and publishing the initial releases
MIT License
Ports
- Original sindresorhus/pure Zsh implementation ;
- :fish: pure-fish/pure Fish implementation (features rich) ;
- :snake: edouard-lopez/pure.py Python implementation (partial features) ;
- :goat: edouard-lopez/pure.go Golang implementation (partial features) ;
- :gear: xcambar/purs Rust implementation ;
- :window: nickcox/pure-pwsh PowerShell implementation.
- :shell: krashikiworks/pure-prompt-bash Bash implementation.