The minimal, blazing-fast, and infinitely customizable prompt for any shell!
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.
# Prerequisites
- A Nerd Font (opens new window) installed and enabled in your terminal.
# Quick Install
Install the starship binary:
# Install Latest Version
With Shell:
curl -sS https://starship.rs/install.sh | shTo update the Starship itself, rerun the above script. It will replace the current version without touching Starship's configuration.
# Install via Package Manager
With Homebrew (opens new window):
brew install starshipWith Winget (opens new window):
winget install starshipAdd 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
Microsoft.PowerShell_profile.ps1. You can check the location of this file by querying the$PROFILEvariable in PowerShell. Typically the path is~\Documents\PowerShell\Microsoft.PowerShell_profile.ps1or~/.config/powershell/Microsoft.PowerShell_profile.ps1on -Nix.Invoke-Expression (&starship init powershell)# Ion
Add the following to the end of
~/.config/ion/initrc:# ~/.config/ion/initrc eval $(starship init ion)# Elvish
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)# Tcsh
Add the following to the end of
~/.tcshrc:# ~/.tcshrc eval `starship init tcsh`# Nushell
WARNING
This will change in the future. Only Nushell v0.73+ is supported.
Add the following to the end of your Nushell env file (find it by running
$nu.env-pathin Nushell):mkdir ~/.cache/starship starship init nu | save -f ~/.cache/starship/init.nuAnd add the following to the end of your Nushell configuration (find it by running
$nu.config-path):source ~/.cache/starship/init.nu# Xonsh
Add the following to the end of
~/.xonshrc:# ~/.xonshrc execx($(starship init xonsh))# Cmd
You need to use Clink (opens new window) (v1.2.30+) with Cmd. Add the following to a file
starship.luaand place this file in Clink scripts directory:-- starship.lua load(io.popen('starship init cmd'):read("*a"))()