andrei/starship
1
0
Fork 0
mirror of https://github.com/starship/starship.git synced 2026-06-22 02:02:12 +07:00
Code Issues Packages Projects Releases 10 Wiki Activity

docs(i18n): new Crowdin updates (#3460)

Browse Source
This commit is contained in:
Matan Kushner
2022-02-07 15:53:55 +01:00
committed by GitHub
parent db86a93824
commit 1d965a9d24
128 changed files with 7869 additions and 5504 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/ko-KR/README.md
+20 -20
View File
@@ -28,13 +28,13 @@ description: Starship is the minimal, blazing fast, and extremely customizable p
</video>
</div>
### Prerequisites
### 준비 사항
- A [Nerd Font](https://www.nerdfonts.com/) installed and enabled in your terminal.
- 터미널에 [Nerd Font](https://www.nerdfonts.com/)가 설치되어 있고 사용 가능해야 합니다.
### 빠른 설치
1. **starship** 바이러니 설치:
1. **starship** 바이너리 설치:
#### 최근 버전 설치
@@ -44,7 +44,7 @@ description: Starship is the minimal, blazing fast, and extremely customizable p
```sh
sh -c "$(curl -fsSL https://starship.rs/install.sh)"
```
To update the Starship itself, rerun the above script. It will replace the current version without touching Starship's configuration.
Starship을 업데이트하고 싶은 경우에도 위의 스크립트를 실행시키면 됩니다. Starship의 설정은 변경되지 않고 버전만 최근 버전으로 대체될 것입니다.
#### 패키지 매니저를 이용한 설치
@@ -55,18 +55,18 @@ description: Starship is the minimal, blazing fast, and extremely customizable p
brew install starship
```
With [Scoop](https://scoop.sh):
[Scoop](https://scoop.sh)을 통한 설치:
```powershell
scoop install starship
```
1. 쉘 설정에 시동 스크립트를 추가:
1. 쉘 설정 파일에 init 스크립트 추가:
#### Bash
`~/.bashrc`에 아래 라인을 추가
`~/.bashrc`의 끝부분에 아래 라인을 추가:
```sh
# ~/.bashrc
@@ -77,7 +77,7 @@ description: Starship is the minimal, blazing fast, and extremely customizable p
#### Fish
`~/.config/fish/config.fish`에 아래 라인을 추가
`~/.config/fish/config.fish`의 끝부분에 아래 라인을 추가:
```sh
# ~/.config/fish/config.fish
@@ -88,7 +88,7 @@ description: Starship is the minimal, blazing fast, and extremely customizable p
#### Zsh
`~/.zshrc`에 아래 라인을 추가
`~/.zshrc`의 끝부분에 아래 라인을 추가
```sh
# ~/.zshrc
@@ -99,7 +99,7 @@ description: Starship is the minimal, blazing fast, and extremely customizable p
#### Powershell
`Microsoft.PowerShell_profile.ps1`의 끝부분에 아래 내용을 추가. 해당 설정파일은 파워쉘에서 `$PROFILE` 변수 확인을 통해 확인 가능. 일반적으로 해당 파일은 `~\Documents\PowerShell\Microsoft.PowerShell_profile.ps1` 혹은 -Nix의 경우 `~/.config/powershell/Microsoft.PowerShell_profile.ps1`에 위치.
`Microsoft.PowerShell_profile.ps1`의 끝부분에 아래 내용을 추가합니다. 해당 설정파일은 파워쉘에서 `$PROFILE` 변수 확인을 통해 확인 가능합니다. 일반적으로 해당 파일은 `~\Documents\PowerShell\Microsoft.PowerShell_profile.ps1` 혹은 -Nix의 경우 `~/.config/powershell/Microsoft.PowerShell_profile.ps1`에 있습니다.
```sh
Invoke-Expression (&starship init powershell)
@@ -108,7 +108,7 @@ description: Starship is the minimal, blazing fast, and extremely customizable p
#### Ion
아래의 라인을 `~/.config/ion/initrc` 마지막에 추가:
`~/.config/ion/initrc` 의 끝부분에 아래 라인을 추가:
```sh
# ~/.config/ion/initrc
@@ -119,9 +119,9 @@ description: Starship is the minimal, blazing fast, and extremely customizable p
#### Elvish
::: warning Only elvish v0.17 or higher is supported. :::
::: 주의 elvish 버전 v0.17 이상에서만 지원됩니다. :::
아래의 라인을 `~/.elvish/rc.elv` 마지막에 추가:
`~/.elvish/rc.elv` 의 끝부분에 아래 라인을 추가:
```sh
# ~/.elvish/rc.elv
@@ -132,7 +132,7 @@ description: Starship is the minimal, blazing fast, and extremely customizable p
#### Tcsh
아래의 라인을 `~/.tcshrc` 마지막에 추가:
`~/.tcshrc` 의 끝부분에 아래 라인을 추가:
```sh
# ~/.tcshrc
@@ -143,13 +143,13 @@ description: Starship is the minimal, blazing fast, and extremely customizable p
#### Nushell
::: warning This will change in the future. Only nu version v0.33 or higher is supported. ::: Add the following to your nu config file. You can check the location of this file by running `config path` in nu.
::: 주의 이는 추후 변경될 예정입니다. 버전 v0.33 이상에서만 지원됩니다. ::: 새로운 설정 파일에 아래의 내용을 추가하세요. `config path`를 실행시키면 파일의 위치를 확인할 수 있습니다.
```toml
startup = [
"mkdir ~/.cache/starship",
"starship init nu | save ~/.cache/starship/init.nu",
"source ~/.cache/starship/init.nu"
"mkdir ~/.cache/starship",
"starship init nu | save ~/.cache/starship/init.nu",
"source ~/.cache/starship/init.nu",
]
prompt = "starship_prompt"
```
@@ -157,7 +157,7 @@ description: Starship is the minimal, blazing fast, and extremely customizable p
#### Xonsh
Add the following to the end of `~/.xonshrc`:
`~/.xonshrc` 의 끝부분에 아래 라인을 추가:
```sh
# ~/.xonshrc
@@ -168,7 +168,7 @@ description: Starship is the minimal, blazing fast, and extremely customizable p
#### Cmd
You need to use [Clink](https://chrisant996.github.io/clink/clink.html) (v1.2.30+) with Cmd. Add the following to a file `starship.lua` and place this file in Clink scripts directory:
Cmd를 이용하려면 [Clink](https://chrisant996.github.io/clink/clink.html) (v1.2.30+) 를 사용해야 합니다. `starship.lua` 파일에 아래의 라인을 추가하고 파일을 Clink scripts 폴더에 저장합니다.
```lua
-- starship.lua
docs/ko-KR/advanced-config/README.md
+18 -16
View File
@@ -45,14 +45,16 @@ function blastoff(){
starship_precmd_user_func="blastoff"
```
- To run a custom function right before a command runs, you can use the [`DEBUG` trap mechanism](https://jichu4n.com/posts/debug-trap-and-prompt_command-in-bash/). However, you **must** trap the DEBUG signal *before* initializing Starship! Starship can preserve the value of the DEBUG trap, but if the trap is overwritten after starship starts up, some functionality will break.
- To run a custom function right before a command runs, you can use the [`DEBUG` trap mechanism](https://jichu4n.com/posts/debug-trap-and-prompt_command-in-bash/). However, you **must** trap the DEBUG signal _before_ initializing Starship! Starship can preserve the value of the DEBUG trap, but if the trap is overwritten after starship starts up, some functionality will break.
```bash
function blastoff(){
echo "🚀"
}
trap blastoff DEBUG # Trap DEBUG *before* running starship
set -o functrace
eval $(starship init bash)
set +o functrace
```
## Custom pre-prompt and pre-execution Commands in PowerShell
@@ -161,9 +163,9 @@ Note: `continuation_prompt` should be set to a literal string without any variab
Note: Continuation prompts are only available in the following shells:
- `bash`
- `zsh`
- `파워셀`
- `bash`
- `zsh`
- `파워셀`
### Example
@@ -178,15 +180,15 @@ continuation_prompt = "▶▶"
Style strings are a list of words, separated by whitespace. The words are not case sensitive (i.e. `bold` and `BoLd` are considered the same string). Each word can be one of the following:
- `bold`
- `italic`
- `underline`
- `dimmed`
- `inverted`
- `bg:<color>`
- `fg:<color>`
- `<color>`
- `none`
- `bold`
- `italic`
- `underline`
- `dimmed`
- `inverted`
- `bg:<color>`
- `fg:<color>`
- `<color>`
- `none`
where `<color>` is a color specifier (discussed below). `fg:<color>` and `<color>` currently do the same thing, though this may change in the future. `inverted` swaps the background and foreground colors. The order of words in the string does not matter.
@@ -194,8 +196,8 @@ The `none` token overrides all other tokens in a string if it is not part of a `
A color specifier can be one of the following:
- One of the standard terminal colors: `black`, `red`, `green`, `blue`, `yellow`, `purple`, `cyan`, `white`. You can optionally prefix these with `bright-` to get the bright version (e.g. `bright-white`).
- A `#` followed by a six-digit hexadecimal number. This specifies an [RGB color hex code](https://www.w3schools.com/colors/colors_hexadecimal.asp).
- A number between 0-255. This specifies an [8-bit ANSI Color Code](https://i.stack.imgur.com/KTSQa.png).
- One of the standard terminal colors: `black`, `red`, `green`, `blue`, `yellow`, `purple`, `cyan`, `white`. You can optionally prefix these with `bright-` to get the bright version (e.g. `bright-white`).
- A `#` followed by a six-digit hexadecimal number. This specifies an [RGB color hex code](https://www.w3schools.com/colors/colors_hexadecimal.asp).
- A number between 0-255. This specifies an [8-bit ANSI Color Code](https://i.stack.imgur.com/KTSQa.png).
If multiple colors are specified for foreground/background, the last one in the string will take priority.
docs/ko-KR/config/README.md
+164 -105
View File
@@ -13,8 +13,8 @@ All configuration for starship is done in this [TOML](https://github.com/toml-la
add_newline = true
# Replace the "❯" symbol in the prompt with "➜"
[character] # The name of the module we are configuring is "character"
success_symbol = "[➜](bold green)" # The "success_symbol" segment is being set to "➜" with the color "bold green"
[character] # The name of the module we are configuring is "character"
success_symbol = "[➜](bold green)" # The "success_symbol" segment is being set to "➜" with the color "bold green"
# Disable the package module, hiding it from the prompt completely
[package]
@@ -155,7 +155,6 @@ This is the list of prompt-wide configuration options.
| `command_timeout` | `500` | Timeout for commands executed by starship (in milliseconds). |
| `add_newline` | `true` | Inserts blank line between shell prompts. |
### Example
```toml
@@ -185,6 +184,7 @@ format = "$all"
format = """
$username\
$hostname\
$localip\
$shlvl\
$singularity\
$kubernetes\
@@ -200,6 +200,7 @@ $docker_context\
$package\
$cmake\
$cobol\
$container\
$dart\
$deno\
$dotnet\
@@ -255,7 +256,7 @@ If you just want to extend the default format, you can use `$all`; modules you e
```toml
# Move the directory to the second line
format="$all$directory$character"
format = "$all$directory$character"
```
## AWS
@@ -289,7 +290,7 @@ When using [AWSume](https://awsu.me) the profile is read from the `AWSUME_PROFIL
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
*: This variable can only be used as a part of a style string
### Examples
@@ -411,17 +412,16 @@ The `display` option is an array of the following table.
#### Example
```toml
[[battery.display]] # "bold red" style and discharging_symbol when capacity is between 0% and 10%
[[battery.display]] # "bold red" style and discharging_symbol when capacity is between 0% and 10%
threshold = 10
style = "bold red"
[[battery.display]] # "bold yellow" style and 💦 symbol when capacity is between 10% and 30%
[[battery.display]] # "bold yellow" style and 💦 symbol when capacity is between 10% and 30%
threshold = 30
style = "bold yellow"
discharging_symbol = "💦"
# when capacity is over 30%, the battery indicator will not be displayed
```
## Character
@@ -522,7 +522,7 @@ The `cmake` module shows the currently installed version of [CMake](https://cmak
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
*: This variable can only be used as a part of a style string
## COBOL / GNUCOBOL
@@ -552,7 +552,7 @@ The `cobol` module shows the currently installed version of COBOL. By default, t
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
*: This variable can only be used as a part of a style string
## Command Duration
@@ -568,21 +568,16 @@ Bash users who need preexec-like functionality can use [rcaloras's bash_preexec
### Options
| Option | Default | Description |
| -------------------- | ----------------------------- | ---------------------------------------------------------- |
| `min_time` | `2_000` | Shortest duration to show time for (in milliseconds). |
| `show_milliseconds` | `false` | Show milliseconds in addition to seconds for the duration. |
| `format` | `"took [$duration]($style) "` | The format for the module. |
| `style` | `"bold yellow"` | The style for the module. |
| `disabled` | `false` | Disables the `cmd_duration` module. |
| `show_notifications` | `false` | Show desktop notifications when command completes. |
| `min_time_to_notify` | `45_000` | Shortest duration for notification (in milliseconds). |
::: tip
Showing desktop notifications requires starship to be built with `notify-rust` support. You check if your starship supports notifications by running `STARSHIP_LOG=debug starship module cmd_duration -d 60000` when `show_notifications` is set to `true`.
:::
| Option | Default | Description |
| ---------------------- | ----------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `min_time` | `2_000` | Shortest duration to show time for (in milliseconds). |
| `show_milliseconds` | `false` | Show milliseconds in addition to seconds for the duration. |
| `format` | `"took [$duration]($style) "` | The format for the module. |
| `style` | `"bold yellow"` | The style for the module. |
| `disabled` | `false` | Disables the `cmd_duration` module. |
| `show_notifications` | `false` | Show desktop notifications when command completes. |
| `min_time_to_notify` | `45_000` | Shortest duration for notification (in milliseconds). |
| `notification_timeout` | | Duration to show notification for (in milliseconds). If unset, notification timeout will be determined by daemon. Not all notification daemons honor this option. |
### Variables
@@ -591,7 +586,7 @@ Showing desktop notifications requires starship to be built with `notify-rust` s
| duration | `16m40s` | The time it took to execute the command |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
*: This variable can only be used as a part of a style string
### Example
@@ -632,7 +627,7 @@ This does not suppress conda's own prompt modifier, you may want to run `conda c
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
*: This variable can only be used as a part of a style string
### Example
@@ -643,6 +638,38 @@ This does not suppress conda's own prompt modifier, you may want to run `conda c
format = "[$symbol$environment](dimmed green) "
```
## Container
The `container` module displays a symbol and container name, if inside a container.
### Options
| Option | Default | Description |
| ---------- | ------------------------------------ | ----------------------------------------- |
| `symbol` | `"⬢"` | The symbol shown, when inside a container |
| `style` | `"bold red dimmed"` | The style for the module. |
| `format` | "[$symbol \\[$name\\]]($style) " | The format for the module. |
| `disabled` | `false` | Disables the `container` module. |
### Variables
| Variable | Example | Description |
| --------- | ------------------- | ------------------------------------ |
| name | `fedora-toolbox:35` | The name of the container |
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
*: This variable can only be used as a part of a style string
### Example
```toml
# ~/.config/starship.toml
[container]
format = "[$symbol \\[$name\\]]($style) "
```
## Crystal
The `crystal` module shows the currently installed version of [Crystal](https://crystal-lang.org/). By default the module will be shown if any of the following conditions are met:
@@ -671,7 +698,7 @@ The `crystal` module shows the currently installed version of [Crystal](https://
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
*: This variable can only be used as a part of a style string
### Example
@@ -711,7 +738,7 @@ The `dart` module shows the currently installed version of [Dart](https://dart.d
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
*: This variable can only be used as a part of a style string
### Example
@@ -725,6 +752,7 @@ format = "via [🔰 $version](bold red) "
## Deno
The `deno` module shows you your currently installed version of [Deno](https://deno.land/). By default the module will be shown if any of the following conditions are met:
- The current directory contains a `deno.json`, `deno.jsonc`, `mod.ts`, `mod.js`, `deps.ts` or `deps.js` file
### Options
@@ -809,7 +837,7 @@ For example, given `~/Dev/Nix/nixpkgs/pkgs` where `nixpkgs` is the repo root, an
| path | `"D:/Projects"` | The current directory path |
| style\* | `"black bold dimmed"` | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
*: This variable can only be used as a part of a style string
### Example
@@ -846,7 +874,7 @@ The `docker_context` module shows the currently active [Docker context](https://
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
*: This variable can only be used as a part of a style string
### Example
@@ -901,7 +929,7 @@ The module will also show the Target Framework Moniker (<https://docs.microsoft.
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
*: This variable can only be used as a part of a style string
### Example
@@ -942,7 +970,7 @@ The `elixir` module shows the currently installed version of [Elixir](https://el
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
*: This variable can only be used as a part of a style string
### Example
@@ -984,7 +1012,7 @@ The `elm` module shows the currently installed version of [Elm](https://elm-lang
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
*: This variable can only be used as a part of a style string
### Example
@@ -1002,16 +1030,17 @@ The `env_var` module displays the current value of a selected environment variab
- The `variable` configuration option matches an existing environment variable
- The `variable` configuration option is not defined, but the `default` configuration option is
::: tip Multiple environmental variables can be displayed by using a `.`. (see example) If the `variable` configuration option is not set, the module will display value of variable under the name of text after the `.` character.
Example: following configuration will display value of USER environment variable
```toml
# ~/.config/starship.toml
[env_var.USER]
default = "unknown user"
```
:::
### Options
@@ -1032,7 +1061,7 @@ default = "unknown user"
| symbol | | Mirrors the value of option `symbol` |
| style\* | `black bold dimmed` | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
*: This variable can only be used as a part of a style string
### Example
@@ -1045,6 +1074,7 @@ default = "unknown shell"
```
Displaying multiple environmental variables:
```toml
# ~/.config/starship.toml
@@ -1083,7 +1113,7 @@ The `erlang` module shows the currently installed version of [Erlang/OTP](https:
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
*: This variable can only be used as a part of a style string
### Example
@@ -1110,7 +1140,7 @@ The `fill` module fills any extra space on the line with a symbol. If multiple `
```toml
# ~/.config/starship.toml
format="AA $fill BB $fill CC"
format = "AA $fill BB $fill CC"
[fill]
symbol = "-"
@@ -1121,7 +1151,6 @@ Produces a prompt that looks like:
```
AA -------------------------------------------- BB -------------------------------------------- CC
```
## Google Cloud (`gcloud`)
@@ -1150,7 +1179,7 @@ The `gcloud` module shows the current configuration for [`gcloud`](https://cloud
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
*: This variable can only be used as a part of a style string
### Examples
@@ -1212,7 +1241,7 @@ The `git_branch` module shows the active branch of the repo in your current dire
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
*: This variable can only be used as a part of a style string
### Example
@@ -1248,7 +1277,7 @@ The `git_commit` module shows the current commit hash and also the tag (if any)
| hash | `b703eb3` | The current git commit hash |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
*: This variable can only be used as a part of a style string
### Example
@@ -1288,7 +1317,7 @@ The `git_state` module will show in directories which are part of a git reposito
| progress_total | `2` | The total operation progress |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
*: This variable can only be used as a part of a style string
### Example
@@ -1329,7 +1358,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y
| added_style\* | | Mirrors the value of option `added_style` |
| deleted_style\* | | Mirrors the value of option `deleted_style` |
\*: This variable can only be used as a part of a style string
*: This variable can only be used as a part of a style string
### Example
@@ -1382,7 +1411,7 @@ The following variables can be used in `format`:
| `deleted` | Displays `deleted` when a file's deletion has been added to the staging area. |
| style\* | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
*: This variable can only be used as a part of a style string
The following variables can be used in `diverged`:
@@ -1408,7 +1437,7 @@ ahead = "🏎💨"
behind = "😰"
diverged = "😵"
up_to_date = "✓"
untracked = "🤷‍"
untracked = "🤷"
stashed = "📦"
modified = "📝"
staged = '[++\($count\)](green)'
@@ -1461,7 +1490,7 @@ The `golang` module shows the currently installed version of [Go](https://golang
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
*: This variable can only be used as a part of a style string
### Example
@@ -1500,7 +1529,7 @@ The `helm` module shows the currently installed version of [Helm](https://helm.s
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
*: This variable can only be used as a part of a style string
### Example
@@ -1532,7 +1561,7 @@ The `hostname` module shows the system hostname.
| hostname | `computer` | The hostname of the computer |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
*: This variable can only be used as a part of a style string
### Example
@@ -1541,7 +1570,7 @@ The `hostname` module shows the system hostname.
[hostname]
ssh_only = false
format = "on [$hostname](bold red) "
format = "on [$hostname](bold red) "
trim_at = ".companyname.com"
disabled = false
```
@@ -1574,7 +1603,7 @@ The `java` module shows the currently installed version of [Java](https://www.or
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
*: This variable can only be used as a part of a style string
### Example
@@ -1587,7 +1616,7 @@ symbol = "🌟 "
## Jobs
The `jobs` module shows the current number of jobs running. The module will be shown only if there are background jobs running. The module will show the number of jobs running if there are at least 2 jobs, or more than the `number_threshold` config value, if it exists. The module will show a symbol if there is at least 1 job, or more than the `symbol_threshold` config value, if it exists. You can set both values to 0 in order to *always* show the symbol and number of jobs, even if there are 0 jobs running.
The `jobs` module shows the current number of jobs running. The module will be shown only if there are background jobs running. The module will show the number of jobs running if there are at least 2 jobs, or more than the `number_threshold` config value, if it exists. The module will show a symbol if there is at least 1 job, or more than the `symbol_threshold` config value, if it exists. You can set both values to 0 in order to _always_ show the symbol and number of jobs, even if there are 0 jobs running.
The default functionality is:
@@ -1611,16 +1640,15 @@ The `threshold` option is deprecated, but if you want to use it, the module will
| Option | Default | Description |
| ------------------ | ----------------------------- | ------------------------------------------------------------------------ |
| `threshold`\* | `1` | Show number of jobs if exceeded. |
| `threshold`* | `1` | Show number of jobs if exceeded. |
| `symbol_threshold` | `1` | Show `symbol` if the job count is at least `symbol_threshold`. |
| `number_threshold` | `2` | Show the number of jobs if the job count is at least `number_threshold`. |
| `format` | `"[$symbol$number]($style) "` | The format for the module. |
| `symbol` | `"✦"` | The string used to represent the `symbol` variable. |
| `style` | `"bold blue"` | The style for the module. |
| `disabled` | `false` | Disables the `jobs` module. |
\*: This option is deprecated, please use the
`number_threshold` and `symbol_threshold` options instead.
*: This option is deprecated, please use the `number_threshold` and `symbol_threshold` options instead.
### Variables
@@ -1630,7 +1658,7 @@ The `threshold` option is deprecated, but if you want to use it, the module will
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
*: This variable can only be used as a part of a style string
### Example
@@ -1672,7 +1700,7 @@ The `julia` module shows the currently installed version of [Julia](https://juli
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
*: This variable can only be used as a part of a style string
### Example
@@ -1683,6 +1711,39 @@ The `julia` module shows the currently installed version of [Julia](https://juli
symbol = "∴ "
```
## localip
The `localip` module shows the IPv4 address of the primary network interface.
### Options
| Option | Default | Description |
| ---------- | ------------------------- | ------------------------------------------------------ |
| `ssh_only` | `true` | Only show IP address when connected to an SSH session. |
| `format` | `"[$localipv4]($style) "` | The format for the module. |
| `style` | `"bold yellow"` | The style for the module. |
| `disabled` | `true` | Disables the `localip` module. |
### Variables
| Variable | Example | Description |
| --------- | ------------ | ----------------------------------- |
| localipv4 | 192.168.1.13 | Contains the primary IPv4 address |
| style\* | | Mirrors the value of option `style` |
*: This variable can only be used as a part of a style string
### Example
```toml
# ~/.config/starship.toml
[localip]
ssh_only = false
format = "@[$localipv4](bold red) "
disabled = false
```
## Kotlin
The `kotlin` module shows the currently installed version of [Kotlin](https://kotlinlang.org/). By default the module will be shown if any of the following conditions are met:
@@ -1711,7 +1772,7 @@ The `kotlin` module shows the currently installed version of [Kotlin](https://ko
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
*: This variable can only be used as a part of a style string
### Example
@@ -1759,7 +1820,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
*: This variable can only be used as a part of a style string
### Example
@@ -1845,7 +1906,7 @@ The `lua` module shows the currently installed version of [Lua](http://www.lua.o
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
*: This variable can only be used as a part of a style string
### Example
@@ -1889,7 +1950,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y
| symbol | `🐏` | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string \*\*: The SWAP file information is only displayed if detected on the current system
*: This variable can only be used as a part of a style string *\*: The SWAP file information is only displayed if detected on the current system
### Example
@@ -1926,7 +1987,7 @@ The `hg_branch` module shows the active branch of the repo in your current direc
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
*: This variable can only be used as a part of a style string
### Example
@@ -1969,7 +2030,7 @@ The `nim` module shows the currently installed version of [Nim](https://nim-lang
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
*: This variable can only be used as a part of a style string
### Example
@@ -2005,7 +2066,7 @@ The `nix_shell` module shows the [nix-shell](https://nixos.org/guides/nix-pills/
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
*: This variable can only be used as a part of a style string
### Example
@@ -2036,7 +2097,7 @@ The `nodejs` module shows the currently installed version of [Node.js](https://n
| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `" "` | A format string representing the symbol of Node.js. |
| `symbol` | `" "` | A format string representing the symbol of Node.js. |
| `detect_extensions` | `["js", "mjs", "cjs", "ts"]` | Which extensions should trigger this module. |
| `detect_files` | `["package.json", ".node-version"]` | Which filenames should trigger this module. |
| `detect_folders` | `["node_modules"]` | Which folders should trigger this module. |
@@ -2052,7 +2113,7 @@ The `nodejs` module shows the currently installed version of [Node.js](https://n
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
*: This variable can only be used as a part of a style string
### Example
@@ -2099,7 +2160,7 @@ The `ocaml` module shows the currently installed version of [OCaml](https://ocam
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
*: This variable can only be used as a part of a style string
### Example
@@ -2132,7 +2193,7 @@ The `openstack` module shows the current OpenStack cloud and project. The module
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
*: This variable can only be used as a part of a style string
### Example
@@ -2187,7 +2248,7 @@ The `package` module is shown when the current directory is the repository for a
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
*: This variable can only be used as a part of a style string
### Example
@@ -2267,7 +2328,7 @@ The `php` module shows the currently installed version of [PHP](https://www.php.
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
*: This variable can only be used as a part of a style string
### Example
@@ -2280,7 +2341,7 @@ format = "via [🔹 $version](147 bold) "
## Pulumi
The `pulumi` module shows the currently selected [Pulumi Stack](https://www.pulumi.com/docs/intro/concepts/stack/) and version.
The `pulumi` module shows the current username, selected [Pulumi Stack](https://www.pulumi.com/docs/intro/concepts/stack/), and version.
::: tip
@@ -2295,13 +2356,13 @@ By default the module will be shown if any of the following conditions are met:
### Options
| Option | Default | Description |
| ---------------- | -------------------------------- | ------------------------------------------------------------------------- |
| `format` | `"via [$symbol$stack]($style) "` | The format string for the module. |
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `" "` | A format string shown before the Pulumi stack. |
| `style` | `"bold 5"` | The style for the module. |
| `disabled` | `false` | Disables the `pulumi` module. |
| Option | Default | Description |
| ---------------- | -------------------------------------------- | ------------------------------------------------------------------------- |
| `format` | `"via [$symbol($username@)$stack]($style) "` | The format string for the module. |
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `" "` | A format string shown before the Pulumi stack. |
| `style` | `"bold 5"` | The style for the module. |
| `disabled` | `false` | Disables the `pulumi` module. |
### Variables
@@ -2309,10 +2370,11 @@ By default the module will be shown if any of the following conditions are met:
| --------- | ---------- | ------------------------------------ |
| version | `v0.12.24` | The version of `pulumi` |
| stack | `dev` | The current Pulumi stack |
| username | `alice` | The current Pulumi username |
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
*: This variable can only be used as a part of a style string
### Example
@@ -2332,7 +2394,6 @@ format = "[🛥 ($version )$stack]($style) "
[pulumi]
symbol = "🛥 "
format = "[$symbol$stack]($style) "
```
## PureScript
@@ -2363,7 +2424,7 @@ The `purescript` module shows the currently installed version of [PureScript](ht
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
*: This variable can only be used as a part of a style string
### Example
@@ -2532,7 +2593,7 @@ By default the `red` module shows the currently installed version of [Red](https
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
*: This variable can only be used as a part of a style string
### Example
@@ -2576,7 +2637,7 @@ Starship gets the current Ruby version by running `ruby -v`.
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
*: This variable can only be used as a part of a style string
### Example
@@ -2615,7 +2676,7 @@ By default the `rust` module shows the currently installed version of [Rust](htt
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
*: This variable can only be used as a part of a style string
### Example
@@ -2655,7 +2716,7 @@ The `scala` module shows the currently installed version of [Scala](https://www.
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
*: This variable can only be used as a part of a style string
### Example
@@ -2702,7 +2763,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y
| indicator | | Mirrors the value of `indicator` for currently used shell. |
| style\* | | Mirrors the value of option `style`. |
\*: This variable can only be used as a part of a style string
*: This variable can only be used as a part of a style string
### Examples
@@ -2740,7 +2801,7 @@ The `shlvl` module shows the current [`SHLVL`](https://tldp.org/LDP/abs/html/int
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
*: This variable can only be used as a part of a style string
### Example
@@ -2774,7 +2835,7 @@ The `singularity` module shows the current [Singularity](https://sylabs.io/singu
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
*: This variable can only be used as a part of a style string
### Example
@@ -2787,7 +2848,7 @@ format = '[📦 \[$env\]]($style) '
## Status
The `status` module displays the exit code of the previous command. The module will be shown only if the exit code is not `0`.
The `status` module displays the exit code of the previous command. The module will be shown only if the exit code is not `0`. The status code will cast to a signed 32-bit integer.
::: tip
@@ -2812,7 +2873,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y
| `recognize_signal_code` | `true` | Enable signal mapping from exit code |
| `map_symbol` | `false` | Enable symbols mapping from exit code |
| `pipestatus` | `false` | Enable pipestatus reporting |
| `pipestatus_separator` | `|` | The symbol that separate in pipe program exit codes |
| `pipestatus_separator` | `|` | |
| `pipestatus_format` | `\\[$pipestatus\\] => [$symbol$common_meaning$signal_name$maybe_int]($style)` | The format of the module when the command is a pipeline |
| `disabled` | `true` | Disables the `status` module. |
@@ -2831,12 +2892,11 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
*: This variable can only be used as a part of a style string
### Example
```toml
# ~/.config/starship.toml
[status]
@@ -2845,7 +2905,6 @@ symbol = "🔴"
format = '[\[$symbol $common_meaning$signal_name$maybe_int\]]($style) '
map_symbol = true
disabled = false
```
## Sudo
@@ -2875,12 +2934,11 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
*: This variable can only be used as a part of a style string
### Example
```toml
# ~/.config/starship.toml
[sudo]
@@ -2926,7 +2984,7 @@ By default the `swift` module shows the currently installed version of [Swift](h
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
*: This variable can only be used as a part of a style string
### Example
@@ -2974,7 +3032,7 @@ By default the module will be shown if any of the following conditions are met:
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
*: This variable can only be used as a part of a style string
### Example
@@ -3027,7 +3085,7 @@ If `use_12hr` is `true`, then `time_format` defaults to `"%r"`. Otherwise, it de
| time | `13:08:10` | The current time. |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
*: This variable can only be used as a part of a style string
### Example
@@ -3114,7 +3172,7 @@ The `vagrant` module shows the currently installed version of [Vagrant](https://
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
*: This variable can only be used as a part of a style string
### Example
@@ -3128,6 +3186,7 @@ format = "via [⍱ $version](bold white) "
## V
The `vlang` module shows you your currently installed version of [V](https://vlang.io/). By default the module will be shown if any of the following conditions are met:
- The current directory contains a file with `.v` extension
- The current directory contains a `v.mod`, `vpkg.json` or `.vpkg-lock.json` file
@@ -3181,7 +3240,7 @@ The `vcsh` module displays the current active [VCSH](https://github.com/RichiH/v
| symbol | | Mirrors the value of option `symbol` |
| style\* | `black bold dimmed` | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
*: This variable can only be used as a part of a style string
### Example
@@ -3219,7 +3278,7 @@ By default the the `zig` module shows the currently installed version of [Zig](h
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
*: This variable can only be used as a part of a style string
### Example
@@ -3293,7 +3352,7 @@ Format strings can also contain shell specific prompt sequences, e.g. [Bash](htt
| symbol | Mirrors the value of option `symbol` |
| style\* | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
*: This variable can only be used as a part of a style string
#### Custom command shell
@@ -3330,13 +3389,13 @@ Automatic detection of shells and proper parameters addition are currently imple
# ~/.config/starship.toml
[custom.foo]
command = "echo foo" # shows output of command
files = ["foo"] # can specify filters but wildcards are not supported
command = "echo foo" # shows output of command
files = ["foo"] # can specify filters but wildcards are not supported
when = """ test "$HOME" == "$PWD" """
format = " transcending [$output]($style)"
[custom.time]
command = "time /T"
extensions = ["pst"] # filters *.pst files
extensions = ["pst"] # filters *.pst files
shell = ["pwsh.exe", "-NoProfile", "-Command", "-"]
```
docs/ko-KR/faq/README.md
+1 -1
View File
@@ -58,7 +58,7 @@ sh -c "$(curl -fsSL https://starship.rs/install.sh)" -- --platform unknown-linux
## Why do I see `Executing command "..." timed out.` warnings?
Starship executes different commands to get information to display in the prompt, for example the version of a program or the current git status. To make sure starship doesn't hang while trying to execute these commands we set a time limit, if a command takes longer than this limit starship will stop the execution of the command and output the above warning, this is expected behaviour. This time limit is configurable using the [`command_timeout` key](/config/#prompt) so if you want you can increase the time limit. You can also follow the debugging steps below to see which command is being slow and see if you can optimise it. Finally you can set the `STARSHIP_LOG` env var to `error` to hide these warnings.
Starship executes different commands to get information to display in the prompt, for example the version of a program or the current git status. To make sure starship doesn't hang while trying to execute these commands we set a time limit, if a command takes longer than this limit starship will stop the execution of the command and output the above warning, this is expected behaviour. This time limit is configurable using the [`command_timeout`key](/config/#prompt) so if you want you can increase the time limit. You can also follow the debugging steps below to see which command is being slow and see if you can optimise it. Finally you can set the `STARSHIP_LOG` env var to `error` to hide these warnings.
## I see symbols I don't understand or expect, what do they mean?
docs/ko-KR/guide/README.md
+166 -98
View File
@@ -150,178 +150,246 @@
**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.
- ** Fast:** 빨라요 – _엄청 엄청_ 빠릅니다! 🚀
- ** Customizable:** 프롬프트의 모든 측면을 커스텀 가능합니다.
- **Universal:** 어떤 쉘 위에서도, 어떤 운영체제 위에서도 동작합니다.
- **Intelligent:** 관련 정보를 한눈에 보여줍니다.
- **Feature rich:** 원하는 모든 도구를 지원합니다.
- **Easy:** 빠른 설치 - 몇 분 안에 사용할 수 있습니다.
<p align="center">
<a href="https://starship.rs/config/"><strong>Explore the Starship docs&nbsp;&nbsp;▶</strong></a>
<a href="https://starship.rs/config/"><strong>Starship 문서 보기&nbsp;&nbsp;▶</strong></a>
</p>
<a name="🚀-installation"></a>
## 🚀 설치
### Prerequisites
### 준비 사항
- 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)).
- 터미널에 [Nerd Font](https://www.nerdfonts.com/)가 설치되어 있고 사용 가능해야 합니다. (ex. [Fira Code Nerd Font](https://www.nerdfonts.com/font-downloads))
### 시작하기
### Step 1. Starship 설치하기
**Note**: due to the proliferation of different platforms, only a subset of supported platforms are shown below. Can't see yours? Have a look at the [extra platform instructions](https://starship.rs/installing/).
아래의 목록 중 해당하는 운영체제를 골라 설치 지침을 확인하세요:
1. **starship** 바이러니 설치:
<details>
<summary>Android</summary>
Install Starship using any of the following package managers:
#### 최근 버전 설치
| Repository | Instructions |
| --------------------------------------------------------------------------------- | ---------------------- |
| [Termux](https://github.com/termux/termux-packages/tree/master/packages/starship) | `pkg install starship` |
</details>
##### From prebuilt binary, with Shell:
<details>
<summary>BSD</summary>
```sh
sh -c "$(curl -fsSL https://starship.rs/install.sh)"
```
Install Starship using any of the following package managers:
To update the Starship itself, rerun the above script. It will replace the current version without touching Starship's configuration.
| Distribution | Repository | Instructions |
| ------------ | -------------------------------------------------------- | --------------------------------- |
| **_Any_** | **[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` |
**Note** - The defaults of the install script can be overridden see the built-in help.
</details>
```sh
sh -c "$(curl -fsSL https://starship.rs/install.sh)" -- --help
```
<details>
<summary>Linux</summary>
Install the latest version for your system:
#### 패키지 매니저를 이용한 설치
```sh
sh -c "$(curl -fsSL https://starship.rs/install.sh)"
```
Alternatively, install Starship using any of the following package managers:
##### [Homebrew](https://brew.sh/)를 통한 설치:
| Distribution | Repository | Instructions |
| ------------------ | ----------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ |
| **_Any_** | **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` |
| _Any_ | [conda-forge](https://anaconda.org/conda-forge/starship) | `conda install -c conda-forge starship` |
| _Any_ | [Linuxbrew](https://formulae.brew.sh/formula/starship) | `brew install starship` |
| _Any_ | [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` |
| Fedora 31+ | [Fedora Packages](https://src.fedoraproject.org/rpms/rust-starship) | `dnf install starship` |
| NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/misc/starship/default.nix) | `nix-env -iA nixos.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` |
```sh
brew install starship
```
</details>
<details>
<summary>macOS</summary>
##### With [Scoop](https://scoop.sh):
Install the latest version for your system:
```powershell
scoop install starship
```
```sh
sh -c "$(curl -fsSL https://starship.rs/install.sh)"
```
2. 쉘 설정에 시동 스크립트를 추가:
Alternatively, install Starship using any of the following package managers:
| Repository | Instructions |
| -------------------------------------------------------- | --------------------------------------- |
| **[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` |
#### Bash
</details>
`~/.bashrc`에 아래 라인을 추가
<details>
<summary>Windows</summary>
```sh
# ~/.bashrc
Install Starship using any of the following package managers:
eval "$(starship init bash)"
```
| Repository | Instructions |
| -------------------------------------------------------------------------------- | --------------------------------------- |
| **[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` |
</details>
#### Fish
### Step 2. 쉘에 Starship 적용하기
`~/.config/fish/config.fish`에 아래 라인을 추가
쉘에 Starship 초기 설정을 합니다. 아래의 리스트 중에 해당하는 것을 고르세요:
```sh
# ~/.config/fish/config.fish
<details>
<summary>Bash</summary>
starship init fish | source
```
`~/.bashrc`의 끝부분에 아래 라인을 추가:
```sh
eval "$(starship init bash)"
```
#### Zsh
</details>
`~/.zshrc`에 아래 라인을 추가
<details>
<summary>Cmd</summary>
```sh
# ~/.zshrc
Cmd를 이용하려면 [Clink](https://chrisant996.github.io/clink/clink.html) (v1.2.30+) 를 사용해야 합니다. Create a file at this path `%LocalAppData%\clink\starship.lua` with the following contents:
eval "$(starship init zsh)"
```
```lua
load(io.popen('starship init cmd'):read("*a"))()
```
</details>
#### 파워셀
<details>
<summary>Elvish</summary>
`Microsoft.PowerShell_profile.ps1`의 끝부분에 아래 내용을 추가. 해당 설정파일은 파워쉘에서 `$PROFILE` 변수 확인을 통해 확인 가능. 일반적으로 해당 파일은 `~\Documents\PowerShell\Microsoft.PowerShell_profile.ps1` 혹은 -Nix의 경우 `~/.config/powershell/Microsoft.PowerShell_profile.ps1`에 위치.
`~/.elvish/rc.elv` 의 끝부분에 아래 라인을 추가:
```powershell
Invoke-Expression (&starship init powershell)
```
```sh
eval (starship init elvish)
```
Note: Only Elvish v0.17+ is supported
#### Ion
</details>
아래의 라인을 `~/.config/ion/initrc` 마지막에 추가:
<details>
<summary>Fish</summary>
```sh
# ~/.config/ion/initrc
`~/.config/fish/config.fish`의 끝부분에 아래 라인을 추가:
eval $(starship init ion)
```
```fish
starship init fish | source
```
</details>
#### Elvish
<details>
<summary>Ion</summary>
**Warning** Only elvish v0.17 or higher is supported. 아래의 라인을 `~/.elvish/rc.elv` 마지막에 추가:
`~/.config/ion/initrc` 의 끝부분에 아래 라인을 추가:
```sh
# ~/.elvish/rc.elv
```sh
eval $(starship init ion)
```
eval (starship init elvish)
```
</details>
<details>
<summary>Nushell</summary>
#### Tcsh
Add the following to the end of your Nushell configuration (find it by running `config path`):
아래의 라인을 `~/.tcshrc` 마지막에 추가:
```toml
startup = [
"mkdir ~/.cache/starship",
"starship init nu | save ~/.cache/starship/init.nu",
"source ~/.cache/starship/init.nu",
]
prompt = "starship_prompt"
```
```sh
# ~/.tcshrc
</details>
eval `starship init tcsh`
```
<details>
<summary>Powershell</summary>
Add the following to the end of your PowerShell configuration (find it by running `$PROFILE`):
#### Xonsh
```powershell
Invoke-Expression (&starship init powershell)
```
Add the following to the end of `~/.xonshrc`:
</details>
```sh
# ~/.xonshrc
<details>
<summary>Tcsh</summary>
execx($(starship init xonsh))
```
`~/.tcshrc` 의 끝부분에 아래 라인을 추가:
```sh
eval `starship init tcsh`
```
#### Cmd
</details>
You need to use [Clink](https://chrisant996.github.io/clink/clink.html) (v1.2.30+) with Cmd. Add the following to a file `starship.lua` and place this file in Clink scripts directory:
<details>
<summary>Xonsh</summary>
```lua
-- starship.lua
`~/.xonshrc` 의 끝부분에 아래 라인을 추가:
load(io.popen('starship init cmd'):read("*a"))()
```
```python
execx($(starship init xonsh))
```
</details>
#### Nushell
<details>
<summary>Zsh</summary>
**Warning** This will change in the future. Only nu version v0.33 or higher is supported. Add the following to your nu config file. You can check the location of this file by running `config path` in nu.
`~/.zshrc`의 끝부분에 아래 라인을 추가
```toml
startup = [
"mkdir ~/.cache/starship",
"starship init nu | save ~/.cache/starship/init.nu",
"source ~/.cache/starship/init.nu"
]
prompt = "starship_prompt"
```
```sh
eval "$(starship init zsh)"
```
</details>
### Step 3. Starship 설정하기
새로운 쉘 인스턴스를 시작하면 아름다운 새 쉘 프롬프트를 볼 수 있습니다. 기본 설정에 만족한다면, 즐기세요!
Starship을 추가로 커스터마이징 하고싶다면:
- **[Configuration](https://starship.rs/config/)** – 원하는대로 프롬프트를 수정할 수 있도록 Starship 설정을 배울 수 있습니다.
- **[Presets](https://starship.rs/presets/)** – 다른 사람들이 만들어둔 설정들을 보고 영감을 받을 수 있습니다.
## 🤝 기여
@@ -335,11 +403,11 @@ If you are interested in helping contribute to starship, please take a look at o
Please check out these previous works that helped inspire the creation of starship. 🙏
- **[denysdovhan/spaceship-prompt](https://github.com/denysdovhan/spaceship-prompt)** - A ZSH prompt for astronauts.
- **[denysdovhan/spaceship-prompt](https://github.com/denysdovhan/spaceship-prompt)** – A ZSH prompt for astronauts.
- **[denysdovhan/robbyrussell-node](https://github.com/denysdovhan/robbyrussell-node)** - Cross-shell robbyrussell theme written in JavaScript.
- **[denysdovhan/robbyrussell-node](https://github.com/denysdovhan/robbyrussell-node)** – Cross-shell robbyrussell theme written in JavaScript.
- **[reujab/silver](https://github.com/reujab/silver)** - A cross-shell customizable powerline-like prompt with icons.
- **[reujab/silver](https://github.com/reujab/silver)** – A cross-shell customizable powerline-like prompt with icons.
<p align="center">
<br>
docs/ko-KR/installing/README.md
+2 -2
View File
@@ -11,7 +11,7 @@ There are so many platforms out there that they didn't fit into the main README.
## [Chocolatey](https://chocolatey.org)
### Prerequisites
### 준비 사항
Head over to the [Chocolatey installation page](https://chocolatey.org/install) and follow the instructions to install Chocolatey.
@@ -23,7 +23,7 @@ choco install starship
## [termux](https://termux.com)
### Prerequisites
### 준비 사항
```sh
pkg install getconf
docs/ko-KR/migrating-to-0.45.0/README.md
+1 -1
View File
@@ -109,7 +109,7 @@ To configure the prompt to use the older `use_symbol_for_status = true` configur
error_symbol = "[✖](bold red)"
```
*Note:* The `character` element automatically adds a space after, so unlike the other `format` strings, we specifically do not add one in the above examples.
_Note:_ The `character` element automatically adds a space after, so unlike the other `format` strings, we specifically do not add one in the above examples.
#### Command Duration
docs/ko-KR/presets/README.md
+5 -2
View File
@@ -8,7 +8,7 @@ This preset doesn't change anything except for the symbols used for each module.
![Screenshot of Nerd Font Symbols preset](/presets/nerd-font-symbols.png)
### Prerequisites
### 준비 사항
- A [Nerd Font](https://www.nerdfonts.com/) installed and enabled in your terminal (the example uses Fira Code Nerd Font)
@@ -60,6 +60,9 @@ symbol = " "
[nix_shell]
symbol = " "
[nodejs]
symbol = " "
[package]
symbol = " "
@@ -110,7 +113,7 @@ format = '\[[$symbol($profile)(\($region\))(\[$duration\])]($style)\]'
format = '\[[$symbol($version)]($style)\]'
[cmd_duration]
format = '\[[⏱ $duration ]($style)\]'
format = '\[[⏱ $duration]($style)\]'
[cobol]
format = '\[[$symbol($version)]($style)\]'