GitHub - starship/starship: ☄?️ The cross-shell prompt for astronauts.

README.md

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.

? 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 (?)
• Nix-shell environment detection
• 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

Prerequisites

• A Powerline font installed and enabled in your terminal (for example, try Fira Code).

Getting Started

1. Install the starship binary:

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

   Homebrew

   $ 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

   Termux

   $ pkg install starship

2. Add the init script to your shell's config file:

   Bash

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

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

   Fish

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

   # ~/.config/fish/config.fish
   
   eval (starship init fish)

   Zsh

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

Contributors

Thanks goes to these wonderful people (emoji key):

Matan Kushner
? ? ? ? ? ? ⚠️
John Letey
? ? ? ⚠️
Tim Mulqueen
? ? ? ⚠️
Tiffany Le-Nguyen
? ? ? ?
​Snuggle
? ? ? ?
Ryan Leckey
?
Youssef Habri
?
Kevin Song
? ? ? ⚠️
Andrew Dassonville
? ?
MaT1g3R
? ? ⚠️
André Zanellato
? ? ⚠️
Saghm Rossi
? ? ⚠️
Shu Kutsuzawa
? ? ⚠️
Saurav Sharma
? ?
Thomas O'Donnell
? ⚠️
Bruno Bigras
? ?
Neil Kistner
? ⚠️ ?
Quinn Strahl
? ⚠️
Titouan Vervack
? ⚠️
Francisco Lopes
?
Andrew Houts
? ? ⚠️
Nick Young
? ? ⚠️

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

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

? License

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