starship/docs
2019-08-13 18:43:29 -04:00
..
.vuepress docs: Add vuepress with initial docs (#99) 2019-07-19 16:18:52 -04:00
config feat: implement the ruby module (#131) 2019-08-13 18:43:29 -04:00
guide docs: Add vuepress with initial docs (#99) 2019-07-19 16:18:52 -04:00
package-lock.json docs: Add vuepress with initial docs (#99) 2019-07-19 16:18:52 -04:00
package.json docs: Add vuepress with initial docs (#99) 2019-07-19 16:18:52 -04:00
README.md docs: Attribute copyright to Starship Contributors (#115) 2019-07-25 12:50:29 -04:00

home heroImage actionText actionLink footer
true /logo.svg Get Started → /guide/ ISC Licensed | Copyright © 2019-present Starship Contributors

Compatibility First

Works on the most common shells on the most common operating systems. Use it everywhere!

Rust-Powered

Brings the best-in-class speed and safety of Rust, to make your prompt as quick and reliable as possible.

Customizable

Every little detail is customizable to your liking, to make this prompt as minimal or feature-rich as you'd like it to be.

Quick Install

  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/fish/config.fish
    
    eval (starship init fish)