The minimal, blazing-fast, and infinitely customizable prompt for any shell!
- Fast: it's fast β really really fast! π
- Customizable: configure every aspect of your prompt.
- Universal: works on any shell, on any operating system.
- Intelligent: shows relevant information at a glance.
- Feature rich: support for all your favorite tools.
- Easy: quick to install βΒ start using it in minutes.
π Installation
Prerequisites
- A Nerd Font installed and enabled in your terminal (for example, try the Fira Code Nerd Font).
Getting Started
Note: due to the proliferation of different platforms, only a subset of supported platforms are shown below. Can't see yours? Have a look at the extra platform instructions.
-
Install the starship binary:
Install Latest Version
From prebuilt binary, with Shell:
|
Install via Package Manager
Example: 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
Microsoft.PowerShell_profile.ps1
. You can check the location of this file by querying the$PROFILE
variable in PowerShell. Typically the path is~\Documents\PowerShell\Microsoft.PowerShell_profile.ps1
or~/.config/powershell/Microsoft.PowerShell_profile.ps1
on -Nix.Invoke-Expression (&starship init powershell)
Ion
Add the following to the end of
~/.config/ion/initrc
:# ~/.config/ion/initrc
Elvish
Warning Only elvish v0.15 or higher is supported. Add the following to the end of
~/.elvish/rc.elv
:# ~/.elvish/rc.elv )
π€ 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.
If you are fluent in a non-English language, we greatly appreciate any help keeping our docs translated and up-to-date in other languages. If you would like to help, translations can be contributed on the Starship Crowdin.
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. π
Code Contributors
This project exists thanks to all the people who contribute. [Contribute].
Financial Contributors
Become a financial contributor and help us sustain our community. [Contribute]
Individuals
Organizations
Support this project with your organization. Your logo will show up here with a link to your website. [Contribute]
π 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.