haskal
/
starship
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
starship/docs
History
Nick Young eb724279da feat: Adds Git State module for showing "REBASING 2/3", etc. (#276) 
- Adds the git_state module.
- Adds git_state to the default prompt order
- Updates the documentation to describe the git_state module
 		2019-09-05 12:45:04 -04:00
..
.vuepress docs: Add new demo gif to README (#231) 2019-08-22 20:03:45 -04:00
advanced-config feat: Allow bash users to specify a precmd function (#166) 2019-08-17 16:53:59 -07:00
config feat: Adds Git State module for showing "REBASING 2/3", etc. (#276) 2019-09-05 12:45:04 -04:00
guide docs: Add vuepress with initial docs (#99) 2019-07-19 16:18:52 -04:00
README.md docs: add termux install instructions (#248) 2019-08-27 19:32:26 -04:00
package-lock.json docs: Add a GA tag 2019-08-20 11:13:19 -04:00
package.json docs: Add a GA tag 2019-08-20 11:13:19 -04:00

README.md

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:

    Download archives of precompiled binaries if you don't use the platforms below.

    Homebrew

    $ brew install starship

    Rust (v1.33 or higher)

    $ cargo install starship

    Arch Linux (AUR)

    Starship is available on the AUR under the name starship. Install it with yay or your favorite AUR helper.

    $ yay -S starship

    Nix (unstable)

    $ nix-env --install starship

    Termux

    $ pkg 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

eval (starship init fish)

    Zsh

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

    # ~/.zshrc

eval "$(starship init zsh)"