Skip to content

The minimal, blazing-fast, and infinitely customizable prompt for any shell!

Prerequisites

  • A Nerd Font installed and enabled in your terminal.

Quick Install

  1. Install the starship binary:

    Install Latest Version

    With Shell:

    sh
    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:

    sh
    brew install starship

    With Winget:

    powershell
    winget install starship
  2. Add the init script to your shell's config file:

    Bash

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

    sh
    # ~/.bashrc
    
    eval "$(starship init bash)"

    Fish

    Add the following to the end of ~/.config/fish/config.fish:

    sh
    # ~/.config/fish/config.fish
    
    starship init fish | source

    Zsh

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

    sh
    # ~/.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.

    sh
    Invoke-Expression (&starship init powershell)

    Ion

    Add the following to the end of ~/.config/ion/initrc:

    sh
    # ~/.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:

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

    Tcsh

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

    sh
    # ~/.tcshrc
    
    eval `starship init tcsh`

    Nushell

    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):

    sh
    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):

    sh
    use ~/.cache/starship/init.nu

    Xonsh

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

    sh
    # ~/.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:

    lua
    -- starship.lua
    
    load(io.popen('starship init cmd'):read("*a"))()