Starship – Cross-shell prompt version Azure Pipelines Build Status All Contributors Chat on Discord

Website Β· Installation Β· Configuration

Starship is the minimal, blazing fast, and extremely customizable prompt for any shell!
The prompt shows information you need while you're working, while staying sleek and out of the way.

Starship with Hyper and One Dark

🍬 Features

  • Prompt character turns red if the last command exits with non-zero code
  • Current username if not the same as the logged-in user
  • Current Node.js version(β¬’)
  • Current Rust version (πŸ¦€)
  • Current Ruby version (πŸ’Ž)
  • Current Python version (🐍)
  • Current Go version (🐹)
  • Current version of package in current directory (πŸ“¦)
    • npm (Node.js)
    • cargo (Rust)
    • poetry (Python)
  • Current battery level and status
  • Current Git branch and rich repo status:
    • = β€” conflicting changes
    • ⇑ β€” ahead of remote branch
    • ⇣ β€” behind of remote branch
    • ⇕ β€” diverged changes
    • ? β€” untracked changes
    • $ β€” stashed changes
    • ! β€” modified files
    • + β€” added files
    • Β» β€” renamed files
    • ✘ β€” deleted files
  • Execution time of the last command if it exceeds the set threshold
  • Indicator for jobs in the background (✦)

πŸš€ Installation


Getting Started

  1. Install the starship binary:

    Download archives of precompiled binaries if you don't use the platforms below.


    $ brew install starship

    Rust (v1.33 or higher)

    $ cargo install starship

    Arch Linux (AUR)

    Starship is available on the AUR under the name starship. Install it with yay or your favorite AUR helper.

    $ yay -S starship

    Nix (unstable)

    $ nix-env --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/
    eval (starship init fish)


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

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

πŸ”§ Configuration

For details on how to configure Starship, check out our documentation.

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

High Priority Needs

  • πŸ‘©β€πŸ’Ό Product Manager
    • We have a GitHub Project and many unorganized/unprioritized features, as well as ideas that haven't yet been made into issues. Starship needs someone to own the product direction!
  • πŸ‘©β€πŸŽ¨ Designer
    • Like making eye-catching websites? Excellent! We are looking to create a beautiful landing page showing off Starship in all its glory. Helping design for Starship's brand is a great opportunity to try out new ideas!
  • πŸ‘©β€πŸ’» Rust Developer
    • There is a lot of low-hanging fruit when it comes to writing idiomatic Rust, designing effective Rust architecture, performance optimizations, cross-platform build optimizations, and more! I (@matchai) am a beginner to Rust. Come point us in the right direction!

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. πŸ‘‹


Thanks goes to these wonderful people (emoji key):

Matan Kushner
Matan Kushner

πŸ’» 🎨 πŸ€” πŸš‡ 🚧 πŸ‘€ ⚠️
John Letey
John Letey

πŸ’» πŸ€” πŸ‘€ ⚠️
Tim Mulqueen
Tim Mulqueen

πŸ’» πŸ€” πŸ‘€ ⚠️
Tiffany Le-Nguyen
Tiffany Le-Nguyen

πŸ€” 🚧 πŸ‘€ πŸ“–

🎨 πŸ€” 🚧 πŸ‘€
Ryan Leckey
Ryan Leckey

Youssef Habri
Youssef Habri

Kevin Song
Kevin Song

πŸ› πŸ’» πŸ“– ⚠️
Andrew Dassonville
Andrew Dassonville

πŸ› πŸ’»

πŸ’» πŸ“– ⚠️
AndrΓ© Zanellato
AndrΓ© Zanellato

πŸ’» πŸ“– ⚠️
Saghm Rossi
Saghm Rossi

πŸ’» πŸ“– ⚠️
Shu Kutsuzawa
Shu Kutsuzawa

πŸ’» πŸ“– ⚠️
Saurav Sharma
Saurav Sharma

πŸ’» πŸ“–
Thomas O'Donnell
Thomas O'Donnell

πŸ’» ⚠️

This project follows the all-contributors specification. Contributions of any kind welcome!

Starship rocket icon

πŸ“ License

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