2019-07-24 16:34:37 +00:00
< p align = "center" >
2019-08-14 02:38:17 +00:00
< br / >
< img
width="400"
src="https://raw.githubusercontent.com/starship/starship/master/media/logo.png"
alt="Starship –
/>
< / p >
< p align = "center" >
< a href = "https://crates.io/crates/starship" >
< img src = "https://badgen.net/crates/v/starship" alt = "Crates.io version" / >
< / a >
< a href = "https://dev.azure.com/starship-control/starship/_build" >
< img
src="https://badgen.net/azure-pipelines/starship-control/starship/Starship%20Test%20Suite"
alt="Azure Pipelines Build Status"
/>
< / a >
2019-09-04 23:22:28 +00:00
< a href = "https://repology.org/project/starship/versions" >
< img src = "https://repology.org/badge/tiny-repos/starship.svg" alt = "Packaging status" >
< / a > < br >
2019-08-14 02:38:17 +00:00
< a href = "#contributors" >
< img
2019-09-04 23:22:28 +00:00
src="https://badgen.net/badge/all%20contributors/20/orange"
2019-08-14 02:38:17 +00:00
alt="All Contributors"
/>
< / a >
< a href = "https://discord.gg/8Jzqu3T" >
< img
src="https://badgen.net/badge/chat/on%20discord/7289da"
alt="Chat on Discord"
/>
< / a >
2019-07-24 16:34:37 +00:00
< / p >
2019-07-20 01:39:35 +00:00
< h4 align = "center" >
2019-08-14 02:38:17 +00:00
< br / >
< a href = "https://starship.rs" > Website< / a >
·
< a href = "#-installation" > Installation< / a >
·
< a href = "https://starship.rs/config/" > Configuration< / a >
2019-07-20 01:39:35 +00:00
< / h4 >
2019-04-13 04:45:33 +00:00
2019-07-24 16:34:37 +00:00
< h1 > < / h1 >
2019-08-23 00:03:45 +00:00
< p align = "center" >
2019-07-24 16:34:37 +00:00
Starship is the minimal, blazing fast, and extremely customizable prompt for any shell!< br >
2019-08-12 17:42:33 +00:00
The prompt shows information you need while you're working, while staying sleek and out of the way.
2019-08-23 00:03:45 +00:00
< p >
2019-04-13 04:45:33 +00:00
2019-07-15 16:01:37 +00:00
< p align = "center" >
2019-08-23 00:03:45 +00:00
< br >
< img alt = "Starship with iTerm2 and the Snazzy theme" src = "https://raw.githubusercontent.com/starship/starship/master/media/demo.gif" width = "80%" >
< br >
< br >
2019-07-15 16:01:37 +00:00
< / p >
2019-04-13 04:45:33 +00:00
2019-07-24 16:34:37 +00:00
## 🍬 Features
2019-07-20 01:39:35 +00:00
2019-08-14 02:38:17 +00:00
- 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 (`🦀`)
2019-08-19 19:50:36 +00:00
- Current Ruby version (`💎`)
2019-08-14 02:38:17 +00:00
- Current Python version (`🐍`)
- Current Go version (`🐹`)
2019-08-25 15:41:20 +00:00
- Nix-shell environment detection
2019-08-17 20:38:20 +00:00
- Current version of package in current directory (`📦`)
- npm (Node.js)
- cargo (Rust)
- poetry (Python)
2019-08-14 02:38:17 +00:00
- Current battery level and status
2019-07-20 01:39:35 +00:00
- 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
2019-08-14 02:38:17 +00:00
- Execution time of the last command if it exceeds the set threshold
- Indicator for jobs in the background (`✦`)
2019-07-20 01:39:35 +00:00
2019-07-24 16:34:37 +00:00
## 🚀 Installation
2019-04-13 04:33:50 +00:00
### Prerequisites
2019-08-10 23:22:28 +00:00
- A [Powerline font ](https://github.com/powerline/fonts ) installed and enabled in your terminal (for example, try [Fira Code ](https://github.com/tonsky/FiraCode )).
2019-04-13 04:33:50 +00:00
### Getting Started
1. Install the **starship** binary:
2019-08-10 23:22:28 +00:00
** [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)
2019-08-14 02:38:17 +00:00
2019-07-20 01:39:35 +00:00
```sh
2019-08-10 23:22:28 +00:00
$ cargo install starship
2019-07-20 01:39:35 +00:00
```
2019-04-13 04:33:50 +00:00
2019-08-19 15:10:25 +00:00
#### Arch Linux (AUR)
Starship is available on the AUR under the name `starship` . Install it with `yay` or your favorite AUR helper.
2019-08-19 19:50:36 +00:00
```sh
2019-08-19 15:10:25 +00:00
$ yay -S starship
```
2019-08-20 04:50:35 +00:00
#### Nix (unstable)
```sh
$ nix-env --install starship
```
2019-08-27 23:32:26 +00:00
#### Termux
```sh
$ pkg install starship
```
2019-07-03 12:03:02 +00:00
1. Add the init script to your shell's config file:
2019-04-17 15:38:36 +00:00
2019-08-17 20:38:20 +00:00
#### Bash
2019-07-20 01:39:35 +00:00
2019-08-17 20:38:20 +00:00
Add the following to the end of `~/.bashrc` :
2019-04-17 15:38:36 +00:00
2019-08-17 20:38:20 +00:00
```sh
# ~/.bashrc
2019-04-13 04:33:50 +00:00
2019-08-17 20:38:20 +00:00
eval "$(starship init bash)"
```
2019-04-17 15:38:36 +00:00
2019-08-17 20:38:20 +00:00
#### Fish
2019-04-17 15:38:36 +00:00
2019-08-17 20:38:20 +00:00
Add the following to the end of `~/.config/fish/config.fish` :
2019-04-17 15:38:36 +00:00
2019-08-17 20:38:20 +00:00
```sh
# ~/.config/fish/config.fish
2019-04-17 15:38:36 +00:00
2019-08-17 20:38:20 +00:00
eval (starship init fish)
```
2019-08-14 02:38:17 +00:00
2019-08-17 20:38:20 +00:00
#### Zsh
2019-08-14 02:38:17 +00:00
2019-08-17 20:38:20 +00:00
Add the following to the end of `~/.zshrc` :
2019-08-14 02:38:17 +00:00
2019-08-17 20:38:20 +00:00
```sh
# ~/.zshrc
2019-08-14 02:38:17 +00:00
2019-08-17 20:38:20 +00:00
eval "$(starship init zsh)"
```
2019-05-14 04:43:11 +00:00
2019-07-24 16:34:37 +00:00
## 🔧 Configuration
2019-07-10 17:09:45 +00:00
2019-07-20 01:39:35 +00:00
For details on how to configure Starship, check out our [documentation ](https://starship.rs/config/ ).
2019-07-10 17:09:45 +00:00
2019-07-24 16:34:37 +00:00
## 🤝 Contributing
2019-07-20 01:39:35 +00:00
2019-08-20 13:51:00 +00:00
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 ).
2019-05-16 16:46:07 +00:00
2019-07-24 16:34:37 +00:00
### 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**
2019-08-10 23:22:28 +00:00
- 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!
2019-07-24 16:34:37 +00:00
2019-08-22 14:35:15 +00:00
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. 👋
2019-07-24 16:34:37 +00:00
### Contributors
2019-08-10 23:22:28 +00:00
2019-05-16 16:46:07 +00:00
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
<!-- ALL - CONTRIBUTORS - LIST:START - Do not remove or modify this section -->
<!-- prettier - ignore -->
2019-07-19 20:21:53 +00:00
< table >
< tr >
< td align = "center" > < a href = "https://twitter.com/matchai" > < img src = "https://avatars0.githubusercontent.com/u/4658208?v=4" width = "100px;" alt = "Matan Kushner" / > < br / > < sub > < b > Matan Kushner< / b > < / sub > < / a > < br / > < a href = "https://github.com/starship/starship/commits?author=matchai" title = "Code" > 💻< / a > < a href = "#design-matchai" title = "Design" > 🎨< / a > < a href = "#ideas-matchai" title = "Ideas, Planning, & Feedback" > 🤔< / a > < a href = "#infra-matchai" title = "Infrastructure (Hosting, Build-Tools, etc)" > 🚇< / a > < a href = "#maintenance-matchai" title = "Maintenance" > 🚧< / a > < a href = "#review-matchai" title = "Reviewed Pull Requests" > 👀< / a > < a href = "https://github.com/starship/starship/commits?author=matchai" title = "Tests" > ⚠️< / a > < / td >
< td align = "center" > < a href = "https://github.com/johnletey" > < img src = "https://avatars0.githubusercontent.com/u/30328854?v=4" width = "100px;" alt = "John Letey" / > < br / > < sub > < b > John Letey< / b > < / sub > < / a > < br / > < a href = "https://github.com/starship/starship/commits?author=johnletey" title = "Code" > 💻< / a > < a href = "#ideas-johnletey" title = "Ideas, Planning, & Feedback" > 🤔< / a > < a href = "#review-johnletey" title = "Reviewed Pull Requests" > 👀< / a > < a href = "https://github.com/starship/starship/commits?author=johnletey" title = "Tests" > ⚠️< / a > < / td >
< td align = "center" > < a href = "http://timmulqueen.com" > < img src = "https://avatars1.githubusercontent.com/u/6132021?v=4" width = "100px;" alt = "Tim Mulqueen" / > < br / > < sub > < b > Tim Mulqueen< / b > < / sub > < / a > < br / > < a href = "https://github.com/starship/starship/commits?author=Multimo" title = "Code" > 💻< / a > < a href = "#ideas-Multimo" title = "Ideas, Planning, & Feedback" > 🤔< / a > < a href = "#review-Multimo" title = "Reviewed Pull Requests" > 👀< / a > < a href = "https://github.com/starship/starship/commits?author=Multimo" title = "Tests" > ⚠️< / a > < / td >
< td align = "center" > < a href = "https://github.com/sirMerr" > < img src = "https://avatars2.githubusercontent.com/u/11183523?v=4" width = "100px;" alt = "Tiffany Le-Nguyen" / > < br / > < sub > < b > Tiffany Le-Nguyen< / b > < / sub > < / a > < br / > < a href = "#ideas-sirMerr" title = "Ideas, Planning, & Feedback" > 🤔< / a > < a href = "#maintenance-sirMerr" title = "Maintenance" > 🚧< / a > < a href = "#review-sirMerr" title = "Reviewed Pull Requests" > 👀< / a > < a href = "https://github.com/starship/starship/commits?author=sirMerr" title = "Documentation" > 📖< / a > < / td >
< td align = "center" > < a href = "https://about.snuggi.es" > < img src = "https://avatars0.githubusercontent.com/u/26250962?v=4" width = "100px;" alt = " / > < br / > < sub > < b > < / b > < / sub > < / a > < br / > < a href = "#design-Snuggle" title = "Design" > 🎨< / a > < a href = "#ideas-Snuggle" title = "Ideas, Planning, & Feedback" > 🤔< / a > < a href = "#maintenance-Snuggle" title = "Maintenance" > 🚧< / a > < a href = "#review-Snuggle" title = "Reviewed Pull Requests" > 👀< / a > < / td >
< td align = "center" > < a href = "https://github.com/mehcode" > < img src = "https://avatars1.githubusercontent.com/u/753919?v=4" width = "100px;" alt = "Ryan Leckey" / > < br / > < sub > < b > Ryan Leckey< / b > < / sub > < / a > < br / > < a href = "#review-mehcode" title = "Reviewed Pull Requests" > 👀< / a > < / td >
< td align = "center" > < a href = "https://github.com/youssefhabri" > < img src = "https://avatars3.githubusercontent.com/u/1578005?v=4" width = "100px;" alt = "Youssef Habri" / > < br / > < sub > < b > Youssef Habri< / b > < / sub > < / a > < br / > < a href = "https://github.com/starship/starship/commits?author=youssefhabri" title = "Code" > 💻< / a > < / td >
< / tr >
2019-07-20 17:47:07 +00:00
< tr >
2019-08-08 17:39:14 +00:00
< td align = "center" > < a href = "https://github.com/chipbuster" > < img src = "https://avatars2.githubusercontent.com/u/4605384?v=4" width = "100px;" alt = "Kevin Song" / > < br / > < sub > < b > Kevin Song< / b > < / sub > < / a > < br / > < a href = "https://github.com/starship/starship/issues?q=author%3Achipbuster" title = "Bug reports" > 🐛< / a > < a href = "https://github.com/starship/starship/commits?author=chipbuster" title = "Code" > 💻< / a > < a href = "https://github.com/starship/starship/commits?author=chipbuster" title = "Documentation" > 📖< / a > < a href = "https://github.com/starship/starship/commits?author=chipbuster" title = "Tests" > ⚠️< / a > < / td >
2019-07-29 00:28:32 +00:00
< td align = "center" > < a href = "https://andrewda.me" > < img src = "https://avatars1.githubusercontent.com/u/10191084?v=4" width = "100px;" alt = "Andrew Dassonville" / > < br / > < sub > < b > Andrew Dassonville< / b > < / sub > < / a > < br / > < a href = "https://github.com/starship/starship/issues?q=author%3Aandrewda" title = "Bug reports" > 🐛< / a > < a href = "https://github.com/starship/starship/commits?author=andrewda" title = "Code" > 💻< / a > < / td >
2019-08-12 15:59:41 +00:00
< td align = "center" > < a href = "https://github.com/MaT1g3R" > < img src = "https://avatars1.githubusercontent.com/u/15258494?v=4" width = "100px;" alt = "MaT1g3R" / > < br / > < sub > < b > MaT1g3R< / b > < / sub > < / a > < br / > < a href = "https://github.com/starship/starship/commits?author=MaT1g3R" title = "Code" > 💻< / a > < a href = "https://github.com/starship/starship/commits?author=MaT1g3R" title = "Documentation" > 📖< / a > < a href = "https://github.com/starship/starship/commits?author=MaT1g3R" title = "Tests" > ⚠️< / a > < / td >
2019-08-14 14:50:11 +00:00
< td align = "center" > < a href = "https://github.com/AZanellato" > < img src = "https://avatars3.githubusercontent.com/u/30451287?v=4" width = "100px;" alt = "André Zanellato" / > < br / > < sub > < b > André Zanellato< / b > < / sub > < / a > < br / > < a href = "https://github.com/starship/starship/commits?author=AZanellato" title = "Code" > 💻< / a > < a href = "https://github.com/starship/starship/commits?author=AZanellato" title = "Documentation" > 📖< / a > < a href = "https://github.com/starship/starship/commits?author=AZanellato" title = "Tests" > ⚠️< / a > < / td >
2019-08-17 04:16:22 +00:00
< td align = "center" > < a href = "https://saghm.com" > < img src = "https://avatars2.githubusercontent.com/u/5875560?v=4" width = "100px;" alt = "Saghm Rossi" / > < br / > < sub > < b > Saghm Rossi< / b > < / sub > < / a > < br / > < a href = "https://github.com/starship/starship/commits?author=saghm" title = "Code" > 💻< / a > < a href = "https://github.com/starship/starship/commits?author=saghm" title = "Documentation" > 📖< / a > < a href = "https://github.com/starship/starship/commits?author=saghm" title = "Tests" > ⚠️< / a > < / td >
2019-08-17 20:03:26 +00:00
< td align = "center" > < a href = "https://medium.com/@cappyzawa" > < img src = "https://avatars3.githubusercontent.com/u/12455284?v=4" width = "100px;" alt = "Shu Kutsuzawa" / > < br / > < sub > < b > Shu Kutsuzawa< / b > < / sub > < / a > < br / > < a href = "https://github.com/starship/starship/commits?author=cappyzawa" title = "Code" > 💻< / a > < a href = "https://github.com/starship/starship/commits?author=cappyzawa" title = "Documentation" > 📖< / a > < a href = "https://github.com/starship/starship/commits?author=cappyzawa" title = "Tests" > ⚠️< / a > < / td >
2019-08-19 05:02:39 +00:00
< td align = "center" > < a href = "https://github.com/iamsauravsharma" > < img src = "https://avatars0.githubusercontent.com/u/38726015?v=4" width = "100px;" alt = "Saurav Sharma" / > < br / > < sub > < b > Saurav Sharma< / b > < / sub > < / a > < br / > < a href = "https://github.com/starship/starship/commits?author=iamsauravsharma" title = "Code" > 💻< / a > < a href = "https://github.com/starship/starship/commits?author=iamsauravsharma" title = "Documentation" > 📖< / a > < / td >
2019-07-20 17:47:07 +00:00
< / tr >
2019-08-22 14:36:35 +00:00
< tr >
< td align = "center" > < a href = "https://github.com/andytom" > < img src = "https://avatars1.githubusercontent.com/u/108836?v=4" width = "100px;" alt = "Thomas O'Donnell" / > < br / > < sub > < b > Thomas O'Donnell< / b > < / sub > < / a > < br / > < a href = "https://github.com/starship/starship/commits?author=andytom" title = "Code" > 💻< / a > < a href = "https://github.com/starship/starship/commits?author=andytom" title = "Tests" > ⚠️< / a > < / td >
2019-08-31 23:34:29 +00:00
< td align = "center" > < a href = "https://github.com/bbigras" > < img src = "https://avatars1.githubusercontent.com/u/24027?v=4" width = "100px;" alt = "Bruno Bigras" / > < br / > < sub > < b > Bruno Bigras< / b > < / sub > < / a > < br / > < a href = "https://github.com/starship/starship/commits?author=bbigras" title = "Code" > 💻< / a > < a href = "#review-bbigras" title = "Reviewed Pull Requests" > 👀< / a > < / td >
2019-09-05 16:47:45 +00:00
< td align = "center" > < a href = "https://neilkistner.com/" > < img src = "https://avatars1.githubusercontent.com/u/186971?v=4" width = "100px;" alt = "Neil Kistner" / > < br / > < sub > < b > Neil Kistner< / b > < / sub > < / a > < br / > < a href = "https://github.com/starship/starship/commits?author=wyze" title = "Code" > 💻< / a > < a href = "https://github.com/starship/starship/commits?author=wyze" title = "Tests" > ⚠️< / a > < a href = "#review-wyze" title = "Reviewed Pull Requests" > 👀< / a > < / td >
2019-08-31 23:29:38 +00:00
< td align = "center" > < a href = "http://ca.linkedin.com/in/qstrahl" > < img src = "https://avatars3.githubusercontent.com/u/2235277?v=4" width = "100px;" alt = "Quinn Strahl" / > < br / > < sub > < b > Quinn Strahl< / b > < / sub > < / a > < br / > < a href = "https://github.com/starship/starship/commits?author=qstrahl" title = "Code" > 💻< / a > < a href = "https://github.com/starship/starship/commits?author=qstrahl" title = "Tests" > ⚠️< / a > < / td >
2019-09-03 00:27:50 +00:00
< td align = "center" > < a href = "https://github.com/tivervac" > < img src = "https://avatars2.githubusercontent.com/u/3389524?v=4" width = "100px;" alt = "Titouan Vervack" / > < br / > < sub > < b > Titouan Vervack< / b > < / sub > < / a > < br / > < a href = "https://github.com/starship/starship/commits?author=tivervac" title = "Code" > 💻< / a > < a href = "https://github.com/starship/starship/commits?author=tivervac" title = "Tests" > ⚠️< / a > < / td >
2019-09-03 00:36:33 +00:00
< td align = "center" > < a href = "http://nosubstance.me" > < img src = "https://avatars1.githubusercontent.com/u/1269815?v=4" width = "100px;" alt = "Francisco Lopes" / > < br / > < sub > < b > Francisco Lopes< / b > < / sub > < / a > < br / > < a href = "https://github.com/starship/starship/commits?author=oblitum" title = "Code" > 💻< / a > < / td >
2019-09-04 17:05:00 +00:00
< td align = "center" > < a href = "https://github.com/ahouts" > < img src = "https://avatars1.githubusercontent.com/u/16907671?v=4" width = "100px;" alt = "Andrew Houts" / > < br / > < sub > < b > Andrew Houts< / b > < / sub > < / a > < br / > < a href = "https://github.com/starship/starship/commits?author=ahouts" title = "Code" > 💻< / a > < a href = "https://github.com/starship/starship/commits?author=ahouts" title = "Documentation" > 📖< / a > < a href = "https://github.com/starship/starship/commits?author=ahouts" title = "Tests" > ⚠️< / a > < / td >
2019-09-05 16:47:09 +00:00
< / tr >
< tr >
2019-09-07 19:17:00 +00:00
< td align = "center" > < a href = "https://github.com/nickwb" > < img src = "https://avatars2.githubusercontent.com/u/594211?v=4" width = "100px;" alt = "Nick Young" / > < br / > < sub > < b > Nick Young< / b > < / sub > < / a > < br / > < a href = "https://github.com/starship/starship/commits?author=nickwb" title = "Code" > 💻< / a > < a href = "https://github.com/starship/starship/commits?author=nickwb" title = "Documentation" > 📖< / a > < a href = "https://github.com/starship/starship/commits?author=nickwb" title = "Tests" > ⚠️< / a > < a href = "#review-nickwb" title = "Reviewed Pull Requests" > 👀< / a > < / td >
2019-09-07 15:13:10 +00:00
< td align = "center" > < a href = "https://github.com/g2p" > < img src = "https://avatars1.githubusercontent.com/u/61678?v=4" width = "100px;" alt = "Gabriel de Perthuis" / > < br / > < sub > < b > Gabriel de Perthuis< / b > < / sub > < / a > < br / > < a href = "https://github.com/starship/starship/commits?author=g2p" title = "Code" > 💻< / a > < / td >
2019-08-22 14:36:35 +00:00
< / tr >
2019-07-19 20:21:53 +00:00
< / table >
2019-05-16 16:46:07 +00:00
<!-- ALL - CONTRIBUTORS - LIST:END -->
This project follows the [all-contributors ](https://github.com/all-contributors/all-contributors ) specification. Contributions of any kind welcome!
2019-07-20 01:39:35 +00:00
2019-09-04 23:22:28 +00:00
## 💭 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.
2019-09-04 23:23:55 +00:00
< p align = "center" >
< br >
< img width = "100" src = "media/icon.png" alt = "Starship rocket icon" >
< / p >
2019-07-24 16:34:37 +00:00
## 📝 License
2019-07-20 01:39:35 +00:00
2019-07-25 16:50:29 +00:00
Copyright © 2019-present, [Starship Contributors ](https://github.com/starship/starship/graphs/contributors ).< br >
2019-08-22 14:35:15 +00:00
This project is [ISC ](https://github.com/starship/starship/blob/master/LICENSE ) licensed.
