1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
|
<p align="center">
<br>
<img width="400" src="https://raw.githubusercontent.com/starship/starship/master/media/logo.png" alt="Starship β Cross-shell prompt">
<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>
<a href="#contributors"><img src="https://badgen.net/badge/all%20contributors/9/orange" 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>
</p>
</p>
<h4 align="center">
<br>
<a href="https://starship.rs">Website</a> Β·
<a href="#-installation">Installation</a> Β·
<a href="https://starship.rs/config/">Configuration</a>
</h4>
<h1></h1>
Starship is the minimal, blazing fast, and extremely customizable prompt for any shell!<br>
The prompt shows information need while you're working, while staying sleek and out of the way.
<p align="center">
<img alt="Starship with Hyper and One Dark" src="https://raw.githubusercontent.com/starship/starship/master/media/demo.gif">
</p>
## π¬ 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/).
## π€ 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)):
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore -->
<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="βSnuggle"/><br /><sub><b>βSnuggle</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>
<tr>
<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></td>
<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>
</tr>
</table>
<!-- ALL-CONTRIBUTORS-LIST:END -->
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
<p align="center">
<br>
<img width="100" src="media/icon.png" alt="Starship rocket icon">
</p>
## π License
Copyright Β© 2019-present, [Starship Contributors](https://github.com/starship/starship/graphs/contributors).<br>
This project is [ISC](./LICENSE) licensed.
|