summaryrefslogtreecommitdiffstats
path: root/docs/zh-CN/README.md
blob: 4ce164ea31f219076124f2b23132a535a8ffbc06 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
---
home: true
heroImage: /logo.svg
heroText:
tagline: 轻量、迅速、客制化的高颜值终端!
actionText: 快速上手 →
actionLink: ./guide/
features:
  - 
    title: 兼容性优先
    details: Starship 可以在常见的操作系统和 shell 上运行。 尝试着在各种地方使用它吧!
  - 
    title: 基于 Rust
    details: Rust 特有的的速度与安全性,让你的提示尽可能的快速可靠。
  - 
    title: 客制化
    details: 每个小细节都可以按您喜欢的客制化,不论是最小化以求速度,还是更大以获得最完善的功能。
footer: ISC 许可 | 版权所有 © 2019至今 - Starship 贡献者
#Used for the description meta tag, for SEO
metaTitle: "Starship:可用于各种 Shell 的提示符"
description: Starship是一款轻量、迅速、可客制化的高颜值终端! 只显示所需要的信息,将优雅和轻量化合二为一。 可以为Bash、Fish、ZSH、Ion、Tcsh、Elvish、Nu、Xonsh、Cmd和PowerShell执行快速安装。
---

<div class="center">
  <video class="demo-video" muted autoplay loop playsinline>
    <source src="/demo.webm" type="video/webm">
    <source src="/demo.mp4" type="video/mp4">
  </video>
</div>

### 前置要求

- 安装并在你的终端启用 [Nerd Font](https://www.nerdfonts.com/) 。

### 快速安装

1. 安装 **starship** 二进制文件:


   #### 安装最新版本

   使用 Shell 命令:

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

   要更新 Starship ,运行上面的脚本 将会在不改动 Starship 配置文件的情况下升级版本


   #### 通过软件包管理器安装

   使用 [Homebrew](https://brew.sh/):

   ```sh
   brew install starship
   ```
   使用 [ Winget](https://github.com/microsoft/winget-cli):

   ```powershell
   winget install starship
   ```

1. 将初始化脚本添加到您的 shell 的配置文件中:


   #### Bash

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

   ```sh
   # ~/.bashrc

   eval "$(starship init bash)"
   ```


   #### Fish

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

   ```sh
   # ~/.config/fish/config.fish

   starship init fish | source
   ```


   #### Zsh

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

   ```sh
   # ~/.zshrc

   eval "$(starship init zsh)"
   ```


   #### PowerShell

   将以下内容添加到 `Microsoft.PowerShell_profile.ps1`。 你可以在 PowerShell 通过 `$PROFILE` 变量来查询文件的位置。 对于 -Nix 来说,通常文件路径是 `~\Documents\PowerShell\Microsoft.PowerShell_profile.ps1``~/.config/powershell/Microsoft.PowerShell_profile.ps1`   ```sh
   Invoke-Expression (&starship init powershell)
   ```


   #### Ion

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

   ```sh
   # ~/.config/ion/initrc

   eval $(starship init ion)
   ```


   #### Elvish

   ::: warning

   仅支持 elvish 0.18 及更高的版本。

   :::

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

   ```sh
   # ~/.elvish/rc.elv

   eval (starship init elvish)
   ```


   #### Tcsh

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

   ```sh
   # ~/.tcshrc

   eval `starship init tcsh`
   ```


   #### Nushell

   ::: warning

   这部分今后可能会改变。 仅支持 Nushell v0.78+。

   :::

   在您的 Nushell 环境文件的最后(使用 `$nu.env-path` 来获取它的路径),添加以下内容:
   ```sh
   mkdir ~/.cache/starship
   starship init nu | save -f ~/.cache/starship/init.nu
   ```

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

   ```sh
   use ~/.cache/starship/init.nu
   ```


   #### Xonsh

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

   ```sh
   # ~/.xonshrc

   execx($(starship init xonsh))
   ```


   #### Cmd

   您需要使用 [Clink](https://chrisant996.github.io/clink/clink.html) (v1.2.30+) 与 Cmd. 将以下文件添加到文件 `starship.lua` 中,并将此文件放置在 Clink脚本目录中:

   ```lua
   -- starship.lua

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