starship/docs
Matan Kushner 3ddb7460a6
docs: Add a "Presets" page to the website (#783)
2019-12-23 22:32:48 -05:00
..
.vuepress docs: Add a "Presets" page to the website (#783) 2019-12-23 22:32:48 -05:00
advanced-config docs: Add extra newlines around custom containers 2019-09-28 20:20:18 +09:00
config docs: A few small improvements 2019-12-23 18:10:25 -05:00
de-DE docs(i18n): Update doc translations (#697) 2019-12-14 18:46:45 -05:00
faq docs: Correct a typo in the FAQs (#732) 2019-12-13 15:26:23 -05:00
fr-FR docs(i18n): Update doc translations (#697) 2019-12-14 18:46:45 -05:00
guide docs: Add vuepress with initial docs (#99) 2019-07-19 16:18:52 -04:00
ja-JP docs(i18n): Update doc translations (#697) 2019-12-14 18:46:45 -05:00
presets docs: Add a "Presets" page to the website (#783) 2019-12-23 22:32:48 -05:00
ru-RU docs(i18n): Update doc translations (#697) 2019-12-14 18:46:45 -05:00
zh-CN docs(i18n): Update doc translations (#697) 2019-12-14 18:46:45 -05:00
zh-TW docs(i18n): Update doc translations (#697) 2019-12-14 18:46:45 -05:00
README.md docs: Fix landing page formatting 2019-12-17 16:48:17 -05:00
package-lock.json docs: Add a "Presets" page to the website (#783) 2019-12-23 22:32:48 -05:00
package.json docs: Add a "Presets" page to the website (#783) 2019-12-23 22:32:48 -05: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:

    Install Latest Version

    With Shell:

    curl -fsSL https://starship.rs/install.sh | bash
    

    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):

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

    Ion

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

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