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](https://github.com/starship/starship/issues/80) β Indicator for jobs in the background (`β¦`).
- [PLANNED #104](https://github.com/starship/starship/issues/104) β Execution time of the last command if it exceeds the set threshold.
## Installation
### Prerequisites
- [Rust](https://rustup.rs/) v1.33 or higher
- A [Powerline font](https://github.com/powerline/fonts) installed and enabled in your terminal (for example, try [Fira Code](https://github.com/tonsky/FiraCode)).
### Getting Started
1. Install the **starship** binary:
```sh
cargo install starship
```
1. Add the init script to your shell's config file:
#### Bash / Zsh
Add the following to the end of `~/.bashrc` or `~/.zshrc`:
```sh
# ~/.bashrc or ~/.zshrc
eval "$(starship init $0)"
```
#### Fish
Add the following to the end of `~/.config/fish/config.fish`:
```sh
# ~/.config/fish/config.fish
eval (starship init fish)
```
## Configuration
For details on how to configure Starship, check out our [documentation](https://starship.rs/config/).
## Contribution
If you are interested in helping contribute to starship, please take a look at our [Contributing Guide](./CONTRIBUTING.md).
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
