starship/docs
David Knaack 9738b84b6f
fix: fix docker_context module name in nf preset (#2526)
2021-03-28 22:36:09 +02:00
..
.vuepress build(deps-dev): bump vuepress-theme-default-prefers-color-scheme from 1.1.2 to 2.0.0 in /docs (#1946) 2021-02-16 17:09:59 -05:00
advanced-config fix: bg:none overwrites foreground colour (#1903) 2020-12-02 00:40:15 -06:00
ar-SA docs(i18n): New Crowdin updates (#2362) 2021-03-15 18:18:42 +01:00
ckb-IR docs(i18n): New Crowdin updates (#2362) 2021-03-15 18:18:42 +01:00
config feat(vcsh): Add new module for VCSH (#2513) 2021-03-28 17:48:15 +02:00
de-DE docs(i18n): New Crowdin updates (#2362) 2021-03-15 18:18:42 +01:00
es-ES docs(i18n): New Crowdin updates (#2362) 2021-03-15 18:18:42 +01:00
faq fix(docs): "Command Duration" section link target (#2416) 2021-03-12 15:31:26 +01:00
fr-FR docs(i18n): New Crowdin updates (#2362) 2021-03-15 18:18:42 +01:00
guide docs: Add vuepress with initial docs (#99) 2019-07-19 16:18:52 -04:00
installing docs(readme): add missing link to home-manager (#2490) 2021-03-24 11:02:14 -05:00
it-IT docs(i18n): New Crowdin updates (#2362) 2021-03-15 18:18:42 +01:00
ja-JP docs(i18n): New Crowdin updates (#2362) 2021-03-15 18:18:42 +01:00
ko-KR docs(i18n): New Crowdin updates (#2362) 2021-03-15 18:18:42 +01:00
migrating-to-0.45.0 docs: Update defaults in config docs (#1759) 2020-10-12 00:10:39 -04:00
nl-NL docs(i18n): New Crowdin updates (#2362) 2021-03-15 18:18:42 +01:00
pl-PL docs(i18n): New Crowdin updates (#2362) 2021-03-15 18:18:42 +01:00
presets fix: fix docker_context module name in nf preset (#2526) 2021-03-28 22:36:09 +02:00
pt-BR docs(i18n): New Crowdin updates (#2362) 2021-03-15 18:18:42 +01:00
pt-PT docs(i18n): New Crowdin updates (#2362) 2021-03-15 18:18:42 +01:00
ru-RU docs(i18n): New Crowdin updates (#2362) 2021-03-15 18:18:42 +01:00
tr-TR docs(i18n): New Crowdin updates (#2362) 2021-03-15 18:18:42 +01:00
vi-VN docs(i18n): New Crowdin updates (#2362) 2021-03-15 18:18:42 +01:00
zh-CN docs(i18n): New Crowdin updates (#2362) 2021-03-15 18:18:42 +01:00
zh-TW docs(i18n): New Crowdin updates (#2362) 2021-03-15 18:18:42 +01:00
README.md fix(tcsh): remove quotes and escape backticks (#2429) 2021-03-12 16:27:04 +01:00
package-lock.json build(deps-dev): bump vuepress from 1.8.1 to 1.8.2 in /docs (#2368) 2021-02-22 14:49:21 -05:00
package.json docs: Add install for chocolatey (#2372) 2021-03-07 15:40:03 -06:00

README.md

home heroImage heroText tagline actionText actionLink features footer metaTitle description
true /logo.svg null The minimal, blazing-fast, and infinitely customizable prompt for any shell! 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 Microsoft.PowerShell_profile.ps1. You can check the location of this file by querying the $PROFILE variable in PowerShell. Typically the path is ~\Documents\PowerShell\Microsoft.PowerShell_profile.ps1 or ~/.config/powershell/Microsoft.PowerShell_profile.ps1 on -Nix.

    Invoke-Expression (&starship init powershell)
    

    Ion

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

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

    Elvish

    ::: warning Only elvish v0.15 or higher is supported. :::

    Add the following to the end of ~/.elvish/rc.elv:

    # ~/.elvish/rc.elv
    
    eval (starship init elvish)
    

    Tcsh

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

    # ~/.tcshrc
    
    eval `starship init tcsh`