Starship – Cross-shell prompt

GitHub Actions workflow status Crates.io version Packaging status
Chat on Discord Follow @StarshipPrompt on Twitter

Website · Installation · Configuration

English   Deutsch   Español   Français   Bahasa Indonesia   Italiano   日本語   Português do Brasil   Русский   Tiếng Việt   简体中文   繁體中文

SWUbanner (opens new window)

Starship with iTerm2 and the Snazzy theme

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

  • Fast: it's fast – really really fast! 🚀
  • Customizable: configure every aspect of your prompt.
  • Universal: works on any shell, on any operating system.
  • Intelligent: shows relevant information at a glance.
  • Feature rich: support for all your favorite tools.
  • Easy: quick to install – start using it in minutes.

Explore the Starship docs  ▶

# 🚀 Installation

# Prerequisites

# Step 1. Install Starship

Select your operating system from the list below to view installation instructions:

Android

Install Starship using any of the following package managers:

Repository Instructions
Termux (opens new window) pkg install starship
BSD

Install Starship using any of the following package managers:

Distribution Repository Instructions
Any crates.io (opens new window) cargo install starship --locked
FreeBSD FreshPorts (opens new window) pkg install starship
NetBSD pkgsrc (opens new window) pkgin install starship
Linux

Install the latest version for your system:

curl -sS https://starship.rs/install.sh | sh

Alternatively, install Starship using any of the following package managers:

Distribution Repository Instructions
Any crates.io (opens new window) cargo install starship --locked
Any conda-forge (opens new window) conda install -c conda-forge starship
Any Linuxbrew (opens new window) brew install starship
Any Snapcraft (opens new window) snap install starship
Alpine Linux 3.13+ Alpine Linux Packages (opens new window) apk add starship
Arch Linux Arch Linux Community (opens new window) pacman -S starship
CentOS 7+ Copr (opens new window) dnf copr enable atim/starship
dnf install starship
Fedora 31+ Fedora Packages (opens new window) dnf install starship
Gentoo Gentoo Packages (opens new window) emerge app-shells/starship
Manjaro pacman -S starship
NixOS nixpkgs (opens new window) nix-env -iA nixpkgs.starship
Void Linux Void Linux Packages (opens new window) xbps-install -S starship
macOS

Install the latest version for your system:

curl -sS https://starship.rs/install.sh | sh

Alternatively, install Starship using any of the following package managers:

Repository Instructions
crates.io (opens new window) cargo install starship --locked
conda-forge (opens new window) conda install -c conda-forge starship
Homebrew (opens new window) brew install starship
MacPorts (opens new window) port install starship
Windows

Install the latest version for your system with the MSI-installers from the releases section (opens new window).

Install Starship using any of the following package managers:

Repository Instructions
crates.io (opens new window) cargo install starship --locked
Chocolatey (opens new window) choco install starship
conda-forge (opens new window) conda install -c conda-forge starship
Scoop (opens new window) scoop install starship
winget (opens new window) winget install --id Starship.Starship

# Step 2. Setup your shell to use Starship

Configure your shell to initialize starship. Select yours from the list below:

Bash

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

eval "$(starship init bash)"
Cmd

You need to use Clink (opens new window) (v1.2.30+) with Cmd. Create a file at this path %LocalAppData%\clink\starship.lua with the following contents:

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

Add the following to the end of ~/.elvish/rc.elv:

eval (starship init elvish)

Note: Only Elvish v0.18+ is supported

Fish

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

starship init fish | source
Ion

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

eval $(starship init ion)
Nushell

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 ~/.cache/starship/init.nu

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

source ~/.cache/starship/init.nu

Note: Only Nushell v0.61+ is supported

PowerShell

Add the following to the end of your PowerShell configuration (find it by running $PROFILE):

Invoke-Expression (&starship init powershell)
Tcsh

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

eval `starship init tcsh`
Xonsh

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

execx($(starship init xonsh))
Zsh

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

eval "$(starship init zsh)"

# Step 3. Configure Starship

Start a new shell instance, and you should see your beautiful new shell prompt. If you're happy with the defaults, enjoy!

If you're looking to further customize Starship:

# 🤝 Contributing

We are always looking for contributors of all skill levels! If you're looking to ease your way into the project, try out a good first issue (opens new window).

If you are fluent in a non-English language, we greatly appreciate any help keeping our docs translated and up-to-date in other languages. If you would like to help, translations can be contributed on the Starship Crowdin (opens new window).

If you are interested in helping contribute to starship, please take a look at our Contributing Guide (opens new window). Also, feel free to drop into our Discord server (opens new window) and say hi. 👋

# 💭 Inspired By

Please check out these previous works that helped inspire the creation of starship. 🙏


Starship rocket icon

# 📝 License

Copyright © 2019-present, Starship Contributors (opens new window).
This project is ISC (opens new window) licensed.