starship/starship

▲ 25 stars today★ 60,329⑂ 2,711

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

Open on GitHub ↗

About starship/starship

starship/starship is an open-source project on GitHub, mainly written in Rust. ☄🌌️ The minimal, blazing-fast, and infinitely customizable prompt for any shell! It currently holds 60,329 stars and 2,711 forks with 0 open issues, and was last pushed on an unknown date (repository created unknown).

Project Overview

AI Homed tracks it on the Today's Trending board, currently at rank #54 with 25 new stars today.

GitHub Repository Details

Repository starship/starship · default branch - · size 0 KB · watchers 0 · source: GitHub REST API and repository README

README

https://github.com/starship/starship/blob/HEAD/Starship – Cross-shell prompt

https://github.com/starship/starship/blob/HEAD/GitHub Actions workflow status https://github.com/starship/starship/blob/HEAD/Crates.io version https://github.com/starship/starship/blob/HEAD/Packaging status
https://github.com/starship/starship/blob/HEAD/Chat on Discord https://github.com/starship/starship/blob/HEAD/Follow @StarshipPrompt on Twitter https://github.com/starship/starship/blob/HEAD/Stand With Ukraine

Website · Installation · Configuration

https://github.com/starship/starship/blob/HEAD/English   https://github.com/starship/starship/blob/HEAD/Deutsch   https://github.com/starship/starship/blob/HEAD/Español   https://github.com/starship/starship/blob/HEAD/Français   https://github.com/starship/starship/blob/HEAD/Bahasa Indonesia   https://github.com/starship/starship/blob/HEAD/Italiano   https://github.com/starship/starship/blob/HEAD/日本語   https://github.com/starship/starship/blob/HEAD/Português do Brasil   https://github.com/starship/starship/blob/HEAD/Русский   https://github.com/starship/starship/blob/HEAD/Українська   https://github.com/starship/starship/blob/HEAD/Tiếng Việt   https://github.com/starship/starship/blob/HEAD/简体中文   https://github.com/starship/starship/blob/HEAD/繁體中文

https://github.com/starship/starship/blob/HEAD/Starship with iTerm2 and the Snazzy theme

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

Explore the Starship docs  ▶

🚀 Installation

Prerequisites

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:

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 | | Debian 13+ | [Debian Main] | apt install starship | | Fedora 40+ | [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 | | Ubuntu 25.04+ | [Ubuntu Universe] | apt install starship | | Void Linux | [Void Linux Packages] | xbps-install -S starship |

macOS

Install the latest version for your system:

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.

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:

eval "$(starship init bash)"

Cmd

You need to use Clink (v1.2.30+) with Cmd. Create a file at this path %LocalAppData%\clink\starship.lua with the following contents:

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

Elvish

Add the following to the end of ~/.config/elvish/rc.elv (%AppData%\elvish\rc.elv on Windows):

eval (starship init elvish)

Note: Only Elvish v0.18+ is supported. For elvish versions prior to v0.21.0 the config file might instead be ~/.elvish/rc.elv

Fish

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

starship init fish | source

Ion

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

eval $(starship init ion)

Nushell

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

mkdir ($nu.data-dir | path join "vendor/autoload")
starship init nu | save -f ($nu.data-dir | path join "vendor/autoload/starship.nu")

Note: Only Nushell v0.96+ is supported

PowerShell

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

Invoke-Expression (&starship init powershell)

Tcsh

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

eval starship init tcsh

Xonsh

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

execx($(starship init xonsh))

Zsh

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

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:

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

💭 Inspired By

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

❤️ Sponsors

Support this project by becoming a sponsor. 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:

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


https://github.com/starship/starship/blob/HEAD/Starship rocket icon

📝 License

Copyright © 2019-present, Starship Contributors.
This project is ISC 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 [debian main]: https://sources.debian.org/src/starship/1.22.1-1/ [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/by-name/st/starship/package.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 [ubuntu universe]: https://packages.ubuntu.com/source/plucky/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

GitHub Stars & Activity

60,329Stars
2,711Forks
0Open issues
RustLanguage

GitHub Popularity

GitHub stars60,329
Forks2,711
Open issues0
Primary languageRust
License-
Stars gained today25
Created-
Last pushed-

Trending History

Daily boardrank #54 · ▲ 25 stars

Related AI Projects

1

rtk-ai / rtk

Rust★ 83,857⑂ 5,327▲ 160 stars
→
2

googleworkspace / cli

Rust★ 31,649⑂ 1,993▲ 51 stars
→
3

akitaonrails / ai-memory

Rust★ 10,370⑂ 743▲ 513 stars
→
4

xerj-org / xerj

Rust★ 8,314⑂ 443▲ 842 stars
→
5

GCWing / OpenBitFun

Rust★ 2,849⑂ 271▲ 21 stars
→
6

mixelpixx / Konnect

Rust★ 1,278⑂ 144▲ 47 stars
→
7

reason-machines / reason-network

Rust★ 396⑂ 30
→
8

fzn0x / idx

Rust★ 115⑂ 2
→

More AI Rankings