Llewellyn/starship
1
0
Fork 0
mirror of https://github.com/Llewellynvdm/starship.git synced 2024-12-26 19:40:20 +00:00
Code Issues Releases Activity
34f81d2af1
starship/docs/vi-VN/config/README.md
Matan Kushner ebd9baf5f7 New translations README.md (Vietnamese)
2023-09-03 02:05:58 +01:00

4385 lines
261 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# Cấu hình
Để bắt đầu cấu hình starship, tạo tập tin sau: `~/.config/starship.toml`.
```sh
mkdir -p ~/.config && touch ~/.config/starship.toml
```
Tất cả cấu hình của starship đã xong trong tập tin này: [TOML](https://github.com/toml-lang/toml):
```toml
# Get editor completions based on the config schema
"$schema" = 'https://starship.rs/config-schema.json'
# Inserts a blank line between shell prompts
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'
# Disable the package module, hiding it from the prompt completely
[package]
disabled = true
```
### Config File Location
Bạn thay đổi địa chỉ tệp tin cấu hình mặc định bằng biến môi trường `STARSHIP_CONFIG`:
```sh
export STARSHIP_CONFIG=~/example/non/default/path/starship.toml
```
Tương đương trong PowerShell (Windows) sẽ được thêm dòng này vào `$PROFILE` của bạn:
```powershell
$ENV:STARSHIP_CONFIG = "$HOME\example\non\default\path\starship.toml"
```
Or for Cmd (Windows) would be adding this line to your `starship.lua`:
```lua
os.setenv('STARSHIP_CONFIG', 'C:\\Users\\user\\example\\non\\default\\path\\starship.toml')
```
### Logging
By default starship logs warnings and errors into a file named `~/.cache/starship/session_${STARSHIP_SESSION_KEY}.log`, where the session key is corresponding to an instance of your terminal. Cái này, tuy nhiên có thể được thay đổi bằng cách sử dụng biến môi trường `STARSHIP_CACHE`:
```sh
export STARSHIP_CACHE=~/.starship/cache
```
Tương đương trong PowerShell (Windows) sẽ được thêm dòng này vào `$PROFILE` của bạn:
```powershell
$ENV:STARSHIP_CACHE = "$HOME\AppData\Local\Temp"
```
Or for Cmd (Windows) would be adding this line to your `starship.lua`:
```lua
os.setenv('STARSHIP_CACHE', 'C:\\Users\\user\\AppData\\Local\\Temp')
```
### Thuật ngữ
**Module**: Một thành phần trong prompt, thông tin lấy được dựa trên thông tin ngữ cảnh từ hệ điều hành của bạn. For example, the "nodejs" module shows the version of Node.js that is currently installed on your computer, if your current directory is a Node.js project.
**Variable**: Các thành phần con nhỏ hơn chứa thông tin cung cấp bởi module. For example, the "version" variable in the "nodejs" module contains the current version of Node.js.
Bằng việc quy ước, đa số các module có một tiền tố của terminal mặc định (ví dụ `via` trong "nodejs") và một khoảng trắng như là một hậu tố.
### Strings
In TOML syntax, [text values](https://toml.io/en/v1.0.0#string) are declared with `'`, `"`, `'''`, or `"""`.
The following Starship syntax symbols have special usage in a format string and must be escaped to display as that character: `$ [ ] ( )`.
| Symbol | Type | Notes |
| ------ | ------------------------- | ------------------------------------------------------ |
| `'` | literal string | less escaping |
| `"` | string | more escaping |
| `'''` | multi-line literal string | less escaping |
| `"""` | multi-line string | more escaping, newlines in declarations can be ignored |
Ví dụ:
```toml
# literal string
format = '☺\☻ '
# regular string
format = "☺\\☻ "
# escaping Starship symbols
format = '\[\$\] '
```
When using line breaks, multi-line declarations can be used. For example, if you want to print a `$` symbol on a new line, the following values for `format` are equivalent:
```toml
# with literal string
format = '''
\$'''
# with multiline basic string
format = """
\\$"""
# with basic string
format = "\n\\$"
```
In multiline basic strings, newlines can be used for formatting without being present in the value by escaping them.
```toml
format = """
line1\
line1\
line1
line2\
line2\
line2
"""
```
### Định dạng các chuỗi
Định dạng các chuỗi là định dạng một module với việc in ra tất cả các biến của nó. Đa số các module có một cái bắt đầu gọi là `format`, cái đó cấu hình việc hiển thị định dạng của module. Bạn có thể sử dụng các văn bản, các biến và các nhóm văn bản trong một định dạng chuỗi.
#### Biến
Một biến chứa một kí hiệu `$` theo sau bởi tên biến. The name of a variable can only contain letters, numbers and `_`.
Ví dụ:
- `'$version'` is a format string with a variable named `version`.
- `'$git_branch$git_commit'` is a format string with two variables named `git_branch` and `git_commit`.
- `'$git_branch $git_commit'` has the two variables separated with a space.
#### Nhóm văn bản
Một nhóm văn bản được tạo nên bởi hai phần khác nhau.
Phần đầu tiên, cái được bao bọc trong một `[]`, là một [định dạng chuỗi](#format-strings). Bạn có thể thêm các văn bản, các biến, hoặc thậm chí các nhóm văn bản lồng nhau vào trong nó.
Phần thứ hai, cái được bao bọc trong một `()`, là một [chuỗi kiểu](#style-strings). This can be used to style the first part.
Ví dụ:
- `'[on](red bold)'` will print a string `on` with bold text colored red.
- `'[⌘ $version](bold green)'` will print a symbol `⌘` followed by the content of variable `version`, with bold text colored green.
- `'[a [b](red) c](green)'` will print `a b c` with `b` red, and `a` and `c` green.
#### Các chuỗi kiểu
Đa số các module trong starship cho phép bạn cấu hình kiểu hiển thị của chúng. This is done with an entry (thường được gọi là `kiểu`) cái là một cuỗi cấu hình đặc biệt. Đây là vài ví dụ của các chuỗi kiểu cũng với những gì chúng làm. Cú pháp chi tiết đầy đủ, tham khảo [hướng dẫn cấu hình nâng cao](/advanced-config/).
- `'fg:green bg:blue'` sets green text on a blue background
- `'bg:blue fg:bright-green'` sets bright green text on a blue background
- `'bold fg:27'` sets bold text with [ANSI color](https://i.stack.imgur.com/KTSQa.png) 27
- `'underline bg:#bf5700'` sets underlined text on a burnt orange background
- `'bold italic fg:purple'` sets bold italic purple text
- `''` explicitly disables all styling
Lưu ý rằng những style trông như thế nào sẽ được điều khiển bởi giả lập terminal của bạn. Ví dụ, một vài giả lập terminal sẽ làm sáng những màu thay vì làm đậm chữ, và một vài theme màu sử dụng cũng các giá trị cho các màu thường và màu sáng. Tương tự, để có được chữ nghiêng, terminal của bạn phải hỗ trợ các kiểu chữ nghiêng.
#### Điều kiện định dạng chuỗi
Một điều kiện định dạng chuỗi bọc trong `(` và `)` sẽ không render nếu tất cả các biến bên trong là rỗng.
Ví dụ:
- `'(@$region)'` will show nothing if the variable `region` is `None` or empty string, otherwise `@` followed by the value of region.
- `'(some text)'` will always show nothing since there are no variables wrapped in the braces.
- When `$combined` is a shortcut for `\[$a$b\]`, `'($combined)'` will show nothing only if `$a` and `$b` are both `None`. This works the same as `'(\[$a$b\] )'`.
### Negative matching
Many modules have `detect_extensions`, `detect_files`, and `detect_folders` variables. These take lists of strings to match or not match. "Negative" options, those which should not be matched, are indicated with a leading '!' character. The presence of _any_ negative indicator in the directory will result in the module not being matched.
Extensions are matched against both the characters after the last dot in a filename, and the characters after the first dot in a filename. For example, `foo.bar.tar.gz` will be matched against `bar.tar.gz` and `gz` in the `detect_extensions` variable. Files whose name begins with a dot are not considered to have extensions at all.
To see how this works in practice, you could match TypeScript but not MPEG Transport Stream files thus:
```toml
detect_extensions = ['ts', '!video.ts', '!audio.ts']
```
## Prompt
Cái này là danh sách các tuỳ chọn cho cấu hình prompt-wide.
### Các tuỳ chọn
| Tuỳ chọn | Mặc định | Mô tả |
| ----------------- | ------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `format` | [link](#default-prompt-format) | Cấu hình định dạng của prompt. |
| `right_format` | `''` | See [Enable Right Prompt](/advanced-config/#enable-right-prompt) |
| `scan_timeout` | `30` | Timeout của starship cho việc quét các tập tin (tính theo milliseconds). |
| `command_timeout` | `500` | Timeout for commands executed by starship (in milliseconds). |
| `add_newline` | `true` | Chèn dòng trắng giữa các dấu nhắc lệnh. |
| `palette` | `''` | Sets which color palette from `palettes` to use. |
| `palettes` | `{}` | Collection of color palettes that assign [colors](/advanced-config/#style-strings) to user-defined names. Note that color palettes cannot reference their own color definitions. |
### Ví dụ
```toml
# ~/.config/starship.toml
# Use custom format
format = '''
[┌───────────────────>](bold green)
[│](bold green)$directory$rust$package
[└─>](bold green) '''
# Wait 10 milliseconds for starship to check files under the current directory.
scan_timeout = 10
# Disable the blank line at the start of the prompt
add_newline = false
# Set 'foo' as custom color palette
palette = 'foo'
# Define custom colors
[palettes.foo]
# Overwrite existing color
blue = '21'
# Define new color
mustard = '#af8700'
```
### Định dạng prompt mặc định
Mặc định `format` được sử dụng để định nghĩa định dạng của prompt, nếu rỗng hoặc không `format` được cung cấp. Mặc định như sau:
```toml
format = '$all'
# Which is equivalent to
format = """
$username\
$hostname\
$localip\
$shlvl\
$singularity\
$kubernetes\
$directory\
$vcsh\
$fossil_branch\
$fossil_metrics\
$git_branch\
$git_commit\
$git_state\
$git_metrics\
$git_status\
$hg_branch\
$pijul_channel\
$docker_context\
$package\
$c\
$cmake\
$cobol\
$daml\
$dart\
$deno\
$dotnet\
$elixir\
$elm\
$erlang\
$fennel\
$golang\
$guix_shell\
$haskell\
$haxe\
$helm\
$java\
$julia\
$kotlin\
$gradle\
$lua\
$nim\
$nodejs\
$ocaml\
$opa\
$perl\
$php\
$pulumi\
$purescript\
$python\
$raku\
$rlang\
$red\
$ruby\
$rust\
$scala\
$solidity\
$swift\
$terraform\
$vlang\
$vagrant\
$zig\
$buf\
$nix_shell\
$conda\
$meson\
$spack\
$memory_usage\
$aws\
$gcloud\
$openstack\
$azure\
$env_var\
$crystal\
$custom\
$sudo\
$cmd_duration\
$line_break\
$jobs\
$battery\
$time\
$status\
$os\
$container\
$shell\
$character"""
```
If you just want to extend the default format, you can use `$all`; modules you explicitly add to the format will not be duplicated. Eg.
```toml
# Move the directory to the second line
format = '$all$directory$character'
```
## AWS
The `aws` module shows the current AWS region and profile and an expiration timer when using temporary credentials. The output of the module uses the `AWS_REGION`, `AWS_DEFAULT_REGION`, and `AWS_PROFILE` env vars and the `~/.aws/config` and `~/.aws/credentials` files as required.
The module will display a profile only if its credentials are present in `~/.aws/credentials` or if a `credential_process`, `sso_start_url`, or `sso_session` are defined in `~/.aws/config`. Alternatively, having any of the `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, or `AWS_SESSION_TOKEN` env vars defined will also suffice. If the option `force_display` is set to `true`, all available information will be displayed even if no credentials per the conditions above are detected.
When using [aws-vault](https://github.com/99designs/aws-vault) the profile is read from the `AWS_VAULT` env var and the credentials expiration date is read from the `AWS_SESSION_EXPIRATION` env var.
When using [awsu](https://github.com/kreuzwerker/awsu) the profile is read from the `AWSU_PROFILE` env var.
When using [AWSume](https://awsu.me) the profile is read from the `AWSUME_PROFILE` env var and the credentials expiration date is read from the `AWSUME_EXPIRATION` env var.
When using [saml2aws](https://github.com/Versent/saml2aws) the expiration information obtained from `~/.aws/credentials` falls back to the `x_security_token_expires` key.
### Các tuỳ chọn
| Tuỳ chọn | Mặc định | Mô tả |
| ------------------- | --------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
| `format` | `'on [$symbol($profile )(\($region\) )(\[$duration\] )]($style)'` | Định dạng cho module. |
| `symbol` | `'☁️ '` | Kí hiệu sử dụng hiển thị trước profile AWS hiện tại. |
| `region_aliases` | `{}` | Bảng của các region alias để hiển thị ngoài tên AWS. |
| `profile_aliases` | `{}` | Table of profile aliases to display in addition to the AWS name. |
| `style` | `'bold yellow'` | Kiểu cho module. |
| `expiration_symbol` | `X` | The symbol displayed when the temporary credentials have expired. |
| `disabled` | `false` | Vô hiệu `AWS` module. |
| `force_display` | `false` | If `true` displays info even if `credentials`, `credential_process` or `sso_start_url` have not been setup. |
### Các biến
| Biến | Ví dụ | Mô tả |
| --------- | ---------------- | ------------------------------------------- |
| region | `ap-northeast-1` | Region AWS hiện tại |
| profile | `astronauts` | Profile AWS hiện tại |
| duration | `2h27m20s` | The temporary credentials validity duration |
| symbol | | Giá trị ghi đè tuỳ chọn `symbol` |
| style\* | | Giá trị ghi đè của `style` |
*: Biến này có thể chỉ được sử dụng như một phần của style string
### Các ví dụ
#### Hiển thị mọi thứ
```toml
# ~/.config/starship.toml
[aws]
format = 'on [$symbol($profile )(\($region\) )]($style)'
style = 'bold blue'
symbol = '🅰 '
[aws.region_aliases]
ap-southeast-2 = 'au'
us-east-1 = 'va'
[aws.profile_aliases]
CompanyGroupFrobozzOnCallAccess = 'Frobozz'
```
#### Hiển thị region
```toml
# ~/.config/starship.toml
[aws]
format = 'on [$symbol$region]($style) '
style = 'bold blue'
symbol = '🅰 '
[aws.region_aliases]
ap-southeast-2 = 'au'
us-east-1 = 'va'
```
#### Hiển thị profile
```toml
# ~/.config/starship.toml
[aws]
format = 'on [$symbol$profile]($style) '
style = 'bold blue'
symbol = '🅰 '
[aws.profile_aliases]
Enterprise_Naming_Scheme-voidstars = 'void**'
```
## Azure
The `azure` module shows the current Azure Subscription. This is based on showing the name of the default subscription or the username, as defined in the `~/.azure/azureProfile.json` file.
### Các tuỳ chọn
| Biến | Mặc định | Mô tả |
| ---------------------- | ---------------------------------------- | ------------------------------------------------------------------------------------- |
| `format` | `'on [$symbol($subscription)]($style) '` | The format for the Azure module to render. |
| `symbol` | `'󰠅 '` | The symbol used in the format. |
| `style` | `'blue bold'` | The style used in the format. |
| `disabled` | `true` | Disables the `azure` module. |
| `subscription_aliases` | `{}` | Table of subscription name aliases to display in addition to Azure subscription name. |
### Các ví dụ
#### Display Subscription Name
```toml
# ~/.config/starship.toml
[azure]
disabled = false
format = 'on [$symbol($subscription)]($style) '
symbol = '󰠅 '
style = 'blue bold'
```
#### Display Username
```toml
# ~/.config/starship.toml
[azure]
disabled = false
format = "on [$symbol($username)]($style) "
symbol = "󰠅 "
style = "blue bold"
```
#### Display Subscription Name Alias
```toml
# ~/.config/starship.toml
[azure.subscription_aliases]
very-long-subscription-name = 'vlsn'
```
## Battery
`battery` module cho biết cách sạc pin của thiết bị là gì và tình trạng sạc hiện tại của nó. Module chỉ được nhìn thấy khi pin của thiết bị dưới 10%.
### Options
| Tuỳ chọn | Mặc định | Mô tả |
| -------------------- | --------------------------------- | -------------------------------------------------------- |
| `full_symbol` | `'󰁹 '` | Kí hiệu cho biết khi pin đầy. |
| `charging_symbol` | `'󰂄 '` | Kí hiệu cho biết khi ping đang sạc. |
| `discharging_symbol` | `'󰂃 '` | Kí hiệu cho biết khi pin đang không sạc. |
| `unknown_symbol` | `'󰁽 '` | Kí hiệu cho biết khi trạng thái pin không được xác định. |
| `empty_symbol` | `'󰂎 '` | Kí hiệu cho biết khi hết pin. |
| `format` | `'[$symbol$percentage]($style) '` | Định dạng cho module. |
| `display` | [link](#battery-display) | Ngưỡng hiển thị và kiểu cho module. |
| `disabled` | `false` | Vô hiệu `battery` module. |
### Ví dụ
```toml
# ~/.config/starship.toml
[battery]
full_symbol = '🔋 '
charging_symbol = '⚡️ '
discharging_symbol = '💀 '
```
### Hiển thị pin
The `display` configuration option is used to define when the battery indicator should be shown (threshold), which symbol would be used (symbol), and what it would like (style). Nếu `display` không được cung cấp. Mặc định như sau:
```toml
[[battery.display]]
threshold = 10
style = 'bold red'
```
The default value for the `charging_symbol` and `discharging_symbol` option is respectively the value of `battery`'s `charging_symbol` and `discharging_symbol` option.
#### Các tuỳ chọn
Tuỳ chọn `display` là một mảng của của bảng sau.
| Tuỳ chọn | Mặc định | Mô tả |
| -------------------- | ------------ | --------------------------------------------------------------------------------------------------------- |
| `threshold` | `10` | Cận trên cho tuỳ chọn hiển thị. |
| `style` | `'red bold'` | Kiểu sử dụng nếu tuỳ chọn hiển thị được sử dụng bên trong. |
| `charging_symbol` | | Optional symbol displayed if display option is in use, defaults to battery's `charging_symbol` option. |
| `discharging_symbol` | | Optional symbol displayed if display option is in use, defaults to battery's `discharging_symbol` option. |
#### Ví dụ
```toml
[[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%
threshold = 30
style = 'bold yellow'
discharging_symbol = '💦'
# when capacity is over 30%, the battery indicator will not be displayed
```
## Buf
The `buf` module shows the currently installed version of [Buf](https://buf.build). By default, the module is shown if all of the following conditions are met:
- The [`buf`](https://github.com/bufbuild/buf) CLI is installed.
- The current directory contains a [`buf.yaml`](https://docs.buf.build/configuration/v1/buf-yaml), [`buf.gen.yaml`](https://docs.buf.build/configuration/v1/buf-gen-yaml), or [`buf.work.yaml`](https://docs.buf.build/configuration/v1/buf-work-yaml) configuration file.
### Các tuỳ chọn
| Tuỳ chọn | Mặc định | Mô tả |
| ------------------- | ----------------------------------------------- | ----------------------------------------------------- |
| `format` | `'with [$symbol($version )]($style)'` | The format for the `buf` module. |
| `version_format` | `'v${raw}'` | The version format. |
| `symbol` | `'🐃 '` | The symbol used before displaying the version of Buf. |
| `detect_extensions` | `[]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. |
| `detect_files` | `['buf.yaml', 'buf.gen.yaml', 'buf.work.yaml']` | Những tên tệp nào sẽ kích hoạt mô-đun này. |
| `detect_folders` | `[]` | Những thư mục nào nên kích hoạt các mô đun này. |
| `style` | `'bold blue'` | Kiểu cho module. |
| `disabled` | `false` | Vô hiệu mô đun `elixir`. |
### Các biến
| Biến | Ví dụ | Mô tả |
| --------- | -------- | -------------------------------- |
| `version` | `v1.0.0` | The version of `buf` |
| `symbol` | | Giá trị ghi đè tuỳ chọn `symbol` |
| `style`* | | Giá trị ghi đè của `style` |
*: Biến này có thể chỉ được sử dụng như một phần của style string
### Ví dụ
```toml
# ~/.config/starship.toml
[buf]
symbol = '🦬 '
```
## Bun
The `bun` module shows the currently installed version of the [bun](https://bun.sh) JavaScript runtime. Mặc định module sẽ được hiển thị nếu có bất kì điều kiện nào dưới đây thoả mãn:
- Thư mục hiện tại chứa một tập tin `bun.lockb`
- Thư mục hiện tại chứa một tập tin `bunfig.toml`
### Các tuỳ chọn
| Tuỳ chọn | Mặc định | Mô tả |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | Định dạng cho module. |
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'🍞 '` | A format string representing the symbol of Bun. |
| `detect_extensions` | `[]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. |
| `detect_files` | `['bun.lockb', 'bunfig.toml']` | Những tên tệp nào sẽ kích hoạt mô-đun này. |
| `detect_folders` | `[]` | Những thư mục nào sẽ kích hoạt mô-đun này. |
| `style` | `'bold red'` | Kiểu cho module. |
| `disabled` | `false` | Disables the `bun` module. |
### Các biến
| Biến | Ví dụ | Mô tả |
| --------- | -------- | -------------------------------- |
| version | `v0.1.4` | The version of `bun` |
| symbol | | Giá trị ghi đè tuỳ chọn `symbol` |
| style\* | | Giá trị ghi đè của `style` |
*: Biến này có thể chỉ được sử dụng như một phần của style string
### Ví dụ
```toml
# ~/.config/starship.toml
[bun]
format = 'via [🍔 $version](bold green) '
```
## C
The `c` module shows some information about your C compiler. By default the module will be shown if the current directory contains a `.c` or `.h` file.
### Options
| Tuỳ chọn | Mặc định | Mô tả |
| ------------------- | --------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version(-$name) )]($style)'` | The format string for the module. |
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'C '` | The symbol used before displaying the compiler details |
| `detect_extensions` | `['c', 'h']` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. |
| `detect_files` | `[]` | Những tên tệp nào sẽ kích hoạt mô-đun này. |
| `detect_folders` | `[]` | Những thư mục nào sẽ kích hoạt mô-đun này. |
| `commands` | [ [ 'cc', '--version' ], [ 'gcc', '--version' ], [ 'clang', '--version' ] ] | How to detect what the compiler is |
| `style` | `'bold 149'` | Kiểu cho module. |
| `disabled` | `false` | Disables the `c` module. |
### Các biến
| Biến | Ví dụ | Mô tả |
| ------- | ------ | -------------------------------- |
| name | clang | The name of the compiler |
| version | 13.0.0 | The version of the compiler |
| symbol | | Giá trị ghi đè tuỳ chọn `symbol` |
| style | | Giá trị ghi đè của `style` |
NB that `version` is not in the default format.
### Commands
The `commands` option accepts a list of commands to determine the compiler version and name.
Each command is represented as a list of the executable name, followed by its arguments, usually something like `['mycc', '--version']`. Starship will try executing each command until it gets a result on STDOUT.
If a C compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/).
### Ví dụ
```toml
# ~/.config/starship.toml
[c]
format = 'via [$name $version]($style)'
```
## Character
Module `character` cho biết một kí tự (thường là một mũi tên) bên cạnh nơi văn bản được nhập trong terminal của bạn.
Kí tự sẽ nói cho bạn câu lệnh cuối liệu thành công hay thất bại. Nó có thể làm điều này bằng hai cách:
- thay đổi màu(`đỏ`/`xanh lá`)
- thay đổi hình dạng (`❯`/`✖`)
Mặc định, nó chỉ thay đổi màu. If you also want to change its shape take a look at [this example](#with-custom-error-shape).
::: warning
`vimcmd_symbol` is only supported in cmd, fish and zsh. `vimcmd_replace_one_symbol`, `vimcmd_replace_symbol`, and `vimcmd_visual_symbol` are only supported in fish due to [upstream issues with mode detection in zsh](https://github.com/starship/starship/issues/625#issuecomment-732454148).
:::
### Options
| Tuỳ chọn | Mặc định | Mô tả |
| --------------------------- | -------------------- | --------------------------------------------------------------------------------------- |
| `format` | `'$symbol '` | Định dạng chuỗi sử dụng trước văn bản nhập vào. |
| `success_symbol` | `'[❯](bold green)'` | Định dạng chuỗi sửa dụng trước văn bản nhập vào nếu câu lệnh trước đó đã thành công. |
| `error_symbol` | `'[❯](bold red)'` | Định dạng chuỗi sửa dụng trước văn bản nhập vào nếu câu lệnh trước đó đã thất bại. |
| `vimcmd_symbol` | `'[❮](bold green)'` | Định dạng chuỗi sửa dụng trước văn bản nhập vào nếu shell trong chế độ vim normal. |
| `vimcmd_replace_one_symbol` | `'[❮](bold purple)'` | The format string used before the text input if the shell is in vim `replace_one` mode. |
| `vimcmd_replace_symbol` | `'[❮](bold purple)'` | The format string used before the text input if the shell is in vim replace mode. |
| `vimcmd_visual_symbol` | `'[❮](bold yellow)'` | The format string used before the text input if the shell is in vim visual mode. |
| `disabled` | `false` | Vô hiệu module `character`. |
### Các biến
| Biến | Ví dụ | Mô tả |
| ------ | ----- | -------------------------------------------------------------------------------------------------------- |
| symbol | | A mirror of either `success_symbol`, `error_symbol`, `vimcmd_symbol` or `vimcmd_replace_one_symbol` etc. |
### Các ví dụ
#### Có tuỳ chỉnh hình dạng lỗi
```toml
# ~/.config/starship.toml
[character]
success_symbol = '[➜](bold green) '
error_symbol = '[✗](bold red) '
```
#### Không có tuỳ chỉnh hình dạng lỗi
```toml
# ~/.config/starship.toml
[character]
success_symbol = '[➜](bold green) '
error_symbol = '[➜](bold red) '
```
#### Có tuỳ chỉnh hình dạng vim
```toml
# ~/.config/starship.toml
[character]
vimcmd_symbol = '[V](bold green) '
```
## CMake
The `cmake` module shows the currently installed version of [CMake](https://cmake.org/). Mặc định module sẽ được kích hoạt nếu thoả mãn bất kì điều kiện nào dưới đây:
- Đường dẫn hiện tại chứa một tập tin `CmakeLists.txt`
- Đường dẫn hiện tại chứa một tập tin `CMakeCache.txt`
### Options
| Tuỳ chọn | Mặc định | Mô tả |
| ------------------- | -------------------------------------- | ------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | Định dạng cho module. |
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'△ '` | Kí hiệu sử dụng trước phiên bản của cmake. |
| `detect_extensions` | `[]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này |
| `detect_files` | `['CMakeLists.txt', 'CMakeCache.txt']` | Tên tệp nào sẽ kích hoạt mô-đun này |
| `detect_folders` | `[]` | Thư mục nào sẽ kích hoạt mô-đun này |
| `style` | `'bold blue'` | Kiểu cho module. |
| `disabled` | `false` | Vô hiệu hoá `cmake` module. |
### Các biến
| Biến | Ví dụ | Mô tả |
| --------- | --------- | -------------------------------- |
| version | `v3.17.3` | Phiên bản của cmake |
| symbol | | Giá trị ghi đè tuỳ chọn `symbol` |
| style\* | | Giá trị ghi đè của `style` |
*: Biến này có thể chỉ được sử dụng như một phần của style string
## COBOL / GNUCOBOL
The `cobol` module shows the currently installed version of COBOL. By default, the module will be shown if any of the following conditions are met:
- The current directory contains any files ending in `.cob` or `.COB`
- The current directory contains any files ending in `.cbl` or `.CBL`
### Các tuỳ chọn
| Tuỳ chọn | Mặc định | Mô tả |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
| `symbol` | `'⚙️ '` | The symbol used before displaying the version of COBOL. |
| `format` | `'via [$symbol($version )]($style)'` | Định dạng cho module. |
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `style` | `'bold blue'` | Kiểu cho module. |
| `detect_extensions` | `['cbl', 'cob', 'CBL', 'COB']` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. |
| `detect_files` | `[]` | Những tên tệp nào sẽ kích hoạt mô-đun này. |
| `detect_folders` | `[]` | Những thư mục nào sẽ kích hoạt mô-đun này. |
| `disabled` | `false` | Disables the `cobol` module. |
### Các biến
| Biến | Ví dụ | Mô tả |
| --------- | ---------- | -------------------------------- |
| version | `v3.1.2.0` | The version of `cobol` |
| symbol | | Giá trị ghi đè tuỳ chọn `symbol` |
| style\* | | Giá trị ghi đè của `style` |
*: Biến này có thể chỉ được sử dụng như một phần của style string
## Command Duration
Module `cmd_duration`. cho biết câu lệnh cuối cùng thực thi trong bao lâu. Module sẽ được hiện chỉ khi câu lệnh lấy nhiều hơn 2 giây, hoặc giá trị cấu hình `min_time`, nếu nó tồn tại.
::: warning Không thể hook DEBUG trap trong Bash
Nếu bạn đang chạy Starship trong `bash`, không thể hook `DEBUG` trap sau khi chạy `eval $(starship init $0)`, hoặc module này **sẽ** ngắt.
:::
Người dùng Bash, những người cần chức năng giống preexec có thể sử dụng [rcaloras's bash_preexec framework](https://github.com/rcaloras/bash-preexec). Đơn giản là định nghĩa các mảng `preexec_functions` và `precmd_functions` trước khi chạy `eval $(starship init $0)`, và sau đó thực thi như bình thường.
### Options
| Tuỳ chọn | Mặc định | Mô tả |
| ---------------------- | ----------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `min_time` | `2_000` | Khoảng thời gian ngắn nhất để hiện thời gian (tính bằng milliseconds). |
| `show_milliseconds` | `false` | Hiện milliseconds. |
| `format` | `'took [$duration]($style) '` | Định dạng cho module. |
| `style` | `'bold yellow'` | Kiểu cho module. |
| `disabled` | `false` | Vô hiệu module `cmd_duration`. |
| `show_notifications` | `false` | Hiện thông báo desktop khi câu lệnh hoàn thành. |
| `min_time_to_notify` | `45_000` | Khoảng thời gian ngắn nhất để thông báo (tính bằng 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. |
### Các biến
| Biến | Ví dụ | Mô tả |
| --------- | -------- | ------------------------------------- |
| duration | `16m40s` | Thời gian nó lấy để thực thi câu lệnh |
| style\* | | Giá trị ghi đè của `style` |
*: Biến này có thể chỉ được sử dụng như một phần của style string
### Ví dụ
```toml
# ~/.config/starship.toml
[cmd_duration]
min_time = 500
format = 'underwent [$duration](bold yellow)'
```
## Conda
The `conda` module shows the current [Conda](https://docs.conda.io/en/latest/) environment, if `$CONDA_DEFAULT_ENV` is set.
::: tip
Cái này không loại bỏ conda's prompt mà nó sở hữu, bạn có thể muốn chạy `conda config --set changeps1 False`.
:::
### Options
| Tuỳ chọn | Mặc định | Mô tả |
| ------------------- | -------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `truncation_length` | `1` | Số lượng đường dẫn của biến môi trường nên được cắt bớt, nếu biến môi trường được tạo thông qua via `conda create -p [path]`. `0` nghĩa là không cắt bớt. Cũng thấy trong module [`directory`](#directory). |
| `symbol` | `'🅒 '` | Kí hiệu sử dụng trước tên biến môi trường. |
| `style` | `'bold green'` | Kiểu cho module. |
| `format` | `'via [$symbol$environment]($style) '` | Định dạng cho module. |
| `ignore_base` | `true` | Bỏ qua biến môi trường `base` khi đã kích hoạt. |
| `disabled` | `false` | Vô hiệu module `conda`. |
### Các biến
| Biến | Ví dụ | Mô tả |
| ----------- | ------------ | ---------------------------------- |
| environment | `astronauts` | Biến môi trường hiện tại của conda |
| symbol | | Giá trị ghi đè tuỳ chọn `symbol` |
| style\* | | Giá trị ghi đè của `style` |
*: Biến này có thể chỉ được sử dụng như một phần của style string
### Ví dụ
```toml
# ~/.config/starship.toml
[conda]
format = '[$symbol$environment](dimmed green) '
```
## Container
The `container` module displays a symbol and container name, if inside a container.
### Options
| Tuỳ chọn | Mặc định | Mô tả |
| ---------- | ---------------------------------- | ----------------------------------------- |
| `symbol` | `'⬢'` | The symbol shown, when inside a container |
| `style` | `'bold red dimmed'` | Kiểu cho module. |
| `format` | `'[$symbol \[$name\]]($style) '` | Định dạng cho module. |
| `disabled` | `false` | Disables the `container` module. |
### Các biến
| Biến | Ví dụ | Mô tả |
| --------- | ------------------- | -------------------------------- |
| name | `fedora-toolbox:35` | The name of the container |
| symbol | | Giá trị ghi đè tuỳ chọn `symbol` |
| style\* | | Giá trị ghi đè của `style` |
*: Biến này có thể chỉ được sử dụng như một phần của style string
### Ví dụ
```toml
# ~/.config/starship.toml
[container]
format = '[$symbol \[$name\]]($style) '
```
## Crystal
The `crystal` module shows the currently installed version of [Crystal](https://crystal-lang.org/). Mặc định module sẽ được hiển thị nếu có bất kì điều kiện nào dưới đây thoả mãn:
- Đường dẫn hiện tại chứa một tập tin `shard.yml`
- Đường dẫn hiện tại chứa một tập tin `.cr`
### Options
| Tuỳ chọn | Mặc định | Mô tả |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
| `symbol` | `'🔮 '` | Kí hiệu sử dụng trước phiên bản hiển thị của crystal. |
| `format` | `'via [$symbol($version )]($style)'` | Định dạng cho module. |
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `style` | `'bold red'` | Kiểu cho module. |
| `detect_extensions` | `['cr']` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. |
| `detect_files` | `['shard.yml']` | Những tên tệp nào sẽ kích hoạt mô-đun này. |
| `detect_folders` | `[]` | Những thư mục nào sẽ kích hoạt mô-đun này. |
| `disabled` | `false` | Vô hiệu hoá module `crystal`. |
### Các biến
| Biến | Ví dụ | Mô tả |
| --------- | --------- | -------------------------------- |
| version | `v0.32.1` | Phiên bản của `crystal` |
| symbol | | Giá trị ghi đè tuỳ chọn `symbol` |
| style\* | | Giá trị ghi đè của `style` |
*: Biến này có thể chỉ được sử dụng như một phần của style string
### Ví dụ
```toml
# ~/.config/starship.toml
[crystal]
format = 'via [✨ $version](bold blue) '
```
## Daml
The `daml` module shows the currently used [Daml](https://www.digitalasset.com/developers) SDK version when you are in the root directory of your Daml project. The `sdk-version` in the `daml.yaml` file will be used, unless it's overridden by the `DAML_SDK_VERSION` environment variable. Mặc định module sẽ được hiển thị nếu có bất kì điều kiện nào dưới đây thoả mãn:
- Thư mục hiện tại chứa một tập tin `daml.yaml`
### Options
| Tuỳ chọn | Mặc định | Mô tả |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | Định dạng cho module. |
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'Λ '` | A format string representing the symbol of Daml |
| `style` | `'bold cyan'` | Kiểu cho module. |
| `detect_extensions` | `[]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. |
| `detect_files` | `['daml.yaml']` | Những tên tệp nào sẽ kích hoạt mô-đun này. |
| `detect_folders` | `[]` | Những thư mục nào sẽ kích hoạt mô-đun này. |
| `disabled` | `false` | Disables the `daml` module. |
### Các biến
| Biến | Ví dụ | Mô tả |
| --------- | -------- | -------------------------------- |
| version | `v2.2.0` | The version of `daml` |
| symbol | | Giá trị ghi đè tuỳ chọn `symbol` |
| style\* | | Giá trị ghi đè của `style` |
*: Biến này có thể chỉ được sử dụng như một phần của style string
### Ví dụ
```toml
# ~/.config/starship.toml
[daml]
format = 'via [D $version](bold bright-green) '
```
## Dart
The `dart` module shows the currently installed version of [Dart](https://dart.dev/). Mặc định module sẽ được hiển thị nếu có bất kì điều kiện nào dưới đây thoả mãn:
- Đường dẫn hiện tại chứa một tập tin với phần mở rộng `.dart`
- Đường dẫn hiện tại chứa một đường dẫn `.dart_tool`
- Đường dẫn hiện tại chứa một tệp tin `pubspec.yaml`, `pubspec.yml` hoặc `pubspec.lock`
### Options
| Tuỳ chọn | Mặc định | Mô tả |
| ------------------- | ------------------------------------------------- | ------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | Định dạng cho module. |
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'🎯 '` | Một chuỗi định dạng hiển thị biểu tượng của Dart |
| `detect_extensions` | `['dart']` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. |
| `detect_files` | `['pubspec.yaml', 'pubspec.yml', 'pubspec.lock']` | Những tên tệp nào sẽ kích hoạt mô-đun này. |
| `detect_folders` | `['.dart_tool']` | Những thư mục nào sẽ kích hoạt mô-đun này. |
| `style` | `'bold blue'` | Kiểu cho module. |
| `disabled` | `false` | Vô hiệu `dart` module. |
### Các biến
| Biến | Ví dụ | Mô tả |
| --------- | -------- | -------------------------------- |
| version | `v2.8.4` | Phiên bản của `dart` |
| symbol | | Giá trị ghi đè tuỳ chọn `symbol` |
| style\* | | Giá trị ghi đè của `style` |
*: Biến này có thể chỉ được sử dụng như một phần của style string
### Ví dụ
```toml
# ~/.config/starship.toml
[dart]
format = 'via [🔰 $version](bold red) '
```
## Deno
The `deno` module shows you your currently installed version of [Deno](https://deno.land/). Mặc định module sẽ được hiển thị nếu có bất kì điều kiện nào dưới đây thoả mãn:
- The current directory contains a `deno.json`, `deno.jsonc`, `mod.ts`, `mod.js`, `deps.ts` or `deps.js` file
### Options
| Tuỳ chọn | Mặc định | Mô tả |
| ------------------- | ----------------------------------------------------------------------- | ------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | Định dạng cho module. |
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'🦕 '` | A format string representing the symbol of Deno |
| `detect_extensions` | `[]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. |
| `detect_files` | `['deno.json', 'deno.jsonc', 'mod.ts', 'mod.js', 'deps.ts', 'deps.js']` | Những tên tệp nào sẽ kích hoạt mô-đun này. |
| `detect_folders` | `[]` | Những thư mục nào sẽ kích hoạt mô-đun này. |
| `style` | `'green bold'` | Kiểu cho module. |
| `disabled` | `false` | Disables the `deno` module. |
### Các biến
| Biến | Ví dụ | Mô tả |
| --------- | -------- | -------------------------------- |
| version | `v1.8.3` | The version of `deno` |
| symbol | | Giá trị ghi đè tuỳ chọn `symbol` |
| style\* | | Giá trị ghi đè của `style` |
### Ví dụ
```toml
# ~/.config/starship.toml
[deno]
format = 'via [🦕 $version](green bold) '
```
## Đường dẫn
`directory` module hiển thị đường dẫn thư mục hiện hành của bạn,, cắt ngắn ba thư mục cha. Đường dẫn của bạn cũng sẽ được cắt ngắn tới đường dẫn gốc của git repo hiện tại của bạn.
When using the `fish_style_pwd_dir_length` option, instead of hiding the path that is truncated, you will see a shortened name of each directory based on the number you enable for the option.
Cho ví dụ, `~/Dev/Nix/nixpkgs/pkgs` nơi `nixpkgs` là gốc của repo, và tuỳ chọn thiết lập sang `1`. Bây giờ bạn sẽ thấy `~/D/N/nixpkgs/pkgs`, trong khi trước nó là `nixpkgs/pkgs`.
### Options
| Tuỳ chọn | Mặc định | Mô tả |
| ------------------------ | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
| `truncation_length` | `3` | Số lượng thư mục cha của thư mục hiện tại nên được rút gọn. |
| `truncate_to_repo` | `true` | Có hoặc không rút gọn đường dẫn gốc của git repo hiện tại của bạn. |
| `format` | `'[$path]($style)[$read_only]($read_only_style) '` | Định dạng cho module. |
| `style` | `'bold cyan'` | Kiểu cho module. |
| `disabled` | `false` | Vô hiệu mô đun `directory`. |
| `read_only` | `'🔒'` | Biểu tượng để nhận biết thư mục hiện tại là chỉ đọc. |
| `read_only_style` | `'red'` | Style cho biểu tượng chỉ đọc. |
| `truncation_symbol` | `''` | Biểu tượng tiền tố cho các đường dẫn rút gọn. eg: '…/' |
| `before_repo_root_style` | | The style for the path segment above the root of the git repo. The default value is equivalent to `style`. |
| `repo_root_style` | | The style for the root of the git repo. The default value is equivalent to `style`. |
| `repo_root_format` | `'[$before_root_path]($before_repo_root_style)[$repo_root]($repo_root_style)[$path]($style)[$read_only]($read_only_style) '` | The format of a git repo when `before_repo_root_style` and `repo_root_style` is defined. |
| `home_symbol` | `'~'` | Biểu tượng nhận biết thư mục home. |
| `use_os_path_sep` | `true` | Use the OS specific path separator instead of always using `/` (e.g. `\` on Windows) |
<details>
<summary>Mô đun này có một vài tùy chọn nâng cao để điều khiển cách thư mục được hiển thị.</summary>
| Tùy chọn nâng cao | Mặc định | Mô tả |
| --------------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `substitutions` | | A table of substitutions to be made to the path. |
| `fish_style_pwd_dir_length` | `0` | The number of characters to use when applying fish shell pwd path logic. |
| `use_logical_path` | `true` | If `true` render the logical path sourced from the shell via `PWD` or `--logical-path`. If `false` instead render the physical filesystem path with symlinks resolved. |
`substitutions` allows you to define arbitrary replacements for literal strings that occur in the path, for example long network prefixes or development directories (i.e. Java). Note that this will disable the fish style PWD.
```toml
[directory.substitutions]
'/Volumes/network/path' = '/net'
'src/com/long/java/path' = 'mypath'
```
`fish_style_pwd_dir_length` interacts with the standard truncation options in a way that can be surprising at first: if it's non-zero, the components of the path that would normally be truncated are instead displayed with that many characters. For example, the path `/built/this/city/on/rock/and/roll`, which would normally be displayed as `rock/and/roll`, would be displayed as `/b/t/c/o/rock/and/roll` with `fish_style_pwd_dir_length = 1`--the path components that would normally be removed are displayed with a single character. For `fish_style_pwd_dir_length = 2`, it would be `/bu/th/ci/on/rock/and/roll`.
</details>
### Các biến
| Biến | Ví dụ | Mô tả |
| --------- | --------------------- | -------------------------- |
| path | `'D:/Projects'` | Đường dẫn thư mục hiện tại |
| style\* | `'black bold dimmed'` | Giá trị ghi đè của `style` |
*: Biến này có thể chỉ được sử dụng như một phần của style string
<details>
<summary>The git repos have additional variables.</summary>
Let us consider the path `/path/to/home/git_repo/src/lib`
| Biến | Ví dụ | Mô tả |
| ------------------ | --------------------- | --------------------------------------- |
| before_root_path | `'/path/to/home/'` | The path before git root directory path |
| repo_root | `'git_repo'` | The git root directory name |
| path | `'/src/lib'` | The remaining path |
| style | `'black bold dimmed'` | Giá trị ghi đè của `style` |
| repo_root_style | `'underline white'` | Style for git root directory name |
</details>
### Ví dụ
```toml
# ~/.config/starship.toml
[directory]
truncation_length = 8
truncation_symbol = '…/'
```
## Docker Context
The `docker_context` module shows the currently active [Docker context](https://docs.docker.com/engine/context/working-with-contexts/) if it's not set to `default` or if the `DOCKER_MACHINE_NAME`, `DOCKER_HOST` or `DOCKER_CONTEXT` environment variables are set (as they are meant to override the context in use).
### Options
| Tuỳ chọn | Mặc định | Mô tả |
| ------------------- | ------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |
| `format` | `'via [$symbol$context]($style) '` | Định dạng cho module. |
| `symbol` | `'🐳 '` | Biểu tượng sử dụng để hiển thị trước Docker context. |
| `only_with_files` | `true` | Chỉ hiển thị khi có một tệp tin khớp |
| `detect_extensions` | `[]` | Các mở rộng nào nên kích hoạt mô đun này (cần `only_with_files` thiết lập là true). |
| `detect_files` | `['docker-compose.yml', 'docker-compose.yaml', 'Dockerfile']` | Tên tệp tin nào nên kích hoạt mô đun này (cần `only_with_files` được thiết lập là true). |
| `detect_folders` | `[]` | Thư mục nào nên kích hoạt mô đun này (cần `only_with_files` được thiết lập là true). |
| `style` | `'blue bold'` | Kiểu cho module. |
| `disabled` | `false` | Vô hiệu mô đun `docker_context`. |
### Các biến
| Biến | Ví dụ | Mô tả |
| --------- | -------------- | -------------------------------- |
| context | `test_context` | Docker context hiện tại |
| symbol | | Giá trị ghi đè tuỳ chọn `symbol` |
| style\* | | Giá trị ghi đè của `style` |
*: Biến này có thể chỉ được sử dụng như một phần của style string
### Ví dụ
```toml
# ~/.config/starship.toml
[docker_context]
format = 'via [🐋 $context](blue bold)'
```
## Dotnet
The `dotnet` module shows the relevant version of the [.NET Core SDK](https://dotnet.microsoft.com/) for the current directory. Nếu SDK được ghim trong thư mục hiện tại, phiên bản ghim đó được hiển thị. Ngược lại, mô đun hiển thị phiên bản cuối cùng của SDK được cài đặt.
Mặc định, mô đun này sẽ chỉ được hiển thị trong dấu nhắc lệnh của bạn khi một hoặc nhiều tệp tin dưới đây xuất hiện trong thư mục hiện tại:
- `global.json`
- `project.json`
- `Directory.Build.props`
- `Directory.Build.targets`
- `Packages.props`
- `*.csproj`
- `*.fsproj`
- `*.xproj`
Bạn cũng sẽ cần cài đặt .NET Core SDK đúng cách để sử dụng một cách chính xác.
Mô đun này sử dụng cơ chế của bản thân để phát hiện phiên bản của chính nó. Thông thường, nó nhanh gấp đôi nếu chạy `dotnet --version`, nhưng nó có thể hiện sai phiên bản nếu dự án .NET của bạn có một cấu trúc thư mục bất thường. Nếu độ chính xác quan trọng hơn tốc độ, bạn có thể vô hiệu cơ chế bằng cài đặt `heuristic = false` trong các tùy chọn mô đun.
The module will also show the Target Framework Moniker (<https://docs.microsoft.com/en-us/dotnet/standard/frameworks#supported-target-frameworks>) when there is a `.csproj` file in the current directory.
### Options
| Tuỳ chọn | Mặc định | Mô tả |
| ------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )(🎯 $tfm )]($style)'` | Định dạng cho module. |
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'.NET '` | Biểu tượng sử dụng để hiển thị trước phiên bản của dotnet. |
| `heuristic` | `true` | Sử dụng phiên bản phát hiện thông minh hơn. |
| `detect_extensions` | `['csproj', 'fsproj', 'xproj']` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. |
| `detect_files` | `['global.json', 'project.json', 'Directory.Build.props', 'Directory.Build.targets', 'Packages.props']` | Những tên tệp nào sẽ kích hoạt mô-đun này. |
| `detect_folders` | `[]` | Những thư mục nào nên kích hoạt các mô đun này. |
| `style` | `'bold blue'` | Kiểu cho module. |
| `disabled` | `false` | Vô hiệu mô đun `dotnet`. |
### Các biến
| Biến | Ví dụ | Mô tả |
| --------- | ---------------- | ------------------------------------------------------------- |
| version | `v3.1.201` | Phiên bản của `dotnet` sdk |
| tfm | `netstandard2.0` | Target Framework Monike của dự án hiện tại đang được nhắm đến |
| symbol | | Giá trị ghi đè tuỳ chọn `symbol` |
| style\* | | Giá trị ghi đè của `style` |
*: Biến này có thể chỉ được sử dụng như một phần của style string
### Ví dụ
```toml
# ~/.config/starship.toml
[dotnet]
symbol = '🥅 '
style = 'green'
heuristic = false
```
## Elixir
The `elixir` module shows the currently installed version of [Elixir](https://elixir-lang.org/) and [Erlang/OTP](https://erlang.org/doc/). Mặc định module sẽ được hiển thị nếu có bất kì điều kiện nào dưới đây thoả mãn:
- Thư mục hiện tại chứa một tập tin `mix.exs`.
### Options
| Tuỳ chọn | Mặc định | Mô tả |
| ------------------- | ----------------------------------------------------------- | ------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version \(OTP $otp_version\) )]($style)'` | Định dạng cho module elixir. |
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'💧 '` | Kí hiệu sử dụng trước phiên bản hiển thị của Elixir/Erlang. |
| `detect_extensions` | `[]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. |
| `detect_files` | `['mix.exs']` | Những tên tệp nào sẽ kích hoạt mô-đun này. |
| `detect_folders` | `[]` | Những thư mục nào nên kích hoạt các mô đun này. |
| `style` | `'bold purple'` | Kiểu cho module. |
| `disabled` | `false` | Vô hiệu mô đun `elixir`. |
### Các biến
| Biến | Ví dụ | Mô tả |
| ----------- | ------- | -------------------------------- |
| version | `v1.10` | Phiên bản của `elixir` |
| otp_version | | Phiên bản otp của `elixir` |
| symbol | | Giá trị ghi đè tuỳ chọn `symbol` |
| style\* | | Giá trị ghi đè của `style` |
*: Biến này có thể chỉ được sử dụng như một phần của style string
### Ví dụ
```toml
# ~/.config/starship.toml
[elixir]
symbol = '🔮 '
```
## Elm
The `elm` module shows the currently installed version of [Elm](https://elm-lang.org/). Mặc định module sẽ được hiển thị nếu có bất kì điều kiện nào dưới đây thoả mãn:
- Thư mục hiện tại chứa một tập tin `elm.json`
- Thư mục hiện tại chứa một tập tin `elm-package.json`
- Đường dẫn hiện tại chứa một tệp tin `.elm-version`
- Đường dẫn hiện tại chứa một thư mục `elm-stuff`
- The current directory contains `*.elm` files
### Options
| Tuỳ chọn | Mặc định | Mô tả |
| ------------------- | -------------------------------------------------- | ------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | Định dạng cho module. |
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'🌳 '` | Một format string đại diện cho biểu tượng của Elm. |
| `detect_extensions` | `['elm']` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. |
| `detect_files` | `['elm.json', 'elm-package.json', '.elm-version']` | Những tên tệp nào sẽ kích hoạt mô-đun này. |
| `detect_folders` | `['elm-stuff']` | Những thư mục nào nên kích hoạt các mô đun này. |
| `style` | `'cyan bold'` | Kiểu cho module. |
| `disabled` | `false` | Vô hiệu mô đun `elm`. |
### Các biến
| Biến | Ví dụ | Mô tả |
| --------- | --------- | -------------------------------- |
| version | `v0.19.1` | Phiên bản của `elm` |
| symbol | | Giá trị ghi đè tuỳ chọn `symbol` |
| style\* | | Giá trị ghi đè của `style` |
*: Biến này có thể chỉ được sử dụng như một phần của style string
### Ví dụ
```toml
# ~/.config/starship.toml
[elm]
format = 'via [ $version](cyan bold) '
```
## Biến môi trường
The `env_var` module displays the current value of a selected environment variables. Mô đun sẽ được hiển thị chỉ khi bất kì điều kiện nào sau đây thỏa mãn:
- Tùy chọn `variable` khớp với mootjj biến môi trường tồn tại
- Tùy chọn `variable` không được định nghĩa, nhưng tùy chọn `default` là
::: tip
The order in which env_var modules are shown can be individually set by including `${env_var.foo}` in the top level `format` (as it includes a dot, you need to use `${...}`). By default, the `env_var` module will simply show all env_var modules in the order they were defined.
:::
::: 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
| Tuỳ chọn | Mặc định | Mô tả |
| ---------- | ------------------------------ | ---------------------------------------------------------------------------- |
| `symbol` | `""` | Biểu tượng sử dụng để hiển thị trước giá trị của biến. |
| `variable` | | Biến môi trường được hiển thị. |
| `default` | | Giá trị mặc định được hiển thị khi biến được chọn không được định nghĩa. |
| `format` | `"with [$env_value]($style) "` | Định dạng cho module. |
| `mô tả` | `"<env_var module>"` | The description of the module that is shown when running `starship explain`. |
| `disabled` | `false` | Vô hiệu `env_var`. |
### Các biến
| Biến | Ví dụ | Mô tả |
| --------- | ----------------------------------------- | ----------------------------------------------- |
| env_value | `Windows NT` (nếu _variable_ sẽ là `$OS`) | Giá trị biến môi trường của tùy chọn `variable` |
| symbol | | Giá trị ghi đè tuỳ chọn `symbol` |
| style\* | `black bold dimmed` | Giá trị ghi đè của `style` |
*: Biến này có thể chỉ được sử dụng như một phần của style string
### Ví dụ
```toml
# ~/.config/starship.toml
[env_var]
variable = 'SHELL'
default = 'unknown shell'
```
Displaying multiple environmental variables:
```toml
# ~/.config/starship.toml
[env_var.SHELL]
variable = 'SHELL'
default = 'unknown shell'
[env_var.USER]
default = 'unknown user'
```
## Erlang
The `erlang` module shows the currently installed version of [Erlang/OTP](https://erlang.org/doc/). Mặc định module sẽ được hiển thị nếu có bất kì điều kiện nào dưới đây thoả mãn:
- Thư mục hiện tại chứa một tập tin `rebar.config`.
- Thư mục hiện tại chứa một tập tin `erlang.mk`.
### Options
| Tuỳ chọn | Mặc định | Mô tả |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | Định dạng cho module. |
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `' '` | Biểu tượng sử dụng để hiển thị trước phiên bản của erlang. |
| `style` | `'bold red'` | Kiểu cho module. |
| `detect_extensions` | `[]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. |
| `detect_files` | `['rebar.config', 'elang.mk']` | Những tên tệp nào sẽ kích hoạt mô-đun này. |
| `detect_folders` | `[]` | Những thư mục nào nên kích hoạt các mô đun này. |
| `disabled` | `false` | Vô hiệu mô đun `erlang`. |
### Các biến
| Biến | Ví dụ | Mô tả |
| --------- | --------- | -------------------------------- |
| version | `v22.1.3` | The version of `erlang` |
| symbol | | Giá trị ghi đè tuỳ chọn `symbol` |
| style\* | | Giá trị ghi đè của `style` |
*: Biến này có thể chỉ được sử dụng như một phần của style string
### Ví dụ
```toml
# ~/.config/starship.toml
[erlang]
format = 'via [e $version](bold red) '
```
## Fennel
The `fennel` module shows the currently installed version of [Fennel](https://fennel-lang.org). Mặc định module sẽ được hiển thị nếu có bất kì điều kiện nào dưới đây thoả mãn:
- The current directory contains a file with the `.fnl` extension
### Options
| Tuỳ chọn | Mặc định | Mô tả |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | Định dạng cho module. |
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'🧅 '` | The symbol used before displaying the version of fennel. |
| `style` | `'bold green'` | Kiểu cho module. |
| `detect_extensions` | `[fnl]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. |
| `detect_files` | `[]` | Những tên tệp nào sẽ kích hoạt mô-đun này. |
| `detect_folders` | `[]` | Những thư mục nào nên kích hoạt các mô đun này. |
| `disabled` | `false` | Disables the `fennel` module. |
### Các biến
| Biến | Ví dụ | Mô tả |
| --------- | -------- | -------------------------------- |
| version | `v1.2.1` | The version of `fennel` |
| symbol | | Giá trị ghi đè tuỳ chọn `symbol` |
| style\* | | Giá trị ghi đè của `style` |
*: Biến này có thể chỉ được sử dụng như một phần của style string
### Ví dụ
```toml
# ~/.config/starship.toml
[fennel]
symbol = '⫰ '
```
## Fill
The `fill` module fills any extra space on the line with a symbol. If multiple `fill` modules are present in a line they will split the space evenly between them. This is useful for aligning other modules.
### Các tuỳ chọn
| Tuỳ chọn | Mặc định | Mô tả |
| ---------- | -------------- | --------------------------------- |
| `symbol` | `'.'` | The symbol used to fill the line. |
| `style` | `'bold black'` | Kiểu cho module. |
| `disabled` | `false` | Disables the `fill` module |
### Ví dụ
```toml
# ~/.config/starship.toml
format = 'AA $fill BB $fill CC'
[fill]
symbol = '-'
style = 'bold green'
```
Produces a prompt that looks like:
```
AA -------------------------------------------- BB -------------------------------------------- CC
```
## Fossil Branch
The `fossil_branch` module shows the name of the active branch of the check-out in your current directory.
### Options
| Tuỳ chọn | Mặc định | Mô tả |
| ------------------- | -------------------------------- | ------------------------------------------------------------------------------------------- |
| `format` | `'on [$symbol$branch]($style) '` | Định dạng cho module. Use `'$branch'` to refer to the current branch name. |
| `symbol` | `' '` | The symbol used before the branch name of the check-out in your current directory. |
| `style` | `'bold purple'` | Kiểu cho module. |
| `truncation_length` | `2^63 - 1` | Truncates a Fossil branch name to `N` graphemes |
| `truncation_symbol` | `'…'` | Biểu tượng sử dụng để nhận biết một tên nhánh được rút gọn. You can use `''` for no symbol. |
| `disabled` | `true` | Disables the `fossil_branch` module. |
### Các biến
| Biến | Ví dụ | Mô tả |
| --------- | ------- | -------------------------------- |
| branch | `trunk` | The active Fossil branch |
| symbol | | Giá trị ghi đè tuỳ chọn `symbol` |
| style\* | | Giá trị ghi đè của `style` |
*: Biến này có thể chỉ được sử dụng như một phần của style string
### Ví dụ
```toml
# ~/.config/starship.toml
[fossil_branch]
symbol = '🦎 '
truncation_length = 4
truncation_symbol = ''
```
## Fossil Metrics
The `fossil_metrics` module will show the number of added and deleted lines in the check-out in your current directory. At least v2.14 (2021-01-20) of Fossil is required.
### Options
| Tuỳ chọn | Mặc định | Mô tả |
| -------------------- | ------------------------------------------------------------ | ------------------------------------- |
| `format` | `'([+$added]($added_style) )([-$deleted]($deleted_style) )'` | Định dạng cho module. |
| `added_style` | `'bold green'` | The style for the added count. |
| `deleted_style` | `'bold red'` | The style for the deleted count. |
| `only_nonzero_diffs` | `true` | Render status only for changed items. |
| `disabled` | `true` | Disables the `fossil_metrics` module. |
### Các biến
| Biến | Ví dụ | Mô tả |
| ----------------- | ----- | ------------------------------------------- |
| added | `1` | The current number of added lines |
| deleted | `2` | The current number of deleted lines |
| added_style\* | | Mirrors the value of option `added_style` |
| deleted_style\* | | Mirrors the value of option `deleted_style` |
*: Biến này có thể chỉ được sử dụng như một phần của style string
### Ví dụ
```toml
# ~/.config/starship.toml
[fossil_metrics]
added_style = 'bold blue'
format = '[+$added]($added_style)/[-$deleted]($deleted_style) '
```
## Google Cloud (`gcloud`)
Mô đun `gcloud` hiển thị cấu hình hiện tại của [`gcloud`](https://cloud.google.com/sdk/gcloud) CLI. Cái này dựa trên tập tin `~/.config/gcloud/active_config`, `~/.config/gcloud/configurations/config_{CONFIG NAME}` và biến môi trường `CLOUDSDK_CONFIG`.
When the module is enabled it will always be active, unless `detect_env_vars` has been set in which case the module will only be active be active when one of the environment variables has been set.
### Options
| Tuỳ chọn | Mặc định | Mô tả |
| ----------------- | ---------------------------------------------------------- | ----------------------------------------------------------------- |
| `format` | `'on [$symbol$account(@$domain)(\($region\))]($style) '` | Định dạng cho module. |
| `symbol` | `'☁️ '` | Kí hiệu sử dụng hiển thị trước profile GCP hiện tại. |
| `region_aliases` | `{}` | Bảng ánh xạ của các bí danh của region để hiển thị ngoài tên GCP. |
| `project_aliases` | `{}` | Table of project aliases to display in addition to the GCP name. |
| `detect_env_vars` | `[]` | Which environmental variables should trigger this module |
| `style` | `'bold blue'` | Kiểu cho module. |
| `disabled` | `false` | Vô hiệu mô đun `gcloud`. |
### Các biến
| Biến | Ví dụ | Mô tả |
| --------- | ------------- | -------------------------------------------------------------------- |
| region | `us-central1` | Region GCP hiện tại |
| account | `foo` | Profile hiện tại của GCP |
| domain | `example.com` | The current GCP profile domain |
| project | | Dự án hiện tại của GCP |
| active | `default` | Tên cấu hình có hiệu lực viết trong `~/.config/gcloud/active_config` |
| symbol | | Giá trị ghi đè tuỳ chọn `symbol` |
| style\* | | Giá trị ghi đè của `style` |
*: Biến này có thể chỉ được sử dụng như một phần của style string
### Các ví dụ
#### Hiển thị tài khoản và dự án
```toml
# ~/.config/starship.toml
[gcloud]
format = 'on [$symbol$account(@$domain)(\($project\))]($style) '
```
#### Chỉ hiển thị tên cấu hình hiệu lực
```toml
# ~/.config/starship.toml
[gcloud]
format = '[$symbol$active]($style) '
style = 'bold yellow'
```
#### Hiển thị tài khoản và bí danh khu vực
```toml
# ~/.config/starship.toml
[gcloud]
symbol = '️🇬️ '
[gcloud.region_aliases]
us-central1 = 'uc1'
asia-northeast1 = 'an1'
```
#### Display account and aliased project
```toml
# ~/.config/starship.toml
[gcloud]
format = 'on [$symbol$account(@$domain)(\($project\))]($style) '
[gcloud.project_aliases]
very-long-project-name = 'vlpn'
```
## Git Branch
Mô đun `git_branch` hiển thị nhánh hiệu lực của repo trong thư mục hiện tại của bạn.
### Options
| Tuỳ chọn | Mặc định | Mô tả |
| -------------------- | ------------------------------------------------- | ------------------------------------------------------------------------------------------- |
| `always_show_remote` | `false` | Hiển thị tên nhánh remote tracking, thậm chí nếu nó bằng với tên nhánh local. |
| `format` | `'on [$symbol$branch(:$remote_branch)]($style) '` | Định dạng cho module. Use `'$branch'` to refer to the current branch name. |
| `symbol` | `' '` | Một chuỗi định dạng hiển thị biểu tượng của nhánh git. |
| `style` | `'bold purple'` | Kiểu cho module. |
| `truncation_length` | `2^63 - 1` | Truncates a git branch to `N` graphemes. |
| `truncation_symbol` | `'…'` | Biểu tượng sử dụng để nhận biết một tên nhánh được rút gọn. You can use `''` for no symbol. |
| `only_attached` | `false` | Only show the branch name when not in a detached `HEAD` state. |
| `ignore_branches` | `[]` | A list of names to avoid displaying. Useful for 'master' or 'main'. |
| `disabled` | `false` | Vô hiệu mô đun `git_branch`. |
### Các biến
| Biến | Ví dụ | Mô tả |
| ------------- | -------- | ------------------------------------------------------------------------------------------------------ |
| branch | `master` | The current branch name, falls back to `HEAD` if there's no current branch (e.g. git detached `HEAD`). |
| remote_name | `origin` | Tên remote. |
| remote_branch | `master` | Tên của nhánh đã theo dõi trên `remote_name`. |
| symbol | | Giá trị ghi đè tuỳ chọn `symbol` |
| style\* | | Giá trị ghi đè của `style` |
*: Biến này có thể chỉ được sử dụng như một phần của style string
### Ví dụ
```toml
# ~/.config/starship.toml
[git_branch]
symbol = '🌱 '
truncation_length = 4
truncation_symbol = ''
ignore_branches = ['master', 'main']
```
## Git Commit
Mô đun `git_commit` hiển thị hash commit hiện tại và tag (nếu có) của repo trong thư mục hiện tại của bạn.
### Options
| Tuỳ chọn | Mặc định | Mô tả |
| -------------------- | ------------------------------ | ------------------------------------------------------------------------------------ |
| `commit_hash_length` | `7` | Độ dài của git commit hash được hiển thị. |
| `format` | `'[\($hash$tag\)]($style) '` | Định dạng cho module. |
| `style` | `'bold green'` | Kiểu cho module. |
| `only_detached` | `true` | Only show git commit hash when in detached `HEAD` state |
| `tag_disabled` | `true` | Vô hiệu hiển thị thông tin tag trong mô đun `git_commit`. |
| `tag_max_candidates` | `0` | How many commits to consider for tag display. The default only allows exact matches. |
| `tag_symbol` | `' 🏷 '` | Biểu tượng tag trước thông tin được hiển thị |
| `disabled` | `false` | Vô hiệu mô đun `git_commit`. |
### Các biến
| Biến | Ví dụ | Mô tả |
| --------- | --------- | -------------------------------------------- |
| hash | `b703eb3` | Git commit hash hiện tại |
| tag | `v1.0.0` | The tag name if showing tag info is enabled. |
| style\* | | Giá trị ghi đè của `style` |
*: Biến này có thể chỉ được sử dụng như một phần của style string
### Ví dụ
```toml
# ~/.config/starship.toml
[git_commit]
commit_hash_length = 4
tag_symbol = '🔖 '
```
## Git State
Mô đun `git_state` sẽ hiển hiển thị trong các thư mục là một phần của gt repository và những nơi tồn tại một hoạt động trong tiến trình như _REBASING_, _BISECTING_. Nếu có thông tin tiến trình (ví dụ, REBASING 3/10), thông tin đó cũng sẽ được hiển thị.
### Options
| Tuỳ chọn | Mặc định | Mô tả |
| -------------- | --------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
| `rebase` | `'REBASING'` | Một format sring hiển thị khi một `rebase` đang trong quá trình. |
| `merge` | `'MERGING'` | Một format sring hiển thị khi một `merge` đang trong quá trình. |
| `revert` | `'REVERTING'` | Một format sring hiển thị khi một `revert` đang trong quá trình. |
| `cherry_pick` | `'CHERRY-PICKING'` | Một format sring hiển thị khi một `cherry-pick` đang trong quá trình. |
| `bisect` | `'BISECTING'` | Một format sring hiển thị khi một `bisect` đang trong quá trình. |
| `am` | `'AM'` | Một format sring hiển thị khi một `apply-mailbox` (`git am`) đang trong quá trình. |
| `am_or_rebase` | `'AM/REBASE'` | Một format sring hiển thị khi một `apply-mailbox` (`rebase`) đang trong quá trình. |
| `style` | `'bold yellow'` | Kiểu cho module. |
| `format` | `'\([$state( $progress_current/$progress_total)]($style)\) '` | Định dạng cho module. |
| `disabled` | `false` | Vô hiệu `git_state` module. |
### Các biến
| Biến | Ví dụ | Mô tả |
| ---------------- | ---------- | --------------------------------- |
| state | `REBASING` | Trạng thái của repo hiện tại |
| progress_current | `1` | Trạng thái của quá trình hiện tại |
| progress_total | `2` | Tổng số các quá trình |
| style\* | | Giá trị ghi đè của `style` |
*: Biến này có thể chỉ được sử dụng như một phần của style string
### Ví dụ
```toml
# ~/.config/starship.toml
[git_state]
format = '[\($state( $progress_current of $progress_total)\)]($style) '
cherry_pick = '[🍒 PICKING](bold red)'
```
## Git Metrics
The `git_metrics` module will show the number of added and deleted lines in the current git repository.
::: tip
Mặc định, mô đun này được vô hiệu. Để kích hoạt nó, thiết lập `disabled` sang `false` trong tập tin cấu hình của bạn.
:::
### Options
| Tuỳ chọn | Mặc định | Mô tả |
| -------------------- | ------------------------------------------------------------ | ------------------------------------- |
| `added_style` | `'bold green'` | The style for the added count. |
| `deleted_style` | `'bold red'` | The style for the deleted count. |
| `only_nonzero_diffs` | `true` | Render status only for changed items. |
| `format` | `'([+$added]($added_style) )([-$deleted]($deleted_style) )'` | Định dạng cho module. |
| `disabled` | `true` | Disables the `git_metrics` module. |
| `ignore_submodules` | `false` | Ignore changes to submodules |
### Các biến
| Biến | Ví dụ | Mô tả |
| ----------------- | ----- | ------------------------------------------- |
| added | `1` | The current number of added lines |
| deleted | `2` | The current number of deleted lines |
| added_style\* | | Mirrors the value of option `added_style` |
| deleted_style\* | | Mirrors the value of option `deleted_style` |
*: Biến này có thể chỉ được sử dụng như một phần của style string
### Ví dụ
```toml
# ~/.config/starship.toml
[git_metrics]
added_style = 'bold blue'
format = '[+$added]($added_style)/[-$deleted]($deleted_style) '
```
## Git Status
Mô đun `git_status` hiển thị các biểu tượng đại diện cho trạng thái của repo trong thư mục hiện tại của bạn.
::: tip
The Git Status module is very slow in Windows directories (for example under `/mnt/c/`) when in a WSL environment. You can disable the module or use the `windows_starship` option to use a Windows-native Starship executable to compute `git_status` for those paths.
:::
### Options
| Tuỳ chọn | Mặc định | Mô tả |
| ------------------- | ----------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
| `format` | `'([\[$all_status$ahead_behind\]]($style) )'` | Định dạng mặc định cho `git_status` |
| `conflicted` | `'='` | Nhánh này có nhiều merge conflicts. |
| `ahead` | `'⇡'` | Định dạng của `ahead` |
| `behind` | `'⇣'` | Định dạng của `behind` |
| `diverged` | `'⇕'` | Định dạng của `diverged` |
| `up_to_date` | `''` | The format of `up_to_date` |
| `untracked` | `'?'` | Định dạng của `untracked` |
| `stashed` | `'$'` | Định dạng của `stashed` |
| `modified` | `'!'` | Định dạng của `modified` |
| `staged` | `'+'` | Định dạng của `modified` |
| `renamed` | `'»'` | Định dạng của `renamed` |
| `deleted` | `'✘'` | Định dạng của `deleted` |
| `typechanged` | `""` | The format of `typechange` |
| `style` | `'bold red'` | Kiểu cho module. |
| `ignore_submodules` | `false` | Ignore changes to submodules. |
| `disabled` | `false` | Vô hiệu `git_status` module. |
| `windows_starship` | | Use this (Linux) path to a Windows Starship executable to render `git_status` when on Windows paths in WSL. |
### Các biến
Các biến dưới đây có thể được sử dụng trong `format`:
| Biến | Mô tả |
| -------------- | ------------------------------------------------------------------------------------------------------------- |
| `all_status` | Shortcut cho `$conflicted$stashed$deleted$renamed$modified$staged$untracked` |
| `ahead_behind` | Displays `diverged`, `ahead`, `behind` or `up_to_date` format string based on the current status of the repo. |
| `conflicted` | Hiển thị `conflicted` khi nhánh này có merge conflicts. |
| `untracked` | Hiển thị `untracked` khi có tệp tin untracked trong thư mục làm việc. |
| `stashed` | Hiển thị `stashed` khi một stash tồn tại trong local repository. |
| `modified` | Hiển thị `modified` khi có tệp tin được chỉnh sửa trong thư mục làm việc. |
| `staged` | Hiển thị `staged` khi một tệp tin mới được thêm vào staging area. |
| `renamed` | Hiển thị `renamed` khi một tệp tin đổi tên đã được thêm vào staging area. |
| `deleted` | Hiển thị `deleted` khi một tệp tin bị xóa đã được thêm vào staging area. |
| `typechanged` | Displays `typechange` when a file's type has been changed in the staging area. |
| style\* | Giá trị ghi đè của `style` |
*: Biến này có thể chỉ được sử dụng như một phần của style string
Các biến sau có thể được sử dụng trong `diverged`:
| Biến | Mô tả |
| -------------- | --------------------------------------------- |
| `ahead_count` | Số lượng commit phía trước của nhánh tracking |
| `behind_count` | Số lượng commit phía sau nhánh tracking |
Các biến sau có thể được sử dụng trong `conflicted`, `ahead`, `behind`, `untracked`, `stashed`, `modified`, `staged`, `renamed` and `deleted`:
| Biến | Mô tả |
| ------- | ----------------------------- |
| `count` | Hiển thị số lượng các tệp tin |
### Ví dụ
```toml
# ~/.config/starship.toml
[git_status]
conflicted = '🏳'
ahead = '🏎💨'
behind = '😰'
diverged = '😵'
up_to_date = '✓'
untracked = '🤷'
stashed = '📦'
modified = '📝'
staged = '[++\($count\)](green)'
renamed = '👅'
deleted = '🗑'
```
Hiển thị tổng số nhánh phía trước/phía sau của nhánh được track
```toml
# ~/.config/starship.toml
[git_status]
ahead = '⇡${count}'
diverged = '⇕⇡${ahead_count}⇣${behind_count}'
behind = '⇣${count}'
```
Use Windows Starship executable on Windows paths in WSL
```toml
# ~/.config/starship.toml
[git_status]
windows_starship = '/mnt/c/Users/username/scoop/apps/starship/current/starship.exe'
```
## Go
The `golang` module shows the currently installed version of [Go](https://golang.org/). Mặc định module sẽ được hiển thị nếu có bất kì điều kiện nào dưới đây thoả mãn:
- Thư mục hiện tại chứa một tập tin `go.mod`
- Thư mục hiện tại chứa một tập tin `go.sum`
- Thư mục hiện tại chứa một tập tin `go.work`
- Thư mục hiện tại chứa một tập tin `glide.yaml`
- Thư mục hiện tại chứa một tập tin `Gopkg.yml`
- Đường dẫn hiện tại chứa một tập tin `Gopkg.lock`
- Thư mục hiện tại chứa một tệp tin `.go-version`
- Thư mục hiện tại chứa một thư mục `Godeps`
- Thư mục hiện tại chứa một tệp tin với phần mở rộng `.go`
### Các tuỳ chọn
| Tuỳ chọn | Mặc định | Mô tả |
| ------------------- | ----------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | Định dạng cho module. |
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'🐹 '` | Một format string đại diện cho biểu tượng của Go. |
| `detect_extensions` | `['go']` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. |
| `detect_files` | `['go.mod', 'go.sum', 'go.work', 'glide.yaml', 'Gopkg.yml', 'Gopkg.lock', '.go-version']` | Những tên tệp nào sẽ kích hoạt mô-đun này. |
| `detect_folders` | `['Godeps']` | Những thư mục nào sẽ kích hoạt mô-đun này. |
| `style` | `'bold cyan'` | Kiểu cho module. |
| `not_capable_style` | `'bold red'` | The style for the module when the go directive in the go.mod file does not match the installed Go version. |
| `disabled` | `false` | Vô hiệu `golang` module. |
### Các biến
| Biến | Ví dụ | Mô tả |
| ----------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
| version | `v1.12.1` | Phiên bản của `go` |
| mod_version | `1.16` | `go` version requirement as set in the go directive of `go.mod`. Will only show if the version requirement does not match the `go` version. |
| symbol | | Giá trị ghi đè tuỳ chọn `symbol` |
| style\* | | Giá trị ghi đè của `style` |
*: Biến này có thể chỉ được sử dụng như một phần của style string
### Ví dụ
```toml
# ~/.config/starship.toml
[golang]
format = 'via [🏎💨 $version](bold cyan) '
```
### Using `mod_version`
```toml
# ~/.config/starship.toml
[golang]
format = 'via [$symbol($version )($mod_version )]($style)'
```
## Guix-shell
The `guix_shell` module shows the [guix-shell](https://guix.gnu.org/manual/devel/en/html_node/Invoking-guix-shell.html) environment. The module will be shown when inside a guix-shell environment.
### Các tuỳ chọn
| Tuỳ chọn | Mặc định | Mô tả |
| ---------- | -------------------------- | ------------------------------------------------------ |
| `format` | `'via [$symbol]($style) '` | Định dạng cho module. |
| `symbol` | `"🐃 "` | A format string representing the symbol of guix-shell. |
| `style` | `"yellow bold"` | Kiểu cho module. |
| `disabled` | `false` | Disables the `guix_shell` module. |
### Các biến
| Biến | Ví dụ | Mô tả |
| --------- | ----- | -------------------------------- |
| symbol | | Giá trị ghi đè tuỳ chọn `symbol` |
| style\* | | Giá trị ghi đè của `style` |
*: Biến này có thể chỉ được sử dụng như một phần của style string
### Ví dụ
```toml
# ~/.config/starship.toml
[guix_shell]
disabled = true
format = 'via [🐂](yellow bold) '
```
## Gradle
The `gradle` module shows the version of the [Gradle Wrapper](https://docs.gradle.org/current/userguide/gradle_wrapper.html) currently used in the project directory.
Mặc định module sẽ được hiển thị nếu có bất kì điều kiện nào dưới đây thoả mãn:
- The current directory contains a `gradle/wrapper/gradle-wrapper.properties` directory.
- The current directory contains a file ending with `.gradle` or `.gradle.kts`.
The `gradle` module is only able to read your Gradle Wrapper version from your config file, we don't execute your wrapper, because of the security concerns.
### Các tuỳ chọn
| Tuỳ chọn | Mặc định | Mô tả |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | Định dạng cho module. |
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `"🅶 "` | A format string representing the symbol of Gradle. |
| `detect_extensions` | `["gradle", "gradle.kts"]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. |
| `detect_files` | `[]` | Những tên tệp nào sẽ kích hoạt mô-đun này. |
| `detect_folders` | `["gradle"]` | Những thư mục nào sẽ kích hoạt mô-đun này. |
| `style` | `"bold bright-cyan"` | Kiểu cho module. |
| `disabled` | `false` | Disables the `gradle` module. |
| `recursive` | `false` | Enables recursive finding for the `gradle` directory. |
### Các biến
| Biến | Ví dụ | Mô tả |
| ------- | -------- | -------------------------------- |
| version | `v7.5.1` | The version of `gradle` |
| symbol | | Giá trị ghi đè tuỳ chọn `symbol` |
| style* | | Giá trị ghi đè của `style` |
*: Biến này có thể chỉ được sử dụng như một phần của style string
## Haskell
The `haskell` module finds the current selected GHC version and/or the selected Stack snapshot.
Mặc định module sẽ được hiển thị nếu có bất kì điều kiện nào dưới đây thoả mãn:
- Thư mục hiện tại chứa một tập tin `stack.yaml`
- The current directory contains any `.hs`, `.cabal`, or `.hs-boot` file
### Các tuỳ chọn
| Tuỳ chọn | Mặc định | Mô tả |
| ------------------- | ------------------------------------ | --------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | Định dạng cho module. |
| `symbol` | `'λ '` | A format string representing the symbol of Haskell |
| `detect_extensions` | `['hs', 'cabal', 'hs-boot']` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. |
| `detect_files` | `['stack.yaml', 'cabal.project']` | Những tên tệp nào sẽ kích hoạt mô-đun này. |
| `detect_folders` | `[]` | Những thư mục nào sẽ kích hoạt mô-đun này. |
| `style` | `'bold purple'` | Kiểu cho module. |
| `disabled` | `false` | Disables the `haskell` module. |
### Các biến
| Biến | Ví dụ | Mô tả |
| -------------- | ----------- | --------------------------------------------------------------------------------------- |
| version | | `ghc_version` or `snapshot` depending on whether the current project is a Stack project |
| snapshot | `lts-18.12` | Currently selected Stack snapshot |
| ghc\_version | `9.2.1` | Currently installed GHC version |
| symbol | | Giá trị ghi đè tuỳ chọn `symbol` |
| style\* | | Giá trị ghi đè của `style` |
*: Biến này có thể chỉ được sử dụng như một phần của style string
## Haxe
The `haxe` module shows the currently installed version of [Haxe](https://haxe.org/). Mặc định module sẽ được hiển thị nếu có bất kì điều kiện nào dưới đây thoả mãn:
- The current directory contains a `project.xml`, `Project.xml`, `application.xml`, `haxelib.json`, `hxformat.json` or `.haxerc` file
- The current directory contains a `.haxelib` or a `haxe_libraries` directory
- The current directory contains a file with the `.hx` or `.hxml` extension
### Các tuỳ chọn
| Tuỳ chọn | Mặc định | Mô tả |
| ------------------- | ----------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | Định dạng cho module. |
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `detect_extensions` | `["hx", "hxml"]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. |
| `detect_files` | `["project.xml", "Project.xml", "application.xml", "haxelib.json", "hxformat.json", ".haxerc"]` | Những tên tệp nào sẽ kích hoạt mô-đun này. |
| `detect_folders` | `[".haxelib", "haxe_libraries"]` | Những thư mục nào nên kích hoạt các mô đun này. |
| `symbol` | `"⌘ "` | Một format string đại diện cho biểu tượng của Helm. |
| `style` | `"bold fg:202"` | Kiểu cho module. |
| `disabled` | `false` | Disables the `haxe` module. |
### Các biến
| Biến | Ví dụ | Mô tả |
| --------- | -------- | -------------------------------- |
| version | `v4.2.5` | The version of `haxe` |
| symbol | | Giá trị ghi đè tuỳ chọn `symbol` |
| style\* | | Giá trị ghi đè của `style` |
*: Biến này có thể chỉ được sử dụng như một phần của style string
### Ví dụ
```toml
# ~/.config/starship.toml
[haxe]
format = "via [⌘ $version](bold fg:202) "
```
## Helm
The `helm` module shows the currently installed version of [Helm](https://helm.sh/). Mặc định module sẽ được hiển thị nếu có bất kì điều kiện nào dưới đây thoả mãn:
- Thư mục hiện tại chứa một tập tin `helmfile.yaml`
- Thư mục hiện tại chứa một tập tin `Chart.yaml`
### Các tuỳ chọn
| Tuỳ chọn | Mặc định | Mô tả |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | Định dạng cho module. |
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `detect_extensions` | `[]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. |
| `detect_files` | `['helmfile.yaml', 'Chart.yaml']` | Những tên tệp nào sẽ kích hoạt mô-đun này. |
| `detect_folders` | `[]` | Những thư mục nào nên kích hoạt các mô đun này. |
| `symbol` | `'⎈ '` | Một format string đại diện cho biểu tượng của Helm. |
| `style` | `'bold white'` | Kiểu cho module. |
| `disabled` | `false` | Vô hiệu `helm` module. |
### Các biến
| Biến | Ví dụ | Mô tả |
| --------- | -------- | -------------------------------- |
| version | `v3.1.1` | Phiên bản của `helm` |
| symbol | | Giá trị ghi đè tuỳ chọn `symbol` |
| style\* | | Giá trị ghi đè của `style` |
*: Biến này có thể chỉ được sử dụng như một phần của style string
### Ví dụ
```toml
# ~/.config/starship.toml
[helm]
format = 'via [⎈ $version](bold white) '
```
## Hostname
Mô đun `hostname` hiển thị hostnam hệ thống.
### Các tuỳ chọn
| Tuỳ chọn | Mặc định | Mô tả |
| ------------ | -------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
| `ssh_only` | `true` | Chỉ hiển thị hostname khi được kết nối tới một phiên SSH. |
| `ssh_symbol` | `'🌐 '` | A format string representing the symbol when connected to SSH session. |
| `trim_at` | `'.'` | Chuỗi mà hostname được cắt ngắn, sau khi khớp lần đầu tiên. `'.'` will stop after the first dot. `''` will disable any truncation |
| `format` | `'[$ssh_symbol$hostname]($style) in '` | Định dạng cho module. |
| `style` | `'bold dimmed green'` | Kiểu cho module. |
| `disabled` | `false` | Vô hiệu `hastname` module. |
### Các biến
| Biến | Ví dụ | Mô tả |
| ---------- | ---------- | ----------------------------------------------------- |
| hostname | `computer` | The hostname of the computer |
| style\* | | Giá trị ghi đè của `style` |
| ssh_symbol | `'🌏 '` | The symbol to represent when connected to SSH session |
*: Biến này có thể chỉ được sử dụng như một phần của style string
### Ví dụ
```toml
# ~/.config/starship.toml
[hostname]
ssh_only = false
format = '[$ssh_symbol](bold blue) on [$hostname](bold red) '
trim_at = '.companyname.com'
disabled = false
```
## Java
The `java` module shows the currently installed version of [Java](https://www.oracle.com/java/). Mặc định module sẽ được hiển thị nếu có bất kì điều kiện nào dưới đây thoả mãn:
- The current directory contains a `pom.xml`, `build.gradle.kts`, `build.sbt`, `.java-version`, `deps.edn`, `project.clj`, `build.boot`, or `.sdkmanrc` file
- Thư mục hiện tại chứa một tệp tin với phần mở rộng `.java`, `.class`, `.gradle`, `.jar`, `.clj`, or `.cljc`
### Các tuỳ chọn
| Tuỳ chọn | Mặc định | Mô tả |
| ------------------- | --------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
| `format` | `'via [${symbol}(${version} )]($style)'` | Định dạng cho module. |
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `detect_extensions` | `['java', 'class', 'gradle', 'jar', 'cljs', 'cljc']` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. |
| `detect_files` | `['pom.xml', 'build.gradle.kts', 'build.sbt', '.java-version', 'deps.edn', 'project.clj', 'build.boot', '.sdkmanrc']` | Những tên tệp nào sẽ kích hoạt mô-đun này. |
| `detect_folders` | `[]` | Những thư mục nào nên kích hoạt các mô đun này. |
| `symbol` | `'☕ '` | Một format string đại diện cho biểu tượng Java |
| `style` | `'red dimmed'` | Kiểu cho module. |
| `disabled` | `false` | Vô hiệu `java` module. |
### Các biến
| Biến | Ví dụ | Mô tả |
| --------- | ----- | -------------------------------- |
| version | `v14` | Phiên bản của `java` |
| symbol | | Giá trị ghi đè tuỳ chọn `symbol` |
| style\* | | Giá trị ghi đè của `style` |
*: Biến này có thể chỉ được sử dụng như một phần của style string
### Ví dụ
```toml
# ~/.config/starship.toml
[java]
symbol = '🌟 '
```
## Jobs
`jobs` module cho biết số lượng các jobs đang chạy. Mô đun sẽ được hiển thị chỉ khi có background jobs đang chạy. 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:
- 0 jobs -> Nothing is shown.
- 1 job -> `symbol` is shown.
- 2 jobs or more -> `symbol` + `number` are shown.
::: cảnh báo
This module is not supported on tcsh and nu.
:::
::: cảnh báo
The `threshold` option is deprecated, but if you want to use it, the module will show the number of jobs running if there is more than 1 job, or more than the `threshold` config value, if it exists. If `threshold` is set to 0, then the module will also show when there are 0 jobs running.
:::
### Các tuỳ chọn
| Tuỳ chọn | Mặc định | Mô tả |
| ------------------ | ----------------------------- | ------------------------------------------------------------------------ |
| `threshold`* | `1` | Cho biết số lượng jobs nếu nó vượt quá. |
| `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) '` | Định dạng cho module. |
| `symbol` | `'✦'` | The string used to represent the `symbol` variable. |
| `style` | `'bold blue'` | Kiểu cho module. |
| `disabled` | `false` | Vô hiệu `jobs` module. |
*: This option is deprecated, please use the `number_threshold` and `symbol_threshold` options instead.
### Các biến
| Biến | Ví dụ | Mô tả |
| --------- | ----- | -------------------------------- |
| number | `1` | Số lượng job |
| symbol | | Giá trị ghi đè tuỳ chọn `symbol` |
| style\* | | Giá trị ghi đè của `style` |
*: Biến này có thể chỉ được sử dụng như một phần của style string
### Ví dụ
```toml
# ~/.config/starship.toml
[jobs]
symbol = '+ '
number_threshold = 4
symbol_threshold = 0
```
## Julia
The `julia` module shows the currently installed version of [Julia](https://julialang.org/). Mặc định module sẽ được hiển thị nếu có bất kì điều kiện nào dưới đây thoả mãn:
- Thư mục hiện tại chứa một tệp tin `Project.toml`
- Thư mục hiện tại chứa một tập tin `Manifest.toml`
- Thư mục hiện tại chứa một tệp tin với phần mở rộng `.jl`
### Các tuỳ chọn
| Tuỳ chọn | Mặc định | Mô tả |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | Định dạng cho module. |
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `detect_extensions` | `['jl']` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. |
| `detect_files` | `['Project.toml', 'Manifest.toml']` | Những tên tệp nào sẽ kích hoạt mô-đun này. |
| `detect_folders` | `[]` | Những thư mục nào nên kích hoạt các mô đun này. |
| `symbol` | `'ஃ '` | Một format string đại diện cho biếu tượng của Julia. |
| `style` | `'bold purple'` | Kiểu cho module. |
| `disabled` | `false` | Vô hiệu `julia` module. |
### Các biến
| Biến | Ví dụ | Mô tả |
| --------- | -------- | -------------------------------- |
| version | `v1.4.0` | Phiên bản của `julia` |
| symbol | | Giá trị ghi đè tuỳ chọn `symbol` |
| style\* | | Giá trị ghi đè của `style` |
*: Biến này có thể chỉ được sử dụng như một phần của style string
### Ví dụ
```toml
# ~/.config/starship.toml
[julia]
symbol = '∴ '
```
## Kotlin
The `kotlin` module shows the currently installed version of [Kotlin](https://kotlinlang.org/). Mặc định module sẽ được hiển thị nếu có bất kì điều kiện nào dưới đây thoả mãn:
- Thư mục hiện tại chứa một tệp tin `.kt` hoặc một tệp tin `.kts`
### Các tuỳ chọn
| Tuỳ chọn | Mặc định | Mô tả |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | Định dạng cho module. |
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `detect_extensions` | `['kt', 'kts']` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. |
| `detect_files` | `[]` | Những tên tệp nào sẽ kích hoạt mô-đun này. |
| `detect_folders` | `[]` | Những thư mục nào nên kích hoạt các mô đun này. |
| `symbol` | `'🅺 '` | Một format string đại diện cho biết tượng của Kotllin. |
| `style` | `'bold blue'` | Kiểu cho module. |
| `kotlin_binary` | `'kotlin'` | Cấu hình kotlin nhị phân mà Starship thực thi khi lấy phiên bản. |
| `disabled` | `false` | Vô hiệu `kotlin` module. |
### Các biến
| Biến | Ví dụ | Mô tả |
| --------- | --------- | -------------------------------- |
| version | `v1.4.21` | Phiên bản của `kotlin` |
| symbol | | Giá trị ghi đè tuỳ chọn `symbol` |
| style\* | | Giá trị ghi đè của `style` |
*: Biến này có thể chỉ được sử dụng như một phần của style string
### Ví dụ
```toml
# ~/.config/starship.toml
[kotlin]
symbol = '🅺 '
```
```toml
# ~/.config/starship.toml
[kotlin]
# Uses the Kotlin Compiler binary to get the installed version
kotlin_binary = 'kotlinc'
```
## Kubernetes
Displays the current [Kubernetes context](https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/#context) name and, if set, the namespace, user and cluster from the kubeconfig file. The namespace needs to be set in the kubeconfig file, this can be done via `kubectl config set-context starship-context --namespace astronaut`. Similarly, the user and cluster can be set with `kubectl config set-context starship-context --user starship-user` and `kubectl config set-context starship-context --cluster starship-cluster`. Nếu biến môi trường `$KUBECONFIG` được thiết lập, mô đun sẽ sử dụng cái đó nếu nó không sử dụng `~/.kube/config`.
::: tip
Mặc định, mô đun này được vô hiệu. Để kích hoạt nó, thiết lập `disabled` sang `false` trong tập tin cấu hình của bạn.
When the module is enabled it will always be active, unless any of `detect_extensions`, `detect_files` or `detect_folders` have been set in which case the module will only be active in directories that match those conditions.
:::
### Các tuỳ chọn
::: cảnh báo
The `context_aliases` and `user_aliases` options are deprecated. Use `contexts` and the corresponding `context_alias` and `user_alias` options instead.
:::
| Tuỳ chọn | Mặc định | Mô tả |
| ------------------- | ---------------------------------------------------- | --------------------------------------------------------------------- |
| `symbol` | `'☸ '` | A format string representing the symbol displayed before the Cluster. |
| `format` | `'[$symbol$context( \($namespace\))]($style) in '` | Định dạng cho module. |
| `style` | `'cyan bold'` | Kiểu cho module. |
| `context_aliases`* | `{}` | Table of context aliases to display. |
| `user_aliases`* | `{}` | Table of user aliases to display. |
| `detect_extensions` | `[]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. |
| `detect_files` | `[]` | Những tên tệp nào sẽ kích hoạt mô-đun này. |
| `detect_folders` | `[]` | Những thư mục nào nên kích hoạt các mô đun này. |
| `contexts` | `[]` | Customized styles and symbols for specific contexts. |
| `disabled` | `true` | Disables the `kubernetes` module. |
*: This option is deprecated, please add `contexts` with the corresponding `context_alias` and `user_alias` options instead.
To customize the style of the module for specific environments, use the following configuration as part of the `contexts` list:
| Biến | Mô tả |
| ----------------- | ---------------------------------------------------------------------------------------- |
| `context_pattern` | **Required** Regular expression to match current Kubernetes context name. |
| `user_pattern` | Regular expression to match current Kubernetes user name. |
| `context_alias` | Context alias to display instead of the full context name. |
| `user_alias` | User alias to display instead of the full user name. |
| `style` | The style for the module when using this context. If not set, will use module's style. |
| `symbol` | The symbol for the module when using this context. If not set, will use module's symbol. |
Note that all regular expression are anchored with `^<pattern>$` and so must match the whole string. The `*_pattern` regular expressions may contain capture groups, which can be referenced in the corresponding alias via `$name` and `$N` (see example below and the [rust Regex::replace() documentation](https://docs.rs/regex/latest/regex/struct.Regex.html#method.replace)).
### Các biến
| Biến | Ví dụ | Mô tả |
| --------- | -------------------- | ---------------------------------------- |
| context | `starship-context` | The current kubernetes context name |
| namespace | `starship-namespace` | If set, the current kubernetes namespace |
| user | `starship-user` | If set, the current kubernetes user |
| cluster | `starship-cluster` | If set, the current kubernetes cluster |
| symbol | | Giá trị ghi đè tuỳ chọn `symbol` |
| style\* | | Giá trị ghi đè của `style` |
*: Biến này có thể chỉ được sử dụng như một phần của style string
### Ví dụ
```toml
# ~/.config/starship.toml
[kubernetes]
format = 'on [⛵ ($user on )($cluster in )$context \($namespace\)](dimmed green) '
disabled = false
contexts = [
{ context_pattern = "dev.local.cluster.k8s", style = "green", symbol = "💔 " },
]
```
Only show the module in directories that contain a `k8s` file.
```toml
# ~/.config/starship.toml
[kubernetes]
disabled = false
detect_files = ['k8s']
```
#### Kubernetes Context specific config
The `contexts` configuration option is used to customise what the current Kubernetes context name looks like (style and symbol) if the name matches the defined regular expression.
```toml
# ~/.config/starship.toml
[[kubernetes.contexts]]
# "bold red" style + default symbol when Kubernetes current context name equals "production" *and* the current user
# equals "admin_user"
context_pattern = "production"
user_pattern = "admin_user"
style = "bold red"
context_alias = "prod"
user_alias = "admin"
[[kubernetes.contexts]]
# "green" style + a different symbol when Kubernetes current context name contains openshift
context_pattern = ".*openshift.*"
style = "green"
symbol = "💔 "
context_alias = "openshift"
[[kubernetes.contexts]]
# Using capture groups
# Contexts from GKE, AWS and other cloud providers usually carry additional information, like the region/zone.
# The following entry matches on the GKE format (`gke_projectname_zone_cluster-name`)
# and renames every matching kube context into a more readable format (`gke-cluster-name`):
context_pattern = "gke_.*_(?P<cluster>[\\w-]+)"
context_alias = "gke-$cluster"
```
## Line Break
The `line_break` module separates the prompt into two lines.
### Các tuỳ chọn
| Tuỳ chọn | Mặc định | Mô tả |
| ---------- | -------- | ------------------------------------------------------------------ |
| `disabled` | `false` | Disables the `line_break` module, making the prompt a single line. |
### Ví dụ
```toml
# ~/.config/starship.toml
[line_break]
disabled = true
```
## Local IP
The `localip` module shows the IPv4 address of the primary network interface.
### Các tuỳ chọn
| Tuỳ chọn | Mặc định | Mô tả |
| ---------- | ------------------------- | ------------------------------------------------------ |
| `ssh_only` | `true` | Only show IP address when connected to an SSH session. |
| `format` | `'[$localipv4]($style) '` | Định dạng cho module. |
| `style` | `'bold yellow'` | Kiểu cho module. |
| `disabled` | `true` | Disables the `localip` module. |
### Các biến
| Biến | Ví dụ | Mô tả |
| --------- | ------------ | --------------------------------- |
| localipv4 | 192.168.1.13 | Contains the primary IPv4 address |
| style\* | | Giá trị ghi đè của `style` |
*: Biến này có thể chỉ được sử dụng như một phần của style string
### Ví dụ
```toml
# ~/.config/starship.toml
[localip]
ssh_only = false
format = '@[$localipv4](bold red) '
disabled = false
```
## Lua
The `lua` module shows the currently installed version of [Lua](http://www.lua.org/). Mặc định module sẽ được hiển thị nếu có bất kì điều kiện nào dưới đây thoả mãn:
- The current directory contains a `.lua-version` file
- The current directory contains a `lua` directory
- The current directory contains a file with the `.lua` extension
### Các tuỳ chọn
| Tuỳ chọn | Mặc định | Mô tả |
| ------------------- | ------------------------------------ | -------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | Định dạng cho module. |
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'🌙 '` | A format string representing the symbol of Lua. |
| `detect_extensions` | `['lua']` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. |
| `detect_files` | `['.lua-version']` | Những tên tệp nào sẽ kích hoạt mô-đun này. |
| `detect_folders` | `['lua']` | Những thư mục nào sẽ kích hoạt mô-đun này. |
| `style` | `'bold blue'` | Kiểu cho module. |
| `lua_binary` | `'lua'` | Configures the lua binary that Starship executes when getting the version. |
| `disabled` | `false` | Disables the `lua` module. |
### Các biến
| Biến | Ví dụ | Mô tả |
| --------- | -------- | -------------------------------- |
| version | `v5.4.0` | The version of `lua` |
| symbol | | Giá trị ghi đè tuỳ chọn `symbol` |
| style\* | | Giá trị ghi đè của `style` |
*: Biến này có thể chỉ được sử dụng như một phần của style string
### Ví dụ
```toml
# ~/.config/starship.toml
[lua]
format = 'via [🌕 $version](bold blue) '
```
## Memory Usage
The `memory_usage` module shows current system memory and swap usage.
By default the swap usage is displayed if the total system swap is non-zero.
::: tip
Mặc định, mô đun này được vô hiệu. Để kích hoạt nó, thiết lập `disabled` sang `false` trong tập tin cấu hình của bạn.
:::
### Các tuỳ chọn
| Tuỳ chọn | Mặc định | Mô tả |
| ----------- | ----------------------------------------------- | -------------------------------------------------------- |
| `threshold` | `75` | Hide the memory usage unless it exceeds this percentage. |
| `format` | `'via $symbol [${ram}( \| ${swap})]($style) '` | Định dạng cho module. |
| `symbol` | `'🐏'` | The symbol used before displaying the memory usage. |
| `style` | `'bold dimmed white'` | Kiểu cho module. |
| `disabled` | `true` | Disables the `memory_usage` module. |
### Các biến
| Biến | Ví dụ | Mô tả |
| ---------------- | ------------- | ------------------------------------------------------------------ |
| ram | `31GiB/65GiB` | The usage/total RAM of the current system memory. |
| ram_pct | `48%` | The percentage of the current system memory. |
| swap\*\* | `1GiB/4GiB` | The swap memory size of the current system swap memory file. |
| swap_pct\*\* | `77%` | The swap memory percentage of the current system swap memory file. |
| symbol | `🐏` | Giá trị ghi đè tuỳ chọn `symbol` |
| style\* | | Giá trị ghi đè của `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
### Ví dụ
```toml
# ~/.config/starship.toml
[memory_usage]
disabled = false
threshold = -1
symbol = ' '
style = 'bold dimmed green'
```
## Meson
The `meson` module shows the current Meson developer environment status.
By default the Meson project name is displayed, if `$MESON_DEVENV` is set.
### Các tuỳ chọn
| Tuỳ chọn | Mặc định | Mô tả |
| ------------------- | ---------------------------------- | ----------------------------------------------------------------------------------------- |
| `truncation_length` | `2^32 - 1` | Truncates a project name to `N` graphemes. |
| `truncation_symbol` | `'…'` | The symbol used to indicate a project name was truncated. You can use `''` for no symbol. |
| `format` | `'via [$symbol$project]($style) '` | Định dạng cho module. |
| `symbol` | `'⬢ '` | The symbol used before displaying the project name. |
| `style` | `'blue bold'` | Kiểu cho module. |
| `disabled` | `false` | Disables the `meson` module. |
### Các biến
| Biến | Ví dụ | Mô tả |
| --------- | ---------- | -------------------------------- |
| project | `starship` | The current Meson project name |
| symbol | `🐏` | Giá trị ghi đè tuỳ chọn `symbol` |
| style\* | | Giá trị ghi đè của `style` |
*: Biến này có thể chỉ được sử dụng như một phần của style string
### Ví dụ
```toml
# ~/.config/starship.toml
[meson]
disabled = false
truncation_symbol = '--'
symbol = ' '
style = 'bold dimmed green'
```
## Mercurial Branch
The `hg_branch` module shows the active branch and topic of the repo in your current directory.
### Các tuỳ chọn
| Tuỳ chọn | Mặc định | Mô tả |
| ------------------- | ----------------------------------------- | -------------------------------------------------------------------------------------------- |
| `symbol` | `' '` | The symbol used before the hg bookmark or branch name of the repo in your current directory. |
| `style` | `'bold purple'` | Kiểu cho module. |
| `format` | `'on [$symbol$branch(:$topic)]($style) '` | Định dạng cho module. |
| `truncation_length` | `2^63 - 1` | Truncates the hg branch / topic name to `N` graphemes |
| `truncation_symbol` | `'…'` | Biểu tượng sử dụng để nhận biết một tên nhánh được rút gọn. |
| `disabled` | `true` | Disables the `hg_branch` module. |
### Các biến
| Biến | Ví dụ | Mô tả |
| --------- | --------- | -------------------------------- |
| branch | `master` | The active mercurial branch |
| topic | `feature` | The active mercurial topic |
| symbol | | Giá trị ghi đè tuỳ chọn `symbol` |
| style\* | | Giá trị ghi đè của `style` |
*: Biến này có thể chỉ được sử dụng như một phần của style string
### Ví dụ
```toml
# ~/.config/starship.toml
[hg_branch]
format = 'on [🌱 $branch](bold purple)'
truncation_length = 4
truncation_symbol = ''
```
## Nim
The `nim` module shows the currently installed version of [Nim](https://nim-lang.org/). Mặc định module sẽ được hiển thị nếu có bất kì điều kiện nào dưới đây thoả mãn:
- Thư mục hiện tại chứa một tập tin `nim.cfg`
- The current directory contains a file with the `.nim` extension
- The current directory contains a file with the `.nims` extension
- The current directory contains a file with the `.nimble` extension
### Các tuỳ chọn
| Tuỳ chọn | Mặc định | Mô tả |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | Định dạng cho module |
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'👑 '` | The symbol used before displaying the version of Nim. |
| `detect_extensions` | `['nim', 'nims', 'nimble']` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. |
| `detect_files` | `['nim.cfg']` | Những tên tệp nào sẽ kích hoạt mô-đun này. |
| `detect_folders` | `[]` | Những thư mục nào sẽ kích hoạt mô-đun này. |
| `style` | `'bold yellow'` | Kiểu cho module. |
| `disabled` | `false` | Disables the `nim` module. |
### Các biến
| Biến | Ví dụ | Mô tả |
| --------- | -------- | -------------------------------- |
| version | `v1.2.0` | The version of `nimc` |
| symbol | | Giá trị ghi đè tuỳ chọn `symbol` |
| style\* | | Giá trị ghi đè của `style` |
*: Biến này có thể chỉ được sử dụng như một phần của style string
### Ví dụ
```toml
# ~/.config/starship.toml
[nim]
style = 'yellow'
symbol = '🎣 '
```
## Nix-shell
The `nix_shell` module shows the [nix-shell](https://nixos.org/guides/nix-pills/developing-with-nix-shell.html) environment. The module will be shown when inside a nix-shell environment.
### Các tuỳ chọn
| Tuỳ chọn | Mặc định | Mô tả |
| ------------- | ---------------------------------------------- | --------------------------------------------------------------------- |
| `format` | `'via [$symbol$state( \($name\))]($style) '` | Định dạng cho module. |
| `symbol` | `'❄️ '` | A format string representing the symbol of nix-shell. |
| `style` | `'bold blue'` | Kiểu cho module. |
| `impure_msg` | `'impure'` | A format string shown when the shell is impure. |
| `pure_msg` | `'pure'` | A format string shown when the shell is pure. |
| `unknown_msg` | `''` | A format string shown when it is unknown if the shell is pure/impure. |
| `disabled` | `false` | Disables the `nix_shell` module. |
| `heuristic` | `false` | Attempts to detect new `nix shell`-style shells with a heuristic. |
### Các biến
| Biến | Ví dụ | Mô tả |
| --------- | ------- | -------------------------------- |
| state | `pure` | The state of the nix-shell |
| name | `lorri` | The name of the nix-shell |
| symbol | | Giá trị ghi đè tuỳ chọn `symbol` |
| style\* | | Giá trị ghi đè của `style` |
*: Biến này có thể chỉ được sử dụng như một phần của style string
### Ví dụ
```toml
# ~/.config/starship.toml
[nix_shell]
disabled = true
impure_msg = '[impure shell](bold red)'
pure_msg = '[pure shell](bold green)'
unknown_msg = '[unknown shell](bold yellow)'
format = 'via [☃️ $state( \($name\))](bold blue) '
```
## Node.js
The `nodejs` module shows the currently installed version of [Node.js](https://nodejs.org/). Mặc định module sẽ được hiển thị nếu có bất kì điều kiện nào dưới đây thoả mãn:
- Thư mục hiện tại chứa một tập tin `package.json`
- The current directory contains a `.node-version` file
- The current directory contains a `.nvmrc` file
- The current directory contains a `node_modules` directory
- The current directory contains a file with the `.js`, `.mjs` or `.cjs` extension
- The current directory contains a file with the `.ts`, `.mts` or `.cts` extension
### Các tuỳ chọn
| Tuỳ chọn | Mặc định | Mô tả |
| ------------------- | ------------------------------------------ | ----------------------------------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | Định dạng cho 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. |
| `detect_extensions` | `['js', 'mjs', 'cjs', 'ts', 'mts', 'cts']` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. |
| `detect_files` | `['package.json', '.node-version']` | Những tên tệp nào sẽ kích hoạt mô-đun này. |
| `detect_folders` | `['node_modules']` | Những thư mục nào sẽ kích hoạt mô-đun này. |
| `style` | `'bold green'` | Kiểu cho module. |
| `disabled` | `false` | Disables the `nodejs` module. |
| `not_capable_style` | `bold red` | The style for the module when an engines property in package.json does not match the Node.js version. |
### Các biến
| Biến | Ví dụ | Mô tả |
| --------------- | ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
| version | `v13.12.0` | The version of `node` |
| engines_version | `>=12.0.0` | `node` version requirement as set in the engines property of `package.json`. Will only show if the version requirement does not match the `node` version. |
| symbol | | Giá trị ghi đè tuỳ chọn `symbol` |
| style\* | | Giá trị ghi đè của `style` |
*: Biến này có thể chỉ được sử dụng như một phần của style string
### Ví dụ
```toml
# ~/.config/starship.toml
[nodejs]
format = 'via [🤖 $version](bold green) '
```
## OCaml
The `ocaml` module shows the currently installed version of [OCaml](https://ocaml.org/). Mặc định module sẽ được hiển thị nếu có bất kì điều kiện nào dưới đây thoả mãn:
- The current directory contains a file with `.opam` extension or `_opam` directory
- The current directory contains a `esy.lock` directory
- The current directory contains a `dune` or `dune-project` file
- The current directory contains a `jbuild` or `jbuild-ignore` file
- The current directory contains a `.merlin` file
- The current directory contains a file with `.ml`, `.mli`, `.re` or `.rei` extension
### Các tuỳ chọn
| Tuỳ chọn | Mặc định | Mô tả |
| ------------------------- | -------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )(\($switch_indicator$switch_name\) )]($style)'` | The format string for the module. |
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'🐫 '` | The symbol used before displaying the version of OCaml. |
| `global_switch_indicator` | `''` | The format string used to represent global OPAM switch. |
| `local_switch_indicator` | `'*'` | The format string used to represent local OPAM switch. |
| `detect_extensions` | `['opam', 'ml', 'mli', 're', 'rei']` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. |
| `detect_files` | `['dune', 'dune-project', 'jbuild', 'jbuild-ignore', '.merlin']` | Những tên tệp nào sẽ kích hoạt mô-đun này. |
| `detect_folders` | `['_opam', 'esy.lock']` | Những thư mục nào sẽ kích hoạt mô-đun này. |
| `style` | `'bold yellow'` | Kiểu cho module. |
| `disabled` | `false` | Disables the `ocaml` module. |
### Các biến
| Biến | Ví dụ | Mô tả |
| ---------------- | ------------ | ----------------------------------------------------------------- |
| version | `v4.10.0` | The version of `ocaml` |
| switch_name | `my-project` | The active OPAM switch |
| switch_indicator | | Mirrors the value of `indicator` for currently active OPAM switch |
| symbol | | Giá trị ghi đè tuỳ chọn `symbol` |
| style\* | | Giá trị ghi đè của `style` |
*: Biến này có thể chỉ được sử dụng như một phần của style string
### Ví dụ
```toml
# ~/.config/starship.toml
[ocaml]
format = 'via [🐪 $version]($style) '
```
## Open Policy Agent
The `opa` module shows the currently installed version of the OPA tool. By default the module will be shown if the current directory contains a `.rego` file.
### Các tuỳ chọn
| Tuỳ chọn | Mặc định | Mô tả |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | Định dạng cho module. |
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'🪖 '` | A format string representing the symbol of OPA. |
| `detect_extensions` | `['rego']` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. |
| `detect_files` | `[]` | Những tên tệp nào sẽ kích hoạt mô-đun này. |
| `detect_folders` | `[]` | Những thư mục nào sẽ kích hoạt mô-đun này. |
| `style` | `'bold blue'` | Kiểu cho module. |
| `disabled` | `false` | Disables the `opa` module. |
### Các biến
| Biến | Ví dụ | Mô tả |
| --------- | --------- | -------------------------------- |
| version | `v0.44.0` | The version of `opa` |
| symbol | | Giá trị ghi đè tuỳ chọn `symbol` |
| style\* | | Giá trị ghi đè của `style` |
*: Biến này có thể chỉ được sử dụng như một phần của style string
### Ví dụ
```toml
# ~/.config/starship.toml
[opa]
format = 'via [⛑️ $version](bold red) '
```
## OpenStack
The `openstack` module shows the current OpenStack cloud and project. The module only active when the `OS_CLOUD` env var is set, in which case it will read `clouds.yaml` file from any of the [default locations](https://docs.openstack.org/python-openstackclient/latest/configuration/index.html#configuration-files). to fetch the current project in use.
### Các tuỳ chọn
| Tuỳ chọn | Mặc định | Mô tả |
| ---------- | ----------------------------------------------- | -------------------------------------------------------------- |
| `format` | `'on [$symbol$cloud(\($project\))]($style) '` | Định dạng cho module. |
| `symbol` | `'☁️ '` | The symbol used before displaying the current OpenStack cloud. |
| `style` | `'bold yellow'` | Kiểu cho module. |
| `disabled` | `false` | Disables the `openstack` module. |
### Các biến
| Biến | Ví dụ | Mô tả |
| --------- | ------ | -------------------------------- |
| cloud | `corp` | The current OpenStack cloud |
| project | `dev` | The current OpenStack project |
| symbol | | Giá trị ghi đè tuỳ chọn `symbol` |
| style\* | | Giá trị ghi đè của `style` |
*: Biến này có thể chỉ được sử dụng như một phần của style string
### Ví dụ
```toml
# ~/.config/starship.toml
[openstack]
format = 'on [$symbol$cloud(\($project\))]($style) '
style = 'bold yellow'
symbol = '☁️ '
```
## OS
The `os` module shows the current operating system. OS information is detected via the [os_info](https://lib.rs/crates/os_info) crate.
::: cảnh báo
The [os_info](https://lib.rs/crates/os_info) crate used by this module is known to be inaccurate on some systems.
:::
::: tip
Mặc định, mô đun này được vô hiệu. Để kích hoạt nó, thiết lập `disabled` sang `false` trong tập tin cấu hình của bạn.
:::
### Các tuỳ chọn
| Tuỳ chọn | Mặc định | Mô tả |
| ---------- | --------------------- | ------------------------------------------------------ |
| `format` | `"[$symbol]($style)"` | Định dạng cho module. |
| `style` | `"bold white"` | Kiểu cho module. |
| `disabled` | `true` | Disables the `os` module. |
| `symbols` | | A table that maps each operating system to its symbol. |
`symbols` allows you to define arbitrary symbols to display for each operating system type. Operating system types not defined by your configuration use the default symbols table below. All operating systems currently supported by the module are listed below. If you would like an operating system to be added, feel free to open a [feature request](https://github.com/starship/starship/issues/new/choose).
```toml
# This is the default symbols table.
[os.symbols]
Alpaquita = "🔔 "
Alpine = "🏔️ "
Amazon = "🙂 "
Android = "🤖 "
Arch = "🎗️ "
Artix = "🎗️ "
CentOS = "💠 "
Debian = "🌀 "
DragonFly = "🐉 "
Emscripten = "🔗 "
EndeavourOS = "🚀 "
Fedora = "🎩 "
FreeBSD = "😈 "
Garuda = "🦅 "
Gentoo = "🗜️ "
HardenedBSD = "🛡️ "
Illumos = "🐦 "
Linux = "🐧 "
Mabox = "📦 "
Macos = "🍎 "
Manjaro = "🥭 "
Mariner = "🌊 "
MidnightBSD = "🌘 "
Mint = "🌿 "
NetBSD = "🚩 "
NixOS = "❄️ "
OpenBSD = "🐡 "
OpenCloudOS = "☁️ "
openEuler = "🦉 "
openSUSE = "🦎 "
OracleLinux = "🦴 "
Pop = "🍭 "
Raspbian = "🍓 "
Redhat = "🎩 "
RedHatEnterprise = "🎩 "
Redox = "🧪 "
Solus = "⛵ "
SUSE = "🦎 "
Ubuntu = "🎯 "
Unknown = "❓ "
Windows = "🪟 "
```
### Các biến
| Biến | Ví dụ | Mô tả |
| --------- | ------------ | ------------------------------------------------------------------ |
| symbol | `🎗️` | The current operating system symbol from advanced option `symbols` |
| name | `Arch Linux` | The current operating system name |
| type | `Arch` | The current operating system type |
| codename | | The current operating system codename, if applicable |
| edition | | The current operating system edition, if applicable |
| version | | The current operating system version, if applicable |
| style\* | | Giá trị ghi đè của `style` |
*: Biến này có thể chỉ được sử dụng như một phần của style string
### Ví dụ
```toml
# ~/.config/starship.toml
[os]
format = "on [($name )]($style)"
style = "bold blue"
disabled = false
[os.symbols]
Windows = " "
Arch = "Arch is the best! "
```
## Package Version
The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards`, `daml` and `dart` packages.
- [**npm**](https://docs.npmjs.com/cli/commands/npm) – The `npm` package version is extracted from the `package.json` present in the current directory
- [**Cargo**](https://doc.rust-lang.org/cargo/) – The `cargo` package version is extracted from the `Cargo.toml` present in the current directory
- [**Nimble**](https://github.com/nim-lang/nimble) - The `nimble` package version is extracted from the `*.nimble` file present in the current directory with the `nimble dump` command
- [**Poetry**](https://python-poetry.org/) – The `poetry` package version is extracted from the `pyproject.toml` present in the current directory
- [**Python**](https://www.python.org) - The `python` package version is extracted from a [PEP 621](https://peps.python.org/pep-0621/) compliant `pyproject.toml` or a `setup.cfg` present in the current directory
- [**Composer**](https://getcomposer.org/) – The `composer` package version is extracted from the `composer.json` present in the current directory
- [**Gradle**](https://gradle.org/) – The `gradle` package version is extracted from the `build.gradle` present in the current directory
- [**Julia**](https://docs.julialang.org/en/v1/stdlib/Pkg/) - The package version is extracted from the `Project.toml` present in the current directory
- [**Mix**](https://hexdocs.pm/mix/) - The `mix` package version is extracted from the `mix.exs` present in the current directory
- [**Helm**](https://helm.sh/docs/helm/helm_package/) - The `helm` chart version is extracted from the `Chart.yaml` present in the current directory
- [**Maven**](https://maven.apache.org/) - The `maven` package version is extracted from the `pom.xml` present in the current directory
- [**Meson**](https://mesonbuild.com/) - The `meson` package version is extracted from the `meson.build` present in the current directory
- [**Shards**](https://crystal-lang.org/reference/the_shards_command/index.html) - The `shards` package version is extracted from the `shard.yml` present in the current directory
- [**V**](https://vlang.io) - The `vlang` package version is extracted from the `v.mod` present in the current directory
- [**SBT**](https://scala-sbt.org) - The `sbt` package version is extracted from the `build.sbt` present in the current directory
- [**Daml**](https://www.digitalasset.com/developers) - The `daml` package version is extracted from the `daml.yaml` present in the current directory
- [**Dart**](https://pub.dev/) - The `dart` package version is extracted from the `pubspec.yaml` present in the current directory
> ⚠️ The version being shown is that of the package whose source code is in your current directory, not your package manager.
### Các tuỳ chọn
| Tuỳ chọn | Mặc định | Mô tả |
| ----------------- | --------------------------------- | ------------------------------------------------------------------------- |
| `format` | `'is [$symbol$version]($style) '` | Định dạng cho module. |
| `symbol` | `'📦 '` | The symbol used before displaying the version the package. |
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `style` | `'bold 208'` | Kiểu cho module. |
| `display_private` | `false` | Enable displaying version for packages marked as private. |
| `disabled` | `false` | Disables the `package` module. |
### Các biến
| Biến | Ví dụ | Mô tả |
| --------- | -------- | -------------------------------- |
| version | `v1.0.0` | The version of your package |
| symbol | | Giá trị ghi đè tuỳ chọn `symbol` |
| style\* | | Giá trị ghi đè của `style` |
*: Biến này có thể chỉ được sử dụng như một phần của style string
### Ví dụ
```toml
# ~/.config/starship.toml
[package]
format = 'via [🎁 $version](208 bold) '
```
## Perl
The `perl` module shows the currently installed version of [Perl](https://www.perl.org/). Mặc định module sẽ được hiển thị nếu có bất kì điều kiện nào dưới đây thoả mãn:
- The current directory contains a `Makefile.PL` or `Build.PL` file
- The current directory contains a `cpanfile` or `cpanfile.snapshot` file
- The current directory contains a `META.json` file or `META.yml` file
- The current directory contains a `.perl-version` file
- The current directory contains a `.pl`, `.pm` or `.pod`
### Các tuỳ chọn
| Tuỳ chọn | Mặc định | Mô tả |
| ------------------- | -------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | The format string for the module. |
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'🐪 '` | The symbol used before displaying the version of Perl |
| `detect_extensions` | `['pl', 'pm', 'pod']` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. |
| `detect_files` | `['Makefile.PL', 'Build.PL', 'cpanfile', 'cpanfile.snapshot', 'META.json', 'META.yml', '.perl-version']` | Những tên tệp nào sẽ kích hoạt mô-đun này. |
| `detect_folders` | `[]` | Những thư mục nào sẽ kích hoạt mô-đun này. |
| `style` | `'bold 149'` | Kiểu cho module. |
| `disabled` | `false` | Disables the `perl` module. |
### Các biến
| Biến | Ví dụ | Mô tả |
| --------- | --------- | -------------------------------- |
| version | `v5.26.1` | The version of `perl` |
| symbol | | Giá trị ghi đè tuỳ chọn `symbol` |
| style\* | | Giá trị ghi đè của `style` |
### Ví dụ
```toml
# ~/.config/starship.toml
[perl]
format = 'via [🦪 $version]($style) '
```
## PHP
The `php` module shows the currently installed version of [PHP](https://www.php.net/). Mặc định module sẽ được hiển thị nếu có bất kì điều kiện nào dưới đây thoả mãn:
- Thư mục hiện tại chứa một tập tin `composer.json`
- The current directory contains a `.php-version` file
- The current directory contains a `.php` extension
### Các tuỳ chọn
| Tuỳ chọn | Mặc định | Mô tả |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | Định dạng cho module. |
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'🐘 '` | The symbol used before displaying the version of PHP. |
| `detect_extensions` | `['php']` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. |
| `detect_files` | `['composer.json', '.php-version']` | Những tên tệp nào sẽ kích hoạt mô-đun này. |
| `detect_folders` | `[]` | Những thư mục nào sẽ kích hoạt mô-đun này. |
| `style` | `'147 bold'` | Kiểu cho module. |
| `disabled` | `false` | Disables the `php` module. |
### Các biến
| Biến | Ví dụ | Mô tả |
| --------- | -------- | -------------------------------- |
| version | `v7.3.8` | The version of `php` |
| symbol | | Giá trị ghi đè tuỳ chọn `symbol` |
| style\* | | Giá trị ghi đè của `style` |
*: Biến này có thể chỉ được sử dụng như một phần của style string
### Ví dụ
```toml
# ~/.config/starship.toml
[php]
format = 'via [🔹 $version](147 bold) '
```
## Pijul Channel
The `pijul_channel` module shows the active channel of the repo in your current directory.
### Các tuỳ chọn
| Tuỳ chọn | Mặc định | Mô tả |
| ------------------- | --------------------------------- | ------------------------------------------------------------------------------------ |
| `symbol` | `' '` | The symbol used before the pijul channel name of the repo in your current directory. |
| `style` | `'bold purple'` | Kiểu cho module. |
| `format` | `'on [$symbol$channel]($style) '` | Định dạng cho module. |
| `truncation_length` | `2^63 - 1` | Truncates the pijul channel name to `N` graphemes |
| `truncation_symbol` | `'…'` | Biểu tượng sử dụng để nhận biết một tên nhánh được rút gọn. |
| `disabled` | `true` | Disables the `pijul` module. |
## Pulumi
The `pulumi` module shows the current username, selected [Pulumi Stack](https://www.pulumi.com/docs/intro/concepts/stack/), and version.
::: tip
By default the Pulumi version is not shown, since it takes an order of magnitude longer to load then most plugins (~70ms). If you still want to enable it, [follow the example shown below](#with-pulumi-version).
:::
Mặc định module sẽ được hiển thị nếu có bất kì điều kiện nào dưới đây thoả mãn:
- The current directory contains either `Pulumi.yaml` or `Pulumi.yml`
- A parent directory contains either `Pulumi.yaml` or `Pulumi.yml` unless `search_upwards` is set to `false`
### Các tuỳ chọn
| Tuỳ chọn | Mặc định | Mô tả |
| ---------------- | -------------------------------------------- | ------------------------------------------------------------------------- |
| `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'` | Kiểu cho module. |
| `search_upwards` | `true` | Enable discovery of pulumi config files in parent directories. |
| `disabled` | `false` | Disables the `pulumi` module. |
### Các biến
| Biến | Ví dụ | Mô tả |
| --------- | ---------- | -------------------------------- |
| version | `v0.12.24` | The version of `pulumi` |
| stack | `dev` | The current Pulumi stack |
| username | `alice` | The current Pulumi username |
| symbol | | Giá trị ghi đè tuỳ chọn `symbol` |
| style\* | | Giá trị ghi đè của `style` |
*: Biến này có thể chỉ được sử dụng như một phần của style string
### Ví dụ
#### With Pulumi Version
```toml
# ~/.config/starship.toml
[pulumi]
format = '[🛥 ($version )$stack]($style) '
```
#### Without Pulumi version
```toml
# ~/.config/starship.toml
[pulumi]
symbol = '🛥 '
format = '[$symbol$stack]($style) '
```
## PureScript
The `purescript` module shows the currently installed version of [PureScript](https://www.purescript.org/) version. Mặc định module sẽ được hiển thị nếu có bất kì điều kiện nào dưới đây thoả mãn:
- Thư mục hiện tại chứa một tập tin `spago.dhall`
- The current directory contains a file with the `.purs` extension
### Các tuỳ chọn
| Tuỳ chọn | Mặc định | Mô tả |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | Định dạng cho module. |
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'<=> '` | The symbol used before displaying the version of PureScript. |
| `detect_extensions` | `['purs']` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. |
| `detect_files` | `['spago.dhall']` | Những tên tệp nào sẽ kích hoạt mô-đun này. |
| `detect_folders` | `[]` | Những thư mục nào sẽ kích hoạt mô-đun này. |
| `style` | `'bold white'` | Kiểu cho module. |
| `disabled` | `false` | Disables the `purescript` module. |
### Các biến
| Biến | Ví dụ | Mô tả |
| --------- | -------- | -------------------------------- |
| version | `0.13.5` | The version of `purescript` |
| symbol | | Giá trị ghi đè tuỳ chọn `symbol` |
| style\* | | Giá trị ghi đè của `style` |
*: Biến này có thể chỉ được sử dụng như một phần của style string
### Ví dụ
```toml
# ~/.config/starship.toml
[purescript]
format = 'via [$symbol$version](bold white)'
```
## Python
The `python` module shows the currently installed version of [Python](https://www.python.org/) and the current [Python virtual environment](https://docs.python.org/tutorial/venv.html) if one is activated.
If `pyenv_version_name` is set to `true`, it will display the pyenv version name. Otherwise, it will display the version number from `python --version`.
Mặc định module sẽ được hiển thị nếu có bất kì điều kiện nào dưới đây thoả mãn:
- The current directory contains a `.python-version` file
- The current directory contains a `Pipfile` file
- The current directory contains a `__init__.py` file
- Thư mục hiện tại chứa một tập tin `pyproject.toml`
- Thư mục hiện tại chứa một tập tin `requirements.txt`
- Thư mục hiện tại chứa một tập tin `setup.py`
- Thư mục hiện tại chứa một tập tin `tox.ini`
- The current directory contains a file with the `.py` extension.
- A virtual environment is currently activated
### Các tuỳ chọn
| Tuỳ chọn | Mặc định | Mô tả |
| -------------------- | ------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------- |
| `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\) )]($style)'` | Định dạng cho module. |
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'🐍 '` | A format string representing the symbol of Python |
| `style` | `'yellow bold'` | Kiểu cho module. |
| `pyenv_version_name` | `false` | Use pyenv to get Python version |
| `pyenv_prefix` | `pyenv` | Prefix before pyenv version display, only used if pyenv is used |
| `python_binary` | `['python', 'python3', 'python2']` | Configures the python binaries that Starship should executes when getting the version. |
| `detect_extensions` | `['py']` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này |
| `detect_files` | `['.python-version', 'Pipfile', '__init__.py', 'pyproject.toml', 'requirements.txt', 'setup.py', 'tox.ini']` | Tên tệp nào sẽ kích hoạt mô-đun này |
| `detect_folders` | `[]` | Thư mục nào sẽ kích hoạt mô-đun này |
| `disabled` | `false` | Disables the `python` module. |
::: tip
The `python_binary` variable accepts either a string or a list of strings. Starship will try executing each binary until it gets a result. Note you can only change the binary that Starship executes to get the version of Python not the arguments that are used.
The default values and order for `python_binary` was chosen to first identify the Python version in a virtualenv/conda environments (which currently still add a `python`, no matter if it points to `python3` or `python2`). This has the side effect that if you still have a system Python 2 installed, it may be picked up before any Python 3 (at least on Linux Distros that always symlink `/usr/bin/python` to Python 2). If you do not work with Python 2 anymore but cannot remove the system Python 2, changing this to `'python3'` will hide any Python version 2, see example below.
:::
### Các biến
| Biến | Ví dụ | Mô tả |
| ------------ | --------------- | ------------------------------------------ |
| version | `'v3.8.1'` | The version of `python` |
| symbol | `'🐍 '` | Giá trị ghi đè tuỳ chọn `symbol` |
| style | `'yellow bold'` | Giá trị ghi đè của `style` |
| pyenv_prefix | `'pyenv '` | Mirrors the value of option `pyenv_prefix` |
| virtualenv | `'venv'` | The current `virtualenv` name |
### Ví dụ
```toml
# ~/.config/starship.toml
[python]
symbol = '👾 '
pyenv_version_name = true
```
```toml
# ~/.config/starship.toml
[python]
# Only use the `python3` binary to get the version.
python_binary = 'python3'
```
```toml
# ~/.config/starship.toml
[python]
# Don't trigger for files with the py extension
detect_extensions = []
```
```toml
# ~/.config/starship.toml
[python]
# Display the version of python from inside a local venv.
#
# Note this will only work when the venv is inside the project and it will only
# work in the directory that contains the venv dir but maybe this is ok?
python_binary = ['./venv/bin/python', 'python', 'python3', 'python2']
```
## R
The `rlang` module shows the currently installed version of [R](https://www.r-project.org/). The module will be shown if any of the following conditions are met:
- The current directory contains a file with the `.R` extension.
- The current directory contains a file with the `.Rd` extension.
- The current directory contains a file with the `.Rmd` extension.
- The current directory contains a file with the `.Rproj` extension.
- The current directory contains a file with the `.Rsx` extension.
- The current directory contains a `.Rprofile` file
- The current directory contains a `.Rproj.user` folder
### Các tuỳ chọn
| Tuỳ chọn | Mặc định | Mô tả |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | Định dạng cho module. |
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'📐'` | A format string representing the symbol of R. |
| `style` | `'blue bold'` | Kiểu cho module. |
| `detect_extensions` | `['R', 'Rd', 'Rmd', 'Rproj', 'Rsx']` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này |
| `detect_files` | `['.Rprofile']` | Tên tệp nào sẽ kích hoạt mô-đun này |
| `detect_folders` | `['.Rproj.user']` | Thư mục nào sẽ kích hoạt mô-đun này |
| `disabled` | `false` | Disables the `r` module. |
### Các biến
| Biến | Ví dụ | Mô tả |
| ------- | ------------- | -------------------------------- |
| version | `v4.0.5` | The version of `R` |
| symbol | | Giá trị ghi đè tuỳ chọn `symbol` |
| style | `'blue bold'` | Giá trị ghi đè của `style` |
### Ví dụ
```toml
# ~/.config/starship.toml
[rlang]
format = 'with [📐 $version](blue bold) '
```
## Raku
The `raku` module shows the currently installed version of [Raku](https://www.raku.org/). Mặc định module sẽ được hiển thị nếu có bất kì điều kiện nào dưới đây thoả mãn:
- The current directory contains a `META6.json` file
- The current directory contains a `.p6`, `.pm6`, `.raku`, `.rakumod` or `.pod6`
### Các tuỳ chọn
| Tuỳ chọn | Mặc định | Mô tả |
| ------------------- | ------------------------------------------------ | ------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version-$vm_version )]($style)'` | The format string for the module. |
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'🦋 '` | The symbol used before displaying the version of Raku |
| `detect_extensions` | `['p6', 'pm6', 'pod6', 'raku', 'rakumod']` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. |
| `detect_files` | `['META6.json']` | Những tên tệp nào sẽ kích hoạt mô-đun này. |
| `detect_folders` | `[]` | Những thư mục nào sẽ kích hoạt mô-đun này. |
| `style` | `'bold 149'` | Kiểu cho module. |
| `disabled` | `false` | Disables the `raku` module. |
### Các biến
| Biến | Ví dụ | Mô tả |
| ---------- | ------ | ------------------------------------ |
| version | `v6.d` | The version of `raku` |
| vm_version | `moar` | The version of VM `raku` is built on |
| symbol | | Giá trị ghi đè tuỳ chọn `symbol` |
| style\* | | Giá trị ghi đè của `style` |
### Ví dụ
```toml
# ~/.config/starship.toml
[raku]
format = 'via [🦪 $version]($style) '
```
## Red
By default the `red` module shows the currently installed version of [Red](https://www.red-lang.org/). Module cho sẽ được hiện nếu bất kì điều kiện nào dưới đây thoả mãn:
- The current directory contains a file with `.red` or `.reds` extension
### Các tuỳ chọn
| Tuỳ chọn | Mặc định | Mô tả |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | Định dạng cho module. |
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'🔺 '` | A format string representing the symbol of Red. |
| `detect_extensions` | `['red']` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. |
| `detect_files` | `[]` | Những tên tệp nào sẽ kích hoạt mô-đun này. |
| `detect_folders` | `[]` | Những thư mục nào sẽ kích hoạt mô-đun này. |
| `style` | `'red bold'` | Kiểu cho module. |
| `disabled` | `false` | Disables the `red` module. |
### Các biến
| Biến | Ví dụ | Mô tả |
| --------- | -------- | -------------------------------- |
| version | `v2.5.1` | The version of `red` |
| symbol | | Giá trị ghi đè tuỳ chọn `symbol` |
| style\* | | Giá trị ghi đè của `style` |
*: Biến này có thể chỉ được sử dụng như một phần của style string
### Ví dụ
```toml
# ~/.config/starship.toml
[red]
symbol = '🔴 '
```
## Ruby
By default the `ruby` module shows the currently installed version of [Ruby](https://www.ruby-lang.org/). Module cho sẽ được hiện nếu bất kì điều kiện nào dưới đây thoả mãn:
- The current directory contains a `Gemfile` file
- The current directory contains a `.ruby-version` file
- The current directory contains a `.rb` file
- The environment variables `RUBY_VERSION` or `RBENV_VERSION` are set
Starship gets the current Ruby version by running `ruby -v`.
### Các tuỳ chọn
| Tuỳ chọn | Mặc định | Mô tả |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | Định dạng cho module. |
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'💎 '` | A format string representing the symbol of Ruby. |
| `detect_extensions` | `['rb']` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. |
| `detect_files` | `['Gemfile', '.ruby-version']` | Những tên tệp nào sẽ kích hoạt mô-đun này. |
| `detect_folders` | `[]` | Những thư mục nào sẽ kích hoạt mô-đun này. |
| `detect_variables` | `['RUBY_VERSION', 'RBENV_VERSION']` | Which environment variables should trigger this module. |
| `style` | `'bold red'` | Kiểu cho module. |
| `disabled` | `false` | Disables the `ruby` module. |
### Các biến
| Biến | Ví dụ | Mô tả |
| --------- | -------- | -------------------------------- |
| version | `v2.5.1` | The version of `ruby` |
| symbol | | Giá trị ghi đè tuỳ chọn `symbol` |
| style\* | | Giá trị ghi đè của `style` |
*: Biến này có thể chỉ được sử dụng như một phần của style string
### Ví dụ
```toml
# ~/.config/starship.toml
[ruby]
symbol = '🔺 '
```
## Rust
By default the `rust` module shows the currently installed version of [Rust](https://www.rust-lang.org/). Module cho sẽ được hiện nếu bất kì điều kiện nào dưới đây thoả mãn:
- The current directory contains a `Cargo.toml` file
- The current directory contains a file with the `.rs` extension
### Các tuỳ chọn
| Tuỳ chọn | Mặc định | Mô tả |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | Định dạng cho module. |
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'🦀 '` | A format string representing the symbol of Rust |
| `detect_extensions` | `['rs']` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. |
| `detect_files` | `['Cargo.toml']` | Những tên tệp nào sẽ kích hoạt mô-đun này. |
| `detect_folders` | `[]` | Những thư mục nào sẽ kích hoạt mô-đun này. |
| `style` | `'bold red'` | Kiểu cho module. |
| `disabled` | `false` | Disables the `rust` module. |
### Các biến
| Biến | Ví dụ | Mô tả |
| --------- | ----------------- | -------------------------------------------- |
| version | `v1.43.0-nightly` | The version of `rustc` |
| numver | `1.51.0` | The numeric component of the `rustc` version |
| toolchain | `beta` | The toolchain version |
| symbol | | Giá trị ghi đè tuỳ chọn `symbol` |
| style\* | | Giá trị ghi đè của `style` |
*: Biến này có thể chỉ được sử dụng như một phần của style string
### Ví dụ
```toml
# ~/.config/starship.toml
[rust]
format = 'via [⚙️ $version](red bold)'
```
## Scala
The `scala` module shows the currently installed version of [Scala](https://www.scala-lang.org/). Mặc định module sẽ được hiển thị nếu có bất kì điều kiện nào dưới đây thoả mãn:
- The current directory contains a `build.sbt`, `.scalaenv` or `.sbtenv` file
- The current directory contains a file with the `.scala` or `.sbt` extension
- The current directory contains a directory named `.metals`
### Các tuỳ chọn
| Tuỳ chọn | Mặc định | Mô tả |
| ------------------- | ---------------------------------------- | ------------------------------------------------------------------------- |
| `format` | `'via [${symbol}(${version} )]($style)'` | Định dạng cho module. |
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `detect_extensions` | `['sbt', 'scala']` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. |
| `detect_files` | `['.scalaenv', '.sbtenv', 'build.sbt']` | Những tên tệp nào sẽ kích hoạt mô-đun này. |
| `detect_folders` | `['.metals']` | Những thư mục nào nên kích hoạt các mô đun này. |
| `symbol` | `'🆂 '` | A format string representing the symbol of Scala. |
| `style` | `'red dimmed'` | Kiểu cho module. |
| `disabled` | `false` | Disables the `scala` module. |
### Các biến
| Biến | Ví dụ | Mô tả |
| --------- | -------- | -------------------------------- |
| version | `2.13.5` | The version of `scala` |
| symbol | | Giá trị ghi đè tuỳ chọn `symbol` |
| style\* | | Giá trị ghi đè của `style` |
*: Biến này có thể chỉ được sử dụng như một phần của style string
### Ví dụ
```toml
# ~/.config/starship.toml
[scala]
symbol = '🌟 '
```
## Shell
The `shell` module shows an indicator for currently used shell.
::: tip
Mặc định, mô đun này được vô hiệu. Để kích hoạt nó, thiết lập `disabled` sang `false` trong tập tin cấu hình của bạn.
:::
### Các tuỳ chọn
| Tuỳ chọn | Mặc định | Mô tả |
| ---------------------- | ------------------------- | ------------------------------------------------------------ |
| `bash_indicator` | `'bsh'` | A format string used to represent bash. |
| `fish_indicator` | `'fsh'` | A format string used to represent fish. |
| `zsh_indicator` | `'zsh'` | A format string used to represent zsh. |
| `powershell_indicator` | `'psh'` | A format string used to represent powershell. |
| `ion_indicator` | `'ion'` | A format string used to represent ion. |
| `elvish_indicator` | `'esh'` | A format string used to represent elvish. |
| `tcsh_indicator` | `'tsh'` | A format string used to represent tcsh. |
| `xonsh_indicator` | `'xsh'` | A format string used to represent xonsh. |
| `cmd_indicator` | `'cmd'` | A format string used to represent cmd. |
| `nu_indicator` | `'nu'` | A format string used to represent nu. |
| `unknown_indicator` | `''` | The default value to be displayed when the shell is unknown. |
| `format` | `'[$indicator]($style) '` | Định dạng cho module. |
| `style` | `'white bold'` | Kiểu cho module. |
| `disabled` | `true` | Disables the `shell` module. |
### Các biến
| Biến | Mặc định | Mô tả |
| --------- | -------- | ---------------------------------------------------------- |
| indicator | | Mirrors the value of `indicator` for currently used shell. |
| style\* | | Giá trị ghi đè của `style`. |
*: Biến này có thể chỉ được sử dụng như một phần của style string
### Các ví dụ
```toml
# ~/.config/starship.toml
[shell]
fish_indicator = '󰈺 '
powershell_indicator = '_'
unknown_indicator = 'mystery shell'
style = 'cyan bold'
disabled = false
```
## SHLVL
The `shlvl` module shows the current [`SHLVL`](https://tldp.org/LDP/abs/html/internalvariables.html#SHLVLREF) ('shell level') environment variable, if it is set to a number and meets or exceeds the specified threshold.
### Các tuỳ chọn
| Tuỳ chọn | Mặc định | Mô tả |
| --------------- | ---------------------------- | ------------------------------------------------------------------- |
| `threshold` | `2` | Display threshold. |
| `format` | `'[$symbol$shlvl]($style) '` | Định dạng cho module. |
| `symbol` | `'↕️ '` | The symbol used to represent the `SHLVL`. |
| `repeat` | `false` | Causes `symbol` to be repeated by the current `SHLVL` amount. |
| `repeat_offset` | `0` | Decrements number of times `symbol` is repeated by the offset value |
| `style` | `'bold yellow'` | Kiểu cho module. |
| `disabled` | `true` | Disables the `shlvl` module. |
### Các biến
| Biến | Ví dụ | Mô tả |
| --------- | ----- | -------------------------------- |
| shlvl | `3` | The current value of `SHLVL` |
| symbol | | Giá trị ghi đè tuỳ chọn `symbol` |
| style\* | | Giá trị ghi đè của `style` |
*: Biến này có thể chỉ được sử dụng như một phần của style string
### Ví dụ
```toml
# ~/.config/starship.toml
[shlvl]
disabled = false
format = '$shlvl level(s) down'
threshold = 3
```
Using `repeat` and `repeat_offset` along with `character` module, one can get prompt like `❯❯❯` where last character is colored appropriately for return status code and preceeding characters are provided by `shlvl`.
```toml
# ~/.config/starship.toml
[shlvl]
disabled = false
format = '[$symbol$shlvl]($style)'
repeat = true
symbol = '❯'
repeat_offset = 1
threshold = 0
```
## Singularity
The `singularity` module shows the current [Singularity](https://sylabs.io/singularity/) image, if inside a container and `$SINGULARITY_NAME` is set.
### Các tuỳ chọn
| Tuỳ chọn | Mặc định | Mô tả |
| ---------- | -------------------------------- | ------------------------------------------------ |
| `format` | `'[$symbol\[$env\]]($style) '` | Định dạng cho module. |
| `symbol` | `''` | A format string displayed before the image name. |
| `style` | `'bold dimmed blue'` | Kiểu cho module. |
| `disabled` | `false` | Disables the `singularity` module. |
### Các biến
| Biến | Ví dụ | Mô tả |
| --------- | ------------ | -------------------------------- |
| env | `centos.img` | The current Singularity image |
| symbol | | Giá trị ghi đè tuỳ chọn `symbol` |
| style\* | | Giá trị ghi đè của `style` |
*: Biến này có thể chỉ được sử dụng như một phần của style string
### Ví dụ
```toml
# ~/.config/starship.toml
[singularity]
format = '[📦 \[$env\]]($style) '
```
## Solidity
The `solidity` module shows the currently installed version of [Solidity](https://soliditylang.org/) The module will be shown if any of the following conditions are met:
- The current directory contains a file with the `.sol` extension
### Các tuỳ chọn
| Tuỳ chọn | Mặc định | Mô tả |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | Định dạng cho module. |
| `version_format` | `"v${major}.${minor}.${patch}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `"S "` | A format string representing the symbol of Solidity |
| `compiler | ["solc"] | The default compiler for Solidity. |
| `detect_extensions` | `["sol"]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. |
| `detect_files` | `[]` | Những tên tệp nào sẽ kích hoạt mô-đun này. |
| `detect_folders` | `[]` | Những thư mục nào sẽ kích hoạt mô-đun này. |
| `style` | `"bold blue"` | Kiểu cho module. |
| `disabled` | `false` | Disables this module. |
### Các biến
| Biến | Ví dụ | Mô tả |
| --------- | -------- | -------------------------------- |
| version | `v0.8.1` | The version of `solidity` |
| symbol | | Giá trị ghi đè tuỳ chọn `symbol` |
| style\* | | Giá trị ghi đè của `style` |
*: Biến này có thể chỉ được sử dụng như một phần của style string
### Ví dụ
```toml
# ~/.config/starship.toml
[solidity]
format = "via [S $version](blue bold)"
```
## Spack
The `spack` module shows the current [Spack](https://spack.readthedocs.io/en/latest/) environment, if `$SPACK_ENV` is set.
### Các tuỳ chọn
| Tuỳ chọn | Mặc định | Mô tả |
| ------------------- | -------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
| `truncation_length` | `1` | The number of directories the environment path should be truncated to. `0` nghĩa là không cắt bớt. Cũng thấy trong module [`directory`](#directory). |
| `symbol` | `'🅢 '` | Kí hiệu sử dụng trước tên biến môi trường. |
| `style` | `'bold blue'` | Kiểu cho module. |
| `format` | `'via [$symbol$environment]($style) '` | Định dạng cho module. |
| `disabled` | `false` | Disables the `spack` module. |
### Các biến
| Biến | Ví dụ | Mô tả |
| ----------- | ------------ | -------------------------------- |
| environment | `astronauts` | The current spack environment |
| symbol | | Giá trị ghi đè tuỳ chọn `symbol` |
| style\* | | Giá trị ghi đè của `style` |
*: Biến này có thể chỉ được sử dụng như một phần của style string
### Ví dụ
```toml
# ~/.config/starship.toml
[spack]
format = '[$symbol$environment](dimmed blue) '
```
## Status
The `status` module displays the exit code of the previous command. If $success_symbol is empty (default), 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
Mặc định, mô đun này được vô hiệu. Để kích hoạt nó, thiết lập `disabled` sang `false` trong tập tin cấu hình của bạn.
:::
### Các tuỳ chọn
| Tuỳ chọn | Mặc định | Mô tả |
| --------------------------- | ---------------------------------------------------------------------------------- | --------------------------------------------------------------------- |
| `format` | `'[$symbol$status]($style) '` | The format of the module |
| `symbol` | `'❌'` | The symbol displayed on program error |
| `success_symbol` | `''` | The symbol displayed on program success |
| `not_executable_symbol` | `'🚫'` | The symbol displayed when file isn't executable |
| `not_found_symbol` | `'🔍'` | The symbol displayed when the command can't be found |
| `sigint_symbol` | `'🧱'` | The symbol displayed on SIGINT (Ctrl + c) |
| `signal_symbol` | `'⚡'` | The symbol displayed on any signal |
| `style` | `'bold red'` | Kiểu cho module. |
| `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` | <code>&vert;</code> | The symbol used to separate pipestatus segments (supports formatting) |
| `pipestatus_format` | `'\[$pipestatus\] => [$symbol$common_meaning$signal_name$maybe_int]($style)'` | The format of the module when the command is a pipeline |
| `pipestatus_segment_format` | | When specified, replaces `format` when formatting pipestatus segments |
| `disabled` | `true` | Disables the `status` module. |
### Các biến
| Biến | Ví dụ | Mô tả |
| -------------- | ------- | ------------------------------------------------------------------------------------------ |
| status | `127` | The exit code of the last command |
| hex_status | `0x7F` | The exit code of the last command in hex |
| int | `127` | The exit code of the last command |
| common_meaning | `ERROR` | Meaning of the code if not a signal |
| signal_number | `9` | Signal number corresponding to the exit code, only if signalled |
| signal_name | `KILL` | Name of the signal corresponding to the exit code, only if signalled |
| maybe_int | `7` | Contains the exit code number when no meaning has been found |
| pipestatus | | Rendering of in pipeline programs' exit codes, this is only available in pipestatus_format |
| symbol | | Giá trị ghi đè tuỳ chọn `symbol` |
| style\* | | Giá trị ghi đè của `style` |
*: Biến này có thể chỉ được sử dụng như một phần của style string
### Ví dụ
```toml
# ~/.config/starship.toml
[status]
style = 'bg:blue'
symbol = '🔴 '
success_symbol = '🟢 SUCCESS'
format = '[\[$symbol$common_meaning$signal_name$maybe_int\]]($style) '
map_symbol = true
disabled = false
```
## Sudo
The `sudo` module displays if sudo credentials are currently cached. The module will only be shown if credentials are cached.
::: tip
Mặc định, mô đun này được vô hiệu. Để kích hoạt nó, thiết lập `disabled` sang `false` trong tập tin cấu hình của bạn.
:::
### Các tuỳ chọn
| Tuỳ chọn | Mặc định | Mô tả |
| --------------- | ------------------------ | ------------------------------------------------------- |
| `format` | `'[as $symbol]($style)'` | The format of the module |
| `symbol` | `'🧙 '` | The symbol displayed when credentials are cached |
| `style` | `'bold blue'` | Kiểu cho module. |
| `allow_windows` | `false` | Since windows has no default sudo, default is disabled. |
| `disabled` | `true` | Disables the `sudo` module. |
### Các biến
| Biến | Ví dụ | Mô tả |
| --------- | ----- | -------------------------------- |
| symbol | | Giá trị ghi đè tuỳ chọn `symbol` |
| style\* | | Giá trị ghi đè của `style` |
*: Biến này có thể chỉ được sử dụng như một phần của style string
### Ví dụ
```toml
# ~/.config/starship.toml
[sudo]
style = 'bold green'
symbol = '👩‍💻 '
disabled = false
```
```toml
# On windows
# $HOME\.starship\config.toml
[sudo]
allow_windows = true
disabled = false
```
## Swift
By default the `swift` module shows the currently installed version of [Swift](https://swift.org/). Module cho sẽ được hiện nếu bất kì điều kiện nào dưới đây thoả mãn:
- The current directory contains a `Package.swift` file
- The current directory contains a file with the `.swift` extension
### Các tuỳ chọn
| Tuỳ chọn | Mặc định | Mô tả |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | Định dạng cho module. |
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'🐦 '` | A format string representing the symbol of Swift |
| `detect_extensions` | `['swift']` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. |
| `detect_files` | `['Package.swift']` | Những tên tệp nào sẽ kích hoạt mô-đun này. |
| `detect_folders` | `[]` | Những thư mục nào sẽ kích hoạt mô-đun này. |
| `style` | `'bold 202'` | Kiểu cho module. |
| `disabled` | `false` | Disables the `swift` module. |
### Các biến
| Biến | Ví dụ | Mô tả |
| --------- | -------- | -------------------------------- |
| version | `v5.2.4` | The version of `swift` |
| symbol | | Giá trị ghi đè tuỳ chọn `symbol` |
| style\* | | Giá trị ghi đè của `style` |
*: Biến này có thể chỉ được sử dụng như một phần của style string
### Ví dụ
```toml
# ~/.config/starship.toml
[swift]
format = 'via [🏎 $version](red bold)'
```
## Terraform
The `terraform` module shows the currently selected [Terraform workspace](https://www.terraform.io/docs/language/state/workspaces.html) and version.
::: tip
By default the Terraform version is not shown, since this is slow for current versions of Terraform when a lot of plugins are in use. If you still want to enable it, [follow the example shown below](#with-terraform-version).
:::
Mặc định module sẽ được hiển thị nếu có bất kì điều kiện nào dưới đây thoả mãn:
- The current directory contains a `.terraform` folder
- Current directory contains a file with the `.tf`, `.tfplan` or `.tfstate` extensions
### Các tuỳ chọn
| Tuỳ chọn | Mặc định | Mô tả |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
| `format` | `'via [$symbol$workspace]($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 terraform workspace. |
| `detect_extensions` | `['tf', 'tfplan', 'tfstate']` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. |
| `detect_files` | `[]` | Những tên tệp nào sẽ kích hoạt mô-đun này. |
| `detect_folders` | `['.terraform']` | Những thư mục nào sẽ kích hoạt mô-đun này. |
| `style` | `'bold 105'` | Kiểu cho module. |
| `disabled` | `false` | Disables the `terraform` module. |
### Các biến
| Biến | Ví dụ | Mô tả |
| --------- | ---------- | -------------------------------- |
| version | `v0.12.24` | The version of `terraform` |
| workspace | `default` | The current Terraform workspace |
| symbol | | Giá trị ghi đè tuỳ chọn `symbol` |
| style\* | | Giá trị ghi đè của `style` |
*: Biến này có thể chỉ được sử dụng như một phần của style string
### Ví dụ
#### With Terraform Version
```toml
# ~/.config/starship.toml
[terraform]
format = '[🏎💨 $version$workspace]($style) '
```
#### Without Terraform version
```toml
# ~/.config/starship.toml
[terraform]
format = '[🏎💨 $workspace]($style) '
```
## Thời gian
The `time` module shows the current **local** time. The `format` configuration value is used by the [`chrono`](https://crates.io/crates/chrono) crate to control how the time is displayed. Take a look [at the chrono strftime docs](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) to see what options are available.
::: tip
Mặc định, mô đun này được vô hiệu. Để kích hoạt nó, thiết lập `disabled` sang `false` trong tập tin cấu hình của bạn.
:::
### Các tuỳ chọn
| Tuỳ chọn | Mặc định | Mô tả |
| ----------------- | ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
| `format` | `'at [$time]($style) '` | The format string for the module. |
| `use_12hr` | `false` | Enables 12 hour formatting |
| `time_format` | see below | The [chrono format string](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) used to format the time. |
| `style` | `'bold yellow'` | The style for the module time |
| `utc_time_offset` | `'local'` | Sets the UTC offset to use. Range from -24 &lt; x &lt; 24. Allows floats to accommodate 30/45 minute timezone offsets. |
| `disabled` | `true` | Disables the `time` module. |
| `time_range` | `'-'` | Sets the time range during which the module will be shown. Times must be specified in 24-hours format |
If `use_12hr` is `true`, then `time_format` defaults to `'%r'`. Otherwise, it defaults to `'%T'`. Manually setting `time_format` will override the `use_12hr` setting.
### Các biến
| Biến | Ví dụ | Mô tả |
| --------- | ---------- | -------------------------- |
| thời gian | `13:08:10` | The current time. |
| style\* | | Giá trị ghi đè của `style` |
*: Biến này có thể chỉ được sử dụng như một phần của style string
### Ví dụ
```toml
# ~/.config/starship.toml
[time]
disabled = false
format = '🕙[\[ $time \]]($style) '
time_format = '%T'
utc_time_offset = '-5'
time_range = '10:00:00-14:00:00'
```
## Username
The `username` module shows active user's username. Module cho sẽ được hiện nếu bất kì điều kiện nào dưới đây thoả mãn:
- The current user is root/admin
- The current user isn't the same as the one that is logged in
- The user is currently connected as an SSH session
- The variable `show_always` is set to true
::: tip
SSH connection is detected by checking environment variables `SSH_CONNECTION`, `SSH_CLIENT`, and `SSH_TTY`. If your SSH host does not set up these variables, one workaround is to set one of them with a dummy value.
:::
### Các tuỳ chọn
| Tuỳ chọn | Mặc định | Mô tả |
| ------------- | ----------------------- | ------------------------------------------- |
| `style_root` | `'bold red'` | The style used when the user is root/admin. |
| `style_user` | `'bold yellow'` | The style used for non-root users. |
| `format` | `'[$user]($style) in '` | Định dạng cho module. |
| `show_always` | `false` | Always shows the `username` module. |
| `disabled` | `false` | Disables the `username` module. |
### Các biến
| Biến | Ví dụ | Mô tả |
| ------- | ------------ | ------------------------------------------------------------------------------------------- |
| `style` | `'red bold'` | Mirrors the value of option `style_root` when root is logged in and `style_user` otherwise. |
| `user` | `'matchai'` | The currently logged-in user ID. |
### Ví dụ
```toml
# ~/.config/starship.toml
[username]
style_user = 'white bold'
style_root = 'black bold'
format = 'user: [$user]($style) '
disabled = false
show_always = true
```
## Vagrant
The `vagrant` module shows the currently installed version of [Vagrant](https://www.vagrantup.com/). Mặc định module sẽ được hiển thị nếu có bất kì điều kiện nào dưới đây thoả mãn:
- The current directory contains a `Vagrantfile` file
### Các tuỳ chọn
| Tuỳ chọn | Mặc định | Mô tả |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | Định dạng cho module. |
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'⍱ '` | A format string representing the symbol of Vagrant. |
| `detect_extensions` | `[]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. |
| `detect_files` | `['Vagrantfile']` | Những tên tệp nào sẽ kích hoạt mô-đun này. |
| `detect_folders` | `[]` | Những thư mục nào sẽ kích hoạt mô-đun này. |
| `style` | `'cyan bold'` | Kiểu cho module. |
| `disabled` | `false` | Disables the `vagrant` module. |
### Các biến
| Biến | Ví dụ | Mô tả |
| --------- | ---------------- | -------------------------------- |
| version | `Vagrant 2.2.10` | The version of `Vagrant` |
| symbol | | Giá trị ghi đè tuỳ chọn `symbol` |
| style\* | | Giá trị ghi đè của `style` |
*: Biến này có thể chỉ được sử dụng như một phần của style string
### Ví dụ
```toml
# ~/.config/starship.toml
[vagrant]
format = 'via [⍱ $version](bold white) '
```
## V
The `vlang` module shows you your currently installed version of [V](https://vlang.io/). Mặc định module sẽ được hiển thị nếu có bất kì điều kiện nào dưới đây thoả mãn:
- The current directory contains a file with `.v` extension
- The current directory contains a `v.mod`, `vpkg.json` or `.vpkg-lock.json` file
### Các tuỳ chọn
| Tuỳ chọn | Mặc định | Mô tả |
| ------------------- | -------------------------------------------- | ------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | Định dạng cho module. |
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'V '` | A format string representing the symbol of V |
| `detect_extensions` | `['v']` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. |
| `detect_files` | `['v.mod', 'vpkg.json', '.vpkg-lock.json' ]` | Những tên tệp nào sẽ kích hoạt mô-đun này. |
| `detect_folders` | `[]` | Những thư mục nào sẽ kích hoạt mô-đun này. |
| `style` | `'blue bold'` | Kiểu cho module. |
| `disabled` | `false` | Disables the `vlang` module. |
### Các biến
| Biến | Ví dụ | Mô tả |
| --------- | ------ | -------------------------------- |
| version | `v0.2` | The version of `v` |
| symbol | | Giá trị ghi đè tuỳ chọn `symbol` |
| style\* | | Giá trị ghi đè của `style` |
### Ví dụ
```toml
# ~/.config/starship.toml
[vlang]
format = 'via [V $version](blue bold) '
```
## VCSH
The `vcsh` module displays the current active [VCSH](https://github.com/RichiH/vcsh) repository. The module will be shown only if a repository is currently in use.
### Các tuỳ chọn
| Tuỳ chọn | Mặc định | Mô tả |
| ---------- | -------------------------------- | ------------------------------------------------------ |
| `symbol` | `''` | The symbol used before displaying the repository name. |
| `style` | `'bold yellow'` | Kiểu cho module. |
| `format` | `'vcsh [$symbol$repo]($style) '` | Định dạng cho module. |
| `disabled` | `false` | Disables the `vcsh` module. |
### Các biến
| Biến | Ví dụ | Mô tả |
| --------- | ------------------------------------------- | -------------------------------- |
| repo | `dotfiles` if in a VCSH repo named dotfiles | The active repository name |
| symbol | | Giá trị ghi đè tuỳ chọn `symbol` |
| style\* | `black bold dimmed` | Giá trị ghi đè của `style` |
*: Biến này có thể chỉ được sử dụng như một phần của style string
### Ví dụ
```toml
# ~/.config/starship.toml
[vcsh]
format = '[🆅 $repo](bold blue) '
```
## Zig
By default the `zig` module shows the currently installed version of [Zig](https://ziglang.org/). Module cho sẽ được hiện nếu bất kì điều kiện nào dưới đây thoả mãn:
- The current directory contains a `.zig` file
### Các tuỳ chọn
| Tuỳ chọn | Mặc định | Mô tả |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | Định dạng cho module. |
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'↯ '` | The symbol used before displaying the version of Zig. |
| `style` | `'bold yellow'` | Kiểu cho module. |
| `disabled` | `false` | Disables the `zig` module. |
| `detect_extensions` | `['zig']` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. |
| `detect_files` | `[]` | Những tên tệp nào sẽ kích hoạt mô-đun này. |
| `detect_folders` | `[]` | Những thư mục nào sẽ kích hoạt mô-đun này. |
### Các biến
| Biến | Ví dụ | Mô tả |
| --------- | -------- | -------------------------------- |
| version | `v0.6.0` | The version of `zig` |
| symbol | | Giá trị ghi đè tuỳ chọn `symbol` |
| style\* | | Giá trị ghi đè của `style` |
*: Biến này có thể chỉ được sử dụng như một phần của style string
### Ví dụ
```toml
# ~/.config/starship.toml
[zig]
symbol = '⚡️ '
```
## Custom commands
The `custom` modules show the output of some arbitrary commands.
These modules will be shown if any of the following conditions are met:
- The current directory contains a file whose name is in `detect_files`
- The current directory contains a directory whose name is in `detect_folders`
- The current directory contains a file whose extension is in `detect_extensions`
- The `when` command returns 0
- The current Operating System (std::env::consts::OS) matches with `os` field if defined.
::: tip
Multiple custom modules can be defined by using a `.`.
:::
::: tip
The order in which custom modules are shown can be individually set by including `${custom.foo}` in the top level `format` (as it includes a dot, you need to use `${...}`). By default, the `custom` module will simply show all custom modules in the order they were defined.
:::
::: tip
[Issue #1252](https://github.com/starship/starship/discussions/1252) contains examples of custom modules. If you have an interesting example not covered there, feel free to share it there!
:::
::: warning Command output is printed unescaped to the prompt
Whatever output the command generates is printed unmodified in the prompt. This means if the output contains special sequences that are interpreted by your shell they will be expanded when displayed. These special sequences are shell specific, e.g. you can write a command module that writes bash sequences, e.g. `\h`, but this module will not work in a fish or zsh shell.
Format strings can also contain shell specific prompt sequences, e.g. [Bash](https://www.gnu.org/software/bash/manual/html_node/Controlling-the-Prompt.html), [Zsh](https://zsh.sourceforge.io/Doc/Release/Prompt-Expansion.html).
:::
### Các tuỳ chọn
| Tuỳ chọn | Mặc định | Mô tả |
| ------------------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `command` | `''` | The command whose output should be printed. The command will be passed on stdin to the shell. |
| `when` | `false` | Either a boolean value (`true` or `false`, without quotes) or a string shell command used as a condition to show the module. In case of a string, the module will be shown if the command returns a `0` status code. |
| `require_repo` | `false` | If `true`, the module will only be shown in paths containing a (git) repository. This option alone is not sufficient display condition in absence of other options. |
| `shell` | | [See below](#custom-command-shell) |
| `mô tả` | `'<custom module>'` | The description of the module that is shown when running `starship explain`. |
| `detect_files` | `[]` | The files that will be searched in the working directory for a match. |
| `detect_folders` | `[]` | The directories that will be searched in the working directory for a match. |
| `detect_extensions` | `[]` | The extensions that will be searched in the working directory for a match. |
| `symbol` | `''` | The symbol used before displaying the command output. |
| `style` | `'bold green'` | Kiểu cho module. |
| `format` | `'[$symbol($output )]($style)'` | Định dạng cho module. |
| `disabled` | `false` | Disables this `custom` module. |
| `os` | | Operating System name on which the module will be shown (unix, linux, macos, windows, ... ) [See possible values](https://doc.rust-lang.org/std/env/consts/constant.OS.html). |
| `use_stdin` | | An optional boolean value that overrides whether commands should be forwarded to the shell via the standard input or as an argument. If unset standard input is used by default, unless the shell does not support it (cmd, nushell). Setting this disables shell-specific argument handling. |
| `ignore_timeout` | `false` | Ignore global `command_timeout` setting and keep running external commands, no matter how long they take. |
### Các biến
| Biến | Mô tả |
| --------- | -------------------------------------- |
| output | The output of shell command in `shell` |
| symbol | Giá trị ghi đè tuỳ chọn `symbol` |
| style\* | Giá trị ghi đè của `style` |
*: Biến này có thể chỉ được sử dụng như một phần của style string
#### Custom command shell
`shell` accepts a non-empty list of strings, where:
- The first string is the path to the shell to use to execute the command.
- Other following arguments are passed to the shell.
If unset, it will fallback to STARSHIP_SHELL and then to 'sh' on Linux, and 'cmd /C' on Windows.
The `command` will be passed in on stdin.
If `shell` is not given or only contains one element and Starship detects PowerShell will be used, the following arguments will automatically be added: `-NoProfile -Command -`. If `shell` is not given or only contains one element and Starship detects Cmd will be used, the following argument will automatically be added: `/C` and `stdin` will be set to `false`. If `shell` is not given or only contains one element and Starship detects Nushell will be used, the following arguments will automatically be added: `-c` and `stdin` will be set to `false`. This behavior can be avoided by explicitly passing arguments to the shell, e.g.
```toml
shell = ['pwsh', '-Command', '-']
```
::: warning Make sure your custom shell configuration exits gracefully
If you set a custom command, make sure that the default Shell used by starship will properly execute the command with a graceful exit (via the `shell` option).
For example, PowerShell requires the `-Command` parameter to execute a one liner. Omitting this parameter might throw starship into a recursive loop where the shell might try to load a full profile environment with starship itself again and hence re-execute the custom command, getting into a never ending loop.
Parameters similar to `-NoProfile` in PowerShell are recommended for other shells as well to avoid extra loading time of a custom profile on every starship invocation.
Automatic detection of shells and proper parameters addition are currently implemented, but it's possible that not all shells are covered. [Please open an issue](https://github.com/starship/starship/issues/new/choose) with shell details and starship configuration if you hit such scenario.
:::
### Ví dụ
```toml
# ~/.config/starship.toml
[custom.foo]
command = 'echo foo' # shows output of command
detect_files = ['foo'] # can specify filters but wildcards are not supported
when = ''' test "$HOME" = "$PWD" '''
format = ' transcending [$output]($style)'
[custom.time]
command = 'time /T'
detect_extensions = ['pst'] # filters *.pst files
shell = ['pwsh.exe', '-NoProfile', '-Command', '-']
[custom.time-as-arg]
command = 'time /T'
detect_extensions = ['pst'] # filters *.pst files
shell = ['pwsh.exe', '-NoProfile', '-Command']
use_stdin = false
```
View Git Blame Copy Permalink