starship 0.12.2

The cross-shell prompt for astronauts. โ˜„๐ŸŒŒ๏ธ

๐Ÿฌ 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

Prerequisites

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

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

๐Ÿ“ License

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