Website · Installation · Configuration
The minimal, blazing-fast, and infinitely customizable prompt for any shell!
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:
sh
sh -c "$(curl -fsSL https://starship.rs/install.sh)"
To update the Starship itself, rerun the above script. It will replace the current version without touching Starship's configuration.
Note - The defaults of the install script can be overridden see the built-in help.
sh
sh -c "$(curl -fsSL https://starship.rs/install.sh)" -- --help
sh
brew install starship
powershell
scoop install starship
Add the init script to your shell's config file:
Add the following to the end of ~/.bashrc:
```sh
eval "$(starship init bash)" ```
Add the following to the end of ~/.config/fish/config.fish:
```sh
starship init fish | source ```
Add the following to the end of ~/.zshrc:
```sh
eval "$(starship init zsh)" ```
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.
powershell
Invoke-Expression (&starship init powershell)
Add the following to the end of ~/.config/ion/initrc:
```sh
eval $(starship init ion) ```
Warning Only elvish v0.15 or higher is supported.
Add the following to the end of ~/.elvish/rc.elv:
```sh
eval (starship init elvish) ```
Add the following to the end of ~/.tcshrc:
```sh
eval starship init tcsh
```
Warning This will change in the future. Only nu version v0.33 or higher is supported.
Add the following to your nu config file. You can check the location of this
file by running config path in nu.
toml
startup = [
"mkdir ~/.cache/starship",
"starship init nu | save ~/.cache/starship/init.nu",
"source ~/.cache/starship/init.nu"
]
prompt = "starship_prompt"
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. 👋
This project exists thanks to all the people who contribute. [Contribute].
Become a financial contributor and help us sustain our community. [[Contribute](https://opencollective.com/starship/contribute)]
Support this project with your organization. Your logo will show up here with a link to your website. [[Contribute](https://opencollective.com/starship/contribute)]
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.
Copyright © 2019-present, Starship Contributors.
This project is ISC licensed.
