#prompt #shell #bash #zsh #fish

bin+lib starship

The cross-shell prompt for astronauts. β˜„πŸŒŒοΈ

31 releases (11 breaking)

βœ“ Uses Rust 2018 edition

new 0.12.2 Aug 23, 2019
0.11.0 Aug 19, 2019
0.4.0 Jul 29, 2019

#26 in Command line utilities

Download history 14/week @ 2019-05-17 30/week @ 2019-05-24 4/week @ 2019-05-31 16/week @ 2019-06-07 5/week @ 2019-06-14 52/week @ 2019-06-21 9/week @ 2019-06-28 66/week @ 2019-07-05 47/week @ 2019-07-12 97/week @ 2019-07-19 90/week @ 2019-07-26 135/week @ 2019-08-02 386/week @ 2019-08-09 336/week @ 2019-08-16

430 downloads per month

ISC license

2.5MB
2K SLoC


Starship – Cross-shell prompt

Crates.io 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 iTerm2 and the Snazzy theme

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

Matan Kushner
Matan Kushner

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

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

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

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

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

πŸ‘€
Youssef Habri
Youssef Habri

πŸ’»
Kevin Song
Kevin Song

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

πŸ› πŸ’»
MaT1g3R
MaT1g3R

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

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

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

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

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

πŸ’» ⚠️
Bruno Bigras
Bruno Bigras

πŸ’»

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.

Dependencies

~16MB
~358K SLoC