Starship – Cross-shell prompt

GitHub Actions workflow status version Packaging status
Chat on Discord Follow @StarshipPrompt on Twitter

Website · Installation · Configuration

English   日本語   繁體中文   Русский   Deutsch   简体中文   Español   Français   Tiếng Việt

Starship with iTerm2 and the Snazzy theme

The minimal, blazing-fast, and infinitely customizable prompt for any shell!

  • Fast: it's fast – really really fast! 🚀
  • Customizable: configure every aspect of your prompt.
  • Universal: works on any shell, on any operating system.
  • Intelligent: shows relevant information at a glance.
  • Feature rich: support for all your favorite tools.
  • Easy: quick to install – start using it in minutes.

Explore the Starship docs  ▶

# 🚀 Installation

# Prerequisites

# Getting Started

Note: due to the proliferation of different platforms, only a subset of supported platforms are shown below. Can't see yours? Have a look at the extra platform instructions (opens new window).

  1. Install the starship binary:

    # Install Latest Version

    # From prebuilt binary, with Shell:
    sh -c "$(curl -fsSL"

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

    Note - The defaults of the install script can be overridden see the built-in help.

    sh -c "$(curl -fsSL" -- --help

    # Install via Package Manager

    # Example: Homebrew (opens new window):
    brew install starship
    # With Scoop (opens new window):
    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/
    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`

    # Xonsh

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

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

    # 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/",
     "source ~/.cache/starship/"
    prompt = "starship_prompt"

# 🤝 Contributing

We are always looking for contributors of all skill levels! If you're looking to ease your way into the project, try out a good first issue (opens new window).

If you are fluent in a non-English language, we greatly appreciate any help keeping our docs translated and up-to-date in other languages. If you would like to help, translations can be contributed on the Starship Crowdin (opens new window).

If you are interested in helping contribute to starship, please take a look at our Contributing Guide (opens new window). Also, feel free to drop into our Discord server (opens new window) and say hi. 👋

# Code Contributors

This project exists thanks to all the people who contribute. [Contribute (opens new window)].

# Financial Contributors

Become a financial contributor and help us sustain our community. [Contribute (opens new window)]

# Individuals

# Organizations

Support this project with your organization. Your logo will show up here with a link to your website. [Contribute (opens new window)]

# 💭 Inspired By

Please check out these previous works that helped inspire the creation of starship. 🙏

Starship rocket icon

# 📝 License

Copyright © 2019-present, Starship Contributors (opens new window).
This project is ISC (opens new window) licensed.