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 Hyper and One Dark

## 🍬 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 Ruby 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 - 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 ``` 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/). ## 🤝 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/good%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](./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} 💻 🎨 🤔 🚇 🚧 👀 ⚠️	_{John Letey} 💻 🤔 👀 ⚠️	_{Tim Mulqueen} 💻 🤔 👀 ⚠️	_{Tiffany Le-Nguyen} 🤔 🚧 👀 📖	_Snuggle 🎨 🤔 🚧 👀	_{Ryan Leckey} 👀	_{Youssef Habri} 💻
_{Kevin Song} 🐛 💻 📖 ⚠️	_{Andrew Dassonville} 🐛 💻	_MaT1g3R 💻 📖 ⚠️

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!