Compatibility First
Works on the most common shells on the most common operating systems. Use it everywhere!
The minimal, blazing-fast, and infinitely customizable prompt for any shell!
Install the starship binary:
With Shell:
curl -sS https://starship.rs/install.sh | sh
To update the Starship itself, rerun the above script. It will replace the current version without touching Starship's configuration.
With Homebrew:
brew install starship
With Winget:
winget install starship
Add the init script to your shell's config file:
Add the following to the end of ~/.bashrc
:
# ~/.bashrc
eval "$(starship init bash)"
Add the following to the end of ~/.config/fish/config.fish
:
# ~/.config/fish/config.fish
starship init fish | source
Add the following to the end of ~/.zshrc
:
# ~/.zshrc
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.
Invoke-Expression (&starship init powershell)
Add the following to the end of ~/.config/ion/initrc
:
# ~/.config/ion/initrc
eval $(starship init ion)
WARNING
Only elvish v0.18 or higher is supported.
Add the following to the end of ~/.elvish/rc.elv
:
# ~/.elvish/rc.elv
eval (starship init elvish)
Add the following to the end of ~/.tcshrc
:
# ~/.tcshrc
eval `starship init tcsh`
WARNING
This will change in the future. Only Nushell v0.78+ is supported.
Add the following to the end of your Nushell env file (find it by running $nu.env-path
in Nushell):
mkdir ~/.cache/starship
starship init nu | save -f ~/.cache/starship/init.nu
And add the following to the end of your Nushell configuration (find it by running $nu.config-path
):
use ~/.cache/starship/init.nu
Add the following to the end of ~/.xonshrc
:
# ~/.xonshrc
execx($(starship init xonsh))
You need to use Clink (v1.2.30+) with Cmd. Add the following to a file starship.lua
and place this file in Clink scripts directory:
-- starship.lua
load(io.popen('starship init cmd'):read("*a"))()