Website · Installation · Configuration

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

• A Nerd Font installed and enabled in your terminal (for example, try the FiraCode Nerd Font).

Step 1. Install Starship

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

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

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

Step 2. Set up your shell to use Starship

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

eval "$(starship init bash)"

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

eval (starship init elvish)

starship init fish | source

eval $(starship init ion)

mkdir ~/.cache/starship
starship init nu | save -f ~/.cache/starship/init.nu

use ~/.cache/starship/init.nu

Invoke-Expression (&starship init powershell)

eval `starship init tcsh`

execx($(starship init xonsh))

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

• denysdovhan/spaceship-prompt – A ZSH prompt for astronauts.

• denysdovhan/robbyrussell-node – Cross-shell robbyrussell theme written in JavaScript.

• reujab/silver – A cross-shell customizable powerline-like prompt with icons.

❤️ 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:

• Reviewers: Astronauts
• Approvers and Authors: Mission Control

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

📝 License

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