🌌️ The minimal, blazing-fast, and infinitely customizable prompt for any shell!
Go to file
2020-04-24 19:37:34 +02:00
.github chore: update "ask a question" to direct to the new discussion page 2020-04-02 00:10:09 -04:00
docs docs: Remove unused closing tag from config page (#1125) 2020-04-20 14:51:36 +02:00
install feat(installer): Ask for permission escalation during installation, if needed (#914) 2020-02-12 21:13:21 -05:00
media chore(bump): v0.35.0 2020-02-06 09:56:39 -05:00
src fix(crystal): Add Crystal module to default prompt order (#1140) 2020-04-24 19:37:34 +02:00
starship_module_config_derive docs: Replace project tagline 2020-02-12 21:46:00 -05:00
tests fix: Fix latest clippy suggestions (#1136) 2020-04-24 12:37:13 +02:00
.gitignore chore: Cleanup after the config refactor (#453) 2019-09-30 23:56:05 +09:00
Cargo.lock build(deps): bump git2 from 0.13.3 to 0.13.4 (#1135) 2020-04-24 14:48:44 +02:00
Cargo.toml build(deps): bump git2 from 0.13.3 to 0.13.4 (#1135) 2020-04-24 14:48:44 +02:00
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md (#42) 2019-04-30 23:30:42 -04:00
CONTRIBUTING.md fix: possible fix for Intermittent Test Failures in GH Actions (#987) 2020-03-15 12:12:25 -05:00
crowdin.yml docs: Fix link to Japanese README 2019-10-11 17:32:52 +09:00
LICENSE docs: Attribute copyright to Starship Contributors (#115) 2019-07-25 12:50:29 -04:00
README.md docs: Fix broken installation link anchor on README (#1033) 2020-04-20 12:43:24 -05:00
snapcraft.yaml docs: Replace project tagline 2020-02-12 21:46:00 -05:00

Starship – Cross-shell prompt

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

Website · Installation · Configuration

English   日本語   繁體中文   Русский   Deutsch   简体中文   Español   Français

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

  1. Install the starship binary:

    Install Latest Version

    From prebuilt binary, with Shell:
    curl -fsSL https://starship.rs/install.sh | bash
    
    From source on crates.io:
    cargo install starship
    

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

    Invoke-Expression (&starship init powershell)
    

    Ion

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

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

🤝 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.

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

Code Contributors

This project exists thanks to all the people who contribute. [Contribute].

Financial Contributors

Become a financial contributor and help us sustain our community. [Contribute]

Individuals

Organizations

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

💭 Inspired By

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


Starship rocket icon

📝 License

Copyright © 2019-present, Starship Contributors.
This project is ISC licensed.