starship/docs

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)