Starship – Cross-shell prompt

Crates.io version Azure Pipelines Build Status All Contributors Chat on Discord


⚠️ Starship is still a work in progress but is now far enough along to be used as a prompt (I personally use it as my daily driver)

Starship is a Rust port of the minimalistic, powerful, and extremely customizable prompt Spaceship ZSH.

Development plans

The project is beginning as a port of Spaceship ZSH, but will be improved in areas where Spaceship ZSH was previously limited:

We will not be aiming to achieve full parity with Spaceship ZSH as a result, so I am very open to discussing and reevaluating new solutions and ideas for the prompt.

I'm very new to Rust, so any help is appreciated when it comes to improving development patterns, writing idiomatic Rust, performance, safety, etc. πŸ˜„

Prompt segments

Other features

Shell support

Test strategy

Setup

Prerequisites

Getting Started

  1. Install the starship binary:

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

    ```bash

    ~/.bashrc or ~/.zshrc

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

    Fish

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

    ```fish

    ~/.config/config.fish

    eval (starship init fish) ```

Configuration

🚧 Configuration features and documentation are in the process of being developed

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

πŸ’»

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