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 need while you're working, while staying sleek and out of the way.

Starship with Hyper and One Dark

Features

Installation

Prerequisites

Getting Started

  1. Install the starship binary:

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

    ```sh

    ~/.bashrc or ~/.zshrc

    eval "$(starship init $0)" ```

    Fish

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

    ```sh

    ~/.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):

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

πŸ› πŸ’»

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


Starship rocket icon

License

ISC Licensed

Copyright Β© 2019-present, Matan Kushner