starship 0.2.0

The cross-shell prompt for astronauts. ☄🌌️
Documentation

⚠️ 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:

  • Speed
  • Concurrency of segment logic execution
    • Memoization of expensive operations
  • Safety and error handling
  • Testability of code
  • Configuration
    • Cross-shell support with JSON or TOML config files

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

  • Prompt character turns red if the last command exits with non-zero code.
  • 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
  • Indicator for jobs in the background (✦).
  • Execution time of the last command if it exceeds the set threshold.

Other features

  • starship.toml configuration
  • Custom sections given commands or binaries
  • Self-updating

Shell support

  • Fish shell
  • Z Shell
  • Bash

Test strategy

  • Per-segment benchmarking
  • Per-segment unit + integration tests
  • Shell + OS matrix acceptance tests

Setup

Prerequisites

  • Rust v1.33 or higher
  • A Powerline font (like Fira Code) installed and enabled in your terminal emulator

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

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