starship/docs
Matan Kushner 9f22bce944
docs: Update use_12hr config option name
2019-10-25 10:05:21 +09:00
..
.vuepress docs(i18n): Update Crowdin translations (#517) 2019-10-21 23:42:08 +09:00
advanced-config docs: Add extra newlines around custom containers 2019-09-28 20:20:18 +09:00
config docs: Update use_12hr config option name 2019-10-25 10:05:21 +09:00
de-DE docs: Fix `Memory Usage` option key (#586) 2019-10-25 09:58:10 +09:00
fr-FR docs: Fix `Memory Usage` option key (#586) 2019-10-25 09:58:10 +09:00
guide docs: Add vuepress with initial docs (#99) 2019-07-19 16:18:52 -04:00
ja-JP docs: Fix `Memory Usage` option key (#586) 2019-10-25 09:58:10 +09:00
ru-RU docs: Fix `Memory Usage` option key (#586) 2019-10-25 09:58:10 +09:00
zh-CN docs: Fix `Memory Usage` option key (#586) 2019-10-25 09:58:10 +09:00
zh-TW docs: Fix `Memory Usage` option key (#586) 2019-10-25 09:58:10 +09:00
README.md feat: Implement PowerShell support (#470) 2019-10-16 00:10:16 +09: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)"
    

    Powershell

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

    # ~\Documents\PowerShell\Profile.ps1
    Invoke-Expression (&starship init powershell)