Github url

starship

by starship

starship /starship

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

8.3K Stars 368 Forks Last release: 7 days ago (v0.43.0) ISC License 987 Commits 80 Releases

Available items

No Items, yet!

The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:

Starship – Cross-shell prompt

GitHub Actions workflow statusCrates.io versionPackaging status
Chat on DiscordFollow @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
  1. 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.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.