Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/starship/starship

โ˜„๐ŸŒŒ๏ธ The minimal, blazing-fast, and infinitely customizable prompt for any shell!
https://github.com/starship/starship

bash fish fish-prompt fish-theme oh-my-zsh powershell rust shell-prompt starship zsh zsh-prompt zsh-theme

Last synced: 3 days ago
JSON representation

โ˜„๐ŸŒŒ๏ธ The minimal, blazing-fast, and infinitely customizable prompt for any shell!

Awesome Lists containing this project

README 

        


  Starship โ€“ Cross-shell prompt






  GitHub Actions workflow status

  Crates.io version

  Packaging status


  Chat on Discord

  Follow @StarshipPrompt on Twitter

  Stand With Ukraine






  Website

  ยท

  Installation

  ยท

  Configuration






  English

  ย 

  Deutsch

  ย 

  Espaรฑol

  ย 

  Franรงais

  ย 

  Bahasa Indonesia

  ย 

  Italiano

  ย 

  ๆ—ฅๆœฌ่ชž

  ย 

  Portuguรชs do Brasil

  ย 

  ะ ัƒััะบะธะน

  ย 

  ะฃะบั€ะฐั—ะฝััŒะบะฐ

  ย 

  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



- A [Nerd Font](https://www.nerdfonts.com/) installed and enabled in your terminal (for example, try the [FiraCode Nerd Font](https://www.nerdfonts.com/font-downloads)).



### Step 1. Install Starship



Select your operating system from the list below to view installation instructions:



Android



Install Starship using any of the following package managers:



| Repository | Instructions           |

| ---------- | ---------------------- |

| [Termux]   | `pkg install starship` |



BSD



Install Starship using any of the following package managers:



| Distribution | Repository      | Instructions                      |

| ------------ | --------------- | --------------------------------- |

| **_Any_**    | **[crates.io]** | `cargo install starship --locked` |

| FreeBSD      | [FreshPorts]    | `pkg install starship`            |

| NetBSD       | [pkgsrc]        | `pkgin install starship`          |



Linux



Install the latest version for your system:



```sh

curl -sS https://starship.rs/install.sh | sh

```



Alternatively, install Starship using any of the following package managers:



| Distribution       | Repository              | Instructions                                                  |

| ------------------ | ----------------------- | ------------------------------------------------------------- |

| **_Any_**          | **[crates.io]**         | `cargo install starship --locked`                             |

| _Any_              | [conda-forge]           | `conda install -c conda-forge starship`                       |

| _Any_              | [Linuxbrew]             | `brew install starship`                                       |

| Alpine Linux 3.13+ | [Alpine Linux Packages] | `apk add starship`                                            |

| Arch Linux         | [Arch Linux Extra]      | `pacman -S starship`                                          |

| CentOS 7+          | [Copr]                  | `dnf copr enable atim/starship` 
 `dnf install starship` |

| Gentoo             | [Gentoo Packages]       | `emerge app-shells/starship`                                  |

| Manjaro            |                         | `pacman -S starship`                                          |

| NixOS              | [nixpkgs]               | `nix-env -iA nixpkgs.starship`                                |

| openSUSE           | [OSS]                   | `zypper in starship`                                          |

| Void Linux         | [Void Linux Packages]   | `xbps-install -S starship`                                    |



macOS



Install the latest version for your system:



```sh

curl -sS https://starship.rs/install.sh | sh

```



Alternatively, install Starship using any of the following package managers:



| Repository      | Instructions                            |

| --------------- | --------------------------------------- |

| **[crates.io]** | `cargo install starship --locked`       |

| [conda-forge]   | `conda install -c conda-forge starship` |

| [Homebrew]      | `brew install starship`                 |

| [MacPorts]      | `port install starship`                 |



Windows



Install the latest version for your system with the MSI-installers from the [releases section](https://github.com/starship/starship/releases/latest).



Install Starship using any of the following package managers:



| Repository      | Instructions                            |

| --------------- | --------------------------------------- |

| **[crates.io]** | `cargo install starship --locked`       |

| [Chocolatey]    | `choco install starship`                |

| [conda-forge]   | `conda install -c conda-forge starship` |

| [Scoop]         | `scoop install starship`                |

| [winget]        | `winget install --id Starship.Starship` |



### Step 2. Set up your shell to use Starship



Configure your shell to initialize starship. Select yours from the list below:



Bash



Add the following to the end of `~/.bashrc`:



```sh

eval "$(starship init bash)"

```



Cmd



You need to use [Clink](https://chrisant996.github.io/clink/clink.html) (v1.2.30+) with Cmd.

Create a file at this path `%LocalAppData%\clink\starship.lua` with the following contents:



```lua

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

```



Elvish



Add the following to the end of `~/.elvish/rc.elv`:



```sh

eval (starship init elvish)

```



Note: Only Elvish v0.18+ is supported



Fish



Add the following to the end of `~/.config/fish/config.fish`:



```fish

starship init fish | source

```



Ion



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



```sh

eval $(starship init ion)

```



Nushell



Add the following to the end of your Nushell env file (find it by running `$nu.env-path` in Nushell):



```sh

mkdir ~/.cache/starship

starship init nu | save -f ~/.cache/starship/init.nu

```



And add the following to the end of your Nushell configuration (find it by running `$nu.config-path`):



```sh

use ~/.cache/starship/init.nu

```



Note: Only Nushell v0.78+ is supported



PowerShell



Add the following to the end of your PowerShell configuration (find it by running `$PROFILE`):



```powershell

Invoke-Expression (&starship init powershell)

```



Tcsh



Add the following to the end of `~/.tcshrc`:



```sh

eval `starship init tcsh`

```



Xonsh



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



```python

execx($(starship init xonsh))

```



Zsh



Add the following to the end of `~/.zshrc`:



```sh

eval "$(starship init zsh)"

```



### Step 3. Configure Starship



Start a new shell instance, and you should see your beautiful new shell prompt.

If you're happy with the defaults, enjoy!



If you're looking to further customize Starship:



- **[Configuration](https://starship.rs/config/)** โ€“ learn how to configure Starship to tweak your prompt to your liking



- **[Presets](https://starship.rs/presets/)** โ€“ get inspired by the pre-built configuration of others



## ๐Ÿค 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](https://github.com/starship/starship/labels/๐ŸŒฑ%20good%20first%20issue).



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](https://translate.starship.rs/).



If you are interested in helping contribute to starship, please take a look at our [Contributing Guide](https://github.com/starship/starship/blob/master/CONTRIBUTING.md). Also, feel free to drop into our [Discord server](https://discord.gg/8Jzqu3T) and say hi. ๐Ÿ‘‹



## ๐Ÿ’ญ Inspired By



Please check out these previous works that helped inspire the creation of starship. ๐Ÿ™



- **[denysdovhan/spaceship-prompt](https://github.com/denysdovhan/spaceship-prompt)** โ€“ A ZSH prompt for astronauts.



- **[denysdovhan/robbyrussell-node](https://github.com/denysdovhan/robbyrussell-node)** โ€“ Cross-shell robbyrussell theme written in JavaScript.



- **[reujab/silver](https://github.com/reujab/silver)** โ€“ A cross-shell customizable powerline-like prompt with icons.



## โค๏ธ Sponsors



Support this project by [becoming a sponsor](https://github.com/sponsors/starship). Your name or logo will show up here with a link to your website.



## ๐Ÿ”’ Code Signing Policy



Free code signing provided by [SignPath.io], certificate by [SignPath Foundation].



Code Signing Roles:



- Reviewers: [Astronauts](https://github.com/orgs/starship/teams/astronauts)

- Approvers and Authors: [Mission Control](https://github.com/orgs/starship/teams/mission-control)



This program will not transfer any information to other networked systems unless specifically requested by the user or the person installing or operating it.





    


    Starship rocket icon




## ๐Ÿ“ License



Copyright ยฉ 2019-present, [Starship Contributors](https://github.com/starship/starship/graphs/contributors).


This project is [ISC](https://github.com/starship/starship/blob/master/LICENSE) licensed.



[alpine linux packages]: https://pkgs.alpinelinux.org/packages?name=starship

[arch linux extra]: https://archlinux.org/packages/extra/x86_64/starship

[chocolatey]: https://community.chocolatey.org/packages/starship

[conda-forge]: https://anaconda.org/conda-forge/starship

[copr]: https://copr.fedorainfracloud.org/coprs/atim/starship

[crates.io]: https://crates.io/crates/starship

[freshports]: https://www.freshports.org/shells/starship

[gentoo packages]: https://packages.gentoo.org/packages/app-shells/starship

[linuxbrew]: https://formulae.brew.sh/formula/starship

[homebrew]: https://formulae.brew.sh/formula/starship

[macports]: https://ports.macports.org/port/starship

[nixpkgs]: https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/misc/starship/default.nix

[OSS]: https://software.opensuse.org/package/starship

[pkgsrc]: https://pkgsrc.se/shells/starship

[scoop]: https://github.com/ScoopInstaller/Main/blob/master/bucket/starship.json

[SignPath Foundation]: https://signpath.org

[SignPath.io]: https://signpath.io

[termux]: https://github.com/termux/termux-packages/tree/master/packages/starship

[void linux packages]: https://github.com/void-linux/void-packages/tree/master/srcpkgs/starship

[winget]: https://github.com/microsoft/winget-pkgs/tree/master/manifests/s/Starship/Starship