starship/docs
Matan Kushner 2b53490e9e
docs(i18n): Add Simplified Chinese docs to the website and README.md (#906)
2020-02-04 23:57:11 -05:00
..
.vuepress docs(i18n): Add Simplified Chinese docs to the website and README.md (#906) 2020-02-04 23:57:11 -05:00
advanced-config docs: Add extra newlines around custom containers 2019-09-28 20:20:18 +09:00
config docs: small doc touchups 2020-02-04 18:28:11 -05:00
de-DE docs(i18n): Update translations (#875) 2020-02-04 12:11:36 -05:00
es-ES docs(i18n): Update translations (#875) 2020-02-04 12:11:36 -05:00
faq docs: Correct a typo in the FAQs (#732) 2019-12-13 15:26:23 -05:00
fr-FR docs(i18n): Update translations (#875) 2020-02-04 12:11:36 -05:00
guide docs: Add vuepress with initial docs (#99) 2019-07-19 16:18:52 -04:00
ja-JP docs(i18n): Fix links in Japanese docs (#905) 2020-02-04 14:31:52 -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 translations (#875) 2020-02-04 12:11:36 -05:00
zh-CN docs(i18n): Update translations (#875) 2020-02-04 12:11:36 -05:00
zh-TW docs(i18n): Update translations (#875) 2020-02-04 12:11:36 -05:00
README.md docs: Add a meta title for SEO 2020-02-02 20:03:47 -05:00
package-lock.json docs: Added dark theme to documentation (#819) 2020-01-28 13:56:53 -05:00
package.json docs: Improve description meta tag for SEO 2020-02-02 19:51:48 -05:00

README.md

home heroImage heroText tagline actionText actionLink features footer metaTitle description
true /logo.svg null The cross-shell prompt for astronauts Get Started → ./guide/
title details
Compatibility First Works on the most common shells on the most common operating systems. Use it everywhere!
title details
Rust-Powered Brings the best-in-class speed and safety of Rust, to make your prompt as quick and reliable as possible.
title details
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.
ISC Licensed | Copyright © 2019-present Starship Contributors Starship: Cross-Shell Prompt Starship is the minimal, blazing fast, and extremely customizable prompt for any shell! Shows the information you need, while staying sleek and minimal. Quick installation available for Bash, Fish, ZSH, Ion, and Powershell.

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)