#prompt #shell #bash #fish #zsh

bin+lib starship

The minimal, blazing-fast, and infinitely customizable prompt for any shell! ☄🌌️

80 releases (40 breaking)

✓ Uses Rust 2018 edition

0.41.3 May 15, 2020
0.41.0 Apr 28, 2020
0.38.1 Mar 22, 2020
0.32.2 Dec 28, 2019
0.4.0 Jul 29, 2019

#1 in #shell

Download history 1147/week @ 2020-01-25 1026/week @ 2020-02-01 1062/week @ 2020-02-08 979/week @ 2020-02-15 1004/week @ 2020-02-22 992/week @ 2020-02-29 951/week @ 2020-03-07 906/week @ 2020-03-14 1073/week @ 2020-03-21 847/week @ 2020-03-28 972/week @ 2020-04-04 1393/week @ 2020-04-11 1352/week @ 2020-04-18 1238/week @ 2020-04-25 887/week @ 2020-05-02 1513/week @ 2020-05-09

4,676 downloads per month
Used in 2 crates (via nu-cli)

ISC and maybe MPL-2.0

345KB
8K SLoC

Starship – Cross-shell prompt

GitHub Actions workflow status Crates.io version Packaging status
Chat on Discord Follow @StarshipPrompt on Twitter

Website · Installation · Configuration

English   日本語   繁體中文   Русский   Deutsch   简体中文   Español   Français

Starship with iTerm2 and the Snazzy theme

The minimal, blazing-fast, and infinitely customizable prompt for any shell!

  • Fast: it's fast – really really fast! 🚀
  • Customizable: configure every aspect of your prompt.
  • Universal: works on any shell, on any operating system.
  • Intelligent: shows relevant information at a glance.
  • Feature rich: support for all your favorite tools.
  • Easy: quick to install – start using it in minutes.

Explore the Starship docs  â–¶

🚀 Installation

Prerequisites

Getting Started

  1. Install the starship binary:

    Install Latest Version

    From prebuilt binary, with Shell:
    curl -fsSL https://starship.rs/install.sh | bash
    
    From source on crates.io:
    cargo install starship
    

    Install via Package Manager

    With Homebrew:
    brew install starship
    
    With Scoop:
    scoop 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
    
    starship init fish | source
    

    Zsh

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

    # ~/.zshrc
    
    eval "$(starship init zsh)"
    

    PowerShell

    Add the following to the end of ~\Documents\PowerShell\Microsoft.PowerShell_profile.ps1 (or ~/.config/powershell/Microsoft.PowerShell_profile.ps1 on -Nix):

    Invoke-Expression (&starship init powershell)
    

    Ion

    Add the following to the end of ~/.config/ion/initrc:

    # ~/.config/ion/initrc
    
    eval $(starship init ion)
    

🤝 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.

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. 👋

Code Contributors

This project exists thanks to all the people who contribute. [Contribute].

Financial Contributors

Become a financial contributor and help us sustain our community. [Contribute]

Individuals

Organizations

Support this project with your organization. Your logo will show up here with a link to your website. [Contribute]

💭 Inspired By

Please check out these previous works that helped inspire the creation of starship. 🙏


Starship rocket icon

📝 License

Copyright © 2019-present, Starship Contributors.
This project is ISC licensed.

Dependencies

~20MB
~457K SLoC