π¬ Features
- Prompt character turns red if the last command exits with non-zero code
- Current Go version (
πΉ
) - Current Java version (
β
) - Current Node.js version (
β¬’
) - Current PHP version (
π
) - Current Python version (
π
) - Current Ruby version (
π
) - Current Rust version (
π¦
) - Current .NET version (
β’NET
) - Current version of package in current directory (
π¦
)- npm (Node.js)
- cargo (Rust)
- poetry (Python)
- composer (PHP)
- 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
- Current Mercurial branch
- Current battery level and status
β‘
β chargingβ£
β dischargingβ’
β fully charged- Indicator for jobs in the background (
β¦
) - Current Kubernetes Cluster and Namespace (
βΈ
) - Current Amazon Web Services (AWS) profile (
βοΈ
) - Execution time of the last command
- Custom environment variable value
- Nix-shell environment detection
- Current username if not the same as the logged-in user
- Optional current time in 12/24hr format
π Installation
Prerequisites
- A Powerline font installed and enabled in your terminal (for example, try Fira Code).
Getting Started
-
Install the starship binary:
Install Latest Version
From prebuilt binary, with Shell:
|
From source on crates.io:
Install via Package Manager
With Homebrew:
With Scoop:
scoop install starship
-
Add the init script to your shell's config file:
Bash
Add the following to the end of
~/.bashrc
:# ~/.bashrc
Fish
Add the following to the end of
~/.config/fish/config.fish
:# ~/.config/fish/config.fish |
Zsh
Add the following to the end of
~/.zshrc
:# ~/.zshrc
PowerShell
Add the following to the end of
~\Documents\PowerShell\Microsoft.PowerShell_profile.ps1
(or~/.config/powershell/Microsoft.PowerShell_profile.ps1
on -Nix):# ~\Documents\PowerShell\Profile.ps1 & )
Ion
Add the following to the end of
~/.config/ion/initrc
:# ~/.config/ion/initrc
π§ Configuration
For details on how to configure Starship, check out our documentation.
π€ 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.
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) 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. Also, feel free to drop into our Discord server and say hi. π
Contributors
Thanks goes to these wonderful people (emoji key):
This project follows the 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 - A ZSH prompt for astronauts.
-
denysdovhan/robbyrussell-node - Cross-shell robbyrussell theme written in JavaScript.
-
reujab/silver - A cross-shell customizable powerline-like prompt with icons.
π License
Copyright Β© 2019-present, Starship Contributors. This project is ISC licensed.