📖 项目介绍

width="400"
src="https://raw.githubusercontent.com/starship/starship/master/media/logo.png"
alt="Starship – Cross-shell prompt"
/>

> src="https://img.shields.io/github/actions/workflow/status/starship/starship/workflow.yml?branch=master&label=workflow&style=flat-square"
alt="GitHub Actions workflow status"
/>
> src="https://img.shields.io/crates/v/starship?style=flat-square"
alt="Crates.io version"
/>
> src="https://img.shields.io/repology/repositories/starship?label=in%20repositories&style=flat-square"
alt="Packaging status"/> >

> src="https://img.shields.io/discord/567163873606500352?label=discord&logoColor=white&style=flat-square"
alt="Chat on Discord"
/>
> src="https://img.shields.io/badge/twitter-@StarshipPrompt-1DA1F3?style=flat-square"
alt="Follow @StarshipPrompt on Twitter"
/>
> src="https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/badges/StandWithUkraineFlat.svg"
alt="Stand With Ukraine"
/>

Website
·
Installation
·
Configuration

> height="20"
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-us.png"
alt="English"
/>
 
href="https://github.com/starship/starship/blob/master/docs/de-DE/guide/README.md"
> height="20"
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-de.png"
alt="Deutsch"
/>
 
href="https://github.com/starship/starship/blob/master/docs/es-ES/guide/README.md"
> height="20"
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-es.png"
alt="Español"
/>
 
href="https://github.com/starship/starship/blob/master/docs/fr-FR/guide/README.md"
> height="20"
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-fr.png"
alt="Français"
/>
 
href="https://github.com/starship/starship/blob/master/docs/id-ID/guide/README.md"
> height="20"
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-id.png"
alt="Bahasa Indonesia"
/>
 
href="https://github.com/starship/starship/blob/master/docs/it-IT/guide/README.md"
> height="20"
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-it.png"
alt="Italiano"
/>
 
href="https://github.com/starship/starship/blob/master/docs/ja-JP/guide/README.md"
> height="20"
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-jp.png"
alt="日本語"
/>
 
href="https://github.com/starship/starship/blob/master/docs/pt-BR/guide/README.md"
> height="20"
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-br.png"
alt="Português do Brasil"
/>
 
href="https://github.com/starship/starship/blob/master/docs/ru-RU/guide/README.md"
> height="20"
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-ru.png"
alt="Русский"
/>
 
href="https://github.com/starship/starship/blob/master/docs/uk-UA/guide/README.md"
> height="20"
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-ua.png"
alt="Українська"
/>
 
href="https://github.com/starship/starship/blob/master/docs/vi-VN/guide/README.md"
> height="20"
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-vn.png"
alt="Tiếng Việt"
/>
 
href="https://github.com/starship/starship/blob/master/docs/zh-CN/guide/README.md"
> height="20"
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-cn.png"
alt="简体中文"
/>
 
href="https://github.com/starship/starship/blob/master/docs/zh-TW/guide/README.md"
> height="20"
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-tw.png"
alt="繁體中文"
/>

src="https://raw.githubusercontent.com/starship/starship/master/media/demo.gif"
alt="Starship with iTerm2 and the Snazzy theme"
width="50%"
align="right"
/>

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 installed and enabled in your terminal (for example, try the FiraCode Nerd Font).

Step 1. Install Starship

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

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

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

Step 2. Set up your shell to use Starship

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

sh
eval "$(starship init bash)"

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

sh
eval (starship init elvish)

fish
starship init fish | source

sh
eval $(starship init ion)

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

powershell
Invoke-Expression (&starship init powershell)

sh
eval starship init tcsh

python
execx($(starship init xonsh))

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 – learn how to configure Starship to tweak your prompt to your liking

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

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

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

❤️ 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:

- Reviewers: Astronauts
- Approvers and Authors: 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.

📝 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