hero

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

Get Started →

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

# Quick Install

  1. Install the starship binary:

    # Install Latest Version

    With Shell:

    sh -c "$(curl -fsSL https://starship.rs/install.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 (opens new window):

    brew install starship
    

    With Scoop (opens new window):

    scoop 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.15 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 nu version v0.33 or higher is supported.

    Add the following to your nu config file. You can check the location of this file by running config path in nu.

    startup = [
     "mkdir ~/.cache/starship",
     "starship init nu | save ~/.cache/starship/init.nu",
     "source ~/.cache/starship/init.nu"
    ]
    prompt = "starship_prompt"
    

    # Xonsh

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

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