Starship is the minimal, blazing fast, and extremely customizable prompt for any shell! The prompt shows information need while you're working, while staying sleek and out of the way.
Features
- Prompt character turns red if the last command exits with non-zero code.
- Current username if not the same as the logged-in user.
- Current Node.js version(
โฌข
). - Current Rust version (
๐ฆ
). - Current Python version (
๐
). - Current Go version (
๐น
). - Package version of package in current directory (
๐ฆ
). - Current battery level and status
- Current Git branch and rich repo status:
=
โ conflicting changesโก
โ ahead of remote branchโฃ
โ behind of remote branchโ
โ diverged changes?
โ untracked changes$
โ stashed changes!
โ modified files+
โ added filesยป
โ renamed filesโ
โ deleted files
- PLANNED #80 โ Indicator for jobs in the background (
โฆ
). - PLANNED #104 โ Execution time of the last command if it exceeds the set threshold.
Installation
Prerequisites
- Rust v1.33 or higher
- A Powerline font installed and enabled in your terminal (for example, try Fira Code).
Getting Started
-
Install the starship binary:
-
Add the init script to your shell's config file:
Bash / Zsh
Add the following to the end of
~/.bashrc
or~/.zshrc
:# ~/.bashrc or ~/.zshrc
Fish
Add the following to the end of
~/.config/fish/config.fish
:# ~/.config/fish/config.fish )
Configuration
For details on how to configure Starship, check out our documentation.
Contribution
If you are interested in helping contribute to starship, please take a look at our Contributing Guide.
Thanks goes to these wonderful people (emoji key):
This project follows the all-contributors specification. Contributions of any kind welcome!
License
Copyright ยฉ 2019-present, Matan Kushner