Starship

为任何 shell 提供最小的、极快的和无限可定制的提示符。「☄🌌️ The minimal, blazing-fast, and infinitely customizable prompt for any shell!」

Github星跟踪图

Starship:可用于各种 Shell 的提示符

GitHub Actions 工作流状态 Crates.io 版本 打包状态
加入 Discord 在 Twitter 上关注 @Starshipmpt

网站 · 安装 · 配置

English   Deutsch   Español   Français   Bahasa Indonesia   Italiano   日本語   Português do Brasil   Pусский   Українська   Tiếng Việt   简体中文   繁體中文

SWUbanner

 

 

轻量、迅速、可无限定制的高颜值终端!

  • 快: 很快 —— 真的真的非常快! 🚀
  • 定制化: 可定制各种各样的提示符。
  • 通用: 适用于任何 Shell、任何操作系统。
  • 智能: 一目了然地显示相关信息。
  • 功能丰富: 支持所有你喜欢的工具。
  • 易用: 安装快速 —— 几分钟就可上手。

探索 Starship 文档

🚀 安装

前置要求

步骤 1. 安装 Starship

请选择你的操作系统以查看合适的安装教程:

Android

使用下列软件包管理器安装Starship:

软件包来源 指令
Termux pkg install starship
BSD

使用下列软件包管理器安装Starship:

发行版 软件包来源 指令
任意发行版 crates.io cargo install starship --locked
FreeBSD FreshPorts pkg install starship
NetBSD pkgsrc pkgin install starship
Linux

安装最新版本:

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

或者,使用以下任一软件包管理器安装Starship:

发行版 软件包来源 指令
任意发行版 crates.io cargo install starship --locked
任意发行版 conda-forge conda install -c conda-forge starship
任意发行版 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
Void Linux Void Linux Packages xbps-install -S starship
macOS

安装最新版本:

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

或者,使用以下任一软件包管理器安装Starship:

软件包来源 指令
crates.io cargo install starship --locked
conda-forge conda install -c conda-forge starship
Homebrew brew install starship
MacPorts port install starship
Windows

在 发布页 下载 MSI 包来安装最新版。

使用下列软件包管理器安装Starship:

软件包来源 指令
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

步骤 2. Set up your shell to use Starship

配置你的终端来初始化 starship。 请从下面列表选择你的终端:

Bash

在 ~/.bashrc 的最后,添加以下内容:

eval "$(starship init bash)"
 
Cmd

您需要使用 Clink (v1.2.30+) 与 Cmd. 在路径 %LocalAppData%\clink\starship.lua 下创建文件,输入以下内容

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

在 ~/.config/fish/rc.elv 的最后,添加以下内容:

eval (starship init elvish)
 

注意:仅支持 v0.18 及以上版本的 Elvish

Fish

在 ~/.config/fish/config.fish 的最后,添加以下内容:

starship init fish | source
 
Ion

在 ~/.config/ion/initrc 的最后,添加以下内容:

eval $(starship init ion)
 
Nushell

在您的 Nushell 环境文件的最后(使用 $nu.env-path 来获取它的路径),添加以下内容:

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

然后将以下内容添加到您 Nushell 配置文件的末尾(使用 $nu.config-path 来获取它的路径):

use ~/.cache/starship/init.nu
 

注意:仅支持 Nushell v0.78+

PowerShell

将以下内容添加到您 PowerShell 配置文件的末尾(通过运行 $PROFILE 来获取配置文件的路径)

Invoke-Expression (&starship init powershell)
 
Tcsh

在 ~/.tcshrc 的最后,添加以下内容:

eval `starship init tcsh`
 
Xonsh

在 ~/.xonshrc 的最后,添加以下内容:

execx($(starship init xonsh))
 
Zsh

在 ~/.zshrc 的最后,添加以下内容:

eval "$(starship init zsh)"
 

步骤 3. 配置 Starship

打开一个新的 Shell 实例,你应该就能看到漂亮的 Shell 新提示符了。 如果你对默认配置感到满意,那么开始使用吧!

如果你想进一步配置 Starship,查阅下列内容:

  • 配置:学习如何配置 Starship 来调节提示符到你喜欢的样子。

  • 预设:从其他构建好的配置中获取灵感。

🤝 贡献

我们欢迎 任何水平 的参与者! 如果想练手,可以试着解决某个标记为 good first issue 的议题。

如果你精通非英语语言,请协助我们翻译并更新文档,非常感谢! 你可以在 Starship Crowdin 上参与翻译。

如果你想参与 Starship 项目,请查看我们的 贡献指南。 也欢迎加入我们的 Discord 服务器 和大家打个招呼。 👋

💭 该项目受以下项目启发

请看看这些之前的项目,他们启发了 Starship 项目。 🙏

❤️ 赞助商

通过 成为赞助商 来支持这个项目。 您的名字或 LOGO 将在此处显示,并链接到您的网站。

支持者级别


Starship 图标

📝 许可证

版权所有 © 2019 至今, Starship 贡献者.
此项目使用 ISC 许可.

概览

名称与所有者mockingbot/react-native-zip-archive
主编程语言Java
编程语言Rust (语言数: 4)
平台Linux, Mac, Windows, Unix-like
许可证MIT License
发布数54
最新版本名称v6.1.0 (发布于 2023-10-16 14:53:59)
第一版名称0.0.11 (发布于 )
创建于2015-08-26 09:06:18
推送于2024-02-21 07:02:37
最后一次提交2023-10-16 18:39:17
星数403
关注者数13
派生数146
提交数292
已启用问题?
问题数181
打开的问题数22
拉请求数82
打开的拉请求数1
关闭的拉请求数36
已启用Wiki?
已存档?
是复刻?
已锁定?
是镜像?
是私有?

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

Step 1. Install Starship

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

Install Starship using any of the following package managers:

Repository Instructions
Termux pkg install starship

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

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

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

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:

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

eval "$(starship init bash)"

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"))()

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

eval (starship init elvish)

Note: Only Elvish v0.18+ is supported

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

starship init fish | source

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

eval $(starship init ion)

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

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):

use ~/.cache/starship/init.nu

Note: Only Nushell v0.78+ is supported

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

Invoke-Expression (&starship init powershell)

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

eval `starship init tcsh`

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

execx($(starship init xonsh))

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:

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

❤️ Sponsors

Support this project by becoming a sponsor. Your name or logo will show up here with a link to your website.

Supporter Tier

📝 License

Copyright © 2019-present, Starship Contributors.
This project is ISC licensed.

去到顶部