starship/docs
Eric Drechsel f38c2a09e4
docs: remove enableZshIntegration from homemanager installation (#3671)
2022-02-28 14:15:19 -05:00
..
.vuepress ci: Use `dprint` to format documentation + TOML files (#3426) 2022-01-20 11:32:09 +03:00
advanced-config docs: Add set commands to advanced config doc (#1526) 2022-01-21 17:26:27 +01:00
ar-SA docs(i18n): new Crowdin updates (#3460) 2022-02-07 15:53:55 +01:00
ckb-IR docs(i18n): new Crowdin updates (#3460) 2022-02-07 15:53:55 +01:00
config docs(directory): add missing doc on option directory.repo_root_format (#3550) 2022-02-20 18:23:35 +01:00
de-DE docs(i18n): new Crowdin updates (#3460) 2022-02-07 15:53:55 +01:00
es-ES docs(i18n): new Crowdin updates (#3460) 2022-02-07 15:53:55 +01:00
faq ci: Use `dprint` to format documentation + TOML files (#3426) 2022-01-20 11:32:09 +03:00
fr-FR docs(i18n): new Crowdin updates (#3460) 2022-02-07 15:53:55 +01:00
guide docs: Add vuepress with initial docs (#99) 2019-07-19 16:18:52 -04:00
id-ID docs(i18n): new Crowdin updates (#3460) 2022-02-07 15:53:55 +01:00
installing docs: remove enableZshIntegration from homemanager installation (#3671) 2022-02-28 14:15:19 -05:00
it-IT docs(i18n): new Crowdin updates (#3460) 2022-02-07 15:53:55 +01:00
ja-JP docs(i18n): new Crowdin updates (#3460) 2022-02-07 15:53:55 +01:00
ko-KR docs(i18n): new Crowdin updates (#3460) 2022-02-07 15:53:55 +01:00
migrating-to-0.45.0 ci: Use `dprint` to format documentation + TOML files (#3426) 2022-01-20 11:32:09 +03:00
nl-NL docs(i18n): new Crowdin updates (#3460) 2022-02-07 15:53:55 +01:00
pl-PL docs(i18n): new Crowdin updates (#3460) 2022-02-07 15:53:55 +01:00
presets docs(preset): Fix redundant space in duration bracket preset (#3548) 2022-01-31 15:16:41 -06:00
pt-BR docs(i18n): new Crowdin updates (#3460) 2022-02-07 15:53:55 +01:00
pt-PT docs(i18n): new Crowdin updates (#3460) 2022-02-07 15:53:55 +01:00
ru-RU docs(i18n): new Crowdin updates (#3460) 2022-02-07 15:53:55 +01:00
tr-TR docs(i18n): new Crowdin updates (#3460) 2022-02-07 15:53:55 +01:00
vi-VN docs(i18n): new Crowdin updates (#3460) 2022-02-07 15:53:55 +01:00
zh-CN docs(i18n): new Crowdin updates (#3460) 2022-02-07 15:53:55 +01:00
zh-TW docs(i18n): new Crowdin updates (#3460) 2022-02-07 15:53:55 +01:00
README.md ci: Use `dprint` to format documentation + TOML files (#3426) 2022-01-20 11:32:09 +03:00
package-lock.json build: bump url-parse from 1.5.4 to 1.5.10 in /docs (#3663) 2022-02-26 18:35:47 -06:00
package.json build: bump vuepress from 1.9.5 to 1.9.7 in /docs (#3494) 2022-01-25 10:53:09 -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, Tcsh, Elvish, Nu, Xonsh, Cmd, and PowerShell.

Prerequisites

  • A Nerd Font installed and enabled in your terminal.

Quick Install

  1. Install the starship binary:

    Install Latest Version

    With Shell:

    sh -c "$(curl -fsSL https://starship.rs/install.sh)"
    

    To update the Starship itself, rerun the above script. It will replace the current version without touching Starship's configuration.

    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.17 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`
    

    Nushell

    ::: warning This will change in the future. Only nu version v0.33 or higher is supported. ::: Add the following to your nu config file. You can check the location of this file by running config path in nu.

    startup = [
      "mkdir ~/.cache/starship",
      "starship init nu | save ~/.cache/starship/init.nu",
      "source ~/.cache/starship/init.nu",
    ]
    prompt = "starship_prompt"
    

    Xonsh

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

    # ~/.xonshrc
    
    execx($(starship init xonsh))
    

    Cmd

    You need to use Clink (v1.2.30+) with Cmd. Add the following to a file starship.lua and place this file in Clink scripts directory:

    -- starship.lua
    
    load(io.popen('starship init cmd'):read("*a"))()