diff --git a/docs/ar-SA/README.md b/docs/ar-SA/README.md index eb5b35ff2..e660e8144 100644 --- a/docs/ar-SA/README.md +++ b/docs/ar-SA/README.md @@ -40,6 +40,7 @@ description: Starship is the minimal, blazing fast, and extremely customizable p ```sh curl -fsSL https://starship.rs/install.sh | bash ``` + To update the Starship itself, rerun the above script. It will replace the current version without touching Starship's configuration. #### Install via Package Manager @@ -133,4 +134,3 @@ description: Starship is the minimal, blazing fast, and extremely customizable p eval `starship init tcsh` ``` - diff --git a/docs/ar-SA/advanced-config/README.md b/docs/ar-SA/advanced-config/README.md index 1cf6ebb78..7db817056 100644 --- a/docs/ar-SA/advanced-config/README.md +++ b/docs/ar-SA/advanced-config/README.md @@ -1,4 +1,4 @@ -# Advanced Configuration +# الإعداد المتقدم While Starship is a versatile shell, sometimes you need to do more than edit `starship.toml` to get it to do certain things. This page details some of the more advanced configuration techniques used in starship. @@ -63,7 +63,7 @@ For example, if you want to display your current directory in your terminal tab ```bash function set_win_title(){ - echo -ne "\033]0; $(basename $PWD) \007" + echo -ne "\033]0; $(basename "$PWD") \007" } starship_precmd_user_func="set_win_title" ``` diff --git a/docs/ar-SA/config/README.md b/docs/ar-SA/config/README.md index 3a9111cd6..1fe3bfa8d 100644 --- a/docs/ar-SA/config/README.md +++ b/docs/ar-SA/config/README.md @@ -3,7 +3,7 @@ To get started configuring starship, create the following file: `~/.config/starship.toml`. ```sh -mkdir -p ~/.config && touch ~/.config/starship.toml +mkdir -p ~/.config && starship print-config --default > ~/.config/starship.toml ``` All configuration for starship is done in this [TOML](https://github.com/toml-lang/toml) file: @@ -180,6 +180,7 @@ $hostname\ $shlvl\ $kubernetes\ $directory\ +$vcsh\ $git_branch\ $git_commit\ $git_state\ @@ -248,7 +249,7 @@ When using [awsu](https://github.com/kreuzwerker/awsu) the profile is read from | `symbol` | `"☁️ "` | The symbol used before displaying the current AWS profile. | | `region_aliases` | | Table of region aliases to display in addition to the AWS name. | | `style` | `"bold yellow"` | The style for the module. | -| `disabled` | `false` | Disables the `AWS` module. | +| `disabled` | `false` | Disables the `aws` module. | ### Variables @@ -310,25 +311,24 @@ The `battery` module shows how charged the device's battery is and its current c | Option | Default | Description | | -------------------- | --------------------------------- | --------------------------------------------------- | -| `full_symbol` | `""` | The symbol shown when the battery is full. | -| `charging_symbol` | `""` | The symbol shown when the battery is charging. | -| `discharging_symbol` | `""` | The symbol shown when the battery is discharging. | -| `unknown_symbol` | `""` | The symbol shown when the battery state is unknown. | -| `empty_symbol` | `""` | The symbol shown when the battery state is empty. | +| `full_symbol` | `" "` | The symbol shown when the battery is full. | +| `charging_symbol` | `" "` | The symbol shown when the battery is charging. | +| `discharging_symbol` | `" "` | The symbol shown when the battery is discharging. | +| `unknown_symbol` | `" "` | The symbol shown when the battery state is unknown. | +| `empty_symbol` | `" "` | The symbol shown when the battery state is empty. | | `format` | `"[$symbol$percentage]($style) "` | The format for the module. | | `display` | [link](#battery-display) | Display threshold and style for the module. | | `disabled` | `false` | Disables the `battery` module. | - ### Example ```toml # ~/.config/starship.toml [battery] -full_symbol = "🔋" -charging_symbol = "⚡️" -discharging_symbol = "💀" +full_symbol = "🔋 " +charging_symbol = "⚡️ " +discharging_symbol = "💀 " ``` ### Battery Display @@ -438,7 +438,7 @@ The `cmake` module shows the currently installed version of CMake. By default th | ------------------- | -------------------------------------- | -------------------------------------------- | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `symbol` | `"△ "` | The symbol used before the version of cmake. | -| `detect_extensions` | `[]` | Which extensions should trigger this moudle | +| `detect_extensions` | `[]` | Which extensions should trigger this module | | `detect_files` | `["CMakeLists.txt", "CMakeCache.txt"]` | Which filenames should trigger this module | | `detect_folders` | `[]` | Which folders should trigger this module | | `style` | `"bold blue"` | The style for the module. | @@ -595,7 +595,7 @@ The `dart` module shows the currently installed version of Dart. By default the | ------------------- | ------------------------------------------------- | ----------------------------------------------- | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `symbol` | `"🎯 "` | A format string representing the symbol of Dart | -| `detect_extensions` | `['dart']` | Which extensions should trigger this moudle. | +| `detect_extensions` | `['dart']` | Which extensions should trigger this module. | | `detect_files` | `["pubspec.yaml", "pubspec.yml", "pubspec.lock"]` | Which filenames should trigger this module. | | `detect_folders` | `[".dart_tool"]` | Which folders should trigger this module. | | `style` | `"bold blue"` | The style for the module. | @@ -745,7 +745,7 @@ The module will also show the Target Framework Moniker ( "` | The symbol used before displaying the version of PureScript. | -| `detect_extensions` | `["purs"]` | Which extensions should trigger this moudle. | +| `detect_extensions` | `["purs"]` | Which extensions should trigger this module. | | `detect_files` | `["spago.dhall"]` | Which filenames should trigger this module. | | `detect_folders` | `[]` | Which folders should trigger this module. | | `style` | `"bold white"` | The style for the module. | @@ -2034,13 +2038,13 @@ By default the module will be shown if any of the following conditions are met: | Option | Default | Description | | -------------------- | ------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------- | -| `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\))]($style)'` | The format for the module. | +| `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\) )]($style)'` | The format for the module. | | `symbol` | `"🐍 "` | A format string representing the symbol of Python | | `style` | `"yellow bold"` | The style for the 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"]` | Which extensions should trigger this moudle | +| `detect_extensions` | `[".py"]` | Which extensions should trigger this module | | `detect_files` | `[".python-version", "Pipfile", "__init__.py", "pyproject.toml", "requirements.txt", "setup.py", "tox.ini"]` | Which filenames should trigger this module | | `detect_folders` | `[]` | Which folders should trigger this module | | `disabled` | `false` | Disables the `python` module. | @@ -2063,7 +2067,6 @@ The default values and order for `python_binary` was chosen to first identify th | pyenv_prefix | `"pyenv "` | Mirrors the value of option `pyenv_prefix` | | virtualenv | `"venv"` | The current `virtualenv` name | - ### Example ```toml @@ -2167,7 +2170,6 @@ By default the `rust` module shows the currently installed version of Rust. The format = "via [⚙️ $version](red bold)" ``` - ## Scala The `scala` module shows the currently installed version of Scala. By default the module will be shown if any of the following conditions are met: @@ -2178,7 +2180,6 @@ The `scala` module shows the currently installed version of Scala. By default th ### Options - | Option | Default | Description | | ------------------- | ---------------------------------------- | ------------------------------------------------- | | `format` | `"via [${symbol}(${version} )]($style)"` | The format for the module. | @@ -2208,7 +2209,6 @@ The `scala` module shows the currently installed version of Scala. By default th symbol = "🌟 " ``` - ## Shell The `shell` module shows an indicator for currently used shell. @@ -2240,6 +2240,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y | indicator | | Mirrors the value of `indicator` for currently used shell. | ### Examples + ```toml # ~/.config/starship.toml @@ -2251,24 +2252,24 @@ disabled = false ## SHLVL -The `shlvl` module shows the current SHLVL ("shell level") environment variable, if it is set to a number and meets or exceeds the specified threshold. +The `shlvl` module shows the current `SHLVL` ("shell level") environment variable, if it is set to a number and meets or exceeds the specified threshold. ### Options -| Option | Default | Description | -| ----------- | ---------------------------- | ----------------------------------------------------------- | -| `threshold` | `2` | Display threshold. | -| `format` | `"[$symbol$shlvl]($style) "` | The format for the module. | -| `symbol` | `"↕️ "` | The symbol used to represent the SHLVL. | -| `repeat` | `false` | Causes `symbol` to be repeated by the current SHLVL amount. | -| `style` | `"bold yellow"` | The style for the module. | -| `disabled` | `true` | Disables the `shlvl` module. | +| Option | Default | Description | +| ----------- | ---------------------------- | ------------------------------------------------------------- | +| `threshold` | `2` | Display threshold. | +| `format` | `"[$symbol$shlvl]($style) "` | The format for the module. | +| `symbol` | `"↕️ "` | The symbol used to represent the `SHLVL`. | +| `repeat` | `false` | Causes `symbol` to be repeated by the current `SHLVL` amount. | +| `style` | `"bold yellow"` | The style for the module. | +| `disabled` | `true` | Disables the `shlvl` module. | ### Variables | Variable | Example | Description | | --------- | ------- | ------------------------------------ | -| shlvl | `3` | The current value of SHLVL | +| shlvl | `3` | The current value of `SHLVL` | | symbol | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | @@ -2387,7 +2388,7 @@ By default the `swift` module shows the currently installed version of Swift. Th | ------------------- | ------------------------------------ | ------------------------------------------------ | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `symbol` | `"🐦 "` | A format string representing the symbol of Swift | -| `detect_extensions` | `["swift"]` | Which extensions should trigger this moudle. | +| `detect_extensions` | `["swift"]` | Which extensions should trigger this module. | | `detect_files` | `["Package.swift"]` | Which filenames should trigger this module. | | `detect_folders` | `[]` | Which folders should trigger this module. | | `style` | `"bold 202"` | The style for the module. | @@ -2577,7 +2578,7 @@ The `vagrant` module shows the currently installed version of Vagrant. By defaul | `detect_files` | `["Vagrantfile"]` | Which filenames should trigger this module. | | `detect_folders` | `[]` | Which folders should trigger this module. | | `style` | `"cyan bold"` | The style for the module. | -| `disabled` | `false` | Disables the `Vagrant` module. | +| `disabled` | `false` | Disables the `vagrant` module. | ### Variables @@ -2598,6 +2599,38 @@ The `vagrant` module shows the currently installed version of Vagrant. By defaul format = "via [⍱ $version](bold white) " ``` +## VCSH + +The `vcsh` module displays the current active VCSH repository. The module will be shown only if a repository is currently in use. + +### Options + +| Option | Default | Description | +| ---------- | -------------------------------- | ------------------------------------------------------ | +| `symbol` | | The symbol used before displaying the repository name. | +| `style` | `"bold yellow"` | The style for the module. | +| `format` | `"vcsh [$symbol$repo]($style) "` | The format for the module. | +| `disabled` | `false` | Disables the `vcsh` module. | + +### Variables + +| Variable | Example | Description | +| --------- | ------------------------------------------- | ------------------------------------ | +| repo | `dotfiles` if in a VCSH repo named dotfiles | The active repository name | +| symbol | | Mirrors the value of option `symbol` | +| style\* | `black bold dimmed` | Mirrors the value of option `style` | + +\*: This variable can only be used as a part of a style string + +### Example + +```toml +# ~/.config/starship.toml + +[vcsh] +format = "[🆅 $repo](bold blue) " +``` + ## Zig By default the the `zig` module shows the currently installed version of Zig. The module will be shown if any of the following conditions are met: diff --git a/docs/ar-SA/faq/README.md b/docs/ar-SA/faq/README.md index d3c6d238c..f5c949629 100644 --- a/docs/ar-SA/faq/README.md +++ b/docs/ar-SA/faq/README.md @@ -92,5 +92,5 @@ If Starship was installed using the `curl | bash` script, the following command ```sh # Locate and delete the starship binary -rm "$(which starship)" +bash -c 'rm "$(which starship)"' ``` diff --git a/docs/ar-SA/guide/README.md b/docs/ar-SA/guide/README.md index fd107ff3c..7367fbf58 100644 --- a/docs/ar-SA/guide/README.md +++ b/docs/ar-SA/guide/README.md @@ -90,7 +90,7 @@ alt="简体中文" />   - Español   - Français   - ~/.config/starship.toml ``` All configuration for starship is done in this [TOML](https://github.com/toml-lang/toml) file: @@ -180,6 +180,7 @@ $hostname\ $shlvl\ $kubernetes\ $directory\ +$vcsh\ $git_branch\ $git_commit\ $git_state\ @@ -248,7 +249,7 @@ When using [awsu](https://github.com/kreuzwerker/awsu) the profile is read from | `symbol` | `"☁️ "` | The symbol used before displaying the current AWS profile. | | `region_aliases` | | Table of region aliases to display in addition to the AWS name. | | `style` | `"bold yellow"` | The style for the module. | -| `disabled` | `false` | Disables the `AWS` module. | +| `disabled` | `false` | Disables the `aws` module. | ### Variables @@ -310,25 +311,24 @@ The `battery` module shows how charged the device's battery is and its current c | Option | Default | Description | | -------------------- | --------------------------------- | --------------------------------------------------- | -| `full_symbol` | `""` | The symbol shown when the battery is full. | -| `charging_symbol` | `""` | The symbol shown when the battery is charging. | -| `discharging_symbol` | `""` | The symbol shown when the battery is discharging. | -| `unknown_symbol` | `""` | The symbol shown when the battery state is unknown. | -| `empty_symbol` | `""` | The symbol shown when the battery state is empty. | +| `full_symbol` | `" "` | The symbol shown when the battery is full. | +| `charging_symbol` | `" "` | The symbol shown when the battery is charging. | +| `discharging_symbol` | `" "` | The symbol shown when the battery is discharging. | +| `unknown_symbol` | `" "` | The symbol shown when the battery state is unknown. | +| `empty_symbol` | `" "` | The symbol shown when the battery state is empty. | | `format` | `"[$symbol$percentage]($style) "` | The format for the module. | | `display` | [link](#battery-display) | Display threshold and style for the module. | | `disabled` | `false` | Disables the `battery` module. | - ### Example ```toml # ~/.config/starship.toml [battery] -full_symbol = "🔋" -charging_symbol = "⚡️" -discharging_symbol = "💀" +full_symbol = "🔋 " +charging_symbol = "⚡️ " +discharging_symbol = "💀 " ``` ### Battery Display @@ -438,7 +438,7 @@ The `cmake` module shows the currently installed version of CMake. By default th | ------------------- | -------------------------------------- | -------------------------------------------- | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `symbol` | `"△ "` | The symbol used before the version of cmake. | -| `detect_extensions` | `[]` | Which extensions should trigger this moudle | +| `detect_extensions` | `[]` | Which extensions should trigger this module | | `detect_files` | `["CMakeLists.txt", "CMakeCache.txt"]` | Which filenames should trigger this module | | `detect_folders` | `[]` | Which folders should trigger this module | | `style` | `"bold blue"` | The style for the module. | @@ -595,7 +595,7 @@ The `dart` module shows the currently installed version of Dart. By default the | ------------------- | ------------------------------------------------- | ----------------------------------------------- | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `symbol` | `"🎯 "` | A format string representing the symbol of Dart | -| `detect_extensions` | `['dart']` | Which extensions should trigger this moudle. | +| `detect_extensions` | `['dart']` | Which extensions should trigger this module. | | `detect_files` | `["pubspec.yaml", "pubspec.yml", "pubspec.lock"]` | Which filenames should trigger this module. | | `detect_folders` | `[".dart_tool"]` | Which folders should trigger this module. | | `style` | `"bold blue"` | The style for the module. | @@ -745,7 +745,7 @@ The module will also show the Target Framework Moniker ( "` | The symbol used before displaying the version of PureScript. | -| `detect_extensions` | `["purs"]` | Which extensions should trigger this moudle. | +| `detect_extensions` | `["purs"]` | Which extensions should trigger this module. | | `detect_files` | `["spago.dhall"]` | Which filenames should trigger this module. | | `detect_folders` | `[]` | Which folders should trigger this module. | | `style` | `"bold white"` | The style for the module. | @@ -2034,13 +2038,13 @@ By default the module will be shown if any of the following conditions are met: | Option | Default | Description | | -------------------- | ------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------- | -| `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\))]($style)'` | The format for the module. | +| `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\) )]($style)'` | The format for the module. | | `symbol` | `"🐍 "` | A format string representing the symbol of Python | | `style` | `"yellow bold"` | The style for the 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"]` | Which extensions should trigger this moudle | +| `detect_extensions` | `[".py"]` | Which extensions should trigger this module | | `detect_files` | `[".python-version", "Pipfile", "__init__.py", "pyproject.toml", "requirements.txt", "setup.py", "tox.ini"]` | Which filenames should trigger this module | | `detect_folders` | `[]` | Which folders should trigger this module | | `disabled` | `false` | Disables the `python` module. | @@ -2063,7 +2067,6 @@ The default values and order for `python_binary` was chosen to first identify th | pyenv_prefix | `"pyenv "` | Mirrors the value of option `pyenv_prefix` | | virtualenv | `"venv"` | The current `virtualenv` name | - ### Example ```toml @@ -2167,7 +2170,6 @@ By default the `rust` module shows the currently installed version of Rust. The format = "via [⚙️ $version](red bold)" ``` - ## Scala The `scala` module shows the currently installed version of Scala. By default the module will be shown if any of the following conditions are met: @@ -2178,7 +2180,6 @@ The `scala` module shows the currently installed version of Scala. By default th ### Options - | Option | Default | Description | | ------------------- | ---------------------------------------- | ------------------------------------------------- | | `format` | `"via [${symbol}(${version} )]($style)"` | The format for the module. | @@ -2208,7 +2209,6 @@ The `scala` module shows the currently installed version of Scala. By default th symbol = "🌟 " ``` - ## Shell The `shell` module shows an indicator for currently used shell. @@ -2240,6 +2240,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y | indicator | | Mirrors the value of `indicator` for currently used shell. | ### Examples + ```toml # ~/.config/starship.toml @@ -2251,24 +2252,24 @@ disabled = false ## SHLVL -The `shlvl` module shows the current SHLVL ("shell level") environment variable, if it is set to a number and meets or exceeds the specified threshold. +The `shlvl` module shows the current `SHLVL` ("shell level") environment variable, if it is set to a number and meets or exceeds the specified threshold. ### Options -| Option | Default | Description | -| ----------- | ---------------------------- | ----------------------------------------------------------- | -| `threshold` | `2` | Display threshold. | -| `format` | `"[$symbol$shlvl]($style) "` | The format for the module. | -| `symbol` | `"↕️ "` | The symbol used to represent the SHLVL. | -| `repeat` | `false` | Causes `symbol` to be repeated by the current SHLVL amount. | -| `style` | `"bold yellow"` | The style for the module. | -| `disabled` | `true` | Disables the `shlvl` module. | +| Option | Default | Description | +| ----------- | ---------------------------- | ------------------------------------------------------------- | +| `threshold` | `2` | Display threshold. | +| `format` | `"[$symbol$shlvl]($style) "` | The format for the module. | +| `symbol` | `"↕️ "` | The symbol used to represent the `SHLVL`. | +| `repeat` | `false` | Causes `symbol` to be repeated by the current `SHLVL` amount. | +| `style` | `"bold yellow"` | The style for the module. | +| `disabled` | `true` | Disables the `shlvl` module. | ### Variables | Variable | Example | Description | | --------- | ------- | ------------------------------------ | -| shlvl | `3` | The current value of SHLVL | +| shlvl | `3` | The current value of `SHLVL` | | symbol | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | @@ -2387,7 +2388,7 @@ By default the `swift` module shows the currently installed version of Swift. Th | ------------------- | ------------------------------------ | ------------------------------------------------ | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `symbol` | `"🐦 "` | A format string representing the symbol of Swift | -| `detect_extensions` | `["swift"]` | Which extensions should trigger this moudle. | +| `detect_extensions` | `["swift"]` | Which extensions should trigger this module. | | `detect_files` | `["Package.swift"]` | Which filenames should trigger this module. | | `detect_folders` | `[]` | Which folders should trigger this module. | | `style` | `"bold 202"` | The style for the module. | @@ -2577,7 +2578,7 @@ The `vagrant` module shows the currently installed version of Vagrant. By defaul | `detect_files` | `["Vagrantfile"]` | Which filenames should trigger this module. | | `detect_folders` | `[]` | Which folders should trigger this module. | | `style` | `"cyan bold"` | The style for the module. | -| `disabled` | `false` | Disables the `Vagrant` module. | +| `disabled` | `false` | Disables the `vagrant` module. | ### Variables @@ -2598,6 +2599,38 @@ The `vagrant` module shows the currently installed version of Vagrant. By defaul format = "via [⍱ $version](bold white) " ``` +## VCSH + +The `vcsh` module displays the current active VCSH repository. The module will be shown only if a repository is currently in use. + +### Options + +| Option | Default | Description | +| ---------- | -------------------------------- | ------------------------------------------------------ | +| `symbol` | | The symbol used before displaying the repository name. | +| `style` | `"bold yellow"` | The style for the module. | +| `format` | `"vcsh [$symbol$repo]($style) "` | The format for the module. | +| `disabled` | `false` | Disables the `vcsh` module. | + +### Variables + +| Variable | Example | Description | +| --------- | ------------------------------------------- | ------------------------------------ | +| repo | `dotfiles` if in a VCSH repo named dotfiles | The active repository name | +| symbol | | Mirrors the value of option `symbol` | +| style\* | `black bold dimmed` | Mirrors the value of option `style` | + +\*: This variable can only be used as a part of a style string + +### Example + +```toml +# ~/.config/starship.toml + +[vcsh] +format = "[🆅 $repo](bold blue) " +``` + ## Zig By default the the `zig` module shows the currently installed version of Zig. The module will be shown if any of the following conditions are met: diff --git a/docs/ckb-IR/faq/README.md b/docs/ckb-IR/faq/README.md index d3c6d238c..f5c949629 100644 --- a/docs/ckb-IR/faq/README.md +++ b/docs/ckb-IR/faq/README.md @@ -92,5 +92,5 @@ If Starship was installed using the `curl | bash` script, the following command ```sh # Locate and delete the starship binary -rm "$(which starship)" +bash -c 'rm "$(which starship)"' ``` diff --git a/docs/ckb-IR/guide/README.md b/docs/ckb-IR/guide/README.md index fd107ff3c..7367fbf58 100644 --- a/docs/ckb-IR/guide/README.md +++ b/docs/ckb-IR/guide/README.md @@ -90,7 +90,7 @@ alt="简体中文" />   - Español   - Français   - ~/.config/starship.toml ``` Die gesamte Konfiguration von Starship wird über diese [TOML](https://github.com/toml-lang/toml)-Datei durchgeführt: @@ -180,6 +180,7 @@ $hostname\ $shlvl\ $kubernetes\ $directory\ +$vcsh\ $git_branch\ $git_commit\ $git_state\ @@ -248,7 +249,7 @@ When using [awsu](https://github.com/kreuzwerker/awsu) the profile is read from | `symbol` | `"☁️ "` | Symbol das vor dem aktuellen AWS-Profil angezeigt wird. | | `region_aliases` | | Table of region aliases to display in addition to the AWS name. | | `style` | `"bold yellow"` | Stil für dieses Modul. | -| `disabled` | `false` | Deaktiviert das `aws`-Modul. | +| `disabled` | `false` | Disables the `aws` module. | ### Variables @@ -310,25 +311,24 @@ The `battery` module shows how charged the device's battery is and its current c | Option | Standartwert | Beschreibung | | -------------------- | --------------------------------- | ----------------------------------------------------------------------------------- | -| `full_symbol` | `""` | Das Symbol das angezeigt wird wenn der Akku voll geladen ist. | -| `charging_symbol` | `""` | Das Symbol das angezeigt wird wenn der Akku aufgeladen wird. | -| `discharging_symbol` | `""` | Das Symbol, das angezeigt wird, wenn die Batterie entladen wird. | -| `unknown_symbol` | `""` | The symbol shown when the battery state is unknown. | -| `empty_symbol` | `""` | The symbol shown when the battery state is empty. | +| `full_symbol` | `" "` | Das Symbol das angezeigt wird wenn der Akku voll geladen ist. | +| `charging_symbol` | `" "` | Das Symbol das angezeigt wird wenn der Akku aufgeladen wird. | +| `discharging_symbol` | `" "` | Das Symbol, das angezeigt wird, wenn die Batterie entladen wird. | +| `unknown_symbol` | `" "` | The symbol shown when the battery state is unknown. | +| `empty_symbol` | `" "` | The symbol shown when the battery state is empty. | | `format` | `"[$symbol$percentage]($style) "` | The format for the module. | | `display` | [link](#battery-display) | Stellt den Grenzwert ein ab dem der Ladezustand (das battery-Modul) angezeigt wird. | | `disabled` | `false` | Wenn der Wert auf `true` steht, wird das Akkustand-Modul deaktiviert. | - ### Beispiel ```toml # ~/.config/starship.toml [battery] -full_symbol = "🔋" -charging_symbol = "⚡️" -discharging_symbol = "💀" +full_symbol = "🔋 " +charging_symbol = "⚡️ " +discharging_symbol = "💀 " ``` ### Anzeige des Akkustandes @@ -438,7 +438,7 @@ The `cmake` module shows the currently installed version of CMake. By default th | ------------------- | -------------------------------------- | -------------------------------------------- | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `symbol` | `"△ "` | The symbol used before the version of cmake. | -| `detect_extensions` | `[]` | Which extensions should trigger this moudle | +| `detect_extensions` | `[]` | Which extensions should trigger this module | | `detect_files` | `["CMakeLists.txt", "CMakeCache.txt"]` | Which filenames should trigger this module | | `detect_folders` | `[]` | Which folders should trigger this module | | `style` | `"bold blue"` | Stil für dieses Modul. | @@ -595,7 +595,7 @@ The `dart` module shows the currently installed version of Dart. By default the | ------------------- | ------------------------------------------------- | ----------------------------------------------- | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `symbol` | `"🎯 "` | A format string representing the symbol of Dart | -| `detect_extensions` | `['dart']` | Which extensions should trigger this moudle. | +| `detect_extensions` | `['dart']` | Which extensions should trigger this module. | | `detect_files` | `["pubspec.yaml", "pubspec.yml", "pubspec.lock"]` | Which filenames should trigger this module. | | `detect_folders` | `[".dart_tool"]` | Which folders should trigger this module. | | `style` | `"bold blue"` | Stil für dieses Modul. | @@ -745,7 +745,7 @@ The module will also show the Target Framework Moniker ( "` | The symbol used before displaying the version of PureScript. | -| `detect_extensions` | `["purs"]` | Which extensions should trigger this moudle. | +| `detect_extensions` | `["purs"]` | Which extensions should trigger this module. | | `detect_files` | `["spago.dhall"]` | Which filenames should trigger this module. | | `detect_folders` | `[]` | Which folders should trigger this module. | | `style` | `"bold white"` | Stil für dieses Modul. | @@ -2034,13 +2038,13 @@ By default the module will be shown if any of the following conditions are met: | Option | Standardwert | Beschreibung | | -------------------- | ------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------- | -| `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\))]($style)'` | The format for the module. | +| `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\) )]($style)'` | The format for the module. | | `symbol` | `"🐍 "` | A format string representing the symbol of Python | | `style` | `"yellow bold"` | Stil für dieses Modul. | | `pyenv_version_name` | `false` | Verwende `pyenv` um die Python-Versionzu beziehen. | | `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"]` | Which extensions should trigger this moudle | +| `detect_extensions` | `[".py"]` | Which extensions should trigger this module | | `detect_files` | `[".python-version", "Pipfile", "__init__.py", "pyproject.toml", "requirements.txt", "setup.py", "tox.ini"]` | Which filenames should trigger this module | | `detect_folders` | `[]` | Which folders should trigger this module | | `disabled` | `false` | Disables the `python` module. | @@ -2063,7 +2067,6 @@ The default values and order for `python_binary` was chosen to first identify th | pyenv_prefix | `"pyenv "` | Mirrors the value of option `pyenv_prefix` | | virtualenv | `"venv"` | The current `virtualenv` name | - ### Beispiel ```toml @@ -2167,7 +2170,6 @@ By default the `rust` module shows the currently installed version of Rust. The format = "via [⚙️ $version](red bold)" ``` - ## Scala The `scala` module shows the currently installed version of Scala. By default the module will be shown if any of the following conditions are met: @@ -2178,7 +2180,6 @@ The `scala` module shows the currently installed version of Scala. By default th ### Optionen - | Option | Standardwert | Beschreibung | | ------------------- | ---------------------------------------- | ------------------------------------------------- | | `format` | `"via [${symbol}(${version} )]($style)"` | The format for the module. | @@ -2208,7 +2209,6 @@ The `scala` module shows the currently installed version of Scala. By default th symbol = "🌟 " ``` - ## Shell The `shell` module shows an indicator for currently used shell. @@ -2240,6 +2240,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y | indicator | | Mirrors the value of `indicator` for currently used shell. | ### Examples + ```toml # ~/.config/starship.toml @@ -2251,24 +2252,24 @@ disabled = false ## SHLVL -The `shlvl` module shows the current SHLVL ("shell level") environment variable, if it is set to a number and meets or exceeds the specified threshold. +The `shlvl` module shows the current `SHLVL` ("shell level") environment variable, if it is set to a number and meets or exceeds the specified threshold. ### Optionen -| Option | Standardwert | Beschreibung | -| ----------- | ---------------------------- | ----------------------------------------------------------- | -| `threshold` | `2` | Display threshold. | -| `format` | `"[$symbol$shlvl]($style) "` | The format for the module. | -| `symbol` | `"↕️ "` | The symbol used to represent the SHLVL. | -| `repeat` | `false` | Causes `symbol` to be repeated by the current SHLVL amount. | -| `style` | `"bold yellow"` | Stil für dieses Modul. | -| `disabled` | `true` | Disables the `shlvl` module. | +| Option | Standardwert | Beschreibung | +| ----------- | ---------------------------- | ------------------------------------------------------------- | +| `threshold` | `2` | Display threshold. | +| `format` | `"[$symbol$shlvl]($style) "` | The format for the module. | +| `symbol` | `"↕️ "` | The symbol used to represent the `SHLVL`. | +| `repeat` | `false` | Causes `symbol` to be repeated by the current `SHLVL` amount. | +| `style` | `"bold yellow"` | Stil für dieses Modul. | +| `disabled` | `true` | Disables the `shlvl` module. | ### Variables | Variable | Beispiel | Beschreibung | | --------- | -------- | ------------------------------------ | -| shlvl | `3` | The current value of SHLVL | +| shlvl | `3` | The current value of `SHLVL` | | symbol | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | @@ -2387,7 +2388,7 @@ By default the `swift` module shows the currently installed version of Swift. Th | ------------------- | ------------------------------------ | ------------------------------------------------ | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `symbol` | `"🐦 "` | A format string representing the symbol of Swift | -| `detect_extensions` | `["swift"]` | Which extensions should trigger this moudle. | +| `detect_extensions` | `["swift"]` | Which extensions should trigger this module. | | `detect_files` | `["Package.swift"]` | Which filenames should trigger this module. | | `detect_folders` | `[]` | Which folders should trigger this module. | | `style` | `"bold 202"` | Stil für dieses Modul. | @@ -2577,7 +2578,7 @@ The `vagrant` module shows the currently installed version of Vagrant. By defaul | `detect_files` | `["Vagrantfile"]` | Which filenames should trigger this module. | | `detect_folders` | `[]` | Which folders should trigger this module. | | `style` | `"cyan bold"` | Stil für dieses Modul. | -| `disabled` | `false` | Disables the `Vagrant` module. | +| `disabled` | `false` | Disables the `vagrant` module. | ### Variables @@ -2598,6 +2599,38 @@ The `vagrant` module shows the currently installed version of Vagrant. By defaul format = "via [⍱ $version](bold white) " ``` +## VCSH + +The `vcsh` module displays the current active VCSH repository. The module will be shown only if a repository is currently in use. + +### Optionen + +| Option | Standardwert | Beschreibung | +| ---------- | -------------------------------- | ------------------------------------------------------ | +| `symbol` | | The symbol used before displaying the repository name. | +| `style` | `"bold yellow"` | Stil für dieses Modul. | +| `format` | `"vcsh [$symbol$repo]($style) "` | The format for the module. | +| `disabled` | `false` | Disables the `vcsh` module. | + +### Variables + +| Variable | Beispiel | Beschreibung | +| --------- | ------------------------------------------- | ------------------------------------ | +| repo | `dotfiles` if in a VCSH repo named dotfiles | The active repository name | +| symbol | | Mirrors the value of option `symbol` | +| style\* | `black bold dimmed` | Mirrors the value of option `style` | + +\*: This variable can only be used as a part of a style string + +### Beispiel + +```toml +# ~/.config/starship.toml + +[vcsh] +format = "[🆅 $repo](bold blue) " +``` + ## Zig By default the the `zig` module shows the currently installed version of Zig. The module will be shown if any of the following conditions are met: diff --git a/docs/de-DE/faq/README.md b/docs/de-DE/faq/README.md index 29f613c36..e366d5e17 100644 --- a/docs/de-DE/faq/README.md +++ b/docs/de-DE/faq/README.md @@ -92,5 +92,5 @@ If Starship was installed using the `curl | bash` script, the following command ```sh # Locate and delete the starship binary -rm "$(which starship)" +bash -c 'rm "$(which starship)"' ``` diff --git a/docs/de-DE/guide/README.md b/docs/de-DE/guide/README.md index a03230dc5..8ab328635 100644 --- a/docs/de-DE/guide/README.md +++ b/docs/de-DE/guide/README.md @@ -90,7 +90,7 @@ alt="简体中文" />   - Español   - Français   - Tiếng Việt

@@ -124,7 +124,7 @@ align="right" /> -**Minimale, super schnelle und unendlich anpassbare Prompt für jede Shell!** +**Der minimale, super schnelle und unendlich anpassbare Prompt für jede Shell!** - **Fast:** it's fast – _really really_ fast! 🚀 - **Customizable:** configure every aspect of your prompt. @@ -160,6 +160,7 @@ ```sh curl -fsSL https://starship.rs/install.sh | bash ``` + To update the Starship itself, rerun the above script. It will replace the current version without touching Starship's configuration. #### Installation mithilfe eines Paket-Managers diff --git a/docs/de-DE/installing/README.md b/docs/de-DE/installing/README.md index aa64a272a..8d5d33edd 100644 --- a/docs/de-DE/installing/README.md +++ b/docs/de-DE/installing/README.md @@ -45,7 +45,7 @@ curl -fsSL https://starship.rs/install.sh | bash -s -- -b /data/data/com.termux/ nix-env -iA nixos.starship ``` -#### Declarative, single user, via [home-manager](home-manager) +#### Declarative, single user, via [home-manager](https://github.com/nix-community/home-manager) Enable the `programs.starship` module in your `home.nix` file, and add your settings diff --git a/docs/de-DE/migrating-to-0.45.0/README.md b/docs/de-DE/migrating-to-0.45.0/README.md index f7be7ec62..fda0100bc 100644 --- a/docs/de-DE/migrating-to-0.45.0/README.md +++ b/docs/de-DE/migrating-to-0.45.0/README.md @@ -1,4 +1,4 @@ -# Migrating to v0.45.0 +# Migration auf v0.45.0 Starship v0.45.0 is a release containing breaking changes, in preparation for the big v1.0.0. We have made some major changes around how configuration is done on the prompt, to allow for a greater degree of customization. diff --git a/docs/de-DE/presets/README.md b/docs/de-DE/presets/README.md index 01e037d0e..f0f183182 100644 --- a/docs/de-DE/presets/README.md +++ b/docs/de-DE/presets/README.md @@ -27,7 +27,7 @@ symbol = " " [directory] read_only = " " -[docker] +[docker_context] symbol = " " [elixir] @@ -42,9 +42,6 @@ symbol = " " [golang] symbol = " " -[haskell] -symbol = " " - [hg_branch] symbol = " " @@ -63,9 +60,6 @@ symbol = " " [nix_shell] symbol = " " -[nodejs] -symbol = " " - [package] symbol = " " diff --git a/docs/es-ES/README.md b/docs/es-ES/README.md index 8f0990d8f..2edb5992a 100644 --- a/docs/es-ES/README.md +++ b/docs/es-ES/README.md @@ -40,11 +40,12 @@ description: '¡Starship es el prompt minimalista, ultrarápido e infinitamente ```sh curl -fsSL https://starship.rs/install.sh | bash ``` + To update the Starship itself, rerun the above script. It will replace the current version without touching Starship's configuration. #### Instalar con un gestor de paquetes - Con [Homebrew](https://brew.sh/): + With [Homebrew](https://brew.sh/): ```sh brew install starship @@ -133,4 +134,3 @@ description: '¡Starship es el prompt minimalista, ultrarápido e infinitamente eval `starship init tcsh` ``` - diff --git a/docs/es-ES/advanced-config/README.md b/docs/es-ES/advanced-config/README.md index 3a84d2f5e..85e992039 100644 --- a/docs/es-ES/advanced-config/README.md +++ b/docs/es-ES/advanced-config/README.md @@ -63,7 +63,7 @@ Por ejemplo, si quieres mostrar tu directorio actual en el título de la pestañ ```bash function set_win_title(){ - echo -ne "\033]0; $(basename $PWD) \007" + echo -ne "\033]0; $(basename "$PWD") \007" } starship_precmd_user_func="set_win_title" ``` diff --git a/docs/es-ES/config/README.md b/docs/es-ES/config/README.md index 7b0ae2f88..9a7896e86 100644 --- a/docs/es-ES/config/README.md +++ b/docs/es-ES/config/README.md @@ -3,7 +3,7 @@ Para comenzar a configurar Starship, crea el siguiente archivo: `~/.config/starship.toml`. ```sh -mkdir -p ~/.config && touch ~/.config/starship.toml +mkdir -p ~/.config && starship print-config --default > ~/.config/starship.toml ``` Toda la configuración de Starship se realiza en este archivo [TOML](https://github.com/toml-lang/toml): @@ -173,13 +173,14 @@ La varieble `format` por defecto se utiliza para definir el formato del prompt, ```toml format = "$all" -# Which is equivalent to +# el cual es el equivalente a format = """ $username\ $hostname\ $shlvl\ $kubernetes\ $directory\ +$vcsh\ $git_branch\ $git_commit\ $git_state\ @@ -238,7 +239,7 @@ El módulo `aws` muestra la región y el perfil actual de AWS. Éste se basa en Cuando uses [aws-vault](https://github.com/99designs/aws-vault) el perfil se obtiene de la variable de entorno `AWS_VAULT`. -When using [awsu](https://github.com/kreuzwerker/awsu) the profile is read from the `AWSU_PROFILE` env var. +Cuando uses [awsu](https://github.com/kreuzwerker/awsu) el perfil se obtiene de la variable de entorno `AWSU_PROFILE`. ### Opciones @@ -248,7 +249,7 @@ When using [awsu](https://github.com/kreuzwerker/awsu) the profile is read from | `symbol` | `"☁️ "` | El símbolo que se muestra antes del perfil de AWS. | | `region_aliases` | | Tabla de alias de región para mostrar además del nombre AWS. | | `style` | `"bold yellow"` | El estilo del módulo. | -| `disabled` | `false` | Desactiva el módulo AWS. | +| `disabled` | `false` | Deshabilita el módulo `aws`. | ### Variables @@ -259,7 +260,7 @@ When using [awsu](https://github.com/kreuzwerker/awsu) the profile is read from | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | -\*: This variable can only be used as a part of a style string +\*: Esta variable sólo puede ser usada como parte de una cadena de estilo ### Ejemplos @@ -304,36 +305,35 @@ symbol = "🅰 " ## Battery -The `battery` module shows how charged the device's battery is and its current charging status. The module is only visible when the device's battery is below 10%. +El módulo `battery` muestra qué tan cargada está la batería del dispositivo y su estado de carga actual. El módulo sólo es visible cuando la batería del dispositivo está por debajo del 10%. ### Opciones | Opción | Por defecto | Descripción | | -------------------- | --------------------------------- | ------------------------------------------------------------------------ | -| `full_symbol` | `""` | Se muestra cuando la batería está cargada. | -| `charging_symbol` | `""` | Se muestra cuando la batería se está cargando. | -| `discharging_symbol` | `""` | Se muestra cuando la batería se está descargando. | -| `unknown_symbol` | `""` | El símbolo que se muestra cuando el estado de la batería es desconocido. | -| `empty_symbol` | `""` | El símbolo que se muestra cuando el estado de la batería está vacío. | +| `full_symbol` | `" "` | Se muestra cuando la batería está cargada. | +| `charging_symbol` | `" "` | Se muestra cuando la batería se está cargando. | +| `discharging_symbol` | `" "` | Se muestra cuando la batería se está descargando. | +| `unknown_symbol` | `" "` | El símbolo que se muestra cuando el estado de la batería es desconocido. | +| `empty_symbol` | `" "` | El símbolo que se muestra cuando el estado de la batería está vacío. | | `format` | `"[$symbol$percentage]($style) "` | El formato del módulo. | | `display` | [ver aquí](#battery-display) | Define cuándo mostrar el indicador y el estilo. | | `disabled` | `false` | Desactiva el módulo `battery`. | - ### Ejemplo ```toml # ~/.config/starship.toml [battery] -full_symbol = "🔋" -charging_symbol = "⚡️" -discharging_symbol = "💀" +full_symbol = "🔋 " +charging_symbol = "⚡️ " +discharging_symbol = "💀 " ``` ### Indicador de batería -The `display` configuration option is used to define when the battery indicator should be shown (threshold) and what it looks like (style). If no `display` is provided. El valor por defecto es el siguiente: +La opción de configuración de `display` se utiliza para definir cuándo se debe mostrar el indicador de batería (umbral) y cómo se ve (estilo). Si no se provee ningún valor para `display`. El valor por defecto es el siguiente: ```toml [[battery.display]] @@ -343,7 +343,7 @@ style = "bold red" #### Opciones -The `display` option is an array of the following table. +La opción `display` es un arreglo de la siguiente tabla. | Opción | Descripción | | ----------- | --------------------------------------------------------------- | @@ -367,16 +367,16 @@ style = "bold yellow" ## Character -The `character` module shows a character (usually an arrow) beside where the text is entered in your terminal. +El módulo `character` muestra un caracter (normalmente una flecha) tras el texto que introduces en el terminal. -The character will tell you whether the last command was successful or not. It can do this in two ways: +El carácter mostrará si el último comando funcionó o no. Se puede hacer de dos maneras: - Cambiando el color (`red`/`green`) - Cambiando la forma (`.`/`✖`) -By default it only changes color. If you also want to change it's shape take a look at [this example](#with-custom-error-shape). +Por defecto sólo cambia el color. Si también se quiere cambiar su forma, ver [este ejemplo](#with-custom-error-shape). -::: warning `error_symbol` is not supported on elvish shell. ::: +::: advertencia `error_symbol` no es compatible con el intérprete de comandos Elvish. ::: ### Opciones @@ -427,7 +427,7 @@ vicmd_symbol = "[V](bold green) " ## CMake -The `cmake` module shows the currently installed version of CMake. By default the module will be activated if any of the following conditions are met: +El módulo `cmake` muestra la versión instalada de CMake. Por defecto el módulo se activará si se cumplen cualquiera de las siguientes condiciones: - El directorio actual contiene un archivo `CMakeLists.txt` - El directorio actual contiene un archivo `CMakeCache.txt` @@ -452,19 +452,19 @@ The `cmake` module shows the currently installed version of CMake. By default th | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | -\*: This variable can only be used as a part of a style string +\*: Esta variable sólo puede ser usada como parte de una cadena de estilo ## Tiempo de Ejecución -The `cmd_duration` module shows how long the last command took to execute. The module will be shown only if the command took longer than two seconds, or the `min_time` config value, if it exists. +El módulo `cmd_duration` muestra cuánto tiempo tardó el último comando en ejecutarse. El módulo se mostrará solo si el comando tomó más de dos segundos, o si el valor de configuración de `min_time` existe. -::: warning Do not hook the DEBUG trap in Bash +::: advertencia No utilizar la trampa DEBUG en Bash -If you are running Starship in `bash`, do not hook the `DEBUG` trap after running `eval $(starship init $0)`, or this module **will** break. +Si estás usando Starship con `bash`, no uses `DEBUG` después de ejecutar `eval $(starship init $0)`, o el módulo **se romperá**. ::: -Bash users who need preexec-like functionality can use [rcaloras's bash_preexec framework](https://github.com/rcaloras/bash-preexec). Simply define the arrays `preexec_functions` and `precmd_functions` before running `eval $(starship init $0)`, and then proceed as normal. +Los usuarios de Bash que necesiten la funcionalidad como preexec pueden usar el [framework bash_preexec de rcaloras](https://github.com/rcaloras/bash-preexec). Basta con definir los arreglos `preexec_functions` y `precmd_functions` antes de ejecutar `eval $(starship init $0)`, y luego proceder como siempre. ### Opciones @@ -478,9 +478,9 @@ Bash users who need preexec-like functionality can use [rcaloras's bash_preexec | `show_notifications` | `false` | Muestra notificaciones de escritorio cuando se complete el comando. | | `min_time_to_notify` | `45_000` | Duración mínima para mostrar el tiempo de ejecución (en milisegundos). | -::: tip +::: consejo -Showing desktop notifications requires starship to be built with `rust-notify` support. You check if your starship supports notifications by running `STARSHIP_LOG=debug starship module cmd_duration -d 60000` when `show_notifications` is set to `true`. +Mostrar notificaciones de escritorio requiere que se construya Starship con soporte de `rust-notify`. Comprueba si tu Starship soporta notificaciones ejecutando `STARSHIP_LOG=debug starship module cmd_duration -d 60000` cuando `show_notifications` está establecido en `true`. ::: @@ -491,7 +491,7 @@ Showing desktop notifications requires starship to be built with `rust-notify` s | duration | `16m40s` | El tiempo que tardó en ejecutar el comando | | style\* | | Refleja el valor de la opción `style` | -\*: This variable can only be used as a part of a style string +\*: Esta variable sólo puede ser usada como parte de una cadena de estilo ### Ejemplo @@ -505,11 +505,11 @@ format = "underwent [$duration](bold yellow)" ## Conda -The `conda` module shows the current conda environment, if `$CONDA_DEFAULT_ENV` is set. +El módulo `conda` muestra el entorno conda actual, si `$CONDA_DEFAULT_ENV` está configurado. -::: tip +::: consejo -This does not suppress conda's own prompt modifier, you may want to run `conda config --set changeps1 False`. +Esto no modifica el propio prompt de conda. En caso de querer suprimirlo, ejecuta `conda config --set changeps1 False`. ::: @@ -532,7 +532,7 @@ This does not suppress conda's own prompt modifier, you may want to run `conda c | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | -\*: This variable can only be used as a part of a style string +\*: Esta variable sólo puede ser usada como parte de una cadena de estilo ### Ejemplo @@ -545,7 +545,7 @@ format = "[$symbol$environment](dimmed green) " ## Crystal -The `crystal` module shows the currently installed version of Crystal. Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: +El módulo `crystal` muestra la versión actualmente instalada de Crystal. Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: - El directorio actual contiene un fichero `shard.yml` - El directorio actual contiene un fichero `.cr` @@ -570,7 +570,7 @@ The `crystal` module shows the currently installed version of Crystal. Por defec | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | -\*: This variable can only be used as a part of a style string +\*: Esta variable sólo puede ser usada como parte de una cadena de estilo ### Ejemplo @@ -583,7 +583,7 @@ format = "via [✨ $version](bold blue) " ## Dart -The `dart` module shows the currently installed version of Dart. Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: +El módulo `dart` muestra la versión actualmente instalada de Dart. Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: - El directorio actual contiene un archivo con la extensión `.dart` - El directorio actual contiene un directorio `.dart_tool` @@ -609,7 +609,7 @@ The `dart` module shows the currently installed version of Dart. Por defecto, el | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | -\*: This variable can only be used as a part of a style string +\*: Esta variable sólo puede ser usada como parte de una cadena de estilo ### Ejemplo @@ -622,11 +622,11 @@ format = "via [🔰 $version](bold red) " ## Directory -The `directory` module shows the path to your current directory, truncated to three parent folders. Your directory will also be truncated to the root of the git repo that you're currently in. +El módulo `directory` muestra la ruta a tu directorio actual, truncado a tres carpetas padres. Tu directorio se truncará a la raíz del repositorio git en el que te encuentres. -When using the fish style pwd 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. +Cuando usas el estilo fish de la opción pwd, en lugar de ocultar la ruta truncada, verás una versión acortada del nombre de cada directorio basada en el número que activaste para la opción. -For example, given `~/Dev/Nix/nixpkgs/pkgs` where `nixpkgs` is the repo root, and the option set to `1`. You will now see `~/D/N/nixpkgs/pkgs`, whereas before it would have been `nixpkgs/pkgs`. +Por ejemplo, dado `~/Dev/Nix/nixpkgs/pkgs` donde `nixpkgs` es la raíz del repositorio y la opción establecida a `1`. Ahora verás `~/D/N/nixpkgs/pkgs`, mientras que antes habría sido `nixpkgs/pkgs`. ### Opciones @@ -643,7 +643,7 @@ For example, given `~/Dev/Nix/nixpkgs/pkgs` where `nixpkgs` is the repo root, an | `home_symbol` | `"~"` | El símbolo que indica el directorio personal. |
-This module has a few advanced configuration options that control how the directory is displayed. +Este módulo tiene algunas opciones avanzadas de configuración que controlan cómo se muestra el directorio. | Opciones avanzadas | Por defecto | Descripción | | --------------------------- | ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | @@ -651,7 +651,7 @@ For example, given `~/Dev/Nix/nixpkgs/pkgs` where `nixpkgs` is the repo root, an | `fish_style_pwd_dir_length` | `0` | El número de caracteres a usar al aplicar la lógica de ruta pwd del intérprete de comandos de Fish. | | `use_logical_path` | `true` | Si `true` renderiza la ruta lógica originada desde el intérprete de comandos a través de `PWD` o `--logical-path`. Si `false` en su lugar renderiza la ruta física del sistema de archivos con enlaces simbólicos resueltos. | -`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. +`substitutions` permite definir reemplazos arbitrarios para cadenas literales que ocurren en la ruta, por ejemplo prefijos largos de red o directorios de desarrollo (p. ej. Java). Ten en cuenta que esto desactivará el estilo PWD de fish. ```toml [directory.substitutions] @@ -659,7 +659,7 @@ For example, given `~/Dev/Nix/nixpkgs/pkgs` where `nixpkgs` is the repo root, an "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 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`. +`fish_style_pwd_dir_length` interactúa con las opciones de truncamiento estándar de una manera que puede sorprenderse primero: si no es cero, los componentes de la ruta que normalmente se truncarían se muestran con esa cantidad de caracteres. Por ejemplo, la ruta `/built/this/city/on/rock/and/roll`, que normalmente se mostraría como `rock/and/roll`, se mostraría como `/b/t/c/o/rock/and/roll` con `fish_style_pwd_dir_length = 1`--los componentes de ruta que normalmente se eliminarían se muestran con un solo carácter. Para `fish_style_pwd_dir_length = 2`, sería `/bu/th/ci/on/rock/and/roll`.
@@ -670,7 +670,7 @@ For example, given `~/Dev/Nix/nixpkgs/pkgs` where `nixpkgs` is the repo root, an | path | `"D:/Projects"` | La ruta de directorio actual | | style\* | `"black bold dimmed"` | Refleja el valor de la opción `style` | -\*: This variable can only be used as a part of a style string +\*: Esta variable sólo puede ser usada como parte de una cadena de estilo ### Ejemplo @@ -684,7 +684,7 @@ 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`. +El módulo `docker_context` muestra el [contexto de Docker](https://docs.docker.com/engine/context/working-with-contexts/) actualmente activo si no está establecido en `por defecto`. ### Opciones @@ -707,7 +707,7 @@ The `docker_context` module shows the currently active [Docker context](https:// | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | -\*: This variable can only be used as a part of a style string +\*: Esta variable sólo puede ser usada como parte de una cadena de estilo ### Ejemplo @@ -720,9 +720,9 @@ format = "via [🐋 $context](blue bold)" ## Dotnet -The `dotnet` module shows the relevant version of the .NET Core SDK for the current directory. If the SDK has been pinned in the current directory, the pinned version is shown. Otherwise the module shows the latest installed version of the SDK. +El módulo `dotnet` muestra la versión relevante de .NET Core SDK para el directorio actual. Si el SDK ha sido anclado en el directorio actual, se mostrará la versión fijada. De lo contrario, el módulo muestra la última versión instalada del SDK. -By default this module will only be shown in your prompt when one or more of the following files are present in the current directory: +Por defecto, este módulo solo se mostrará en tu prompt cuando uno o más de de los siguientes archivos estén presentes en el directorio actual: - `global.json` - `project.json` @@ -734,18 +734,18 @@ By default this module will only be shown in your prompt when one or more of the - `*.fsproj` - `*.xproj` -You'll also need the .NET Core SDK installed in order to use it correctly. +También necesitarás tener instalado .NET Core SDK para poder usarlo correctamente. -Internally, this module uses its own mechanism for version detection. Typically it is twice as fast as running `dotnet --version`, but it may show an incorrect version if your .NET project has an unusual directory layout. If accuracy is more important than speed, you can disable the mechanism by setting `heuristic = false` in the module options. +Internamente, este módulo utiliza su propio mecanismo para la detección de versiones. Normalmente es el doble de rápido que ejecutar `dotnet --version`, pero puede mostrar una versión incorrecta si tu proyecto .NET tiene un diseño de directorio inusual. Si la precisión es más importante que la velocidad, puede desactivar el mecanismo estableciendo `heuristic = false` en las opciones del módulo. -The module will also show the Target Framework Moniker () when there is a csproj file in the current directory. +El módulo también mostrará el Target Framework Moniker ([https://docs.microsoft. om/es/dotnet/standard/frameworks#supported-target-framework-versions](https://docs.microsoft.com/en-us/dotnet/standard/frameworks#supported-target-framework-versions)) cuando exista un archivo csproj en el directorio actual. ### Opciones | Opción | Por defecto | Descripción | | ------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- | | `format` | `"[$symbol($version )(🎯 $tfm )]($style)"` | El formato del módulo. | -| `symbol` | `"•NET "` | Símbolo usado antes de mostrar la versión de .NET | +| `symbol` | `".NET "` | Símbolo usado antes de mostrar la versión de .NET | | `heuristic` | `true` | Usa una detección de versiones más rápida para mantener a starship veloz. | | `detect_extensions` | `["sln", "csproj", "fsproj", "xproj"]` | Qué extensiones deberían activar este módulo. | | `detect_files` | `["global.json", "project.json", "Directory.Build.props", "Directory.Build.targets", "Packages.props"]` | Qué nombres de archivo deberían activar este módulo. | @@ -762,7 +762,7 @@ The module will also show the Target Framework Moniker ("` | The description of the module that is shown when running `starship explain`. | -| `files` | `[]` | The files that will be searched in the working directory for a match. | -| `directories` | `[]` | The directories that will be searched in the working directory for a match. | -| `extensions` | `[]` | The extensions that will be searched in the working directory for a match. | +| `comando` | | The command whose output should be printed. The command will be passed on stdin to the shell. | +| `cuando` | | A shell command used as a condition to show the module. The module will be shown if the command returns a `0` status code. | +| `shell` | | [Ver abajo](#custom-command-shell) | +| `descripción` | `""` | The description of the module that is shown when running `starship explain`. | +| `archivos` | `[]` | The files that will be searched in the working directory for a match. | +| `directorios` | `[]` | The directories that will be searched in the working directory for a match. | +| `extensiones` | `[]` | 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"` | El estilo del módulo. | | `format` | `"[$symbol($output )]($style)"` | El formato del módulo. | -| `disabled` | `false` | Disables this `custom` module. | +| `disabled` | `false` | Deshabilita este `módulo` personalizado. | ### Variables | Variable | Descripción | | --------- | -------------------------------------- | -| output | The output of shell command in `shell` | +| salida | The output of shell command in `shell` | | symbol | Refleja el valor de la opción `symbol` | | style\* | Refleja el valor de la opción `style` | -\*: This variable can only be used as a part of a style string +\*: Esta variable sólo puede ser usada como parte de una cadena de estilo #### Comando personalizado del intérprete de comandos `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. +- La primera cadena es la ruta al intérprete de comandos a usar para ejecutar el comando. +- Otros argumentos siguientes que son pasados al shell. If unset, it will fallback to STARSHIP_SHELL and then to "sh" on Linux, and "cmd /C" on Windows. @@ -2725,7 +2758,7 @@ Automatic detection of shells and proper parameters addition are currently imple # ~/.config/starship.toml [custom.foo] -command = "echo foo" # shows output of command +command = "echo foo" # mostrar resultado de command files = ["foo"] # can specify filters when = """ test "$HOME" == "$PWD" """ format = " transcending [$output]($style)" diff --git a/docs/es-ES/faq/README.md b/docs/es-ES/faq/README.md index 265803741..7d62b40b9 100644 --- a/docs/es-ES/faq/README.md +++ b/docs/es-ES/faq/README.md @@ -38,7 +38,7 @@ NUM_JOBS=$(jobs -p | wc -l) PS1="$(starship prompt --status=$STATUS --jobs=$NUM_JOBS)" ``` -The [Bash implementation](https://github.com/starship/starship/blob/master/src/init/starship.bash) built into Starship is slightly more complex to allow for advanced features like the [Command Duration module](https://starship.rs/config/#command-duration) and to ensure that Starship is compatible with pre-installed Bash configurations. +La [implementación de Bash](https://github.com/starship/starship/blob/master/src/init/starship.bash) integrada en Starship es un poco más compleja para permitir funciones avanzadas como el [módulo Duración del Comando](https://starship.rs/config/#command-duration) y para garantizar que Starship sea compatible con las configuraciones de Bash preinstaladas. Para obtener una lista de todos los parámetros aceptados por `el prompt de Starship`, usa el siguiente comando: @@ -91,6 +91,6 @@ Si Starship fue instalado usando un gestor de paquetes, por favor refiérete a s Si Starship fue instalado usando el script `curl | bash`, el siguiente comando eliminará el binario: ```sh -# Localiza y elimina el binario de starship -rm "$(which starship)" +# Locate and delete the starship binary +bash -c 'rm "$(which starship)"' ``` diff --git a/docs/es-ES/guide/README.md b/docs/es-ES/guide/README.md index 7b6a46e97..ba2accbf6 100644 --- a/docs/es-ES/guide/README.md +++ b/docs/es-ES/guide/README.md @@ -90,7 +90,7 @@ alt="简体中文" />   - Español   - Francés   - ~/.config/starship.toml ``` Toute la configuration de starship est faite dans ce fichier [TOML](https://github.com/toml-lang/toml): @@ -180,6 +180,7 @@ $hostname\ $shlvl\ $kubernetes\ $directory\ +$vcsh\ $git_branch\ $git_commit\ $git_state\ @@ -248,7 +249,7 @@ When using [awsu](https://github.com/kreuzwerker/awsu) the profile is read from | `symbol` | `"☁️ "` | Le symbole affiché avant le profil AWS actuel. | | `region_aliases` | | Table des alias de région à afficher en plus du nom AWS. | | `style` | `"bold yellow"` | Le style du module. | -| `disabled` | `false` | Désactive le module `AWS`. | +| `disabled` | `false` | Disables the `aws` module. | ### Variables @@ -310,25 +311,24 @@ The `battery` module shows how charged the device's battery is and its current c | Option | Default | Description | | -------------------- | --------------------------------- | ------------------------------------------------------------- | -| `full_symbol` | `""` | Le symbole affiché lorsque la batterie est pleine. | -| `charging_symbol` | `""` | Le symbole affiché lorsque la batterie se charge. | -| `discharging_symbol` | `""` | Le symbole affiché lorsque la batterie se décharge. | -| `unknown_symbol` | `""` | Le symbole affiché lorsque l'état de la batterie est inconnu. | -| `empty_symbol` | `""` | Le symbole affiché lorsque la batterie est vide. | +| `full_symbol` | `" "` | Le symbole affiché lorsque la batterie est pleine. | +| `charging_symbol` | `" "` | Le symbole affiché lorsque la batterie se charge. | +| `discharging_symbol` | `" "` | Le symbole affiché lorsque la batterie se décharge. | +| `unknown_symbol` | `" "` | Le symbole affiché lorsque l'état de la batterie est inconnu. | +| `empty_symbol` | `" "` | Le symbole affiché lorsque la batterie est vide. | | `format` | `"[$symbol$percentage]($style) "` | Format du module. | | `display` | [lien](#battery-display) | Affiche le seuil et le style du module. | | `disabled` | `false` | Désactive le module `battery`. | - ### Exemple ```toml # ~/.config/starship.toml [battery] -full_symbol = "🔋" -charging_symbol = "⚡️" -discharging_symbol = "💀" +full_symbol = "🔋 " +charging_symbol = "⚡️ " +discharging_symbol = "💀 " ``` ### Indicateur de batterie @@ -438,7 +438,7 @@ The `cmake` module shows the currently installed version of CMake. By default th | ------------------- | -------------------------------------- | --------------------------------------------- | | `format` | `"via [$symbol($version )]($style)"` | Format du module. | | `symbol` | `"△ "` | Le symbole utilisé avant la version de cmake. | -| `detect_extensions` | `[]` | Which extensions should trigger this moudle | +| `detect_extensions` | `[]` | Which extensions should trigger this module | | `detect_files` | `["CMakeLists.txt", "CMakeCache.txt"]` | Which filenames should trigger this module | | `detect_folders` | `[]` | Which folders should trigger this module | | `style` | `"bold blue"` | Le style du module. | @@ -595,7 +595,7 @@ The `dart` module shows the currently installed version of Dart. By default the | ------------------- | ------------------------------------------------- | -------------------------------------------------------- | | `format` | `"via [$symbol($version )]($style)"` | Format du module. | | `symbol` | `"🎯 "` | Une chaîne de caractères représentant le symbole de Dart | -| `detect_extensions` | `['dart']` | Which extensions should trigger this moudle. | +| `detect_extensions` | `['dart']` | Which extensions should trigger this module. | | `detect_files` | `["pubspec.yaml", "pubspec.yml", "pubspec.lock"]` | Which filenames should trigger this module. | | `detect_folders` | `[".dart_tool"]` | Which folders should trigger this module. | | `style` | `"bold blue"` | Le style du module. | @@ -745,7 +745,7 @@ The module will also show the Target Framework Moniker ( "` | Le symbole utilisé avant d'afficher la version de PureScript. | -| `detect_extensions` | `["purs"]` | Which extensions should trigger this moudle. | +| `detect_extensions` | `["purs"]` | Which extensions should trigger this module. | | `detect_files` | `["spago.dhall"]` | Which filenames should trigger this module. | | `detect_folders` | `[]` | Which folders should trigger this module. | | `style` | `"bold white"` | Le style du module. | @@ -2034,13 +2038,13 @@ By default the module will be shown if any of the following conditions are met: | Option | Défaut | Description | | -------------------- | ------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------- | -| `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\))]($style)'` | Format du module. | +| `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\) )]($style)'` | Format du module. | | `symbol` | `"🐍 "` | A format string representing the symbol of Python | | `style` | `"yellow bold"` | Le style du 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"]` | Which extensions should trigger this moudle | +| `detect_extensions` | `[".py"]` | Which extensions should trigger this module | | `detect_files` | `[".python-version", "Pipfile", "__init__.py", "pyproject.toml", "requirements.txt", "setup.py", "tox.ini"]` | Which filenames should trigger this module | | `detect_folders` | `[]` | Which folders should trigger this module | | `disabled` | `false` | Disables the `python` module. | @@ -2063,7 +2067,6 @@ The default values and order for `python_binary` was chosen to first identify th | pyenv_prefix | `"pyenv "` | Mirrors the value of option `pyenv_prefix` | | virtualenv | `"venv"` | The current `virtualenv` name | - ### Exemple ```toml @@ -2167,7 +2170,6 @@ By default the `rust` module shows the currently installed version of Rust. The format = "via [⚙️ $version](red bold)" ``` - ## Scala The `scala` module shows the currently installed version of Scala. By default the module will be shown if any of the following conditions are met: @@ -2178,7 +2180,6 @@ The `scala` module shows the currently installed version of Scala. By default th ### Options - | Option | Défaut | Description | | ------------------- | ---------------------------------------- | ------------------------------------------------- | | `format` | `"via [${symbol}(${version} )]($style)"` | Format du module. | @@ -2208,7 +2209,6 @@ The `scala` module shows the currently installed version of Scala. By default th symbol = "🌟 " ``` - ## Shell The `shell` module shows an indicator for currently used shell. @@ -2240,6 +2240,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y | indicator | | Mirrors the value of `indicator` for currently used shell. | ### Exemples + ```toml # ~/.config/starship.toml @@ -2251,24 +2252,24 @@ disabled = false ## SHLVL -The `shlvl` module shows the current SHLVL ("shell level") environment variable, if it is set to a number and meets or exceeds the specified threshold. +The `shlvl` module shows the current `SHLVL` ("shell level") environment variable, if it is set to a number and meets or exceeds the specified threshold. ### Options -| Option | Défaut | Description | -| ----------- | ---------------------------- | ----------------------------------------------------------- | -| `threshold` | `2` | Display threshold. | -| `format` | `"[$symbol$shlvl]($style) "` | Format du module. | -| `symbol` | `"↕️ "` | The symbol used to represent the SHLVL. | -| `repeat` | `false` | Causes `symbol` to be repeated by the current SHLVL amount. | -| `style` | `"bold yellow"` | Le style du module. | -| `disabled` | `true` | Disables the `shlvl` module. | +| Option | Défaut | Description | +| ----------- | ---------------------------- | ------------------------------------------------------------- | +| `threshold` | `2` | Display threshold. | +| `format` | `"[$symbol$shlvl]($style) "` | Format du module. | +| `symbol` | `"↕️ "` | The symbol used to represent the `SHLVL`. | +| `repeat` | `false` | Causes `symbol` to be repeated by the current `SHLVL` amount. | +| `style` | `"bold yellow"` | Le style du module. | +| `disabled` | `true` | Disables the `shlvl` module. | ### Variables | Variable | Exemple | Description | | --------- | ------- | -------------------------------------- | -| shlvl | `3` | The current value of SHLVL | +| shlvl | `3` | The current value of `SHLVL` | | symbol | | Reflète la valeur de l'option `symbol` | | style\* | | Reflète la valeur de l'option `style` | @@ -2387,7 +2388,7 @@ By default the `swift` module shows the currently installed version of Swift. Th | ------------------- | ------------------------------------ | ------------------------------------------------ | | `format` | `"via [$symbol($version )]($style)"` | Format du module. | | `symbol` | `"🐦 "` | A format string representing the symbol of Swift | -| `detect_extensions` | `["swift"]` | Which extensions should trigger this moudle. | +| `detect_extensions` | `["swift"]` | Which extensions should trigger this module. | | `detect_files` | `["Package.swift"]` | Which filenames should trigger this module. | | `detect_folders` | `[]` | Which folders should trigger this module. | | `style` | `"bold 202"` | Le style du module. | @@ -2577,7 +2578,7 @@ The `vagrant` module shows the currently installed version of Vagrant. By defaul | `detect_files` | `["Vagrantfile"]` | Which filenames should trigger this module. | | `detect_folders` | `[]` | Which folders should trigger this module. | | `style` | `"cyan bold"` | Le style du module. | -| `disabled` | `false` | Disables the `Vagrant` module. | +| `disabled` | `false` | Disables the `vagrant` module. | ### Variables @@ -2598,6 +2599,38 @@ The `vagrant` module shows the currently installed version of Vagrant. By defaul format = "via [⍱ $version](bold white) " ``` +## VCSH + +The `vcsh` module displays the current active VCSH repository. The module will be shown only if a repository is currently in use. + +### Options + +| Option | Défaut | Description | +| ---------- | -------------------------------- | ------------------------------------------------------ | +| `symbol` | | The symbol used before displaying the repository name. | +| `style` | `"bold yellow"` | Le style du module. | +| `format` | `"vcsh [$symbol$repo]($style) "` | Format du module. | +| `disabled` | `false` | Disables the `vcsh` module. | + +### Variables + +| Variable | Exemple | Description | +| --------- | ------------------------------------------- | -------------------------------------- | +| repo | `dotfiles` if in a VCSH repo named dotfiles | The active repository name | +| symbol | | Reflète la valeur de l'option `symbol` | +| style\* | `black bold dimmed` | Reflète la valeur de l'option `style` | + +\*: This variable can only be used as a part of a style string + +### Exemple + +```toml +# ~/.config/starship.toml + +[vcsh] +format = "[🆅 $repo](bold blue) " +``` + ## Zig By default the the `zig` module shows the currently installed version of Zig. The module will be shown if any of the following conditions are met: diff --git a/docs/fr-FR/faq/README.md b/docs/fr-FR/faq/README.md index 0af05fc9a..987f60549 100644 --- a/docs/fr-FR/faq/README.md +++ b/docs/fr-FR/faq/README.md @@ -91,6 +91,6 @@ If Starship was installed using a package manager, please refer to their docs fo If Starship was installed using the `curl | bash` script, the following command will delete the binary: ```sh -# Localiser et supprimer l'exécutable de Starship -rm "$(which starship)" +# Locate and delete the starship binary +bash -c 'rm "$(which starship)"' ``` diff --git a/docs/fr-FR/guide/README.md b/docs/fr-FR/guide/README.md index 8f88fc960..6dfac7983 100644 --- a/docs/fr-FR/guide/README.md +++ b/docs/fr-FR/guide/README.md @@ -90,7 +90,7 @@ alt="简体中文" />   - Espagnol   - Français   - bash ``` + To update the Starship itself, rerun the above script. It will replace the current version without touching Starship's configuration. #### Installa con Package Manager - Con [Homebrew](https://brew.sh/): + With [Homebrew](https://brew.sh/): ```sh brew install starship @@ -133,4 +134,3 @@ description: Starship è il prompt minimalista, super veloce ed estremamente per eval `starship init tcsh` ``` - diff --git a/docs/it-IT/advanced-config/README.md b/docs/it-IT/advanced-config/README.md index 9e7cfae07..b0e852101 100644 --- a/docs/it-IT/advanced-config/README.md +++ b/docs/it-IT/advanced-config/README.md @@ -63,7 +63,7 @@ Ad esempio, se desideri visualizzare la directory corrente nel titolo della sche ```bash function set_win_title(){ - echo -ne "\033]0; $(basename $PWD) \007" + echo -ne "\033]0; $(basename "$PWD") \007" } starship_precmd_user_func="set_win_title" ``` diff --git a/docs/it-IT/config/README.md b/docs/it-IT/config/README.md index 1465eed39..7b634cecf 100644 --- a/docs/it-IT/config/README.md +++ b/docs/it-IT/config/README.md @@ -3,7 +3,7 @@ To get started configuring starship, create the following file: `~/.config/starship.toml`. ```sh -mkdir -p ~/.config && touch ~/.config/starship.toml +mkdir -p ~/.config && starship print-config --default > ~/.config/starship.toml ``` All configuration for starship is done in this [TOML](https://github.com/toml-lang/toml) file: @@ -180,6 +180,7 @@ $hostname\ $shlvl\ $kubernetes\ $directory\ +$vcsh\ $git_branch\ $git_commit\ $git_state\ @@ -248,7 +249,7 @@ When using [awsu](https://github.com/kreuzwerker/awsu) the profile is read from | `symbol` | `"☁️ "` | The symbol used before displaying the current AWS profile. | | `region_aliases` | | Table of region aliases to display in addition to the AWS name. | | `style` | `"bold yellow"` | The style for the module. | -| `disabled` | `false` | Disables the `AWS` module. | +| `disabled` | `false` | Disables the `aws` module. | ### Variables @@ -310,25 +311,24 @@ The `battery` module shows how charged the device's battery is and its current c | Option | Default | Description | | -------------------- | --------------------------------- | --------------------------------------------------- | -| `full_symbol` | `""` | The symbol shown when the battery is full. | -| `charging_symbol` | `""` | The symbol shown when the battery is charging. | -| `discharging_symbol` | `""` | The symbol shown when the battery is discharging. | -| `unknown_symbol` | `""` | The symbol shown when the battery state is unknown. | -| `empty_symbol` | `""` | The symbol shown when the battery state is empty. | +| `full_symbol` | `" "` | The symbol shown when the battery is full. | +| `charging_symbol` | `" "` | The symbol shown when the battery is charging. | +| `discharging_symbol` | `" "` | The symbol shown when the battery is discharging. | +| `unknown_symbol` | `" "` | The symbol shown when the battery state is unknown. | +| `empty_symbol` | `" "` | The symbol shown when the battery state is empty. | | `format` | `"[$symbol$percentage]($style) "` | The format for the module. | | `display` | [link](#battery-display) | Display threshold and style for the module. | | `disabled` | `false` | Disables the `battery` module. | - ### Example ```toml # ~/.config/starship.toml [battery] -full_symbol = "🔋" -charging_symbol = "⚡️" -discharging_symbol = "💀" +full_symbol = "🔋 " +charging_symbol = "⚡️ " +discharging_symbol = "💀 " ``` ### Battery Display @@ -438,7 +438,7 @@ The `cmake` module shows the currently installed version of CMake. By default th | ------------------- | -------------------------------------- | -------------------------------------------- | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `symbol` | `"△ "` | The symbol used before the version of cmake. | -| `detect_extensions` | `[]` | Which extensions should trigger this moudle | +| `detect_extensions` | `[]` | Which extensions should trigger this module | | `detect_files` | `["CMakeLists.txt", "CMakeCache.txt"]` | Which filenames should trigger this module | | `detect_folders` | `[]` | Which folders should trigger this module | | `style` | `"bold blue"` | The style for the module. | @@ -595,7 +595,7 @@ The `dart` module shows the currently installed version of Dart. By default the | ------------------- | ------------------------------------------------- | ----------------------------------------------- | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `symbol` | `"🎯 "` | A format string representing the symbol of Dart | -| `detect_extensions` | `['dart']` | Which extensions should trigger this moudle. | +| `detect_extensions` | `['dart']` | Which extensions should trigger this module. | | `detect_files` | `["pubspec.yaml", "pubspec.yml", "pubspec.lock"]` | Which filenames should trigger this module. | | `detect_folders` | `[".dart_tool"]` | Which folders should trigger this module. | | `style` | `"bold blue"` | The style for the module. | @@ -745,7 +745,7 @@ The module will also show the Target Framework Moniker ( "` | The symbol used before displaying the version of PureScript. | -| `detect_extensions` | `["purs"]` | Which extensions should trigger this moudle. | +| `detect_extensions` | `["purs"]` | Which extensions should trigger this module. | | `detect_files` | `["spago.dhall"]` | Which filenames should trigger this module. | | `detect_folders` | `[]` | Which folders should trigger this module. | | `style` | `"bold white"` | The style for the module. | @@ -2034,13 +2038,13 @@ By default the module will be shown if any of the following conditions are met: | Option | Default | Description | | -------------------- | ------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------- | -| `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\))]($style)'` | The format for the module. | +| `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\) )]($style)'` | The format for the module. | | `symbol` | `"🐍 "` | A format string representing the symbol of Python | | `style` | `"yellow bold"` | The style for the 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"]` | Which extensions should trigger this moudle | +| `detect_extensions` | `[".py"]` | Which extensions should trigger this module | | `detect_files` | `[".python-version", "Pipfile", "__init__.py", "pyproject.toml", "requirements.txt", "setup.py", "tox.ini"]` | Which filenames should trigger this module | | `detect_folders` | `[]` | Which folders should trigger this module | | `disabled` | `false` | Disables the `python` module. | @@ -2063,7 +2067,6 @@ The default values and order for `python_binary` was chosen to first identify th | pyenv_prefix | `"pyenv "` | Mirrors the value of option `pyenv_prefix` | | virtualenv | `"venv"` | The current `virtualenv` name | - ### Example ```toml @@ -2167,7 +2170,6 @@ By default the `rust` module shows the currently installed version of Rust. The format = "via [⚙️ $version](red bold)" ``` - ## Scala The `scala` module shows the currently installed version of Scala. By default the module will be shown if any of the following conditions are met: @@ -2178,7 +2180,6 @@ The `scala` module shows the currently installed version of Scala. By default th ### Options - | Option | Default | Description | | ------------------- | ---------------------------------------- | ------------------------------------------------- | | `format` | `"via [${symbol}(${version} )]($style)"` | The format for the module. | @@ -2208,7 +2209,6 @@ The `scala` module shows the currently installed version of Scala. By default th symbol = "🌟 " ``` - ## Shell The `shell` module shows an indicator for currently used shell. @@ -2240,6 +2240,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y | indicator | | Mirrors the value of `indicator` for currently used shell. | ### Examples + ```toml # ~/.config/starship.toml @@ -2251,24 +2252,24 @@ disabled = false ## SHLVL -The `shlvl` module shows the current SHLVL ("shell level") environment variable, if it is set to a number and meets or exceeds the specified threshold. +The `shlvl` module shows the current `SHLVL` ("shell level") environment variable, if it is set to a number and meets or exceeds the specified threshold. ### Options -| Option | Default | Description | -| ----------- | ---------------------------- | ----------------------------------------------------------- | -| `threshold` | `2` | Display threshold. | -| `format` | `"[$symbol$shlvl]($style) "` | The format for the module. | -| `symbol` | `"↕️ "` | The symbol used to represent the SHLVL. | -| `repeat` | `false` | Causes `symbol` to be repeated by the current SHLVL amount. | -| `style` | `"bold yellow"` | The style for the module. | -| `disabled` | `true` | Disables the `shlvl` module. | +| Option | Default | Description | +| ----------- | ---------------------------- | ------------------------------------------------------------- | +| `threshold` | `2` | Display threshold. | +| `format` | `"[$symbol$shlvl]($style) "` | The format for the module. | +| `symbol` | `"↕️ "` | The symbol used to represent the `SHLVL`. | +| `repeat` | `false` | Causes `symbol` to be repeated by the current `SHLVL` amount. | +| `style` | `"bold yellow"` | The style for the module. | +| `disabled` | `true` | Disables the `shlvl` module. | ### Variables | Variable | Example | Description | | --------- | ------- | ------------------------------------ | -| shlvl | `3` | The current value of SHLVL | +| shlvl | `3` | The current value of `SHLVL` | | symbol | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | @@ -2387,7 +2388,7 @@ By default the `swift` module shows the currently installed version of Swift. Th | ------------------- | ------------------------------------ | ------------------------------------------------ | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `symbol` | `"🐦 "` | A format string representing the symbol of Swift | -| `detect_extensions` | `["swift"]` | Which extensions should trigger this moudle. | +| `detect_extensions` | `["swift"]` | Which extensions should trigger this module. | | `detect_files` | `["Package.swift"]` | Which filenames should trigger this module. | | `detect_folders` | `[]` | Which folders should trigger this module. | | `style` | `"bold 202"` | The style for the module. | @@ -2577,7 +2578,7 @@ The `vagrant` module shows the currently installed version of Vagrant. By defaul | `detect_files` | `["Vagrantfile"]` | Which filenames should trigger this module. | | `detect_folders` | `[]` | Which folders should trigger this module. | | `style` | `"cyan bold"` | The style for the module. | -| `disabled` | `false` | Disables the `Vagrant` module. | +| `disabled` | `false` | Disables the `vagrant` module. | ### Variables @@ -2598,6 +2599,38 @@ The `vagrant` module shows the currently installed version of Vagrant. By defaul format = "via [⍱ $version](bold white) " ``` +## VCSH + +The `vcsh` module displays the current active VCSH repository. The module will be shown only if a repository is currently in use. + +### Options + +| Option | Default | Description | +| ---------- | -------------------------------- | ------------------------------------------------------ | +| `symbol` | | The symbol used before displaying the repository name. | +| `style` | `"bold yellow"` | The style for the module. | +| `format` | `"vcsh [$symbol$repo]($style) "` | The format for the module. | +| `disabled` | `false` | Disables the `vcsh` module. | + +### Variables + +| Variable | Example | Description | +| --------- | ------------------------------------------- | ------------------------------------ | +| repo | `dotfiles` if in a VCSH repo named dotfiles | The active repository name | +| symbol | | Mirrors the value of option `symbol` | +| style\* | `black bold dimmed` | Mirrors the value of option `style` | + +\*: This variable can only be used as a part of a style string + +### Example + +```toml +# ~/.config/starship.toml + +[vcsh] +format = "[🆅 $repo](bold blue) " +``` + ## Zig By default the the `zig` module shows the currently installed version of Zig. The module will be shown if any of the following conditions are met: diff --git a/docs/it-IT/faq/README.md b/docs/it-IT/faq/README.md index be42b27fb..76e76041b 100644 --- a/docs/it-IT/faq/README.md +++ b/docs/it-IT/faq/README.md @@ -91,6 +91,6 @@ If Starship was installed using a package manager, please refer to their docs fo If Starship was installed using the `curl | bash` script, the following command will delete the binary: ```sh -# Individua ed elimina il binario di Starship -rm "$(che starship)" +# Locate and delete the starship binary +bash -c 'rm "$(which starship)"' ``` diff --git a/docs/it-IT/guide/README.md b/docs/it-IT/guide/README.md index d193fb8ee..b38b0d389 100644 --- a/docs/it-IT/guide/README.md +++ b/docs/it-IT/guide/README.md @@ -90,7 +90,7 @@ alt="简体中文" />   - Spagnolo   - Francese   - ` は色を指定します（以下で述べます）。 `fg:` と `` は現在同様の動作ですが、将来変更される可能性があります。 文字列中の単語の順序は関係ありません。 -`none` トークンは、文字列中の`bg:` 指定子の一部でない場合、他のすべてのトークンをオーバーライドします。そのため、たとえば、`fg:red none fg:blue` と指定した場合、スタイルなしの文字列が作られます。 `bg:none` sets the background to the default color so `fg:red bg:none` is equivalent to `red` or `fg:red` and `bg:green fg:red bg:none` is also equivalent to `fg:red` or `red`. 将来 `none` を他の単語と一緒に使用することはエラーになるかもしれません。 +`none` トークンは、文字列中の`bg:` 指定子の一部でない場合、他のすべてのトークンをオーバーライドします。そのため、たとえば、`fg:red none fg:blue` と指定した場合、スタイルなしの文字列が作られます。 `bg:none` は背景色をデフォルトの色にセットするので、`fg:red bg:none` は `red` や `fg:red` と同じ意味になり、`bg:green fg:red bg:none` も `fg:red` や `red` と同じ意味になります。 将来 `none` を他の単語と一緒に使用することはエラーになるかもしれません。 色は以下のいずれか1つを指定できます。 diff --git a/docs/ja-JP/config/README.md b/docs/ja-JP/config/README.md index 49a86127d..9df3331ca 100644 --- a/docs/ja-JP/config/README.md +++ b/docs/ja-JP/config/README.md @@ -3,7 +3,7 @@ Starshipの設定を開始するには、`~/.config/starship.toml` ファイルを作成します。 ```sh -mkdir -p ~/.config && touch ~/.config/starship.toml +mkdir -p ~/.config && starship print-config --default > ~/.config/starship.toml ``` Starshipのすべての設定は、この[TOML](https://github.com/toml-lang/toml)ファイルで行われます。 @@ -181,6 +181,7 @@ $hostname\ $shlvl\ $kubernetes\ $directory\ +$vcsh\ $git_branch\ $git_commit\ $git_state\ @@ -249,7 +250,7 @@ When using [awsu](https://github.com/kreuzwerker/awsu) the profile is read from | `symbol` | `"☁️ "` | 現在のAWSプロファイルを表示する前に表示される記号です。 | | `region_aliases` | | AWS名に加えて表示するリージョンのエイリアスです。 | | `style` | `"bold yellow"` | モジュールのスタイルです。 | -| `disabled` | `false` | `aws`モジュールを無効にします。 | +| `disabled` | `false` | Disables the `aws` module. | ### 変数 @@ -311,25 +312,24 @@ The `battery` module shows how charged the device's battery is and its current c | オプション | デフォルト | 説明 | | -------------------- | --------------------------------- | ------------------------- | -| `full_symbol` | `""` | バッテリーが満タンのときに表示される記号です。 | -| `charging_symbol` | `""` | バッテリーの充電中に表示される記号です。 | -| `discharging_symbol` | `""` | バッテリーが放電しているときに表示される記号です。 | -| `unknown_symbol` | `""` | バッテリー状態が不明なときに表示される記号です。 | -| `empty_symbol` | `""` | バッテリーが空のときに表示される記号です。 | +| `full_symbol` | `" "` | バッテリーが満タンのときに表示される記号です。 | +| `charging_symbol` | `" "` | バッテリーの充電中に表示される記号です。 | +| `discharging_symbol` | `" "` | バッテリーが放電しているときに表示される記号です。 | +| `unknown_symbol` | `" "` | バッテリー状態が不明なときに表示される記号です。 | +| `empty_symbol` | `" "` | バッテリーが空のときに表示される記号です。 | | `format` | `"[$symbol$percentage]($style) "` | moduleのフォーマットです。 | | `display` | [link](#battery-display) | モジュールの閾値とスタイルを表示します。 | | `disabled` | `false` | `battery`モジュールを無効にします。 | - ### 設定例 ```toml # ~/.config/starship.toml [battery] -full_symbol = "🔋" -charging_symbol = "⚡️" -discharging_symbol = "💀" +full_symbol = "🔋 " +charging_symbol = "⚡️ " +discharging_symbol = "💀 " ``` ### バッテリーの表示 @@ -439,7 +439,7 @@ The `cmake` module shows the currently installed version of CMake. By default th | ------------------- | -------------------------------------- | -------------------------------------------- | | `format` | `"via [$symbol($version )]($style)"` | moduleのフォーマットです。 | | `symbol` | `"△ "` | The symbol used before the version of cmake. | -| `detect_extensions` | `[]` | Which extensions should trigger this moudle | +| `detect_extensions` | `[]` | Which extensions should trigger this module | | `detect_files` | `["CMakeLists.txt", "CMakeCache.txt"]` | Which filenames should trigger this module | | `detect_folders` | `[]` | Which folders should trigger this module | | `style` | `"bold blue"` | モジュールのスタイルです。 | @@ -596,7 +596,7 @@ The `dart` module shows the currently installed version of Dart. By default the | ------------------- | ------------------------------------------------- | ----------------------------------------------- | | `format` | `"via [$symbol($version )]($style)"` | moduleのフォーマットです。 | | `symbol` | `"🎯 "` | A format string representing the symbol of Dart | -| `detect_extensions` | `['dart']` | Which extensions should trigger this moudle. | +| `detect_extensions` | `['dart']` | Which extensions should trigger this module. | | `detect_files` | `["pubspec.yaml", "pubspec.yml", "pubspec.lock"]` | Which filenames should trigger this module. | | `detect_folders` | `[".dart_tool"]` | Which folders should trigger this module. | | `style` | `"bold blue"` | モジュールのスタイルです。 | @@ -746,7 +746,7 @@ The module will also show the Target Framework Moniker ( "` | The symbol used before displaying the version of PureScript. | -| `detect_extensions` | `["purs"]` | Which extensions should trigger this moudle. | +| `detect_extensions` | `["purs"]` | Which extensions should trigger this module. | | `detect_files` | `["spago.dhall"]` | Which filenames should trigger this module. | | `detect_folders` | `[]` | Which folders should trigger this module. | | `style` | `"bold white"` | モジュールのスタイルです。 | @@ -2035,13 +2039,13 @@ By default the module will be shown if any of the following conditions are met: | オプション | デフォルト | 説明 | | -------------------- | ------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------- | -| `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\))]($style)'` | moduleのフォーマットです。 | +| `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\) )]($style)'` | moduleのフォーマットです。 | | `symbol` | `"🐍 "` | A format string representing the symbol of Python | | `style` | `"yellow bold"` | モジュールのスタイルです。 | | `pyenv_version_name` | `false` | pyenvを使用してPythonバージョンを取得します | | `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"]` | Which extensions should trigger this moudle | +| `detect_extensions` | `[".py"]` | Which extensions should trigger this module | | `detect_files` | `[".python-version", "Pipfile", "__init__.py", "pyproject.toml", "requirements.txt", "setup.py", "tox.ini"]` | Which filenames should trigger this module | | `detect_folders` | `[]` | Which folders should trigger this module | | `disabled` | `false` | Disables the `python` module. | @@ -2064,7 +2068,6 @@ The default values and order for `python_binary` was chosen to first identify th | pyenv_prefix | `"pyenv "` | Mirrors the value of option `pyenv_prefix` | | virtualenv | `"venv"` | The current `virtualenv` name | - ### 設定例 ```toml @@ -2168,7 +2171,6 @@ By default the `rust` module shows the currently installed version of Rust. The format = "via [⚙️ $version](red bold)" ``` - ## Scala The `scala` module shows the currently installed version of Scala. By default the module will be shown if any of the following conditions are met: @@ -2179,7 +2181,6 @@ The `scala` module shows the currently installed version of Scala. By default th ### オプション - | オプション | デフォルト | 説明 | | ------------------- | ---------------------------------------- | ------------------------------------------------- | | `format` | `"via [${symbol}(${version} )]($style)"` | moduleのフォーマットです。 | @@ -2209,7 +2210,6 @@ The `scala` module shows the currently installed version of Scala. By default th symbol = "🌟 " ``` - ## Shell The `shell` module shows an indicator for currently used shell. @@ -2241,6 +2241,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y | indicator | | Mirrors the value of `indicator` for currently used shell. | ### 設定例 + ```toml # ~/.config/starship.toml @@ -2252,26 +2253,26 @@ disabled = false ## SHLVL -The `shlvl` module shows the current SHLVL ("shell level") environment variable, if it is set to a number and meets or exceeds the specified threshold. +The `shlvl` module shows the current `SHLVL` ("shell level") environment variable, if it is set to a number and meets or exceeds the specified threshold. ### オプション -| オプション | デフォルト | 説明 | -| ----------- | ---------------------------- | ----------------------------------------------------------- | -| `threshold` | `2` | Display threshold. | -| `format` | `"[$symbol$shlvl]($style) "` | moduleのフォーマットです。 | -| `symbol` | `"↕️ "` | The symbol used to represent the SHLVL. | -| `repeat` | `false` | Causes `symbol` to be repeated by the current SHLVL amount. | -| `style` | `"bold yellow"` | モジュールのスタイルです。 | -| `disabled` | `true` | Disables the `shlvl` module. | +| オプション | デフォルト | 説明 | +| ----------- | ---------------------------- | ------------------------------------------------------------- | +| `threshold` | `2` | Display threshold. | +| `format` | `"[$symbol$shlvl]($style) "` | moduleのフォーマットです。 | +| `symbol` | `"↕️ "` | The symbol used to represent the `SHLVL`. | +| `repeat` | `false` | Causes `symbol` to be repeated by the current `SHLVL` amount. | +| `style` | `"bold yellow"` | モジュールのスタイルです。 | +| `disabled` | `true` | Disables the `shlvl` module. | ### 変数 -| 変数 | 設定例 | 説明 | -| --------- | --- | -------------------------- | -| shlvl | `3` | The current value of SHLVL | -| symbol | | オプション `記号` の値をミラーする | -| style\* | | オプション `style` の値をミラーする | +| 変数 | 設定例 | 説明 | +| --------- | --- | ---------------------------- | +| shlvl | `3` | The current value of `SHLVL` | +| symbol | | オプション `記号` の値をミラーする | +| style\* | | オプション `style` の値をミラーする | \*: This variable can only be used as a part of a style string @@ -2388,7 +2389,7 @@ By default the `swift` module shows the currently installed version of Swift. Th | ------------------- | ------------------------------------ | ------------------------------------------------ | | `format` | `"via [$symbol($version )]($style)"` | moduleのフォーマットです。 | | `symbol` | `"🐦 "` | A format string representing the symbol of Swift | -| `detect_extensions` | `["swift"]` | Which extensions should trigger this moudle. | +| `detect_extensions` | `["swift"]` | Which extensions should trigger this module. | | `detect_files` | `["Package.swift"]` | Which filenames should trigger this module. | | `detect_folders` | `[]` | Which folders should trigger this module. | | `style` | `"bold 202"` | モジュールのスタイルです。 | @@ -2578,7 +2579,7 @@ The `vagrant` module shows the currently installed version of Vagrant. By defaul | `detect_files` | `["Vagrantfile"]` | Which filenames should trigger this module. | | `detect_folders` | `[]` | Which folders should trigger this module. | | `style` | `"cyan bold"` | モジュールのスタイルです。 | -| `disabled` | `false` | Disables the `Vagrant` module. | +| `disabled` | `false` | Disables the `vagrant` module. | ### 変数 @@ -2599,6 +2600,38 @@ The `vagrant` module shows the currently installed version of Vagrant. By defaul format = "via [⍱ $version](bold white) " ``` +## VCSH + +The `vcsh` module displays the current active VCSH repository. The module will be shown only if a repository is currently in use. + +### オプション + +| オプション | デフォルト | 説明 | +| ---------- | -------------------------------- | ------------------------------------------------------ | +| `symbol` | | The symbol used before displaying the repository name. | +| `style` | `"bold yellow"` | モジュールのスタイルです。 | +| `format` | `"vcsh [$symbol$repo]($style) "` | moduleのフォーマットです。 | +| `disabled` | `false` | Disables the `vcsh` module. | + +### 変数 + +| 変数 | 設定例 | 説明 | +| --------- | ------------------------------------------- | -------------------------- | +| repo | `dotfiles` if in a VCSH repo named dotfiles | The active repository name | +| symbol | | オプション `記号` の値をミラーする | +| style\* | `black bold dimmed` | オプション `style` の値をミラーする | + +\*: This variable can only be used as a part of a style string + +### 設定例 + +```toml +# ~/.config/starship.toml + +[vcsh] +format = "[🆅 $repo](bold blue) " +``` + ## Zig By default the the `zig` module shows the currently installed version of Zig. The module will be shown if any of the following conditions are met: diff --git a/docs/ja-JP/faq/README.md b/docs/ja-JP/faq/README.md index aafcc372d..8512e77cd 100644 --- a/docs/ja-JP/faq/README.md +++ b/docs/ja-JP/faq/README.md @@ -38,7 +38,7 @@ NUM_JOBS=$(jobs -p | wc -l) PS1="$(starship prompt --status=$STATUS --jobs=$NUM_JOBS)" ``` -The [Bash implementation](https://github.com/starship/starship/blob/master/src/init/starship.bash) built into Starship is slightly more complex to allow for advanced features like the [Command Duration module](https://starship.rs/config/#command-duration) and to ensure that Starship is compatible with pre-installed Bash configurations. +Starshipに搭載されている[Bashの実装](https://github.com/starship/starship/blob/master/src/init/starship.bash)は、[Command Duration モジュール](https://starship.rs/config/#command-duration)のような高度な機能を可能にするためと、プリインストールされたBashの設定との互換性を確保するために、若干複雑になっています。 `Starshipのプロンプト`で受け入れられるすべてのフラグのリストは、次のコマンドを取得できます。 @@ -91,6 +91,6 @@ Starshipのアンインストールはインストールと同じぐらい簡単 `curl | bash` スクリプトを使用してStarshipをインストールした場合は、以下のコマンドでバイナリを削除してください。 ```sh -# starshipバイナリを見つけて削除 -rm "$(which starship)" +# Locate and delete the starship binary +bash -c 'rm "$(which starship)"' ``` diff --git a/docs/ja-JP/guide/README.md b/docs/ja-JP/guide/README.md index 751c8f541..835f53f7c 100644 --- a/docs/ja-JP/guide/README.md +++ b/docs/ja-JP/guide/README.md @@ -90,7 +90,7 @@ alt="简体中文" />   - Español   - Français   - ~/.config/starship.toml ``` All configuration for starship is done in this [TOML](https://github.com/toml-lang/toml) file: @@ -180,6 +180,7 @@ $hostname\ $shlvl\ $kubernetes\ $directory\ +$vcsh\ $git_branch\ $git_commit\ $git_state\ @@ -248,7 +249,7 @@ When using [awsu](https://github.com/kreuzwerker/awsu) the profile is read from | `symbol` | `"☁️ "` | The symbol used before displaying the current AWS profile. | | `region_aliases` | | Table of region aliases to display in addition to the AWS name. | | `style` | `"bold yellow"` | The style for the module. | -| `disabled` | `false` | Disables the `AWS` module. | +| `disabled` | `false` | Disables the `aws` module. | ### Variables @@ -310,25 +311,24 @@ The `battery` module shows how charged the device's battery is and its current c | Option | Default | Description | | -------------------- | --------------------------------- | --------------------------------------------------- | -| `full_symbol` | `""` | The symbol shown when the battery is full. | -| `charging_symbol` | `""` | The symbol shown when the battery is charging. | -| `discharging_symbol` | `""` | The symbol shown when the battery is discharging. | -| `unknown_symbol` | `""` | The symbol shown when the battery state is unknown. | -| `empty_symbol` | `""` | The symbol shown when the battery state is empty. | +| `full_symbol` | `" "` | The symbol shown when the battery is full. | +| `charging_symbol` | `" "` | The symbol shown when the battery is charging. | +| `discharging_symbol` | `" "` | The symbol shown when the battery is discharging. | +| `unknown_symbol` | `" "` | The symbol shown when the battery state is unknown. | +| `empty_symbol` | `" "` | The symbol shown when the battery state is empty. | | `format` | `"[$symbol$percentage]($style) "` | The format for the module. | | `display` | [link](#battery-display) | Display threshold and style for the module. | | `disabled` | `false` | Disables the `battery` module. | - ### Example ```toml # ~/.config/starship.toml [battery] -full_symbol = "🔋" -charging_symbol = "⚡️" -discharging_symbol = "💀" +full_symbol = "🔋 " +charging_symbol = "⚡️ " +discharging_symbol = "💀 " ``` ### Battery Display @@ -438,7 +438,7 @@ The `cmake` module shows the currently installed version of CMake. By default th | ------------------- | -------------------------------------- | -------------------------------------------- | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `symbol` | `"△ "` | The symbol used before the version of cmake. | -| `detect_extensions` | `[]` | Which extensions should trigger this moudle | +| `detect_extensions` | `[]` | Which extensions should trigger this module | | `detect_files` | `["CMakeLists.txt", "CMakeCache.txt"]` | Which filenames should trigger this module | | `detect_folders` | `[]` | Which folders should trigger this module | | `style` | `"bold blue"` | The style for the module. | @@ -595,7 +595,7 @@ The `dart` module shows the currently installed version of Dart. By default the | ------------------- | ------------------------------------------------- | ----------------------------------------------- | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `symbol` | `"🎯 "` | A format string representing the symbol of Dart | -| `detect_extensions` | `['dart']` | Which extensions should trigger this moudle. | +| `detect_extensions` | `['dart']` | Which extensions should trigger this module. | | `detect_files` | `["pubspec.yaml", "pubspec.yml", "pubspec.lock"]` | Which filenames should trigger this module. | | `detect_folders` | `[".dart_tool"]` | Which folders should trigger this module. | | `style` | `"bold blue"` | The style for the module. | @@ -745,7 +745,7 @@ The module will also show the Target Framework Moniker ( "` | The symbol used before displaying the version of PureScript. | -| `detect_extensions` | `["purs"]` | Which extensions should trigger this moudle. | +| `detect_extensions` | `["purs"]` | Which extensions should trigger this module. | | `detect_files` | `["spago.dhall"]` | Which filenames should trigger this module. | | `detect_folders` | `[]` | Which folders should trigger this module. | | `style` | `"bold white"` | The style for the module. | @@ -2034,13 +2038,13 @@ By default the module will be shown if any of the following conditions are met: | Option | Default | Description | | -------------------- | ------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------- | -| `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\))]($style)'` | The format for the module. | +| `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\) )]($style)'` | The format for the module. | | `symbol` | `"🐍 "` | A format string representing the symbol of Python | | `style` | `"yellow bold"` | The style for the 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"]` | Which extensions should trigger this moudle | +| `detect_extensions` | `[".py"]` | Which extensions should trigger this module | | `detect_files` | `[".python-version", "Pipfile", "__init__.py", "pyproject.toml", "requirements.txt", "setup.py", "tox.ini"]` | Which filenames should trigger this module | | `detect_folders` | `[]` | Which folders should trigger this module | | `disabled` | `false` | Disables the `python` module. | @@ -2063,7 +2067,6 @@ The default values and order for `python_binary` was chosen to first identify th | pyenv_prefix | `"pyenv "` | Mirrors the value of option `pyenv_prefix` | | virtualenv | `"venv"` | The current `virtualenv` name | - ### Example ```toml @@ -2167,7 +2170,6 @@ By default the `rust` module shows the currently installed version of Rust. The format = "via [⚙️ $version](red bold)" ``` - ## Scala The `scala` module shows the currently installed version of Scala. By default the module will be shown if any of the following conditions are met: @@ -2178,7 +2180,6 @@ The `scala` module shows the currently installed version of Scala. By default th ### Options - | Option | Default | Description | | ------------------- | ---------------------------------------- | ------------------------------------------------- | | `format` | `"via [${symbol}(${version} )]($style)"` | The format for the module. | @@ -2208,7 +2209,6 @@ The `scala` module shows the currently installed version of Scala. By default th symbol = "🌟 " ``` - ## Shell The `shell` module shows an indicator for currently used shell. @@ -2240,6 +2240,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y | indicator | | Mirrors the value of `indicator` for currently used shell. | ### Examples + ```toml # ~/.config/starship.toml @@ -2251,24 +2252,24 @@ disabled = false ## SHLVL -The `shlvl` module shows the current SHLVL ("shell level") environment variable, if it is set to a number and meets or exceeds the specified threshold. +The `shlvl` module shows the current `SHLVL` ("shell level") environment variable, if it is set to a number and meets or exceeds the specified threshold. ### Options -| Option | Default | Description | -| ----------- | ---------------------------- | ----------------------------------------------------------- | -| `threshold` | `2` | Display threshold. | -| `format` | `"[$symbol$shlvl]($style) "` | The format for the module. | -| `symbol` | `"↕️ "` | The symbol used to represent the SHLVL. | -| `repeat` | `false` | Causes `symbol` to be repeated by the current SHLVL amount. | -| `style` | `"bold yellow"` | The style for the module. | -| `disabled` | `true` | Disables the `shlvl` module. | +| Option | Default | Description | +| ----------- | ---------------------------- | ------------------------------------------------------------- | +| `threshold` | `2` | Display threshold. | +| `format` | `"[$symbol$shlvl]($style) "` | The format for the module. | +| `symbol` | `"↕️ "` | The symbol used to represent the `SHLVL`. | +| `repeat` | `false` | Causes `symbol` to be repeated by the current `SHLVL` amount. | +| `style` | `"bold yellow"` | The style for the module. | +| `disabled` | `true` | Disables the `shlvl` module. | ### Variables | Variable | Example | Description | | --------- | ------- | ------------------------------------ | -| shlvl | `3` | The current value of SHLVL | +| shlvl | `3` | The current value of `SHLVL` | | symbol | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | @@ -2387,7 +2388,7 @@ By default the `swift` module shows the currently installed version of Swift. Th | ------------------- | ------------------------------------ | ------------------------------------------------ | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `symbol` | `"🐦 "` | A format string representing the symbol of Swift | -| `detect_extensions` | `["swift"]` | Which extensions should trigger this moudle. | +| `detect_extensions` | `["swift"]` | Which extensions should trigger this module. | | `detect_files` | `["Package.swift"]` | Which filenames should trigger this module. | | `detect_folders` | `[]` | Which folders should trigger this module. | | `style` | `"bold 202"` | The style for the module. | @@ -2577,7 +2578,7 @@ The `vagrant` module shows the currently installed version of Vagrant. By defaul | `detect_files` | `["Vagrantfile"]` | Which filenames should trigger this module. | | `detect_folders` | `[]` | Which folders should trigger this module. | | `style` | `"cyan bold"` | The style for the module. | -| `disabled` | `false` | Disables the `Vagrant` module. | +| `disabled` | `false` | Disables the `vagrant` module. | ### Variables @@ -2598,6 +2599,38 @@ The `vagrant` module shows the currently installed version of Vagrant. By defaul format = "via [⍱ $version](bold white) " ``` +## VCSH + +The `vcsh` module displays the current active VCSH repository. The module will be shown only if a repository is currently in use. + +### Options + +| Option | Default | Description | +| ---------- | -------------------------------- | ------------------------------------------------------ | +| `symbol` | | The symbol used before displaying the repository name. | +| `style` | `"bold yellow"` | The style for the module. | +| `format` | `"vcsh [$symbol$repo]($style) "` | The format for the module. | +| `disabled` | `false` | Disables the `vcsh` module. | + +### Variables + +| Variable | Example | Description | +| --------- | ------------------------------------------- | ------------------------------------ | +| repo | `dotfiles` if in a VCSH repo named dotfiles | The active repository name | +| symbol | | Mirrors the value of option `symbol` | +| style\* | `black bold dimmed` | Mirrors the value of option `style` | + +\*: This variable can only be used as a part of a style string + +### Example + +```toml +# ~/.config/starship.toml + +[vcsh] +format = "[🆅 $repo](bold blue) " +``` + ## Zig By default the the `zig` module shows the currently installed version of Zig. The module will be shown if any of the following conditions are met: diff --git a/docs/ko-KR/faq/README.md b/docs/ko-KR/faq/README.md index d3c6d238c..f5c949629 100644 --- a/docs/ko-KR/faq/README.md +++ b/docs/ko-KR/faq/README.md @@ -92,5 +92,5 @@ If Starship was installed using the `curl | bash` script, the following command ```sh # Locate and delete the starship binary -rm "$(which starship)" +bash -c 'rm "$(which starship)"' ``` diff --git a/docs/ko-KR/guide/README.md b/docs/ko-KR/guide/README.md index 2e0f87469..67580b982 100644 --- a/docs/ko-KR/guide/README.md +++ b/docs/ko-KR/guide/README.md @@ -90,7 +90,7 @@ alt="简体中文" />   - Español   - Français   - ~/.config/starship.toml ``` All configuration for starship is done in this [TOML](https://github.com/toml-lang/toml) file: @@ -180,6 +180,7 @@ $hostname\ $shlvl\ $kubernetes\ $directory\ +$vcsh\ $git_branch\ $git_commit\ $git_state\ @@ -248,7 +249,7 @@ When using [awsu](https://github.com/kreuzwerker/awsu) the profile is read from | `symbol` | `"☁️ "` | The symbol used before displaying the current AWS profile. | | `region_aliases` | | Table of region aliases to display in addition to the AWS name. | | `style` | `"bold yellow"` | The style for the module. | -| `disabled` | `false` | Disables the `AWS` module. | +| `disabled` | `false` | Disables the `aws` module. | ### Variables @@ -310,25 +311,24 @@ The `battery` module shows how charged the device's battery is and its current c | Option | Default | Description | | -------------------- | --------------------------------- | --------------------------------------------------- | -| `full_symbol` | `""` | The symbol shown when the battery is full. | -| `charging_symbol` | `""` | The symbol shown when the battery is charging. | -| `discharging_symbol` | `""` | The symbol shown when the battery is discharging. | -| `unknown_symbol` | `""` | The symbol shown when the battery state is unknown. | -| `empty_symbol` | `""` | The symbol shown when the battery state is empty. | +| `full_symbol` | `" "` | The symbol shown when the battery is full. | +| `charging_symbol` | `" "` | The symbol shown when the battery is charging. | +| `discharging_symbol` | `" "` | The symbol shown when the battery is discharging. | +| `unknown_symbol` | `" "` | The symbol shown when the battery state is unknown. | +| `empty_symbol` | `" "` | The symbol shown when the battery state is empty. | | `format` | `"[$symbol$percentage]($style) "` | The format for the module. | | `display` | [link](#battery-display) | Display threshold and style for the module. | | `disabled` | `false` | Disables the `battery` module. | - ### Example ```toml # ~/.config/starship.toml [battery] -full_symbol = "🔋" -charging_symbol = "⚡️" -discharging_symbol = "💀" +full_symbol = "🔋 " +charging_symbol = "⚡️ " +discharging_symbol = "💀 " ``` ### Battery Display @@ -438,7 +438,7 @@ The `cmake` module shows the currently installed version of CMake. By default th | ------------------- | -------------------------------------- | -------------------------------------------- | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `symbol` | `"△ "` | The symbol used before the version of cmake. | -| `detect_extensions` | `[]` | Which extensions should trigger this moudle | +| `detect_extensions` | `[]` | Which extensions should trigger this module | | `detect_files` | `["CMakeLists.txt", "CMakeCache.txt"]` | Which filenames should trigger this module | | `detect_folders` | `[]` | Which folders should trigger this module | | `style` | `"bold blue"` | The style for the module. | @@ -595,7 +595,7 @@ The `dart` module shows the currently installed version of Dart. By default the | ------------------- | ------------------------------------------------- | ----------------------------------------------- | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `symbol` | `"🎯 "` | A format string representing the symbol of Dart | -| `detect_extensions` | `['dart']` | Which extensions should trigger this moudle. | +| `detect_extensions` | `['dart']` | Which extensions should trigger this module. | | `detect_files` | `["pubspec.yaml", "pubspec.yml", "pubspec.lock"]` | Which filenames should trigger this module. | | `detect_folders` | `[".dart_tool"]` | Which folders should trigger this module. | | `style` | `"bold blue"` | The style for the module. | @@ -745,7 +745,7 @@ The module will also show the Target Framework Moniker ( "` | The symbol used before displaying the version of PureScript. | -| `detect_extensions` | `["purs"]` | Which extensions should trigger this moudle. | +| `detect_extensions` | `["purs"]` | Which extensions should trigger this module. | | `detect_files` | `["spago.dhall"]` | Which filenames should trigger this module. | | `detect_folders` | `[]` | Which folders should trigger this module. | | `style` | `"bold white"` | The style for the module. | @@ -2034,13 +2038,13 @@ By default the module will be shown if any of the following conditions are met: | Option | Default | Description | | -------------------- | ------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------- | -| `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\))]($style)'` | The format for the module. | +| `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\) )]($style)'` | The format for the module. | | `symbol` | `"🐍 "` | A format string representing the symbol of Python | | `style` | `"yellow bold"` | The style for the 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"]` | Which extensions should trigger this moudle | +| `detect_extensions` | `[".py"]` | Which extensions should trigger this module | | `detect_files` | `[".python-version", "Pipfile", "__init__.py", "pyproject.toml", "requirements.txt", "setup.py", "tox.ini"]` | Which filenames should trigger this module | | `detect_folders` | `[]` | Which folders should trigger this module | | `disabled` | `false` | Disables the `python` module. | @@ -2063,7 +2067,6 @@ The default values and order for `python_binary` was chosen to first identify th | pyenv_prefix | `"pyenv "` | Mirrors the value of option `pyenv_prefix` | | virtualenv | `"venv"` | The current `virtualenv` name | - ### Example ```toml @@ -2167,7 +2170,6 @@ By default the `rust` module shows the currently installed version of Rust. The format = "via [⚙️ $version](red bold)" ``` - ## Scala The `scala` module shows the currently installed version of Scala. By default the module will be shown if any of the following conditions are met: @@ -2178,7 +2180,6 @@ The `scala` module shows the currently installed version of Scala. By default th ### Options - | Option | Default | Description | | ------------------- | ---------------------------------------- | ------------------------------------------------- | | `format` | `"via [${symbol}(${version} )]($style)"` | The format for the module. | @@ -2208,7 +2209,6 @@ The `scala` module shows the currently installed version of Scala. By default th symbol = "🌟 " ``` - ## Shell The `shell` module shows an indicator for currently used shell. @@ -2240,6 +2240,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y | indicator | | Mirrors the value of `indicator` for currently used shell. | ### Examples + ```toml # ~/.config/starship.toml @@ -2251,24 +2252,24 @@ disabled = false ## SHLVL -The `shlvl` module shows the current SHLVL ("shell level") environment variable, if it is set to a number and meets or exceeds the specified threshold. +The `shlvl` module shows the current `SHLVL` ("shell level") environment variable, if it is set to a number and meets or exceeds the specified threshold. ### Options -| Option | Default | Description | -| ----------- | ---------------------------- | ----------------------------------------------------------- | -| `threshold` | `2` | Display threshold. | -| `format` | `"[$symbol$shlvl]($style) "` | The format for the module. | -| `symbol` | `"↕️ "` | The symbol used to represent the SHLVL. | -| `repeat` | `false` | Causes `symbol` to be repeated by the current SHLVL amount. | -| `style` | `"bold yellow"` | The style for the module. | -| `disabled` | `true` | Disables the `shlvl` module. | +| Option | Default | Description | +| ----------- | ---------------------------- | ------------------------------------------------------------- | +| `threshold` | `2` | Display threshold. | +| `format` | `"[$symbol$shlvl]($style) "` | The format for the module. | +| `symbol` | `"↕️ "` | The symbol used to represent the `SHLVL`. | +| `repeat` | `false` | Causes `symbol` to be repeated by the current `SHLVL` amount. | +| `style` | `"bold yellow"` | The style for the module. | +| `disabled` | `true` | Disables the `shlvl` module. | ### Variables | Variable | Example | Description | | --------- | ------- | ------------------------------------ | -| shlvl | `3` | The current value of SHLVL | +| shlvl | `3` | The current value of `SHLVL` | | symbol | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | @@ -2387,7 +2388,7 @@ By default the `swift` module shows the currently installed version of Swift. Th | ------------------- | ------------------------------------ | ------------------------------------------------ | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `symbol` | `"🐦 "` | A format string representing the symbol of Swift | -| `detect_extensions` | `["swift"]` | Which extensions should trigger this moudle. | +| `detect_extensions` | `["swift"]` | Which extensions should trigger this module. | | `detect_files` | `["Package.swift"]` | Which filenames should trigger this module. | | `detect_folders` | `[]` | Which folders should trigger this module. | | `style` | `"bold 202"` | The style for the module. | @@ -2577,7 +2578,7 @@ The `vagrant` module shows the currently installed version of Vagrant. By defaul | `detect_files` | `["Vagrantfile"]` | Which filenames should trigger this module. | | `detect_folders` | `[]` | Which folders should trigger this module. | | `style` | `"cyan bold"` | The style for the module. | -| `disabled` | `false` | Disables the `Vagrant` module. | +| `disabled` | `false` | Disables the `vagrant` module. | ### Variables @@ -2598,6 +2599,38 @@ The `vagrant` module shows the currently installed version of Vagrant. By defaul format = "via [⍱ $version](bold white) " ``` +## VCSH + +The `vcsh` module displays the current active VCSH repository. The module will be shown only if a repository is currently in use. + +### Options + +| Option | Default | Description | +| ---------- | -------------------------------- | ------------------------------------------------------ | +| `symbol` | | The symbol used before displaying the repository name. | +| `style` | `"bold yellow"` | The style for the module. | +| `format` | `"vcsh [$symbol$repo]($style) "` | The format for the module. | +| `disabled` | `false` | Disables the `vcsh` module. | + +### Variables + +| Variable | Example | Description | +| --------- | ------------------------------------------- | ------------------------------------ | +| repo | `dotfiles` if in a VCSH repo named dotfiles | The active repository name | +| symbol | | Mirrors the value of option `symbol` | +| style\* | `black bold dimmed` | Mirrors the value of option `style` | + +\*: This variable can only be used as a part of a style string + +### Example + +```toml +# ~/.config/starship.toml + +[vcsh] +format = "[🆅 $repo](bold blue) " +``` + ## Zig By default the the `zig` module shows the currently installed version of Zig. The module will be shown if any of the following conditions are met: diff --git a/docs/nl-NL/faq/README.md b/docs/nl-NL/faq/README.md index d3c6d238c..f5c949629 100644 --- a/docs/nl-NL/faq/README.md +++ b/docs/nl-NL/faq/README.md @@ -92,5 +92,5 @@ If Starship was installed using the `curl | bash` script, the following command ```sh # Locate and delete the starship binary -rm "$(which starship)" +bash -c 'rm "$(which starship)"' ``` diff --git a/docs/nl-NL/guide/README.md b/docs/nl-NL/guide/README.md index fd107ff3c..7367fbf58 100644 --- a/docs/nl-NL/guide/README.md +++ b/docs/nl-NL/guide/README.md @@ -90,7 +90,7 @@ alt="简体中文" />   - Español   - Français   - ~/.config/starship.toml ``` All configuration for starship is done in this [TOML](https://github.com/toml-lang/toml) file: @@ -180,6 +180,7 @@ $hostname\ $shlvl\ $kubernetes\ $directory\ +$vcsh\ $git_branch\ $git_commit\ $git_state\ @@ -248,7 +249,7 @@ When using [awsu](https://github.com/kreuzwerker/awsu) the profile is read from | `symbol` | `"☁️ "` | The symbol used before displaying the current AWS profile. | | `region_aliases` | | Table of region aliases to display in addition to the AWS name. | | `style` | `"bold yellow"` | The style for the module. | -| `disabled` | `false` | Disables the `AWS` module. | +| `disabled` | `false` | Disables the `aws` module. | ### Variables @@ -310,25 +311,24 @@ The `battery` module shows how charged the device's battery is and its current c | Option | Default | Description | | -------------------- | --------------------------------- | --------------------------------------------------- | -| `full_symbol` | `""` | The symbol shown when the battery is full. | -| `charging_symbol` | `""` | The symbol shown when the battery is charging. | -| `discharging_symbol` | `""` | The symbol shown when the battery is discharging. | -| `unknown_symbol` | `""` | The symbol shown when the battery state is unknown. | -| `empty_symbol` | `""` | The symbol shown when the battery state is empty. | +| `full_symbol` | `" "` | The symbol shown when the battery is full. | +| `charging_symbol` | `" "` | The symbol shown when the battery is charging. | +| `discharging_symbol` | `" "` | The symbol shown when the battery is discharging. | +| `unknown_symbol` | `" "` | The symbol shown when the battery state is unknown. | +| `empty_symbol` | `" "` | The symbol shown when the battery state is empty. | | `format` | `"[$symbol$percentage]($style) "` | The format for the module. | | `display` | [link](#battery-display) | Display threshold and style for the module. | | `disabled` | `false` | Disables the `battery` module. | - ### Example ```toml # ~/.config/starship.toml [battery] -full_symbol = "🔋" -charging_symbol = "⚡️" -discharging_symbol = "💀" +full_symbol = "🔋 " +charging_symbol = "⚡️ " +discharging_symbol = "💀 " ``` ### Battery Display @@ -438,7 +438,7 @@ The `cmake` module shows the currently installed version of CMake. By default th | ------------------- | -------------------------------------- | -------------------------------------------- | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `symbol` | `"△ "` | The symbol used before the version of cmake. | -| `detect_extensions` | `[]` | Which extensions should trigger this moudle | +| `detect_extensions` | `[]` | Which extensions should trigger this module | | `detect_files` | `["CMakeLists.txt", "CMakeCache.txt"]` | Which filenames should trigger this module | | `detect_folders` | `[]` | Which folders should trigger this module | | `style` | `"bold blue"` | The style for the module. | @@ -595,7 +595,7 @@ The `dart` module shows the currently installed version of Dart. By default the | ------------------- | ------------------------------------------------- | ----------------------------------------------- | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `symbol` | `"🎯 "` | A format string representing the symbol of Dart | -| `detect_extensions` | `['dart']` | Which extensions should trigger this moudle. | +| `detect_extensions` | `['dart']` | Which extensions should trigger this module. | | `detect_files` | `["pubspec.yaml", "pubspec.yml", "pubspec.lock"]` | Which filenames should trigger this module. | | `detect_folders` | `[".dart_tool"]` | Which folders should trigger this module. | | `style` | `"bold blue"` | The style for the module. | @@ -745,7 +745,7 @@ The module will also show the Target Framework Moniker ( "` | The symbol used before displaying the version of PureScript. | -| `detect_extensions` | `["purs"]` | Which extensions should trigger this moudle. | +| `detect_extensions` | `["purs"]` | Which extensions should trigger this module. | | `detect_files` | `["spago.dhall"]` | Which filenames should trigger this module. | | `detect_folders` | `[]` | Which folders should trigger this module. | | `style` | `"bold white"` | The style for the module. | @@ -2034,13 +2038,13 @@ By default the module will be shown if any of the following conditions are met: | Option | Default | Description | | -------------------- | ------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------- | -| `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\))]($style)'` | The format for the module. | +| `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\) )]($style)'` | The format for the module. | | `symbol` | `"🐍 "` | A format string representing the symbol of Python | | `style` | `"yellow bold"` | The style for the 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"]` | Which extensions should trigger this moudle | +| `detect_extensions` | `[".py"]` | Which extensions should trigger this module | | `detect_files` | `[".python-version", "Pipfile", "__init__.py", "pyproject.toml", "requirements.txt", "setup.py", "tox.ini"]` | Which filenames should trigger this module | | `detect_folders` | `[]` | Which folders should trigger this module | | `disabled` | `false` | Disables the `python` module. | @@ -2063,7 +2067,6 @@ The default values and order for `python_binary` was chosen to first identify th | pyenv_prefix | `"pyenv "` | Mirrors the value of option `pyenv_prefix` | | virtualenv | `"venv"` | The current `virtualenv` name | - ### Example ```toml @@ -2167,7 +2170,6 @@ By default the `rust` module shows the currently installed version of Rust. The format = "via [⚙️ $version](red bold)" ``` - ## Scala The `scala` module shows the currently installed version of Scala. By default the module will be shown if any of the following conditions are met: @@ -2178,7 +2180,6 @@ The `scala` module shows the currently installed version of Scala. By default th ### Options - | Option | Default | Description | | ------------------- | ---------------------------------------- | ------------------------------------------------- | | `format` | `"via [${symbol}(${version} )]($style)"` | The format for the module. | @@ -2208,7 +2209,6 @@ The `scala` module shows the currently installed version of Scala. By default th symbol = "🌟 " ``` - ## Shell The `shell` module shows an indicator for currently used shell. @@ -2240,6 +2240,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y | indicator | | Mirrors the value of `indicator` for currently used shell. | ### Examples + ```toml # ~/.config/starship.toml @@ -2251,24 +2252,24 @@ disabled = false ## SHLVL -The `shlvl` module shows the current SHLVL ("shell level") environment variable, if it is set to a number and meets or exceeds the specified threshold. +The `shlvl` module shows the current `SHLVL` ("shell level") environment variable, if it is set to a number and meets or exceeds the specified threshold. ### Options -| Option | Default | Description | -| ----------- | ---------------------------- | ----------------------------------------------------------- | -| `threshold` | `2` | Display threshold. | -| `format` | `"[$symbol$shlvl]($style) "` | The format for the module. | -| `symbol` | `"↕️ "` | The symbol used to represent the SHLVL. | -| `repeat` | `false` | Causes `symbol` to be repeated by the current SHLVL amount. | -| `style` | `"bold yellow"` | The style for the module. | -| `disabled` | `true` | Disables the `shlvl` module. | +| Option | Default | Description | +| ----------- | ---------------------------- | ------------------------------------------------------------- | +| `threshold` | `2` | Display threshold. | +| `format` | `"[$symbol$shlvl]($style) "` | The format for the module. | +| `symbol` | `"↕️ "` | The symbol used to represent the `SHLVL`. | +| `repeat` | `false` | Causes `symbol` to be repeated by the current `SHLVL` amount. | +| `style` | `"bold yellow"` | The style for the module. | +| `disabled` | `true` | Disables the `shlvl` module. | ### Variables | Variable | Example | Description | | --------- | ------- | ------------------------------------ | -| shlvl | `3` | The current value of SHLVL | +| shlvl | `3` | The current value of `SHLVL` | | symbol | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | @@ -2387,7 +2388,7 @@ By default the `swift` module shows the currently installed version of Swift. Th | ------------------- | ------------------------------------ | ------------------------------------------------ | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `symbol` | `"🐦 "` | A format string representing the symbol of Swift | -| `detect_extensions` | `["swift"]` | Which extensions should trigger this moudle. | +| `detect_extensions` | `["swift"]` | Which extensions should trigger this module. | | `detect_files` | `["Package.swift"]` | Which filenames should trigger this module. | | `detect_folders` | `[]` | Which folders should trigger this module. | | `style` | `"bold 202"` | The style for the module. | @@ -2577,7 +2578,7 @@ The `vagrant` module shows the currently installed version of Vagrant. By defaul | `detect_files` | `["Vagrantfile"]` | Which filenames should trigger this module. | | `detect_folders` | `[]` | Which folders should trigger this module. | | `style` | `"cyan bold"` | The style for the module. | -| `disabled` | `false` | Disables the `Vagrant` module. | +| `disabled` | `false` | Disables the `vagrant` module. | ### Variables @@ -2598,6 +2599,38 @@ The `vagrant` module shows the currently installed version of Vagrant. By defaul format = "via [⍱ $version](bold white) " ``` +## VCSH + +The `vcsh` module displays the current active VCSH repository. The module will be shown only if a repository is currently in use. + +### Options + +| Option | Default | Description | +| ---------- | -------------------------------- | ------------------------------------------------------ | +| `symbol` | | The symbol used before displaying the repository name. | +| `style` | `"bold yellow"` | The style for the module. | +| `format` | `"vcsh [$symbol$repo]($style) "` | The format for the module. | +| `disabled` | `false` | Disables the `vcsh` module. | + +### Variables + +| Variable | Example | Description | +| --------- | ------------------------------------------- | ------------------------------------ | +| repo | `dotfiles` if in a VCSH repo named dotfiles | The active repository name | +| symbol | | Mirrors the value of option `symbol` | +| style\* | `black bold dimmed` | Mirrors the value of option `style` | + +\*: This variable can only be used as a part of a style string + +### Example + +```toml +# ~/.config/starship.toml + +[vcsh] +format = "[🆅 $repo](bold blue) " +``` + ## Zig By default the the `zig` module shows the currently installed version of Zig. The module will be shown if any of the following conditions are met: diff --git a/docs/pl-PL/faq/README.md b/docs/pl-PL/faq/README.md index d3c6d238c..f5c949629 100644 --- a/docs/pl-PL/faq/README.md +++ b/docs/pl-PL/faq/README.md @@ -92,5 +92,5 @@ If Starship was installed using the `curl | bash` script, the following command ```sh # Locate and delete the starship binary -rm "$(which starship)" +bash -c 'rm "$(which starship)"' ``` diff --git a/docs/pl-PL/guide/README.md b/docs/pl-PL/guide/README.md index fd107ff3c..7367fbf58 100644 --- a/docs/pl-PL/guide/README.md +++ b/docs/pl-PL/guide/README.md @@ -90,7 +90,7 @@ alt="简体中文" />   - Español   - Français   - ~/.config/starship.toml ``` Todas as configurações do starship são feitas neste arquivo [TOML](https://github.com/toml-lang/toml): @@ -180,6 +180,7 @@ $hostname\ $shlvl\ $kubernetes\ $directory\ +$vcsh\ $git_branch\ $git_commit\ $git_state\ @@ -248,7 +249,7 @@ When using [awsu](https://github.com/kreuzwerker/awsu) the profile is read from | `symbol` | `"☁️ "` | The symbol used before displaying the current AWS profile. | | `region_aliases` | | Table of region aliases to display in addition to the AWS name. | | `style` | `"bold yellow"` | O estilo do módulo. | -| `disabled` | `false` | Disables the `AWS` module. | +| `disabled` | `false` | Disables the `aws` module. | ### Variables @@ -310,25 +311,24 @@ The `battery` module shows how charged the device's battery is and its current c | Option | Padrão | Descrição | | -------------------- | --------------------------------- | --------------------------------------------------- | -| `full_symbol` | `""` | The symbol shown when the battery is full. | -| `charging_symbol` | `""` | The symbol shown when the battery is charging. | -| `discharging_symbol` | `""` | The symbol shown when the battery is discharging. | -| `unknown_symbol` | `""` | The symbol shown when the battery state is unknown. | -| `empty_symbol` | `""` | The symbol shown when the battery state is empty. | +| `full_symbol` | `" "` | The symbol shown when the battery is full. | +| `charging_symbol` | `" "` | The symbol shown when the battery is charging. | +| `discharging_symbol` | `" "` | The symbol shown when the battery is discharging. | +| `unknown_symbol` | `" "` | The symbol shown when the battery state is unknown. | +| `empty_symbol` | `" "` | The symbol shown when the battery state is empty. | | `format` | `"[$symbol$percentage]($style) "` | The format for the module. | | `display` | [link](#battery-display) | Display threshold and style for the module. | | `disabled` | `false` | Disables the `battery` module. | - ### Exemplo ```toml # ~/.config/starship.toml [battery] -full_symbol = "🔋" -charging_symbol = "⚡️" -discharging_symbol = "💀" +full_symbol = "🔋 " +charging_symbol = "⚡️ " +discharging_symbol = "💀 " ``` ### Indicador de bateria @@ -438,7 +438,7 @@ The `cmake` module shows the currently installed version of CMake. By default th | ------------------- | -------------------------------------- | -------------------------------------------- | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `symbol` | `"△ "` | The symbol used before the version of cmake. | -| `detect_extensions` | `[]` | Which extensions should trigger this moudle | +| `detect_extensions` | `[]` | Which extensions should trigger this module | | `detect_files` | `["CMakeLists.txt", "CMakeCache.txt"]` | Which filenames should trigger this module | | `detect_folders` | `[]` | Which folders should trigger this module | | `style` | `"bold blue"` | O estilo do módulo. | @@ -595,7 +595,7 @@ The `dart` module shows the currently installed version of Dart. By default the | ------------------- | ------------------------------------------------- | ----------------------------------------------- | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `symbol` | `"🎯 "` | A format string representing the symbol of Dart | -| `detect_extensions` | `['dart']` | Which extensions should trigger this moudle. | +| `detect_extensions` | `['dart']` | Which extensions should trigger this module. | | `detect_files` | `["pubspec.yaml", "pubspec.yml", "pubspec.lock"]` | Which filenames should trigger this module. | | `detect_folders` | `[".dart_tool"]` | Which folders should trigger this module. | | `style` | `"bold blue"` | O estilo do módulo. | @@ -745,7 +745,7 @@ The module will also show the Target Framework Moniker ( "` | The symbol used before displaying the version of PureScript. | -| `detect_extensions` | `["purs"]` | Which extensions should trigger this moudle. | +| `detect_extensions` | `["purs"]` | Which extensions should trigger this module. | | `detect_files` | `["spago.dhall"]` | Which filenames should trigger this module. | | `detect_folders` | `[]` | Which folders should trigger this module. | | `style` | `"bold white"` | O estilo do módulo. | @@ -2034,13 +2038,13 @@ By default the module will be shown if any of the following conditions are met: | Option | Padrão | Descrição | | -------------------- | ------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------- | -| `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\))]($style)'` | The format for the module. | +| `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\) )]($style)'` | The format for the module. | | `symbol` | `"🐍 "` | A format string representing the symbol of Python | | `style` | `"yellow bold"` | O estilo do módulo. | | `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"]` | Which extensions should trigger this moudle | +| `detect_extensions` | `[".py"]` | Which extensions should trigger this module | | `detect_files` | `[".python-version", "Pipfile", "__init__.py", "pyproject.toml", "requirements.txt", "setup.py", "tox.ini"]` | Which filenames should trigger this module | | `detect_folders` | `[]` | Which folders should trigger this module | | `disabled` | `false` | Disables the `python` module. | @@ -2063,7 +2067,6 @@ The default values and order for `python_binary` was chosen to first identify th | pyenv_prefix | `"pyenv "` | Mirrors the value of option `pyenv_prefix` | | virtualenv | `"venv"` | The current `virtualenv` name | - ### Exemplo ```toml @@ -2167,7 +2170,6 @@ By default the `rust` module shows the currently installed version of Rust. The format = "via [⚙️ $version](red bold)" ``` - ## Scala The `scala` module shows the currently installed version of Scala. By default the module will be shown if any of the following conditions are met: @@ -2178,7 +2180,6 @@ The `scala` module shows the currently installed version of Scala. By default th ### Opções - | Option | Padrão | Descrição | | ------------------- | ---------------------------------------- | ------------------------------------------------- | | `format` | `"via [${symbol}(${version} )]($style)"` | The format for the module. | @@ -2208,7 +2209,6 @@ The `scala` module shows the currently installed version of Scala. By default th symbol = "🌟 " ``` - ## Shell The `shell` module shows an indicator for currently used shell. @@ -2240,6 +2240,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y | indicator | | Mirrors the value of `indicator` for currently used shell. | ### Examples + ```toml # ~/.config/starship.toml @@ -2251,24 +2252,24 @@ disabled = false ## SHLVL -The `shlvl` module shows the current SHLVL ("shell level") environment variable, if it is set to a number and meets or exceeds the specified threshold. +The `shlvl` module shows the current `SHLVL` ("shell level") environment variable, if it is set to a number and meets or exceeds the specified threshold. ### Opções -| Option | Padrão | Descrição | -| ----------- | ---------------------------- | ----------------------------------------------------------- | -| `threshold` | `2` | Display threshold. | -| `format` | `"[$symbol$shlvl]($style) "` | The format for the module. | -| `symbol` | `"↕️ "` | The symbol used to represent the SHLVL. | -| `repeat` | `false` | Causes `symbol` to be repeated by the current SHLVL amount. | -| `style` | `"bold yellow"` | O estilo do módulo. | -| `disabled` | `true` | Disables the `shlvl` module. | +| Option | Padrão | Descrição | +| ----------- | ---------------------------- | ------------------------------------------------------------- | +| `threshold` | `2` | Display threshold. | +| `format` | `"[$symbol$shlvl]($style) "` | The format for the module. | +| `symbol` | `"↕️ "` | The symbol used to represent the `SHLVL`. | +| `repeat` | `false` | Causes `symbol` to be repeated by the current `SHLVL` amount. | +| `style` | `"bold yellow"` | O estilo do módulo. | +| `disabled` | `true` | Disables the `shlvl` module. | ### Variables | Variável | Exemplo | Descrição | | --------- | ------- | ------------------------------------ | -| shlvl | `3` | The current value of SHLVL | +| shlvl | `3` | The current value of `SHLVL` | | symbol | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | @@ -2387,7 +2388,7 @@ By default the `swift` module shows the currently installed version of Swift. Th | ------------------- | ------------------------------------ | ------------------------------------------------ | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `symbol` | `"🐦 "` | A format string representing the symbol of Swift | -| `detect_extensions` | `["swift"]` | Which extensions should trigger this moudle. | +| `detect_extensions` | `["swift"]` | Which extensions should trigger this module. | | `detect_files` | `["Package.swift"]` | Which filenames should trigger this module. | | `detect_folders` | `[]` | Which folders should trigger this module. | | `style` | `"bold 202"` | O estilo do módulo. | @@ -2577,7 +2578,7 @@ The `vagrant` module shows the currently installed version of Vagrant. By defaul | `detect_files` | `["Vagrantfile"]` | Which filenames should trigger this module. | | `detect_folders` | `[]` | Which folders should trigger this module. | | `style` | `"cyan bold"` | O estilo do módulo. | -| `disabled` | `false` | Disables the `Vagrant` module. | +| `disabled` | `false` | Disables the `vagrant` module. | ### Variables @@ -2598,6 +2599,38 @@ The `vagrant` module shows the currently installed version of Vagrant. By defaul format = "via [⍱ $version](bold white) " ``` +## VCSH + +The `vcsh` module displays the current active VCSH repository. The module will be shown only if a repository is currently in use. + +### Opções + +| Option | Padrão | Descrição | +| ---------- | -------------------------------- | ------------------------------------------------------ | +| `symbol` | | The symbol used before displaying the repository name. | +| `style` | `"bold yellow"` | O estilo do módulo. | +| `format` | `"vcsh [$symbol$repo]($style) "` | The format for the module. | +| `disabled` | `false` | Disables the `vcsh` module. | + +### Variables + +| Variável | Exemplo | Descrição | +| --------- | ------------------------------------------- | ------------------------------------ | +| repo | `dotfiles` if in a VCSH repo named dotfiles | The active repository name | +| symbol | | Mirrors the value of option `symbol` | +| style\* | `black bold dimmed` | Mirrors the value of option `style` | + +\*: This variable can only be used as a part of a style string + +### Exemplo + +```toml +# ~/.config/starship.toml + +[vcsh] +format = "[🆅 $repo](bold blue) " +``` + ## Zig By default the the `zig` module shows the currently installed version of Zig. The module will be shown if any of the following conditions are met: diff --git a/docs/pt-BR/faq/README.md b/docs/pt-BR/faq/README.md index d3c6d238c..f5c949629 100644 --- a/docs/pt-BR/faq/README.md +++ b/docs/pt-BR/faq/README.md @@ -92,5 +92,5 @@ If Starship was installed using the `curl | bash` script, the following command ```sh # Locate and delete the starship binary -rm "$(which starship)" +bash -c 'rm "$(which starship)"' ``` diff --git a/docs/pt-BR/guide/README.md b/docs/pt-BR/guide/README.md index 8f27af993..5178f0abb 100644 --- a/docs/pt-BR/guide/README.md +++ b/docs/pt-BR/guide/README.md @@ -90,7 +90,7 @@ alt="简体中文" />   - Español   - Français   - ~/.config/starship.toml ``` All configuration for starship is done in this [TOML](https://github.com/toml-lang/toml) file: @@ -180,6 +180,7 @@ $hostname\ $shlvl\ $kubernetes\ $directory\ +$vcsh\ $git_branch\ $git_commit\ $git_state\ @@ -248,7 +249,7 @@ When using [awsu](https://github.com/kreuzwerker/awsu) the profile is read from | `symbol` | `"☁️ "` | The symbol used before displaying the current AWS profile. | | `region_aliases` | | Table of region aliases to display in addition to the AWS name. | | `style` | `"bold yellow"` | The style for the module. | -| `disabled` | `false` | Disables the `AWS` module. | +| `disabled` | `false` | Disables the `aws` module. | ### Variables @@ -310,25 +311,24 @@ The `battery` module shows how charged the device's battery is and its current c | Option | Default | Description | | -------------------- | --------------------------------- | --------------------------------------------------- | -| `full_symbol` | `""` | The symbol shown when the battery is full. | -| `charging_symbol` | `""` | The symbol shown when the battery is charging. | -| `discharging_symbol` | `""` | The symbol shown when the battery is discharging. | -| `unknown_symbol` | `""` | The symbol shown when the battery state is unknown. | -| `empty_symbol` | `""` | The symbol shown when the battery state is empty. | +| `full_symbol` | `" "` | The symbol shown when the battery is full. | +| `charging_symbol` | `" "` | The symbol shown when the battery is charging. | +| `discharging_symbol` | `" "` | The symbol shown when the battery is discharging. | +| `unknown_symbol` | `" "` | The symbol shown when the battery state is unknown. | +| `empty_symbol` | `" "` | The symbol shown when the battery state is empty. | | `format` | `"[$symbol$percentage]($style) "` | The format for the module. | | `display` | [link](#battery-display) | Display threshold and style for the module. | | `disabled` | `false` | Disables the `battery` module. | - ### Example ```toml # ~/.config/starship.toml [battery] -full_symbol = "🔋" -charging_symbol = "⚡️" -discharging_symbol = "💀" +full_symbol = "🔋 " +charging_symbol = "⚡️ " +discharging_symbol = "💀 " ``` ### Battery Display @@ -438,7 +438,7 @@ The `cmake` module shows the currently installed version of CMake. By default th | ------------------- | -------------------------------------- | -------------------------------------------- | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `symbol` | `"△ "` | The symbol used before the version of cmake. | -| `detect_extensions` | `[]` | Which extensions should trigger this moudle | +| `detect_extensions` | `[]` | Which extensions should trigger this module | | `detect_files` | `["CMakeLists.txt", "CMakeCache.txt"]` | Which filenames should trigger this module | | `detect_folders` | `[]` | Which folders should trigger this module | | `style` | `"bold blue"` | The style for the module. | @@ -595,7 +595,7 @@ The `dart` module shows the currently installed version of Dart. By default the | ------------------- | ------------------------------------------------- | ----------------------------------------------- | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `symbol` | `"🎯 "` | A format string representing the symbol of Dart | -| `detect_extensions` | `['dart']` | Which extensions should trigger this moudle. | +| `detect_extensions` | `['dart']` | Which extensions should trigger this module. | | `detect_files` | `["pubspec.yaml", "pubspec.yml", "pubspec.lock"]` | Which filenames should trigger this module. | | `detect_folders` | `[".dart_tool"]` | Which folders should trigger this module. | | `style` | `"bold blue"` | The style for the module. | @@ -745,7 +745,7 @@ The module will also show the Target Framework Moniker ( "` | The symbol used before displaying the version of PureScript. | -| `detect_extensions` | `["purs"]` | Which extensions should trigger this moudle. | +| `detect_extensions` | `["purs"]` | Which extensions should trigger this module. | | `detect_files` | `["spago.dhall"]` | Which filenames should trigger this module. | | `detect_folders` | `[]` | Which folders should trigger this module. | | `style` | `"bold white"` | The style for the module. | @@ -2034,13 +2038,13 @@ By default the module will be shown if any of the following conditions are met: | Option | Default | Description | | -------------------- | ------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------- | -| `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\))]($style)'` | The format for the module. | +| `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\) )]($style)'` | The format for the module. | | `symbol` | `"🐍 "` | A format string representing the symbol of Python | | `style` | `"yellow bold"` | The style for the 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"]` | Which extensions should trigger this moudle | +| `detect_extensions` | `[".py"]` | Which extensions should trigger this module | | `detect_files` | `[".python-version", "Pipfile", "__init__.py", "pyproject.toml", "requirements.txt", "setup.py", "tox.ini"]` | Which filenames should trigger this module | | `detect_folders` | `[]` | Which folders should trigger this module | | `disabled` | `false` | Disables the `python` module. | @@ -2063,7 +2067,6 @@ The default values and order for `python_binary` was chosen to first identify th | pyenv_prefix | `"pyenv "` | Mirrors the value of option `pyenv_prefix` | | virtualenv | `"venv"` | The current `virtualenv` name | - ### Example ```toml @@ -2167,7 +2170,6 @@ By default the `rust` module shows the currently installed version of Rust. The format = "via [⚙️ $version](red bold)" ``` - ## Scala The `scala` module shows the currently installed version of Scala. By default the module will be shown if any of the following conditions are met: @@ -2178,7 +2180,6 @@ The `scala` module shows the currently installed version of Scala. By default th ### Options - | Option | Default | Description | | ------------------- | ---------------------------------------- | ------------------------------------------------- | | `format` | `"via [${symbol}(${version} )]($style)"` | The format for the module. | @@ -2208,7 +2209,6 @@ The `scala` module shows the currently installed version of Scala. By default th symbol = "🌟 " ``` - ## Shell The `shell` module shows an indicator for currently used shell. @@ -2240,6 +2240,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y | indicator | | Mirrors the value of `indicator` for currently used shell. | ### Examples + ```toml # ~/.config/starship.toml @@ -2251,24 +2252,24 @@ disabled = false ## SHLVL -The `shlvl` module shows the current SHLVL ("shell level") environment variable, if it is set to a number and meets or exceeds the specified threshold. +The `shlvl` module shows the current `SHLVL` ("shell level") environment variable, if it is set to a number and meets or exceeds the specified threshold. ### Options -| Option | Default | Description | -| ----------- | ---------------------------- | ----------------------------------------------------------- | -| `threshold` | `2` | Display threshold. | -| `format` | `"[$symbol$shlvl]($style) "` | The format for the module. | -| `symbol` | `"↕️ "` | The symbol used to represent the SHLVL. | -| `repeat` | `false` | Causes `symbol` to be repeated by the current SHLVL amount. | -| `style` | `"bold yellow"` | The style for the module. | -| `disabled` | `true` | Disables the `shlvl` module. | +| Option | Default | Description | +| ----------- | ---------------------------- | ------------------------------------------------------------- | +| `threshold` | `2` | Display threshold. | +| `format` | `"[$symbol$shlvl]($style) "` | The format for the module. | +| `symbol` | `"↕️ "` | The symbol used to represent the `SHLVL`. | +| `repeat` | `false` | Causes `symbol` to be repeated by the current `SHLVL` amount. | +| `style` | `"bold yellow"` | The style for the module. | +| `disabled` | `true` | Disables the `shlvl` module. | ### Variables | Variable | Example | Description | | --------- | ------- | ------------------------------------ | -| shlvl | `3` | The current value of SHLVL | +| shlvl | `3` | The current value of `SHLVL` | | symbol | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | @@ -2387,7 +2388,7 @@ By default the `swift` module shows the currently installed version of Swift. Th | ------------------- | ------------------------------------ | ------------------------------------------------ | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `symbol` | `"🐦 "` | A format string representing the symbol of Swift | -| `detect_extensions` | `["swift"]` | Which extensions should trigger this moudle. | +| `detect_extensions` | `["swift"]` | Which extensions should trigger this module. | | `detect_files` | `["Package.swift"]` | Which filenames should trigger this module. | | `detect_folders` | `[]` | Which folders should trigger this module. | | `style` | `"bold 202"` | The style for the module. | @@ -2577,7 +2578,7 @@ The `vagrant` module shows the currently installed version of Vagrant. By defaul | `detect_files` | `["Vagrantfile"]` | Which filenames should trigger this module. | | `detect_folders` | `[]` | Which folders should trigger this module. | | `style` | `"cyan bold"` | The style for the module. | -| `disabled` | `false` | Disables the `Vagrant` module. | +| `disabled` | `false` | Disables the `vagrant` module. | ### Variables @@ -2598,6 +2599,38 @@ The `vagrant` module shows the currently installed version of Vagrant. By defaul format = "via [⍱ $version](bold white) " ``` +## VCSH + +The `vcsh` module displays the current active VCSH repository. The module will be shown only if a repository is currently in use. + +### Options + +| Option | Default | Description | +| ---------- | -------------------------------- | ------------------------------------------------------ | +| `symbol` | | The symbol used before displaying the repository name. | +| `style` | `"bold yellow"` | The style for the module. | +| `format` | `"vcsh [$symbol$repo]($style) "` | The format for the module. | +| `disabled` | `false` | Disables the `vcsh` module. | + +### Variables + +| Variable | Example | Description | +| --------- | ------------------------------------------- | ------------------------------------ | +| repo | `dotfiles` if in a VCSH repo named dotfiles | The active repository name | +| symbol | | Mirrors the value of option `symbol` | +| style\* | `black bold dimmed` | Mirrors the value of option `style` | + +\*: This variable can only be used as a part of a style string + +### Example + +```toml +# ~/.config/starship.toml + +[vcsh] +format = "[🆅 $repo](bold blue) " +``` + ## Zig By default the the `zig` module shows the currently installed version of Zig. The module will be shown if any of the following conditions are met: diff --git a/docs/pt-PT/faq/README.md b/docs/pt-PT/faq/README.md index d3c6d238c..f5c949629 100644 --- a/docs/pt-PT/faq/README.md +++ b/docs/pt-PT/faq/README.md @@ -92,5 +92,5 @@ If Starship was installed using the `curl | bash` script, the following command ```sh # Locate and delete the starship binary -rm "$(which starship)" +bash -c 'rm "$(which starship)"' ``` diff --git a/docs/pt-PT/guide/README.md b/docs/pt-PT/guide/README.md index fd107ff3c..7367fbf58 100644 --- a/docs/pt-PT/guide/README.md +++ b/docs/pt-PT/guide/README.md @@ -90,7 +90,7 @@ alt="简体中文" />   - Español   - Français   - ~/.config/starship.toml ``` Вся конфигурация Starship выполняется в этом файле [TOML](https://github.com/toml-lang/toml): @@ -180,6 +180,7 @@ $hostname\ $shlvl\ $kubernetes\ $directory\ +$vcsh\ $git_branch\ $git_commit\ $git_state\ @@ -248,7 +249,7 @@ When using [awsu](https://github.com/kreuzwerker/awsu) the profile is read from | `symbol` | `"☁️ "` | Символ перед отображением текущего профиля AWS. | | `region_aliases` | | Таблица региона псевдонимов, отображаемая вместе с именем AWS. | | `style` | `"bold yellow"` | Стиль модуля. | -| `disabled` | `false` | Отключение модуля `AWS`. | +| `disabled` | `false` | Disables the `aws` module. | ### Переменные @@ -310,25 +311,24 @@ The `battery` module shows how charged the device's battery is and its current c | Параметр | По умолчанию | Описание | | -------------------- | --------------------------------- | ------------------------------------------------------- | -| `full_symbol` | `""` | Символ, отображаемый при полной батарее. | -| `charging_symbol` | `""` | Символ, показываемый при зарядке аккумулятора. | -| `discharging_symbol` | `""` | Символ, показываемый при разрядке аккумулятора. | -| `unknown_symbol` | `""` | Символ, отображаемый при неизвестном состоянии батареи. | -| `empty_symbol` | `""` | Символ, отображаемый при пустом состоянии батареи. | +| `full_symbol` | `" "` | Символ, отображаемый при полной батарее. | +| `charging_symbol` | `" "` | Символ, показываемый при зарядке аккумулятора. | +| `discharging_symbol` | `" "` | Символ, показываемый при разрядке аккумулятора. | +| `unknown_symbol` | `" "` | Символ, отображаемый при неизвестном состоянии батареи. | +| `empty_symbol` | `" "` | Символ, отображаемый при пустом состоянии батареи. | | `format` | `"[$symbol$percentage]($style) "` | Формат модуля. | | `display` | [ссылка](#battery-display) | Порог отображения и стиль для модуля. | | `disabled` | `false` | Отключает модуль `battery`. | - ### Пример ```toml # ~/.config/starship.toml [battery] -full_symbol = "🔋" -charging_symbol = "⚡️" -discharging_symbol = "💀" +full_symbol = "🔋 " +charging_symbol = "⚡️ " +discharging_symbol = "💀 " ``` ### Отображение батареи @@ -438,7 +438,7 @@ The `cmake` module shows the currently installed version of CMake. By default th | ------------------- | -------------------------------------- | -------------------------------------------- | | `format` | `"via [$symbol($version )]($style)"` | Формат модуля. | | `symbol` | `"△ "` | The symbol used before the version of cmake. | -| `detect_extensions` | `[]` | Which extensions should trigger this moudle | +| `detect_extensions` | `[]` | Which extensions should trigger this module | | `detect_files` | `["CMakeLists.txt", "CMakeCache.txt"]` | Which filenames should trigger this module | | `detect_folders` | `[]` | Which folders should trigger this module | | `style` | `"bold blue"` | Стиль модуля. | @@ -595,7 +595,7 @@ The `dart` module shows the currently installed version of Dart. By default the | ------------------- | ------------------------------------------------- | ----------------------------------------------- | | `format` | `"via [$symbol($version )]($style)"` | Формат модуля. | | `symbol` | `"🎯 "` | A format string representing the symbol of Dart | -| `detect_extensions` | `['dart']` | Which extensions should trigger this moudle. | +| `detect_extensions` | `['dart']` | Which extensions should trigger this module. | | `detect_files` | `["pubspec.yaml", "pubspec.yml", "pubspec.lock"]` | Which filenames should trigger this module. | | `detect_folders` | `[".dart_tool"]` | Which folders should trigger this module. | | `style` | `"bold blue"` | Стиль модуля. | @@ -745,7 +745,7 @@ The module will also show the Target Framework Moniker ( "` | The symbol used before displaying the version of PureScript. | -| `detect_extensions` | `["purs"]` | Which extensions should trigger this moudle. | +| `detect_extensions` | `["purs"]` | Which extensions should trigger this module. | | `detect_files` | `["spago.dhall"]` | Which filenames should trigger this module. | | `detect_folders` | `[]` | Which folders should trigger this module. | | `style` | `"bold white"` | Стиль модуля. | @@ -2034,13 +2038,13 @@ By default the module will be shown if any of the following conditions are met: | Параметр | По умолчанию | Описание | | -------------------- | ------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------- | -| `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\))]($style)'` | Формат модуля. | +| `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\) )]($style)'` | Формат модуля. | | `symbol` | `"🐍 "` | A format string representing the symbol of Python | | `style` | `"yellow bold"` | Стиль модуля. | | `pyenv_version_name` | `false` | Использовать pyenv для получения версии Python | | `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"]` | Which extensions should trigger this moudle | +| `detect_extensions` | `[".py"]` | Which extensions should trigger this module | | `detect_files` | `[".python-version", "Pipfile", "__init__.py", "pyproject.toml", "requirements.txt", "setup.py", "tox.ini"]` | Which filenames should trigger this module | | `detect_folders` | `[]` | Which folders should trigger this module | | `disabled` | `false` | Disables the `python` module. | @@ -2063,7 +2067,6 @@ The default values and order for `python_binary` was chosen to first identify th | pyenv_prefix | `"pyenv "` | Mirrors the value of option `pyenv_prefix` | | virtualenv | `"venv"` | The current `virtualenv` name | - ### Пример ```toml @@ -2167,7 +2170,6 @@ By default the `rust` module shows the currently installed version of Rust. The format = "via [⚙️ $version](red bold)" ``` - ## Scala The `scala` module shows the currently installed version of Scala. By default the module will be shown if any of the following conditions are met: @@ -2178,7 +2180,6 @@ The `scala` module shows the currently installed version of Scala. By default th ### Опции - | Параметр | По умолчанию | Описание | | ------------------- | ---------------------------------------- | ------------------------------------------------- | | `format` | `"via [${symbol}(${version} )]($style)"` | Формат модуля. | @@ -2208,7 +2209,6 @@ The `scala` module shows the currently installed version of Scala. By default th symbol = "🌟 " ``` - ## Shell The `shell` module shows an indicator for currently used shell. @@ -2240,6 +2240,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y | indicator | | Mirrors the value of `indicator` for currently used shell. | ### Примеры + ```toml # ~/.config/starship.toml @@ -2251,24 +2252,24 @@ disabled = false ## SHLVL -The `shlvl` module shows the current SHLVL ("shell level") environment variable, if it is set to a number and meets or exceeds the specified threshold. +The `shlvl` module shows the current `SHLVL` ("shell level") environment variable, if it is set to a number and meets or exceeds the specified threshold. ### Опции -| Параметр | По умолчанию | Описание | -| ----------- | ---------------------------- | ----------------------------------------------------------- | -| `threshold` | `2` | Display threshold. | -| `format` | `"[$symbol$shlvl]($style) "` | Формат модуля. | -| `symbol` | `"↕️ "` | The symbol used to represent the SHLVL. | -| `repeat` | `false` | Causes `symbol` to be repeated by the current SHLVL amount. | -| `style` | `"bold yellow"` | Стиль модуля. | -| `disabled` | `true` | Disables the `shlvl` module. | +| Параметр | По умолчанию | Описание | +| ----------- | ---------------------------- | ------------------------------------------------------------- | +| `threshold` | `2` | Display threshold. | +| `format` | `"[$symbol$shlvl]($style) "` | Формат модуля. | +| `symbol` | `"↕️ "` | The symbol used to represent the `SHLVL`. | +| `repeat` | `false` | Causes `symbol` to be repeated by the current `SHLVL` amount. | +| `style` | `"bold yellow"` | Стиль модуля. | +| `disabled` | `true` | Disables the `shlvl` module. | ### Переменные | Переменная | Пример | Описание | | ---------- | ------ | ------------------------------------ | -| shlvl | `3` | The current value of SHLVL | +| shlvl | `3` | The current value of `SHLVL` | | symbol | | Отражает значение параметра `symbol` | | style\* | | Отражает значение параметра `style` | @@ -2387,7 +2388,7 @@ By default the `swift` module shows the currently installed version of Swift. Th | ------------------- | ------------------------------------ | ------------------------------------------------ | | `format` | `"via [$symbol($version )]($style)"` | Формат модуля. | | `symbol` | `"🐦 "` | A format string representing the symbol of Swift | -| `detect_extensions` | `["swift"]` | Which extensions should trigger this moudle. | +| `detect_extensions` | `["swift"]` | Which extensions should trigger this module. | | `detect_files` | `["Package.swift"]` | Which filenames should trigger this module. | | `detect_folders` | `[]` | Which folders should trigger this module. | | `style` | `"bold 202"` | Стиль модуля. | @@ -2577,7 +2578,7 @@ The `vagrant` module shows the currently installed version of Vagrant. By defaul | `detect_files` | `["Vagrantfile"]` | Which filenames should trigger this module. | | `detect_folders` | `[]` | Which folders should trigger this module. | | `style` | `"cyan bold"` | Стиль модуля. | -| `disabled` | `false` | Disables the `Vagrant` module. | +| `disabled` | `false` | Disables the `vagrant` module. | ### Переменные @@ -2598,6 +2599,38 @@ The `vagrant` module shows the currently installed version of Vagrant. By defaul format = "via [⍱ $version](bold white) " ``` +## VCSH + +The `vcsh` module displays the current active VCSH repository. The module will be shown only if a repository is currently in use. + +### Опции + +| Параметр | По умолчанию | Описание | +| ---------- | -------------------------------- | ------------------------------------------------------ | +| `symbol` | | The symbol used before displaying the repository name. | +| `style` | `"bold yellow"` | Стиль модуля. | +| `format` | `"vcsh [$symbol$repo]($style) "` | Формат модуля. | +| `disabled` | `false` | Disables the `vcsh` module. | + +### Переменные + +| Переменная | Пример | Описание | +| ---------- | ------------------------------------------- | ------------------------------------ | +| repo | `dotfiles` if in a VCSH repo named dotfiles | The active repository name | +| symbol | | Отражает значение параметра `symbol` | +| style\* | `black bold dimmed` | Отражает значение параметра `style` | + +\*: This variable can only be used as a part of a style string + +### Пример + +```toml +# ~/.config/starship.toml + +[vcsh] +format = "[🆅 $repo](bold blue) " +``` + ## Zig By default the the `zig` module shows the currently installed version of Zig. The module will be shown if any of the following conditions are met: diff --git a/docs/ru-RU/faq/README.md b/docs/ru-RU/faq/README.md index f6f91a4ca..c47117490 100644 --- a/docs/ru-RU/faq/README.md +++ b/docs/ru-RU/faq/README.md @@ -92,5 +92,5 @@ If Starship was installed using the `curl | bash` script, the following command ```sh # Locate and delete the starship binary -rm "$(which starship)" +bash -c 'rm "$(which starship)"' ``` diff --git a/docs/ru-RU/guide/README.md b/docs/ru-RU/guide/README.md index a9418308d..e223d88e0 100644 --- a/docs/ru-RU/guide/README.md +++ b/docs/ru-RU/guide/README.md @@ -90,7 +90,7 @@ alt="简体中文" />   - Español   - Français   - ~/.config/starship.toml ``` All configuration for starship is done in this [TOML](https://github.com/toml-lang/toml) file: @@ -180,6 +180,7 @@ $hostname\ $shlvl\ $kubernetes\ $directory\ +$vcsh\ $git_branch\ $git_commit\ $git_state\ @@ -248,7 +249,7 @@ When using [awsu](https://github.com/kreuzwerker/awsu) the profile is read from | `symbol` | `"☁️ "` | The symbol used before displaying the current AWS profile. | | `region_aliases` | | Table of region aliases to display in addition to the AWS name. | | `style` | `"bold yellow"` | The style for the module. | -| `disabled` | `false` | Disables the `AWS` module. | +| `disabled` | `false` | Disables the `aws` module. | ### Variables @@ -310,25 +311,24 @@ The `battery` module shows how charged the device's battery is and its current c | Option | Default | Description | | -------------------- | --------------------------------- | --------------------------------------------------- | -| `full_symbol` | `""` | The symbol shown when the battery is full. | -| `charging_symbol` | `""` | The symbol shown when the battery is charging. | -| `discharging_symbol` | `""` | The symbol shown when the battery is discharging. | -| `unknown_symbol` | `""` | The symbol shown when the battery state is unknown. | -| `empty_symbol` | `""` | The symbol shown when the battery state is empty. | +| `full_symbol` | `" "` | The symbol shown when the battery is full. | +| `charging_symbol` | `" "` | The symbol shown when the battery is charging. | +| `discharging_symbol` | `" "` | The symbol shown when the battery is discharging. | +| `unknown_symbol` | `" "` | The symbol shown when the battery state is unknown. | +| `empty_symbol` | `" "` | The symbol shown when the battery state is empty. | | `format` | `"[$symbol$percentage]($style) "` | The format for the module. | | `display` | [link](#battery-display) | Display threshold and style for the module. | | `disabled` | `false` | Disables the `battery` module. | - ### Example ```toml # ~/.config/starship.toml [battery] -full_symbol = "🔋" -charging_symbol = "⚡️" -discharging_symbol = "💀" +full_symbol = "🔋 " +charging_symbol = "⚡️ " +discharging_symbol = "💀 " ``` ### Battery Display @@ -438,7 +438,7 @@ The `cmake` module shows the currently installed version of CMake. By default th | ------------------- | -------------------------------------- | -------------------------------------------- | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `symbol` | `"△ "` | The symbol used before the version of cmake. | -| `detect_extensions` | `[]` | Which extensions should trigger this moudle | +| `detect_extensions` | `[]` | Which extensions should trigger this module | | `detect_files` | `["CMakeLists.txt", "CMakeCache.txt"]` | Which filenames should trigger this module | | `detect_folders` | `[]` | Which folders should trigger this module | | `style` | `"bold blue"` | The style for the module. | @@ -595,7 +595,7 @@ The `dart` module shows the currently installed version of Dart. By default the | ------------------- | ------------------------------------------------- | ----------------------------------------------- | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `symbol` | `"🎯 "` | A format string representing the symbol of Dart | -| `detect_extensions` | `['dart']` | Which extensions should trigger this moudle. | +| `detect_extensions` | `['dart']` | Which extensions should trigger this module. | | `detect_files` | `["pubspec.yaml", "pubspec.yml", "pubspec.lock"]` | Which filenames should trigger this module. | | `detect_folders` | `[".dart_tool"]` | Which folders should trigger this module. | | `style` | `"bold blue"` | The style for the module. | @@ -745,7 +745,7 @@ The module will also show the Target Framework Moniker ( "` | The symbol used before displaying the version of PureScript. | -| `detect_extensions` | `["purs"]` | Which extensions should trigger this moudle. | +| `detect_extensions` | `["purs"]` | Which extensions should trigger this module. | | `detect_files` | `["spago.dhall"]` | Which filenames should trigger this module. | | `detect_folders` | `[]` | Which folders should trigger this module. | | `style` | `"bold white"` | The style for the module. | @@ -2034,13 +2038,13 @@ By default the module will be shown if any of the following conditions are met: | Option | Default | Description | | -------------------- | ------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------- | -| `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\))]($style)'` | The format for the module. | +| `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\) )]($style)'` | The format for the module. | | `symbol` | `"🐍 "` | A format string representing the symbol of Python | | `style` | `"yellow bold"` | The style for the 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"]` | Which extensions should trigger this moudle | +| `detect_extensions` | `[".py"]` | Which extensions should trigger this module | | `detect_files` | `[".python-version", "Pipfile", "__init__.py", "pyproject.toml", "requirements.txt", "setup.py", "tox.ini"]` | Which filenames should trigger this module | | `detect_folders` | `[]` | Which folders should trigger this module | | `disabled` | `false` | Disables the `python` module. | @@ -2063,7 +2067,6 @@ The default values and order for `python_binary` was chosen to first identify th | pyenv_prefix | `"pyenv "` | Mirrors the value of option `pyenv_prefix` | | virtualenv | `"venv"` | The current `virtualenv` name | - ### Example ```toml @@ -2167,7 +2170,6 @@ By default the `rust` module shows the currently installed version of Rust. The format = "via [⚙️ $version](red bold)" ``` - ## Scala The `scala` module shows the currently installed version of Scala. By default the module will be shown if any of the following conditions are met: @@ -2178,7 +2180,6 @@ The `scala` module shows the currently installed version of Scala. By default th ### Options - | Option | Default | Description | | ------------------- | ---------------------------------------- | ------------------------------------------------- | | `format` | `"via [${symbol}(${version} )]($style)"` | The format for the module. | @@ -2208,7 +2209,6 @@ The `scala` module shows the currently installed version of Scala. By default th symbol = "🌟 " ``` - ## Shell The `shell` module shows an indicator for currently used shell. @@ -2240,6 +2240,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y | indicator | | Mirrors the value of `indicator` for currently used shell. | ### Examples + ```toml # ~/.config/starship.toml @@ -2251,24 +2252,24 @@ disabled = false ## SHLVL -The `shlvl` module shows the current SHLVL ("shell level") environment variable, if it is set to a number and meets or exceeds the specified threshold. +The `shlvl` module shows the current `SHLVL` ("shell level") environment variable, if it is set to a number and meets or exceeds the specified threshold. ### Options -| Option | Default | Description | -| ----------- | ---------------------------- | ----------------------------------------------------------- | -| `threshold` | `2` | Display threshold. | -| `format` | `"[$symbol$shlvl]($style) "` | The format for the module. | -| `symbol` | `"↕️ "` | The symbol used to represent the SHLVL. | -| `repeat` | `false` | Causes `symbol` to be repeated by the current SHLVL amount. | -| `style` | `"bold yellow"` | The style for the module. | -| `disabled` | `true` | Disables the `shlvl` module. | +| Option | Default | Description | +| ----------- | ---------------------------- | ------------------------------------------------------------- | +| `threshold` | `2` | Display threshold. | +| `format` | `"[$symbol$shlvl]($style) "` | The format for the module. | +| `symbol` | `"↕️ "` | The symbol used to represent the `SHLVL`. | +| `repeat` | `false` | Causes `symbol` to be repeated by the current `SHLVL` amount. | +| `style` | `"bold yellow"` | The style for the module. | +| `disabled` | `true` | Disables the `shlvl` module. | ### Variables | Variable | Example | Description | | --------- | ------- | ------------------------------------ | -| shlvl | `3` | The current value of SHLVL | +| shlvl | `3` | The current value of `SHLVL` | | symbol | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | @@ -2387,7 +2388,7 @@ By default the `swift` module shows the currently installed version of Swift. Th | ------------------- | ------------------------------------ | ------------------------------------------------ | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `symbol` | `"🐦 "` | A format string representing the symbol of Swift | -| `detect_extensions` | `["swift"]` | Which extensions should trigger this moudle. | +| `detect_extensions` | `["swift"]` | Which extensions should trigger this module. | | `detect_files` | `["Package.swift"]` | Which filenames should trigger this module. | | `detect_folders` | `[]` | Which folders should trigger this module. | | `style` | `"bold 202"` | The style for the module. | @@ -2577,7 +2578,7 @@ The `vagrant` module shows the currently installed version of Vagrant. By defaul | `detect_files` | `["Vagrantfile"]` | Which filenames should trigger this module. | | `detect_folders` | `[]` | Which folders should trigger this module. | | `style` | `"cyan bold"` | The style for the module. | -| `disabled` | `false` | Disables the `Vagrant` module. | +| `disabled` | `false` | Disables the `vagrant` module. | ### Variables @@ -2598,6 +2599,38 @@ The `vagrant` module shows the currently installed version of Vagrant. By defaul format = "via [⍱ $version](bold white) " ``` +## VCSH + +The `vcsh` module displays the current active VCSH repository. The module will be shown only if a repository is currently in use. + +### Options + +| Option | Default | Description | +| ---------- | -------------------------------- | ------------------------------------------------------ | +| `symbol` | | The symbol used before displaying the repository name. | +| `style` | `"bold yellow"` | The style for the module. | +| `format` | `"vcsh [$symbol$repo]($style) "` | The format for the module. | +| `disabled` | `false` | Disables the `vcsh` module. | + +### Variables + +| Variable | Example | Description | +| --------- | ------------------------------------------- | ------------------------------------ | +| repo | `dotfiles` if in a VCSH repo named dotfiles | The active repository name | +| symbol | | Mirrors the value of option `symbol` | +| style\* | `black bold dimmed` | Mirrors the value of option `style` | + +\*: This variable can only be used as a part of a style string + +### Example + +```toml +# ~/.config/starship.toml + +[vcsh] +format = "[🆅 $repo](bold blue) " +``` + ## Zig By default the the `zig` module shows the currently installed version of Zig. The module will be shown if any of the following conditions are met: diff --git a/docs/tr-TR/faq/README.md b/docs/tr-TR/faq/README.md index d3c6d238c..f5c949629 100644 --- a/docs/tr-TR/faq/README.md +++ b/docs/tr-TR/faq/README.md @@ -92,5 +92,5 @@ If Starship was installed using the `curl | bash` script, the following command ```sh # Locate and delete the starship binary -rm "$(which starship)" +bash -c 'rm "$(which starship)"' ``` diff --git a/docs/tr-TR/guide/README.md b/docs/tr-TR/guide/README.md index fd107ff3c..7367fbf58 100644 --- a/docs/tr-TR/guide/README.md +++ b/docs/tr-TR/guide/README.md @@ -90,7 +90,7 @@ alt="简体中文" />   - Español   - Français   - ~/.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): @@ -180,6 +180,7 @@ $hostname\ $shlvl\ $kubernetes\ $directory\ +$vcsh\ $git_branch\ $git_commit\ $git_state\ @@ -248,7 +249,7 @@ When using [awsu](https://github.com/kreuzwerker/awsu) the profile is read from | `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. | | `style` | `"bold yellow"` | Kiểu cho module. | -| `disabled` | `false` | Vô hiệu `AWS` module. | +| `disabled` | `false` | Disables the `aws` module. | ### Các biến @@ -310,25 +311,24 @@ The `battery` module shows how charged the device's battery is and its current c | 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. | +| `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 = "💀" +full_symbol = "🔋 " +charging_symbol = "⚡️ " +discharging_symbol = "💀 " ``` ### Hiển thị pin @@ -434,15 +434,15 @@ The `cmake` module shows the currently installed version of CMake. By default th ### Các tuỳ chọn -| Tuỳ chọn | Mặc định | Mô tả | -| ------------------- | -------------------------------------- | -------------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | Định dạng cho module. | -| `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. | +| Tuỳ chọn | Mặc định | Mô tả | +| ------------------- | -------------------------------------- | ------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | Định dạng cho module. | +| `symbol` | `"△ "` | Kí hiệu sử dụng trước phiên bản của cmake. | +| `detect_extensions` | `[]` | Which extensions should trigger this module | +| `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 @@ -745,7 +745,7 @@ The module will also show the Target Framework Moniker (   - Tiếng Tây Ban Nha   - Thiếng Pháp   - ~/.config/starship.toml ``` Starship 的所有配置都在此 [TOML](https://github.com/toml-lang/toml) 配置文件中完成： @@ -180,6 +180,7 @@ $hostname\ $shlvl\ $kubernetes\ $directory\ +$vcsh\ $git_branch\ $git_commit\ $git_state\ @@ -242,13 +243,13 @@ When using [awsu](https://github.com/kreuzwerker/awsu) the profile is read from ### 配置项 -| Option | 默认值 | 描述 | -| ---------------- | --------------------------------------------------- | ------------------------- | -| `format` | `'on [$symbol($profile )(\($region\) )]($style)'` | 组件格式化模板。 | -| `symbol` | `"☁️ "` | 这个字段的内容会显示在当前 AWS 配置信息之前。 | -| `region_aliases` | | 地区缩写列表，用来显示在 AWS 主机名之后。 | -| `style` | `"bold yellow"` | 此组件的样式。 | -| `disabled` | `false` | 禁用 `AWS` 组件。 | +| Option | 默认值 | 描述 | +| ---------------- | --------------------------------------------------- | -------------------------- | +| `format` | `'on [$symbol($profile )(\($region\) )]($style)'` | 组件格式化模板。 | +| `symbol` | `"☁️ "` | 这个字段的内容会显示在当前 AWS 配置信息之前。 | +| `region_aliases` | | 地区缩写列表，用来显示在 AWS 主机名之后。 | +| `style` | `"bold yellow"` | 此组件的样式。 | +| `disabled` | `false` | Disables the `aws` module. | ### Variables @@ -310,25 +311,24 @@ The `battery` module shows how charged the device's battery is and its current c | Option | 默认值 | 描述 | | -------------------- | --------------------------------- | ---------------- | -| `full_symbol` | `""` | 显示于电池充满时。 | -| `charging_symbol` | `""` | 显示于正在充电时。 | -| `discharging_symbol` | `""` | 显示于电池放电时。 | -| `unknown_symbol` | `""` | 显示于电池状态未知时 | -| `empty_symbol` | `""` | 显示于电池状态为空时 | +| `full_symbol` | `" "` | 显示于电池充满时。 | +| `charging_symbol` | `" "` | 显示于正在充电时。 | +| `discharging_symbol` | `" "` | 显示于电池放电时。 | +| `unknown_symbol` | `" "` | 显示于电池状态未知时 | +| `empty_symbol` | `" "` | 显示于电池状态为空时 | | `format` | `"[$symbol$percentage]($style) "` | 组件格式化模板。 | | `display` | [见下文](#battery-display) | 电量显示阈值和样式。 | | `disabled` | `false` | 禁用 `battery` 组件。 | - ### 示例 ```toml # ~/.config/starship.toml [battery] -full_symbol = "🔋" -charging_symbol = "⚡️" -discharging_symbol = "💀" +full_symbol = "🔋 " +charging_symbol = "⚡️ " +discharging_symbol = "💀 " ``` ### Battery 组件的显示 @@ -438,7 +438,7 @@ The `cmake` module shows the currently installed version of CMake. By default th | ------------------- | -------------------------------------- | -------------------------------------------- | | `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 | | `symbol` | `"△ "` | The symbol used before the version of cmake. | -| `detect_extensions` | `[]` | Which extensions should trigger this moudle | +| `detect_extensions` | `[]` | Which extensions should trigger this module | | `detect_files` | `["CMakeLists.txt", "CMakeCache.txt"]` | Which filenames should trigger this module | | `detect_folders` | `[]` | Which folders should trigger this module | | `style` | `"bold blue"` | 此组件的样式。 | @@ -595,7 +595,7 @@ The `dart` module shows the currently installed version of Dart. By default the | ------------------- | ------------------------------------------------- | ----------------------------------------------- | | `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 | | `symbol` | `"🎯 "` | A format string representing the symbol of Dart | -| `detect_extensions` | `['dart']` | Which extensions should trigger this moudle. | +| `detect_extensions` | `['dart']` | Which extensions should trigger this module. | | `detect_files` | `["pubspec.yaml", "pubspec.yml", "pubspec.lock"]` | Which filenames should trigger this module. | | `detect_folders` | `[".dart_tool"]` | Which folders should trigger this module. | | `style` | `"bold blue"` | 此组件的样式。 | @@ -745,7 +745,7 @@ The module will also show the Target Framework Moniker ( "` | The symbol used before displaying the version of PureScript. | -| `detect_extensions` | `["purs"]` | Which extensions should trigger this moudle. | +| `detect_extensions` | `["purs"]` | Which extensions should trigger this module. | | `detect_files` | `["spago.dhall"]` | Which filenames should trigger this module. | | `detect_folders` | `[]` | Which folders should trigger this module. | | `style` | `"bold white"` | 此组件的样式。 | @@ -2034,13 +2038,13 @@ By default the module will be shown if any of the following conditions are met: | Option | 默认值 | 描述 | | -------------------- | ------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------- | -| `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\))]($style)'` | 组件格式化模板。 | +| `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\) )]($style)'` | 组件格式化模板。 | | `symbol` | `"🐍 "` | 用于表示Python的格式化字符串。 | | `style` | `"yellow bold"` | 此组件的样式。 | | `pyenv_version_name` | `false` | 使用 pyenv 获取 Python 版本 | | `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"]` | Which extensions should trigger this moudle | +| `detect_extensions` | `[".py"]` | Which extensions should trigger this module | | `detect_files` | `[".python-version", "Pipfile", "__init__.py", "pyproject.toml", "requirements.txt", "setup.py", "tox.ini"]` | Which filenames should trigger this module | | `detect_folders` | `[]` | Which folders should trigger this module | | `disabled` | `false` | Disables the `python` module. | @@ -2063,7 +2067,6 @@ The default values and order for `python_binary` was chosen to first identify th | pyenv_prefix | `"pyenv "` | Mirrors the value of option `pyenv_prefix` | | virtualenv | `"venv"` | 当前`virtualenv`名称 | - ### 示例 ```toml @@ -2167,7 +2170,6 @@ By default the `rust` module shows the currently installed version of Rust. The format = "via [⚙️ $version](red bold)" ``` - ## Scala The `scala` module shows the currently installed version of Scala. By default the module will be shown if any of the following conditions are met: @@ -2178,7 +2180,6 @@ The `scala` module shows the currently installed version of Scala. By default th ### 配置项 - | Option | 默认值 | 描述 | | ------------------- | ---------------------------------------- | ------------------------------------------------- | | `format` | `"via [${symbol}(${version} )]($style)"` | 组件格式化模板。 | @@ -2208,7 +2209,6 @@ The `scala` module shows the currently installed version of Scala. By default th symbol = "🌟 " ``` - ## Shell The `shell` module shows an indicator for currently used shell. @@ -2240,6 +2240,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y | indicator | | Mirrors the value of `indicator` for currently used shell. | ### Examples + ```toml # ~/.config/starship.toml @@ -2251,26 +2252,26 @@ disabled = false ## SHLVL -The `shlvl` module shows the current SHLVL ("shell level") environment variable, if it is set to a number and meets or exceeds the specified threshold. +The `shlvl` module shows the current `SHLVL` ("shell level") environment variable, if it is set to a number and meets or exceeds the specified threshold. ### 配置项 -| Option | 默认值 | 描述 | -| ----------- | ---------------------------- | ----------------------------------------------------------- | -| `threshold` | `2` | Display threshold. | -| `format` | `"[$symbol$shlvl]($style) "` | 组件格式化模板。 | -| `symbol` | `"↕️ "` | The symbol used to represent the SHLVL. | -| `repeat` | `false` | Causes `symbol` to be repeated by the current SHLVL amount. | -| `style` | `"bold yellow"` | 此组件的样式。 | -| `disabled` | `true` | Disables the `shlvl` module. | +| Option | 默认值 | 描述 | +| ----------- | ---------------------------- | ------------------------------------------------------------- | +| `threshold` | `2` | Display threshold. | +| `format` | `"[$symbol$shlvl]($style) "` | 组件格式化模板。 | +| `symbol` | `"↕️ "` | The symbol used to represent the `SHLVL`. | +| `repeat` | `false` | Causes `symbol` to be repeated by the current `SHLVL` amount. | +| `style` | `"bold yellow"` | 此组件的样式。 | +| `disabled` | `true` | Disables the `shlvl` module. | ### Variables -| 字段 | 示例 | 描述 | -| --------- | --- | -------------------------- | -| shlvl | `3` | The current value of SHLVL | -| symbol | | `symbol`对应值 | -| style\* | | `style`对应值 | +| 字段 | 示例 | 描述 | +| --------- | --- | ---------------------------- | +| shlvl | `3` | The current value of `SHLVL` | +| symbol | | `symbol`对应值 | +| style\* | | `style`对应值 | \*: This variable can only be used as a part of a style string @@ -2387,7 +2388,7 @@ By default the `swift` module shows the currently installed version of Swift. Th | ------------------- | ------------------------------------ | ------------------------------------------------ | | `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 | | `symbol` | `"🐦 "` | A format string representing the symbol of Swift | -| `detect_extensions` | `["swift"]` | Which extensions should trigger this moudle. | +| `detect_extensions` | `["swift"]` | Which extensions should trigger this module. | | `detect_files` | `["Package.swift"]` | Which filenames should trigger this module. | | `detect_folders` | `[]` | Which folders should trigger this module. | | `style` | `"bold 202"` | 此组件的样式。 | @@ -2577,7 +2578,7 @@ The `vagrant` module shows the currently installed version of Vagrant. By defaul | `detect_files` | `["Vagrantfile"]` | Which filenames should trigger this module. | | `detect_folders` | `[]` | Which folders should trigger this module. | | `style` | `"cyan bold"` | 此组件的样式。 | -| `disabled` | `false` | Disables the `Vagrant` module. | +| `disabled` | `false` | Disables the `vagrant` module. | ### Variables @@ -2598,6 +2599,38 @@ The `vagrant` module shows the currently installed version of Vagrant. By defaul format = "via [⍱ $version](bold white) " ``` +## VCSH + +The `vcsh` module displays the current active VCSH repository. The module will be shown only if a repository is currently in use. + +### 配置项 + +| Option | 默认值 | 描述 | +| ---------- | -------------------------------- | ------------------------------------------------------ | +| `symbol` | | The symbol used before displaying the repository name. | +| `style` | `"bold yellow"` | 此组件的样式。 | +| `format` | `"vcsh [$symbol$repo]($style) "` | 组件格式化模板。 | +| `disabled` | `false` | Disables the `vcsh` module. | + +### Variables + +| 字段 | 示例 | 描述 | +| --------- | ------------------------------------------- | -------------------------- | +| repo | `dotfiles` if in a VCSH repo named dotfiles | The active repository name | +| symbol | | `symbol`对应值 | +| style\* | `black bold dimmed` | `style`对应值 | + +\*: This variable can only be used as a part of a style string + +### 示例 + +```toml +# ~/.config/starship.toml + +[vcsh] +format = "[🆅 $repo](bold blue) " +``` + ## Zig By default the the `zig` module shows the currently installed version of Zig. The module will be shown if any of the following conditions are met: diff --git a/docs/zh-CN/faq/README.md b/docs/zh-CN/faq/README.md index ebb725144..59b1d0469 100644 --- a/docs/zh-CN/faq/README.md +++ b/docs/zh-CN/faq/README.md @@ -92,5 +92,5 @@ If Starship was installed using the `curl | bash` script, the following command ```sh # Locate and delete the starship binary -rm "$(which starship)" +bash -c 'rm "$(which starship)"' ``` diff --git a/docs/zh-CN/guide/README.md b/docs/zh-CN/guide/README.md index 73e60e3a9..ae65d08dd 100644 --- a/docs/zh-CN/guide/README.md +++ b/docs/zh-CN/guide/README.md @@ -90,7 +90,7 @@ alt="简体中文" />   - Español   - Français   - ~/.config/starship.toml ``` 所有關於 Starship 的設定都在這個 [TOML](https://github.com/toml-lang/toml) 檔案內： @@ -180,6 +180,7 @@ $hostname\ $shlvl\ $kubernetes\ $directory\ +$vcsh\ $git_branch\ $git_commit\ $git_state\ @@ -248,7 +249,7 @@ When using [awsu](https://github.com/kreuzwerker/awsu) the profile is read from | `symbol` | `"☁️ "` | 顯示在目前 AWS 配置之前的符號。 | | `region_aliases` | | 除了AWS名稱外，顯示區域別名表 | | `style` | `"bold yellow"` | 這個模組的風格。 | -| `disabled` | `false` | 停用 `AWS` 模組。 | +| `disabled` | `false` | Disables the `aws` module. | ### Variables @@ -310,25 +311,24 @@ The `battery` module shows how charged the device's battery is and its current c | Option | 預設 | 說明 | | -------------------- | --------------------------------- | -------------------------- | -| `full_symbol` | `""` | 當電池充飽時顯示的符號。 | -| `charging_symbol` | `""` | 當電池正在充電時顯示的符號。 | -| `discharging_symbol` | `""` | 當電池正在放電時顯示的符號。 | -| `unknown_symbol` | `""` | 當電池狀態不明時顯示的符號。 | -| `empty_symbol` | `""` | 當電池沒電時顯示的符號。 | +| `full_symbol` | `" "` | 當電池充飽時顯示的符號。 | +| `charging_symbol` | `" "` | 當電池正在充電時顯示的符號。 | +| `discharging_symbol` | `" "` | 當電池正在放電時顯示的符號。 | +| `unknown_symbol` | `" "` | 當電池狀態不明時顯示的符號。 | +| `empty_symbol` | `" "` | 當電池沒電時顯示的符號。 | | `format` | `"[$symbol$percentage]($style) "` | The format for the module. | | `display` | [連結](#battery-display) | 顯示的門檻與模組的風格。 | | `disabled` | `false` | 停用 `battery` 模組。 | - ### 範例 ```toml # ~/.config/starship.toml [battery] -full_symbol = "🔋" -charging_symbol = "⚡️" -discharging_symbol = "💀" +full_symbol = "🔋 " +charging_symbol = "⚡️ " +discharging_symbol = "💀 " ``` ### 電池顯示 @@ -438,7 +438,7 @@ The `cmake` module shows the currently installed version of CMake. By default th | ------------------- | -------------------------------------- | -------------------------------------------- | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `symbol` | `"△ "` | The symbol used before the version of cmake. | -| `detect_extensions` | `[]` | Which extensions should trigger this moudle | +| `detect_extensions` | `[]` | Which extensions should trigger this module | | `detect_files` | `["CMakeLists.txt", "CMakeCache.txt"]` | Which filenames should trigger this module | | `detect_folders` | `[]` | Which folders should trigger this module | | `style` | `"bold blue"` | 這個模組的風格。 | @@ -595,7 +595,7 @@ The `dart` module shows the currently installed version of Dart. By default the | ------------------- | ------------------------------------------------- | ----------------------------------------------- | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `symbol` | `"🎯 "` | A format string representing the symbol of Dart | -| `detect_extensions` | `['dart']` | Which extensions should trigger this moudle. | +| `detect_extensions` | `['dart']` | Which extensions should trigger this module. | | `detect_files` | `["pubspec.yaml", "pubspec.yml", "pubspec.lock"]` | Which filenames should trigger this module. | | `detect_folders` | `[".dart_tool"]` | Which folders should trigger this module. | | `style` | `"bold blue"` | 這個模組的風格。 | @@ -745,7 +745,7 @@ The module will also show the Target Framework Moniker ( "` | The symbol used before displaying the version of PureScript. | -| `detect_extensions` | `["purs"]` | Which extensions should trigger this moudle. | +| `detect_extensions` | `["purs"]` | Which extensions should trigger this module. | | `detect_files` | `["spago.dhall"]` | Which filenames should trigger this module. | | `detect_folders` | `[]` | Which folders should trigger this module. | | `style` | `"bold white"` | 這個模組的風格。 | @@ -2034,13 +2038,13 @@ By default the module will be shown if any of the following conditions are met: | Option | 預設 | 說明 | | -------------------- | ------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------- | -| `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\))]($style)'` | The format for the module. | +| `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\) )]($style)'` | The format for the module. | | `symbol` | `"🐍 "` | A format string representing the symbol of Python | | `style` | `"yellow bold"` | 這個模組的風格。 | | `pyenv_version_name` | `false` | 使用 pyenv 取得 Python 的版本。 | | `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"]` | Which extensions should trigger this moudle | +| `detect_extensions` | `[".py"]` | Which extensions should trigger this module | | `detect_files` | `[".python-version", "Pipfile", "__init__.py", "pyproject.toml", "requirements.txt", "setup.py", "tox.ini"]` | Which filenames should trigger this module | | `detect_folders` | `[]` | Which folders should trigger this module | | `disabled` | `false` | Disables the `python` module. | @@ -2063,7 +2067,6 @@ The default values and order for `python_binary` was chosen to first identify th | pyenv_prefix | `"pyenv "` | Mirrors the value of option `pyenv_prefix` | | virtualenv | `"venv"` | The current `virtualenv` name | - ### 範例 ```toml @@ -2167,7 +2170,6 @@ By default the `rust` module shows the currently installed version of Rust. The format = "via [⚙️ $version](red bold)" ``` - ## Scala The `scala` module shows the currently installed version of Scala. By default the module will be shown if any of the following conditions are met: @@ -2178,7 +2180,6 @@ The `scala` module shows the currently installed version of Scala. By default th ### 選項 - | Option | 預設 | 說明 | | ------------------- | ---------------------------------------- | ------------------------------------------------- | | `format` | `"via [${symbol}(${version} )]($style)"` | The format for the module. | @@ -2208,7 +2209,6 @@ The `scala` module shows the currently installed version of Scala. By default th symbol = "🌟 " ``` - ## Shell The `shell` module shows an indicator for currently used shell. @@ -2240,6 +2240,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y | indicator | | Mirrors the value of `indicator` for currently used shell. | ### Examples + ```toml # ~/.config/starship.toml @@ -2251,24 +2252,24 @@ disabled = false ## SHLVL -The `shlvl` module shows the current SHLVL ("shell level") environment variable, if it is set to a number and meets or exceeds the specified threshold. +The `shlvl` module shows the current `SHLVL` ("shell level") environment variable, if it is set to a number and meets or exceeds the specified threshold. ### 選項 -| Option | 預設 | 說明 | -| ----------- | ---------------------------- | ----------------------------------------------------------- | -| `threshold` | `2` | Display threshold. | -| `format` | `"[$symbol$shlvl]($style) "` | The format for the module. | -| `symbol` | `"↕️ "` | The symbol used to represent the SHLVL. | -| `repeat` | `false` | Causes `symbol` to be repeated by the current SHLVL amount. | -| `style` | `"bold yellow"` | 這個模組的風格。 | -| `disabled` | `true` | Disables the `shlvl` module. | +| Option | 預設 | 說明 | +| ----------- | ---------------------------- | ------------------------------------------------------------- | +| `threshold` | `2` | Display threshold. | +| `format` | `"[$symbol$shlvl]($style) "` | The format for the module. | +| `symbol` | `"↕️ "` | The symbol used to represent the `SHLVL`. | +| `repeat` | `false` | Causes `symbol` to be repeated by the current `SHLVL` amount. | +| `style` | `"bold yellow"` | 這個模組的風格。 | +| `disabled` | `true` | Disables the `shlvl` module. | ### Variables | 變數 | 範例 | 說明 | | --------- | --- | ------------------------------------ | -| shlvl | `3` | The current value of SHLVL | +| shlvl | `3` | The current value of `SHLVL` | | symbol | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | @@ -2387,7 +2388,7 @@ By default the `swift` module shows the currently installed version of Swift. Th | ------------------- | ------------------------------------ | ------------------------------------------------ | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `symbol` | `"🐦 "` | A format string representing the symbol of Swift | -| `detect_extensions` | `["swift"]` | Which extensions should trigger this moudle. | +| `detect_extensions` | `["swift"]` | Which extensions should trigger this module. | | `detect_files` | `["Package.swift"]` | Which filenames should trigger this module. | | `detect_folders` | `[]` | Which folders should trigger this module. | | `style` | `"bold 202"` | 這個模組的風格。 | @@ -2577,7 +2578,7 @@ The `vagrant` module shows the currently installed version of Vagrant. By defaul | `detect_files` | `["Vagrantfile"]` | Which filenames should trigger this module. | | `detect_folders` | `[]` | Which folders should trigger this module. | | `style` | `"cyan bold"` | 這個模組的風格。 | -| `disabled` | `false` | Disables the `Vagrant` module. | +| `disabled` | `false` | Disables the `vagrant` module. | ### Variables @@ -2598,6 +2599,38 @@ The `vagrant` module shows the currently installed version of Vagrant. By defaul format = "via [⍱ $version](bold white) " ``` +## VCSH + +The `vcsh` module displays the current active VCSH repository. The module will be shown only if a repository is currently in use. + +### 選項 + +| Option | 預設 | 說明 | +| ---------- | -------------------------------- | ------------------------------------------------------ | +| `symbol` | | The symbol used before displaying the repository name. | +| `style` | `"bold yellow"` | 這個模組的風格。 | +| `format` | `"vcsh [$symbol$repo]($style) "` | The format for the module. | +| `disabled` | `false` | Disables the `vcsh` module. | + +### Variables + +| 變數 | 範例 | 說明 | +| --------- | ------------------------------------------- | ------------------------------------ | +| repo | `dotfiles` if in a VCSH repo named dotfiles | The active repository name | +| symbol | | Mirrors the value of option `symbol` | +| style\* | `black bold dimmed` | Mirrors the value of option `style` | + +\*: This variable can only be used as a part of a style string + +### 範例 + +```toml +# ~/.config/starship.toml + +[vcsh] +format = "[🆅 $repo](bold blue) " +``` + ## Zig By default the the `zig` module shows the currently installed version of Zig. The module will be shown if any of the following conditions are met: diff --git a/docs/zh-TW/faq/README.md b/docs/zh-TW/faq/README.md index d3c6d238c..f5c949629 100644 --- a/docs/zh-TW/faq/README.md +++ b/docs/zh-TW/faq/README.md @@ -92,5 +92,5 @@ If Starship was installed using the `curl | bash` script, the following command ```sh # Locate and delete the starship binary -rm "$(which starship)" +bash -c 'rm "$(which starship)"' ``` diff --git a/docs/zh-TW/guide/README.md b/docs/zh-TW/guide/README.md index a5f629853..7542940f1 100644 --- a/docs/zh-TW/guide/README.md +++ b/docs/zh-TW/guide/README.md @@ -90,7 +90,7 @@ alt="简体中文" />   - Español   - Français   -