mirror of
https://github.com/Llewellynvdm/starship.git
synced 2024-11-06 05:17:49 +00:00
436 lines
16 KiB
Markdown
436 lines
16 KiB
Markdown
<p align="center">
|
||
<img
|
||
width="400"
|
||
src="https://raw.githubusercontent.com/starship/starship/master/media/logo.png"
|
||
alt="Starship：可用于各种 Shell 的提示符"
|
||
/>
|
||
</p>
|
||
|
||
<p align="center">
|
||
<a href="https://github.com/starship/starship/actions"
|
||
><img
|
||
src="https://img.shields.io/github/actions/workflow/status/starship/starship/workflow.yml?branch=master&label=workflow&style=flat-square"
|
||
alt="GitHub Actions 工作流状态"
|
||
/></a>
|
||
<a href="https://crates.io/crates/starship"
|
||
><img
|
||
src="https://img.shields.io/crates/v/starship?style=flat-square"
|
||
alt="Crates.io 版本"
|
||
/></a>
|
||
<a href="https://repology.org/project/starship/versions"
|
||
><img
|
||
src="https://img.shields.io/repology/repositories/starship?label=in%20repositories&style=flat-square"
|
||
alt="打包状态" /></a
|
||
><br />
|
||
<a href="https://discord.gg/starship"
|
||
><img
|
||
src="https://img.shields.io/discord/567163873606500352?label=discord&logoColor=white&style=flat-square"
|
||
alt="加入 Discord"
|
||
/></a>
|
||
<a href="https://twitter.com/StarshipPrompt"
|
||
><img
|
||
src="https://img.shields.io/badge/twitter-@StarshipPrompt-1DA1F3?style=flat-square"
|
||
alt="在 Twitter 上关注 @Starshipmpt"
|
||
/></a>
|
||
</p>
|
||
|
||
<p align="center">
|
||
<a href="https://starship.rs">网站</a>
|
||
·
|
||
<a href="#🚀-installation">安装</a>
|
||
·
|
||
<a href="https://starship.rs/config/">配置</a>
|
||
</p>
|
||
|
||
<p align="center">
|
||
<a href="https://github.com/starship/starship/blob/master/README.md"
|
||
><img
|
||
height="20"
|
||
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-us.png"
|
||
alt="English"
|
||
/></a>
|
||
|
||
<a
|
||
href="https://github.com/starship/starship/blob/master/docs/de-DE/guide/README.md"
|
||
><img
|
||
height="20"
|
||
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-de.png"
|
||
alt="Deutsch"
|
||
/></a>
|
||
|
||
<a
|
||
href="https://github.com/starship/starship/blob/master/docs/es-ES/guide/README.md"
|
||
><img
|
||
height="20"
|
||
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-es.png"
|
||
alt="Español"
|
||
/></a>
|
||
|
||
<a
|
||
href="https://github.com/starship/starship/blob/master/docs/fr-FR/guide/README.md"
|
||
><img
|
||
height="20"
|
||
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-fr.png"
|
||
alt="Français"
|
||
/></a>
|
||
|
||
<a
|
||
href="https://github.com/starship/starship/blob/master/docs/id-ID/guide/README.md"
|
||
><img
|
||
height="20"
|
||
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-id.png"
|
||
alt="Bahasa Indonesia"
|
||
/></a>
|
||
|
||
<a
|
||
href="https://github.com/starship/starship/blob/master/docs/it-IT/guide/README.md"
|
||
><img
|
||
height="20"
|
||
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-it.png"
|
||
alt="Italiano"
|
||
/></a>
|
||
|
||
<a
|
||
href="https://github.com/starship/starship/blob/master/docs/ja-JP/guide/README.md"
|
||
><img
|
||
height="20"
|
||
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-jp.png"
|
||
alt="日本語"
|
||
/></a>
|
||
|
||
<a
|
||
href="https://github.com/starship/starship/blob/master/docs/pt-BR/guide/README.md"
|
||
><img
|
||
height="20"
|
||
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-br.png"
|
||
alt="Português do Brasil"
|
||
/></a>
|
||
|
||
<a
|
||
href="https://github.com/starship/starship/blob/master/docs/ru-RU/guide/README.md"
|
||
><img
|
||
height="20"
|
||
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-ru.png"
|
||
alt="Pусский"
|
||
/></a>
|
||
|
||
<a
|
||
href="https://github.com/starship/starship/blob/master/docs/vi-VN/guide/README.md"
|
||
><img
|
||
height="20"
|
||
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-vn.png"
|
||
alt="Tiếng Việt"
|
||
/></a>
|
||
|
||
<a
|
||
href="https://github.com/starship/starship/blob/master/docs/zh-CN/guide/README.md"
|
||
><img
|
||
height="20"
|
||
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-cn.png"
|
||
alt="简体中文"
|
||
/></a>
|
||
|
||
<a
|
||
href="https://github.com/starship/starship/blob/master/docs/zh-TW/guide/README.md"
|
||
><img
|
||
height="20"
|
||
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-tw.png"
|
||
alt="繁體中文"
|
||
/></a>
|
||
</p>
|
||
|
||
[](https://vshymanskyy.github.io/StandWithUkraine)
|
||
|
||
<h1></h1>
|
||
|
||
<img
|
||
src="https://raw.githubusercontent.com/starship/starship/master/media/demo.gif"
|
||
alt="使用 iTerm 和 Snazzy 主题的 Starship"
|
||
width="50%"
|
||
align="right"
|
||
/>
|
||
|
||
**轻量、迅速、可无限定制的高颜值终端！**
|
||
|
||
- **快：** 很快 —— 真的真的非常快！ 🚀
|
||
- **定制化：** 可定制各种各样的提示符。
|
||
- **通用：** 适用于任何 Shell、任何操作系统。
|
||
- **智能：** 一目了然地显示相关信息。
|
||
- **功能丰富：** 支持所有你喜欢的工具。
|
||
- **易用：** 安装快速 —— 几分钟就可上手。
|
||
|
||
<p align="center">
|
||
<a href="https://starship.rs/config/"><strong>探索 Starship 文档</strong></a>
|
||
</p>
|
||
|
||
<a name="🚀-installation"></a>
|
||
|
||
## 🚀 安装
|
||
|
||
### 前置要求
|
||
|
||
- 安装并在终端启用 [Nerd Font](https://www.nerdfonts.com/) 字体（如 [Fira Code Nerd Font](https://www.nerdfonts.com/font-downloads) ）。
|
||
|
||
### 步骤 1. 安装 Starship
|
||
|
||
从下面的列表中选择您的操作系统以查看安装指令：
|
||
|
||
<details>
|
||
<summary>Android</summary>
|
||
|
||
使用下列软件包管理器安装Starship：
|
||
|
||
| 软件包来源 | 指令 |
|
||
| --------------------------------------------------------------------------------- | ---------------------- |
|
||
| [Termux](https://github.com/termux/termux-packages/tree/master/packages/starship) | `pkg install starship` |
|
||
|
||
</details>
|
||
|
||
<details>
|
||
<summary>BSD</summary>
|
||
|
||
使用下列软件包管理器安装Starship：
|
||
|
||
| 发行版 | 软件包来源 | 指令 |
|
||
| ----------- | -------------------------------------------------------- | --------------------------------- |
|
||
| **_任意发行版_** | **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` |
|
||
| FreeBSD | [FreshPorts](https://www.freshports.org/shells/starship) | `pkg install starship` |
|
||
| NetBSD | [pkgsrc](https://pkgsrc.se/shells/starship) | `pkgin install starship` |
|
||
|
||
</details>
|
||
|
||
<details>
|
||
<summary>Linux</summary>
|
||
|
||
安装最新版本：
|
||
|
||
```sh
|
||
curl -sS https://starship.rs/install.sh | sh
|
||
```
|
||
|
||
或者，使用以下任一软件包管理器安装Starship：
|
||
|
||
| 发行版 | 软件包来源 | 指令 |
|
||
| ------------------ | ----------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ |
|
||
| **_任意发行版_** | **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` |
|
||
| _任意发行版_ | [conda-forge](https://anaconda.org/conda-forge/starship) | `conda install -c conda-forge starship` |
|
||
| _任意发行版_ | [Linuxbrew](https://formulae.brew.sh/formula/starship) | `brew install starship` |
|
||
| _任意发行版_ | [Snapcraft](https://snapcraft.io/starship) | `snap install starship` |
|
||
| Alpine Linux 3.13+ | [Alpine Linux Packages](https://pkgs.alpinelinux.org/packages?name=starship) | `apk add starship` |
|
||
| Arch Linux | [Arch Linux Community](https://archlinux.org/packages/community/x86_64/starship) | `pacman -S starship` |
|
||
| CentOS 7+ | [Copr](https://copr.fedorainfracloud.org/coprs/atim/starship) | `dnf copr enable atim/starship` <br /> `dnf install starship` |
|
||
| Gentoo | [Gentoo Packages](https://packages.gentoo.org/packages/app-shells/starship) | `emerge app-shells/starship` |
|
||
| Manjaro | | `pacman -S starship` |
|
||
| NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/misc/starship/default.nix) | `nix-env -iA nixpkgs.starship` |
|
||
| Void Linux | [Void Linux Packages](https://github.com/void-linux/void-packages/tree/master/srcpkgs/starship) | `xbps-install -S starship` |
|
||
|
||
</details>
|
||
|
||
<details>
|
||
<summary>macOS</summary>
|
||
|
||
安装最新版本：
|
||
|
||
```sh
|
||
curl -sS https://starship.rs/install.sh | sh
|
||
```
|
||
|
||
或者，使用以下任一软件包管理器安装Starship：
|
||
|
||
| 软件包来源 | 指令 |
|
||
| -------------------------------------------------------- | --------------------------------------- |
|
||
| **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` |
|
||
| [conda-forge](https://anaconda.org/conda-forge/starship) | `conda install -c conda-forge starship` |
|
||
| [Homebrew](https://formulae.brew.sh/formula/starship) | `brew install starship` |
|
||
| [MacPorts](https://ports.macports.org/port/starship) | `port install starship` |
|
||
|
||
</details>
|
||
|
||
<details>
|
||
<summary>Windows</summary>
|
||
|
||
在 [发布页](https://github.com/starship/starship/releases/latest) 下载 MSI 包来安装最新版。
|
||
|
||
使用下列软件包管理器安装Starship：
|
||
|
||
| 软件包来源 | 指令 |
|
||
| -------------------------------------------------------------------------------------------- | --------------------------------------- |
|
||
| **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` |
|
||
| [Chocolatey](https://community.chocolatey.org/packages/starship) | `choco install starship` |
|
||
| [conda-forge](https://anaconda.org/conda-forge/starship) | `conda install -c conda-forge starship` |
|
||
| [Scoop](https://github.com/ScoopInstaller/Main/blob/master/bucket/starship.json) | `scoop install starship` |
|
||
| [winget](https://github.com/microsoft/winget-pkgs/tree/master/manifests/s/Starship/Starship) | `winget install --id Starship.Starship` |
|
||
|
||
</details>
|
||
|
||
### 步骤 2. 设置你的终端以使用 Starship
|
||
|
||
配置你的终端来初始化 starship。 请从下面列表选择你的终端：
|
||
|
||
<details>
|
||
<summary>Bash</summary>
|
||
|
||
在 `~/.bashrc` 的最后，添加以下内容：
|
||
|
||
```sh
|
||
eval "$(starship init bash)"
|
||
```
|
||
|
||
</details>
|
||
|
||
<details>
|
||
<summary>Cmd</summary>
|
||
|
||
您需要使用 [Clink](https://chrisant996.github.io/clink/clink.html) (v1.2.30+) 与 Cmd. 在路径 `%LocalAppData%\clink\starship.lua` 下创建文件，输入以下内容
|
||
|
||
```lua
|
||
load(io.popen('starship init cmd'):read("*a"))()
|
||
```
|
||
|
||
</details>
|
||
|
||
<details>
|
||
<summary>Elvish</summary>
|
||
|
||
在 `~/.config/fish/rc.elv` 的最后，添加以下内容：
|
||
|
||
```sh
|
||
eval (starship init elvish)
|
||
```
|
||
|
||
注意：仅支持 v0.18 及以上版本的 Elvish
|
||
|
||
</details>
|
||
|
||
<details>
|
||
<summary>Fish</summary>
|
||
|
||
在 `~/.config/fish/config.fish` 的最后，添加以下内容：
|
||
|
||
```fish
|
||
starship init fish | source
|
||
```
|
||
|
||
</details>
|
||
|
||
<details>
|
||
<summary>Ion</summary>
|
||
|
||
在 `~/.config/ion/initrc` 的最后，添加以下内容：
|
||
|
||
```sh
|
||
eval $(starship init ion)
|
||
```
|
||
|
||
</details>
|
||
|
||
<details>
|
||
<summary>Nushell</summary>
|
||
|
||
在您的 Nushell 环境文件的最后（使用 `$nu.env-path` 来获取它的路径），添加以下内容：
|
||
|
||
```sh
|
||
mkdir ~/.cache/starship
|
||
starship init nu | save -f ~/.cache/starship/init.nu
|
||
```
|
||
|
||
然后将以下内容添加到您 Nushell 配置文件的末尾（使用 `$nu.config-path` 来获取它的路径）：
|
||
|
||
```sh
|
||
source ~/.cache/starship/init.nu
|
||
```
|
||
|
||
注意：仅支持 Nushell v0.73+
|
||
|
||
</details>
|
||
|
||
<details>
|
||
<summary>PowerShell</summary>
|
||
|
||
将以下内容添加到您 PowerShell 配置文件的末尾（通过运行 `$PROFILE` 来获取配置文件的路径）
|
||
|
||
```powershell
|
||
Invoke-Expression (&starship init powershell)
|
||
```
|
||
|
||
</details>
|
||
|
||
<details>
|
||
<summary>Tcsh</summary>
|
||
|
||
在 `~/.tcshrc` 的最后，添加以下内容：
|
||
|
||
```sh
|
||
eval `starship init tcsh`
|
||
```
|
||
|
||
</details>
|
||
|
||
<details>
|
||
<summary>Xonsh</summary>
|
||
|
||
在 `~/.xonshrc` 的最后，添加以下内容：
|
||
|
||
```python
|
||
execx($(starship init xonsh))
|
||
```
|
||
|
||
</details>
|
||
|
||
<details>
|
||
<summary>Zsh</summary>
|
||
|
||
在 `~/.zshrc` 的最后，添加以下内容：
|
||
|
||
```sh
|
||
eval "$(starship init zsh)"
|
||
```
|
||
|
||
</details>
|
||
|
||
### 步骤 3. 配置 Starship
|
||
|
||
打开一个新的 Shell 实例，你应该就能看到漂亮的 Shell 新提示符了。 如果你对默认配置感到满意，那么开始使用吧！
|
||
|
||
如果你想进一步配置 Starship，查阅下列内容：
|
||
|
||
- **[配置](https://starship.rs/config/)**：学习如何配置 Starship 来调节提示符到你喜欢的样子。
|
||
|
||
- **[预设](https://starship.rs/presets/)**：从其他构建好的配置中获取灵感。
|
||
|
||
## 🤝 贡献
|
||
|
||
我们期待着 **所有技能等级** 的参与者！ 如果你想让自己参与项目的路径轻松一些，可以先试试某个 [good first issue](https://github.com/starship/starship/labels/🌱%20good%20first%20issue)。
|
||
|
||
如果你熟练掌握某个非英语语言，我们非常感谢任何帮助翻译与同步文档到其他语言的贡献。 如果你想要帮忙，可以在 [Starship Crowdin](https://translate.starship.rs/) 上参与。
|
||
|
||
如果你有兴趣贡献 Starship 这个项目，请先看看我们的 [贡献指南](https://github.com/starship/starship/blob/master/CONTRIBUTING.md)。 也欢迎加入我们的 [Discord 服务器](https://discord.gg/8Jzqu3T) 和大家打个招呼。 👋
|
||
|
||
## 💭 该项目受以下项目启发
|
||
|
||
请看看这些之前的项目，他们启发了 Starship 项目。 🙏
|
||
|
||
- **[denysdovhan/spaceship-prompt](https://github.com/denysdovhan/spaceship-prompt)** – 为宇航员准备的 ZSH 提示符。
|
||
|
||
- **[denysdovhan/robbyrussell-node](https://github.com/denysdovhan/robbyrussell-node)** – 可用于所有 Shell 的 Robbyrussell 主题，使用 JavaScript 编写。
|
||
|
||
- **[reujab/silver](https://github.com/reujab/silver)** – 带图标且可定制的类 Powerline 提示符，适用于所有 Shell。
|
||
|
||
## ❤️ 赞助商
|
||
|
||
通过 [成为赞助商 ](https://github.com/sponsors/starship)来支持这个项目。 您的名字或 LOGO 将在此处显示，并链接到您的网站。
|
||
|
||
**支持者级别**
|
||
|
||
- [Dimension](https://dimension.dev/)
|
||
- [Appwrite](https://appwrite.io/)
|
||
|
||
<p align="center">
|
||
<br>
|
||
<img width="100" src="https://raw.githubusercontent.com/starship/starship/master/media/icon.png" alt="Starship 图标">
|
||
</p>
|
||
|
||
## 📝 许可证
|
||
|
||
版权所有 © 2019 至今, [Starship 贡献者](https://github.com/starship/starship/graphs/contributors).<br /> 此项目使用 [ISC](https://github.com/starship/starship/blob/master/LICENSE) 许可.
|