.. | ||
.vuepress | ||
advanced-config | ||
config | ||
de-DE | ||
faq | ||
fr-FR | ||
guide | ||
ja-JP | ||
ru-RU | ||
zh-CN | ||
zh-TW | ||
package-lock.json | ||
package.json | ||
README.md |
home | heroImage | actionText | actionLink | footer |
---|---|---|---|---|
true | /logo.svg | Get Started → | /guide/ | ISC Licensed | Copyright © 2019-present Starship Contributors |
Compatibility First
Works on the most common shells on the most common operating systems. Use it everywhere!
Rust-Powered
Brings the best-in-class speed and safety of Rust, to make your prompt as quick and reliable as possible.
Customizable
Every little detail is customizable to your liking, to make this prompt as minimal or feature-rich as you'd like it to be.
Quick Install
-
Install the starship binary:
Download archives of precompiled binaries if you don't use the platforms below.
Homebrew
$ brew install starship
Rust (v1.38 or higher)
$ cargo install starship
Arch Linux (AUR)
Starship is available on the AUR under the name
starship
. Install it withyay
or your favorite AUR helper.$ yay -S starship
Nix (unstable)
$ nix-env --install starship
Termux
$ pkg install starship
-
Add the init script to your shell's config file:
Bash
Add the following to the end of
~/.bashrc
:# ~/.bashrc eval "$(starship init bash)"
Fish
Add the following to the end of
~/.config/fish/config.fish
:# ~/.config/fish/config.fish starship init fish | source
Zsh
Add the following to the end of
~/.zshrc
:# ~/.zshrc eval "$(starship init zsh)"
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 Invoke-Expression (&starship init powershell)