starship: A Rust repository from ImSejin

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.

🚀 Installation

Prerequisites

A Nerd Font installed and enabled in your terminal (for example, try the Fira Code Nerd Font).

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.

Install the starship binary:

Install Latest Version

From prebuilt binary, 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.

Note - The defaults of the install script can be overridden see the built-in help.
```
sh -c "$(curl -fsSL https://starship.rs/install.sh)" -- --help
```
Install via Package Manager

Example: Homebrew:
```
brew install starship
```
With Scoop:
```
scoop install starship
```
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`
```

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

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

denysdovhan/spaceship-prompt - A ZSH prompt for astronauts.
denysdovhan/robbyrussell-node - Cross-shell robbyrussell theme written in JavaScript.
reujab/silver - A cross-shell customizable powerline-like prompt with icons.

ImSejin/starship

🚀 Installation

Prerequisites

Getting Started

Install Latest Version

From prebuilt binary, with Shell:

Install via Package Manager

Example: Homebrew:

With Scoop:

Bash

Fish

Zsh

PowerShell

Ion

Elvish