Starship – Cross-shell prompt

Crates.io version Azure Pipelines Build Status Packaging status
All Contributors Chat on Discord


Website Β· Installation Β· Configuration

Starship is the minimal, blazing fast, and extremely customizable prompt for any shell!
The prompt shows information you need while you're working, while staying sleek and out of the way.


Starship with iTerm2 and the Snazzy theme

## 🍬 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 Java version(`β˜•`) - Current Node.js version(`β¬’`) - Current Rust version (`πŸ¦€`) - Current Ruby version (`πŸ’Ž`) - Current Python version (`🐍`) - Current Go version (`🐹`) - Nix-shell environment detection - Current version of package in current directory (`πŸ“¦`) - npm (Node.js) - cargo (Rust) - poetry (Python) - 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 - Execution time of the last command if it exceeds the set threshold - Indicator for jobs in the background (`✦`) ## πŸš€ Installation ### Prerequisites - 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: **[Download archives of precompiled binaries](https://github.com/starship/starship/releases)** if you don't use the platforms below. #### Homebrew ```sh $ brew install starship ``` #### Rust (v1.33 or higher) ```sh $ cargo install starship ``` #### Arch Linux (AUR) Starship is available on the AUR under the name `starship`. Install it with `yay` or your favorite AUR helper. ```sh $ yay -S starship ``` #### Nix (unstable) ```sh $ nix-env --install starship ``` #### Termux ```sh $ pkg install starship ``` 1. Add the init script to your shell's config file: #### Bash Add the following to the end of `~/.bashrc`: ```sh # ~/.bashrc eval "$(starship init bash)" ``` #### Fish Add the following to the end of `~/.config/fish/config.fish`: ```sh # ~/.config/fish/config.fish eval (starship init fish) ``` #### Zsh Add the following to the end of `~/.zshrc`: ```sh # ~/.zshrc eval "$(starship init zsh)" ``` ## πŸ”§ Configuration For details on how to configure Starship, check out our [documentation](https://starship.rs/config/). ## 🀝 Contributing We are always looking for contributors of **all skill levels**! If you're looking to ease your way into the project, try out a [good first issue](https://github.com/starship/starship/labels/🌱%20good%20first%20issue). ### High Priority Needs - πŸ‘©β€πŸ’Ό **Product Manager** - We have a GitHub Project and many unorganized/unprioritized features, as well as ideas that haven't yet been made into issues. Starship needs someone to own the product direction! - πŸ‘©β€πŸŽ¨ **Designer** - Like making eye-catching websites? Excellent! We are looking to create a beautiful landing page showing off Starship in all its glory. Helping design for Starship's brand is a great opportunity to try out new ideas! - πŸ‘©β€πŸ’» **Rust Developer** - There is _a lot_ of low-hanging fruit when it comes to writing idiomatic Rust, designing effective Rust architecture, performance optimizations, cross-platform build optimizations, and more! I ([@matchai](https://github.com/matchai)) am a beginner to Rust. Come point us in the right direction! If you are interested in helping contribute to starship, please take a look at our [Contributing Guide](https://github.com/starship/starship/blob/master/CONTRIBUTING.md). Also, feel free to drop into our [Discord server](https://discord.gg/8Jzqu3T) and say hi. πŸ‘‹ ### Contributors Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
Matan Kushner
Matan Kushner

πŸ’» 🎨 πŸ€” πŸš‡ 🚧 πŸ‘€ ⚠️
John Letey
John Letey

πŸ’» πŸ€” πŸ‘€ ⚠️
Tim Mulqueen
Tim Mulqueen

πŸ’» πŸ€” πŸ‘€ ⚠️
Tiffany Le-Nguyen
Tiffany Le-Nguyen

πŸ€” 🚧 πŸ‘€ πŸ“–
​Snuggle
​Snuggle

🎨 πŸ€” 🚧 πŸ‘€
Ryan Leckey
Ryan Leckey

πŸ‘€
Youssef Habri
Youssef Habri

πŸ’»
Kevin Song
Kevin Song

πŸ› πŸ’» πŸ“– ⚠️
Andrew Dassonville
Andrew Dassonville

πŸ› πŸ’»
MaT1g3R
MaT1g3R

πŸ’» πŸ“– ⚠️
AndrΓ© Zanellato
AndrΓ© Zanellato

πŸ’» πŸ“– ⚠️
Saghm Rossi
Saghm Rossi

πŸ’» πŸ“– ⚠️
Shu Kutsuzawa
Shu Kutsuzawa

πŸ’» πŸ“– ⚠️ 🌍
Saurav Sharma
Saurav Sharma

πŸ’» πŸ“–
Thomas O'Donnell
Thomas O'Donnell

πŸ’» ⚠️
Bruno Bigras
Bruno Bigras

πŸ’» πŸ‘€
Neil Kistner
Neil Kistner

πŸ’» ⚠️ πŸ‘€
Quinn Strahl
Quinn Strahl

πŸ’» ⚠️
Titouan Vervack
Titouan Vervack

πŸ’» ⚠️
Francisco Lopes
Francisco Lopes

πŸ’»
Andrew Houts
Andrew Houts

πŸ’» πŸ“– ⚠️
Nick Young
Nick Young

πŸ’» πŸ“– ⚠️ πŸ‘€
Gabriel de Perthuis
Gabriel de Perthuis

πŸ’»
Hofer-Julian
Hofer-Julian

πŸ“–
Yuji Ueki
Yuji Ueki

πŸ–‹ 🌍
θ°’η₯―ζ™–
θ°’η₯―ζ™–

πŸ’» πŸ“– 🌍 πŸ‘€
Kutsuzawa Ryo
Kutsuzawa Ryo

πŸ‘€ πŸ’» ⚠️ 🌍
hdevalke
hdevalke

πŸ€”
Kuba Clark
Kuba Clark

πŸ’» πŸ“– ⚠️
Gimbar
Gimbar

πŸ’» ⚠️ πŸ“–
Tom Hotston
Tom Hotston

πŸ’» πŸ“–
Bijan Chokoufe Nejad
Bijan Chokoufe Nejad

πŸ’» ⚠️
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome! ## πŸ’­ Inspired By Please check out these previous works that helped inspire the creation of starship. πŸ™ - **[denysdovhan/spaceship-prompt](https://github.com/denysdovhan/spaceship-prompt)** - A ZSH prompt for astronauts. - **[denysdovhan/robbyrussell-node](https://github.com/denysdovhan/robbyrussell-node)** - Cross-shell robbyrussell theme written in JavaScript. - **[reujab/silver](https://github.com/reujab/silver)** - A cross-shell customizable powerline-like prompt with icons.


Starship rocket icon

## πŸ“ License Copyright Β© 2019-present, [Starship Contributors](https://github.com/starship/starship/graphs/contributors).
This project is [ISC](https://github.com/starship/starship/blob/master/LICENSE) licensed.