2019-09-18 15:43:59 +00:00
< p align = "center" >
2020-04-03 16:35:39 +00:00
< img
2019-09-18 15:43:59 +00:00
width="400"
src="https://raw.githubusercontent.com/starship/starship/master/media/logo.png"
2019-09-28 11:31:56 +00:00
alt="Starship – Cross-shell prompt" />
2019-09-18 15:43:59 +00:00
< / p >
2020-04-03 16:35:39 +00:00
2019-09-18 15:43:59 +00:00
< p align = "center" >
2019-10-11 08:31:19 +00:00
< a href = "https://github.com/starship/starship/actions"
>< img
2020-04-03 16:35:39 +00:00
src="https://img.shields.io/github/workflow/status/starship/starship/Main workflow/master?label=workflow& style=flat-square"
2019-10-11 08:31:19 +00:00
alt="GitHub Actions workflow status" />< / a >
< a href = "https://crates.io/crates/starship"
2020-04-03 16:35:39 +00:00
>< img
src="https://img.shields.io/crates/v/starship?style=flat-square"
alt="Crates.io version" />< / a >
2019-10-11 08:31:19 +00:00
< a href = "https://repology.org/project/starship/versions"
>< img
2020-04-03 16:35:39 +00:00
src="https://img.shields.io/repology/repositories/starship?label=in%20repositories& style=flat-square"
2019-10-11 08:31:19 +00:00
alt="Packaging status" />< /a
2019-10-21 14:42:08 +00:00
>< br / >
2020-04-03 16:35:39 +00:00
< a href = "https://discord.gg/8Jzqu3T"
2019-10-11 08:31:19 +00:00
>< img
2020-04-03 16:35:39 +00:00
src="https://img.shields.io/discord/567163873606500352?label=discord& logoColor=white& style=flat-square"
2019-11-02 11:12:46 +00:00
alt="加入 Discord" />< / a >
2020-04-03 16:35:39 +00:00
< a href = "https://twitter.com/StarshipPrompt"
>< img
src="https://img.shields.io/badge/twitter-@StarshipPrompt-1DA1F3?style=flat-square"
alt="Follow @StarshipPrompt on Twitter" /></ a >
2019-09-18 15:43:59 +00:00
< / p >
2019-10-11 08:31:19 +00:00
2020-04-03 16:35:39 +00:00
< p align = "center" >
2019-11-02 11:12:46 +00:00
< a href = "https://starship.rs" > 网站< / a >
2019-09-18 15:43:59 +00:00
·
2020-05-05 17:07:34 +00:00
< a href = "#🚀-installation" > 安装< / a >
2019-09-18 15:43:59 +00:00
·
2019-11-02 11:12:46 +00:00
< a href = "https://starship.rs/config/" > 配置< / a >
2020-04-03 16:35:39 +00:00
< / p >
2019-10-11 08:31:19 +00:00
< p align = "center" >
< a href = "https://github.com/starship/starship/blob/master/README.md"
2020-04-03 16:35:39 +00:00
>< img
height="20"
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-us.png"
alt="English" />< / a >
2019-12-06 22:07:57 +00:00
2020-04-03 16:35:39 +00:00
< 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 >
2019-12-06 22:07:57 +00:00
2020-04-03 16:35:39 +00:00
< 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 >
2019-12-06 22:07:57 +00:00
2020-04-03 16:35:39 +00:00
< 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="Русский" />< / a >
2020-01-21 16:15:25 +00:00
2020-04-03 16:35:39 +00:00
< 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 >
2020-01-23 16:27:26 +00:00
2020-04-03 16:35:39 +00:00
< 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 >
2019-12-06 22:07:57 +00:00
2020-01-15 17:23:25 +00:00
< a href = "https://translate.starship.rs/project/starship-prompt/es"
2020-04-03 16:35:39 +00:00
>< img
height="20"
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-es.png"
alt="Español" />< / a >
2020-01-15 17:23:25 +00:00
2019-10-11 08:31:19 +00:00
< a href = "https://translate.starship.rs/project/starship-prompt/fr"
2020-04-03 16:35:39 +00:00
>< img
height="20"
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-fr.png"
alt="Français" />< / a >
2019-10-11 08:31:19 +00:00
< / p >
2019-09-18 15:43:59 +00:00
< h1 > < / h1 >
2020-04-03 16:35:39 +00:00
< img
src="https://raw.githubusercontent.com/starship/starship/master/media/demo.gif"
alt="使用 iTerm 和 Snazz 主题的 Starship"
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.
2019-09-18 15:43:59 +00:00
< p align = "center" >
2020-04-03 16:35:39 +00:00
< a href = "https://starship.rs/" > < strong > Explore the Starship docs ▶< / strong > < / a >
2019-09-18 15:43:59 +00:00
< / p >
2020-05-05 17:07:34 +00:00
< a name = "🚀-installation" > < / a >
2019-10-21 14:42:08 +00:00
## 🚀 安装
2019-09-18 15:43:59 +00:00
2020-02-04 17:11:36 +00:00
### 前置要求
2019-09-18 15:43:59 +00:00
2020-07-23 21:07:10 +00:00
- A [Nerd Font ](https://www.nerdfonts.com/ ) installed and enabled in your terminal (for example, try the [Fira Code Nerd Font ](https://www.nerdfonts.com/font-downloads )).
2019-09-18 15:43:59 +00:00
2020-02-04 17:11:36 +00:00
### 开始安装
2019-09-18 15:43:59 +00:00
2019-10-21 14:42:08 +00:00
1. 安装 **starship** 二进制文件:
2019-09-18 15:43:59 +00:00
2020-02-04 17:11:36 +00:00
#### 安装最新版本
2019-09-18 15:43:59 +00:00
2020-02-04 17:11:36 +00:00
##### 下载预构建的二进制文件,使用 Shell 命令:
2019-09-18 15:43:59 +00:00
```sh
2019-12-14 23:46:45 +00:00
curl -fsSL https://starship.rs/install.sh | bash
2019-09-18 15:43:59 +00:00
```
2019-09-28 11:31:56 +00:00
2020-02-04 17:11:36 +00:00
##### 直接从 [crates.io ](https://crates.io/ ) 获取源代码编译:
2020-01-15 17:23:25 +00:00
```sh
cargo install starship
```
2020-02-04 17:11:36 +00:00
#### 通过软件包管理器安装
2019-09-18 15:43:59 +00:00
2020-02-04 17:11:36 +00:00
##### 使用 [Homebrew ](https://brew.sh/ )
2019-09-18 15:43:59 +00:00
```sh
2019-12-06 22:07:57 +00:00
brew install starship
2019-09-18 15:43:59 +00:00
```
2019-09-28 11:31:56 +00:00
2020-02-04 17:11:36 +00:00
##### 使用 [Scoop ](https://scoop.sh ):
2019-09-18 15:43:59 +00:00
2019-12-06 22:07:57 +00:00
```powershell
scoop install starship
2019-10-21 14:42:08 +00:00
```
1. 将初始化脚本添加到您的 shell 的配置文件:
2019-09-28 11:31:56 +00:00
2019-09-18 15:43:59 +00:00
#### Bash
2019-10-21 14:42:08 +00:00
在 `~/.bashhrc` 的最后,添加以下内容:
2019-09-18 15:43:59 +00:00
```sh
# ~/.bashrc
eval "$(starship init bash)"
```
2019-09-28 11:31:56 +00:00
2019-09-18 15:43:59 +00:00
#### Fish
2019-10-21 14:42:08 +00:00
在 `~/.config/fish/config.fish` 的最后,添加以下内容:
2019-09-18 15:43:59 +00:00
```sh
# ~/.config/fish/config.fish
2019-10-29 03:48:45 +00:00
starship init fish | source
2019-09-18 15:43:59 +00:00
```
2019-09-28 11:31:56 +00:00
2019-09-18 15:43:59 +00:00
#### Zsh
2019-10-21 14:42:08 +00:00
在 `~/.zshrc` 的最后,添加以下内容:
2019-09-18 15:43:59 +00:00
```sh
# ~/.zshrc
eval "$(starship init zsh)"
```
2019-10-21 14:42:08 +00:00
2019-12-24 21:54:29 +00:00
#### PowerShell
2019-10-21 14:42:08 +00:00
2020-02-04 17:11:36 +00:00
将以下内容添加到`~\Documents\PowerShell\Microsoft.PowerShell_profile.ps1` (或`~/.config/powershell/Microsoft.PowerShell_profile.ps1`,对于 *nix 系统):
2019-10-21 14:42:08 +00:00
```sh
Invoke-Expression (& starship init powershell)
```
2019-12-14 23:46:45 +00:00
#### Ion
2020-02-04 17:11:36 +00:00
在 `~/.config/ion/initrc` 的最后,添加以下内容:
2019-12-14 23:46:45 +00:00
```sh
# ~/.config/ion/initrc
eval $(starship init ion)
```
2019-10-21 14:42:08 +00:00
## 🤝 贡献
2019-09-18 15:43:59 +00:00
2020-04-03 16:35:39 +00:00
我们一直在寻找贡献者!你都可以参与贡献 ** 不论你的技能如何 ** 。 如果您希望快速为项目作出贡献,请尝试解决 [good first issue ](https://github.com/starship/starship/labels/🌱%20good%20first%20issue )。
2019-09-18 15:43:59 +00:00
2019-11-02 11:12:46 +00:00
如果您有兴趣贡献于 Starship, 请查看我们的[贡献指南](https://github.com/starship/starship/blob/master/CONTRIBUTING.md)。 另外,你可以自由加入我们的 [Discord 服务器 ](https://discord.gg/8Jzqu3T ) 。 👋
2019-09-18 15:43:59 +00:00
2020-04-06 18:48:26 +00:00
### Code Contributors
2020-07-23 21:07:10 +00:00
This project exists thanks to all the people who contribute. [[Contribute ](https://github.com/starship/starship/blob/master/CONTRIBUTING.md )].
2020-04-06 18:48:26 +00:00
< a href = "https://github.com/starship/starship/graphs/contributors" > < img src = "https://opencollective.com/starship/contributors.svg?width=890&button=false" / > < / a >
### Financial Contributors
Become a financial contributor and help us sustain our community. [[Contribute ](https://opencollective.com/starship/contribute )]
#### Individuals
< a href = "https://opencollective.com/starship" > < img src = "https://opencollective.com/starship/individuals.svg?width=890" > < / a >
#### Organizations
Support this project with your organization. Your logo will show up here with a link to your website. [[Contribute ](https://opencollective.com/starship/contribute )]
< a href = "https://opencollective.com/starship/organization/0/website" > < img src = "https://opencollective.com/starship/organization/0/avatar.svg" > < / a >
< a href = "https://opencollective.com/starship/organization/1/website" > < img src = "https://opencollective.com/starship/organization/1/avatar.svg" > < / a >
< a href = "https://opencollective.com/starship/organization/2/website" > < img src = "https://opencollective.com/starship/organization/2/avatar.svg" > < / a >
< a href = "https://opencollective.com/starship/organization/3/website" > < img src = "https://opencollective.com/starship/organization/3/avatar.svg" > < / a >
< a href = "https://opencollective.com/starship/organization/4/website" > < img src = "https://opencollective.com/starship/organization/4/avatar.svg" > < / a >
< a href = "https://opencollective.com/starship/organization/5/website" > < img src = "https://opencollective.com/starship/organization/5/avatar.svg" > < / a >
< a href = "https://opencollective.com/starship/organization/6/website" > < img src = "https://opencollective.com/starship/organization/6/avatar.svg" > < / a >
< a href = "https://opencollective.com/starship/organization/7/website" > < img src = "https://opencollective.com/starship/organization/7/avatar.svg" > < / a >
< a href = "https://opencollective.com/starship/organization/8/website" > < img src = "https://opencollective.com/starship/organization/8/avatar.svg" > < / a >
< a href = "https://opencollective.com/starship/organization/9/website" > < img src = "https://opencollective.com/starship/organization/9/avatar.svg" > < / a >
2019-10-21 14:42:08 +00:00
## 💭该项目受以下项目启发
2019-09-18 15:43:59 +00:00
2020-05-05 17:07:34 +00:00
请参考这些曾经为 Starship 提供启发的工程。 🙏
2019-09-18 15:43:59 +00:00
2019-10-04 08:57:43 +00:00
- **[denysdovhan/spaceship-prompt](https://github.com/denysdovhan/spaceship-prompt)** - A ZSH prompt for astronauts.
2019-09-18 15:43:59 +00:00
2019-10-04 08:57:43 +00:00
- **[denysdovhan/robbyrussell-node](https://github.com/denysdovhan/robbyrussell-node)** - Cross-shell robbyrussell theme written in JavaScript.
2019-09-18 15:43:59 +00:00
2019-10-04 08:57:43 +00:00
- **[reujab/silver](https://github.com/reujab/silver)** - A cross-shell customizable powerline-like prompt with icons.
2019-09-18 15:43:59 +00:00
< p align = "center" >
< br >
2019-09-28 11:31:56 +00:00
< img width = "100" src = "https://raw.githubusercontent.com/starship/starship/master/media/icon.png" alt = "Starship rocket icon" >
2019-09-18 15:43:59 +00:00
< / p >
2019-10-04 08:57:43 +00:00
## 📝 License
2019-09-18 15:43:59 +00:00
2019-10-04 08:57:43 +00:00
Copyright © 2019-present, [Starship Contributors ](https://github.com/starship/starship/graphs/contributors ).< br /> This project is [ISC ](https://github.com/starship/starship/blob/master/LICENSE ) licensed.