#prompt #shell #bash #fish #zsh

bin+lib starship

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

93 releases (50 breaking)

0.51.0 Mar 23, 2021
0.49.0 Jan 29, 2021
0.47.0 Nov 15, 2020
0.44.0 Jul 6, 2020
0.4.0 Jul 29, 2019

#32 in Command line utilities

Download history 529/week @ 2020-12-23 1050/week @ 2020-12-30 608/week @ 2021-01-06 483/week @ 2021-01-13 371/week @ 2021-01-20 950/week @ 2021-01-27 939/week @ 2021-02-03 847/week @ 2021-02-10 770/week @ 2021-02-17 426/week @ 2021-02-24 449/week @ 2021-03-03 372/week @ 2021-03-10 452/week @ 2021-03-17 1312/week @ 2021-03-24 720/week @ 2021-03-31 480/week @ 2021-04-07

2,681 downloads per month
Used in paper

ISC license

19K SLoC

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


Getting Started

Note: due to the proliferation of different platforms, only a subset of supported platforms are shown below. Can't see yours? Have a look at the extra platform instructions.

  1. Install the starship binary:

    Install Latest Version

    From prebuilt binary, with Shell:
    curl -fsSL https://starship.rs/install.sh | bash

    Install via Package Manager

    Example: Homebrew:
    brew install starship
    With Scoop:
    scoop install starship
  2. Add the init script to your shell's config file:


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

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


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

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


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

    # ~/.zshrc
    eval "$(starship init zsh)"


    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)


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

    # ~/.config/ion/initrc
    eval $(starship init ion)


    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)


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

    # ~/.tcshrc
    eval `starship init tcsh`

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

Code Contributors

This project exists thanks to all the people who contribute. [Contribute].

Financial Contributors

Become a financial contributor and help us sustain our community. [Contribute]



Support this project with your organization. Your logo will show up here with a link to your website. [Contribute]

💭 Inspired By

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

Starship rocket icon

📝 License

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


~496K SLoC