starship 0.3.0

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

Starship is the minimal, blazing fast, and extremely customizable prompt for any shell! The prompt shows information 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 Python version (๐Ÿ).
  • Current Go version (๐Ÿน).
  • Package version of package in current directory (๐Ÿ“ฆ).
  • 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
  • PLANNED #80 โ€“ Indicator for jobs in the background (โœฆ).
  • PLANNED #104 โ€“ Execution time of the last command if it exceeds the set threshold.

Installation

Prerequisites

Getting Started

  1. Install the starship binary:

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

    Bash / Zsh

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

    # ~/.bashrc or ~/.zshrc
    
    eval "$(starship init $0)"
    

    Fish

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

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

Configuration

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

Contribution

If you are interested in helping contribute to starship, please take a look at our Contributing Guide.

Thanks goes to these wonderful people (emoji key):

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

License

ISC Licensed

Copyright ยฉ 2019-present, Matan Kushner