Prerequisites

• A Nerd Font installed and enabled in your terminal.

Quick Install

1. Install the starship binary:

   Install Latest Version

   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.

   Install via Package Manager

   With Homebrew:

   brew install starship
   

   With Winget:

   winget install starship
   

2. 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 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
   
   eval $(starship init ion)
   

   Elvish

   Warning

   Only elvish v0.18 or higher is supported.

   Add the following to the end of ~/.config/elvish/rc.elv (%AppData%\elvish\rc.elv on Windows):

   # ~/.elvish/rc.elv
   
   eval (starship init elvish)
   

   For elvish versions prior to v0.21.0 the config file might instead be ~/.elvish/rc.elv

   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.96+ is supported.

   Add the following to the end of your Nushell configuration (find it by running $nu.config-path in Nushell):

   mkdir ($nu.data-dir | path join "vendor/autoload")
   starship init nu | save -f ($nu.data-dir | path join "vendor/autoload/starship.nu")
   

   Xonsh

   Add the following to the end of ~/.xonshrc:

   # ~/.xonshrc
   
   execx($(starship init xonsh))
   

   Cmd

   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"))()