README.md

Pure ❯❮❯

Pretty, minimal and fast Fish 🐟 prompt, ported from zsh.

Documentation

✨ Check-out our brand-new documentation for configurations, features and colours as well as contributing guide.

🚀 Install

⚠️ requirements: fish ≥3.x, fisher:

fisher install pure-fish/pure

Features

Fully customizable (colors, symbols and features):

• Excellent prompt character ❯ 🛠:

  • Change ❯ to red when previous command has failed 🛠 ;
  • Start prompt with current working directory 🏴 ;
  • Compact-mode (single-line prompt) 🏴 ;

• Check for new release on start 🏴🐌 ;

• Display username and hostname when in an SSH session 🛠 ;

• Display command duration when longer than 5 seconds 🛠 ;

• Display Python virtualenv when activated 🏴🛠 ;

• Display AWS profile when set 🏴🛠 ;

• Display VI mode and custom symbol for non-insert mode 🏴🛠 ;

• Display kubernetes context and namespace 🏴🛠 ;

• Detect when running in a container (e.g. docker, podman, LXC/LXD) 🏴🛠

• Indicate if a nix develop shell is activated 🏴🛠.

• Show system time 🏴 ;

• Show number of running jobs 🏴 ;

• Prefix when root 🏴🛠 ;

• Display git branch name 🏴🛠 ;

  • Display * when git repository is dirty ;
  • Display ≡ when git 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 ;

• Update terminal title with current folder and command 🛠 ;

• Shorten or truncate current folder component 🏴🛠 ;

• 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.

❤️ 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.

👨‍💻 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 ;
• 🐟 pure-fish/pure Fish implementation (features rich) ;
• 🐍 edouard-lopez/pure.py Python implementation (partial features) ;
• 🐐 edouard-lopez/pure.go Golang implementation (partial features) ;
• ⚙️ xcambar/purs Rust implementation ;
• 🪟 nickcox/pure-pwsh PowerShell implementation.
• 🐚 krashikiworks/pure-prompt-bash Bash implementation.