Skip to content

Starship – Cross-shell prompt

GitHub Actions workflow statusCrates.io versionPackaging status
Chat on DiscordFollow @StarshipPrompt on TwitterStand With Ukraine

Website · Installation · Configuration

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

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:

RepositoryInstructions
Termuxpkg install starship
BSD

Install Starship using any of the following package managers:

DistributionRepositoryInstructions
Anycrates.iocargo install starship --locked
FreeBSDFreshPortspkg install starship
NetBSDpkgsrcpkgin install starship
Linux

Install the latest version for your system:

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

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

DistributionRepositoryInstructions
Anycrates.iocargo install starship --locked
Anyconda-forgeconda install -c conda-forge starship
AnyLinuxbrewbrew install starship
Alpine Linux 3.13+Alpine Linux Packagesapk add starship
Arch LinuxArch Linux Extrapacman -S starship
CentOS 7+Coprdnf copr enable atim/starship
dnf install starship
GentooGentoo Packagesemerge app-shells/starship
Manjaropacman -S starship
NixOSnixpkgsnix-env -iA nixpkgs.starship
openSUSEOSSzypper in starship
Void LinuxVoid Linux Packagesxbps-install -S starship
macOS

Install the latest version for your system:

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

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

RepositoryInstructions
crates.iocargo install starship --locked
conda-forgeconda install -c conda-forge starship
Homebrewbrew install starship
MacPortsport install starship
Windows

Install the latest version for your system with the MSI-installers from the releases section.

Install Starship using any of the following package managers:

RepositoryInstructions
crates.iocargo install starship --locked
Chocolateychoco install starship
conda-forgeconda install -c conda-forge starship
Scoopscoop install starship
wingetwinget install --id Starship.Starship

Step 2. Set up 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:

sh
eval "$(starship init bash)"
Cmd

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

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

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

sh
eval (starship init elvish)

Note: Only Elvish v0.18+ is supported

Fish

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

fish
starship init fish | source
Ion

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

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

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

Note: Only Nushell v0.78+ is supported

PowerShell

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

powershell
Invoke-Expression (&starship init powershell)
Tcsh

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

sh
eval `starship init tcsh`
Xonsh

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

python
execx($(starship init xonsh))
Zsh

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

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

  • Configuration – learn how to configure Starship to tweak your prompt to your liking

  • Presets – get inspired by the pre-built configuration of others

🤝 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.

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.

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

💭 Inspired By

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

❤️ Sponsors

Support this project by becoming a sponsor. Your name or logo will show up here with a link to your website.

🔒 Code Signing Policy

Free code signing provided by SignPath.io, certificate by SignPath Foundation.

Code Signing Roles:

This program will not transfer any information to other networked systems unless specifically requested by the user or the person installing or operating it.


Starship rocket icon

📝 License

Copyright © 2019-present, Starship Contributors.
This project is ISC licensed.