diff --git a/docs/ar-SA/config/README.md b/docs/ar-SA/config/README.md index 49d98bc4..61f8fcfd 100644 --- a/docs/ar-SA/config/README.md +++ b/docs/ar-SA/config/README.md @@ -1478,7 +1478,13 @@ symbol = "🌟 " ## Jobs -The `jobs` module shows the current number of jobs running. The module will be shown only if there are background jobs running. The module will show the number of jobs running if there is more than 1 job, or more than the `threshold` config value, if it exists. If `threshold` is set to 0, then the module will also show when there are 0 jobs running. +The `jobs` module shows the current number of jobs running. The module will be shown only if there are background jobs running. The module will show the number of jobs running if there are at least 2 jobs, or more than the `number_threshold` config value, if it exists. The module will show a symbol if there is at least 1 job, or more than the `symbol_threshold` config value, if it exists. You can set both values to 0 in order to *always* show the symbol and number of jobs, even if there are 0 jobs running. + +The default functionality is: + +- 0 jobs -> Nothing is shown. +- 1 job -> `symbol` is shown. +- 2 jobs or more -> `symbol` + `number` are shown. ::: warning @@ -1486,15 +1492,26 @@ This module is not supported on tcsh and nu. ::: +::: warning + +The `threshold` option is deprecated, but if you want to use it, the module will show the number of jobs running if there is more than 1 job, or more than the `threshold` config value, if it exists. If `threshold` is set to 0, then the module will also show when there are 0 jobs running. + +::: + ### Options -| Option | Default | Description | -| ----------- | ----------------------------- | ------------------------------------------------ | -| `threshold` | `1` | Show number of jobs if exceeded. | -| `format` | `"[$symbol$number]($style) "` | The format for the module. | -| `symbol` | `"✦"` | A format string representing the number of jobs. | -| `style` | `"bold blue"` | The style for the module. | -| `disabled` | `false` | Disables the `jobs` module. | +| Option | Default | Description | +| ------------------ | ----------------------------- | ------------------------------------------------------------------------ | +| `threshold`\* | `1` | Show number of jobs if exceeded. | +| `symbol_threshold` | `1` | Show `symbol` if the job count is at least `symbol_threshold`. | +| `number_threshold` | `2` | Show the number of jobs if the job count is at least `number_threshold`. | +| `format` | `"[$symbol$number]($style) "` | The format for the module. | +| `symbol` | `"✦"` | The string used to represent the `symbol` variable. | +| `style` | `"bold blue"` | The style for the module. | +| `disabled` | `false` | Disables the `jobs` module. | + \*: This option is deprecated, please use the + +`number_threshold` and `symbol_threshold` options instead. ### Variables @@ -1513,7 +1530,8 @@ This module is not supported on tcsh and nu. [jobs] symbol = "+ " -threshold = 4 +number_threshold = 4 +symbol_threshold = 0 ``` ## Julia @@ -2884,15 +2902,16 @@ The `vlang` module shows you your currently installed version of V. By default t ### Options -| Option | Default | Description | -| ------------------- | -------------------------------------------- | -------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `symbol` | `"V "` | A format string representing the symbol of V | -| `detect_extensions` | `["v"]` | Which extensions should trigger this module. | -| `detect_files` | `["v.mod", "vpkg.json", ".vpkg-lock.json" ]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `style` | `"blue bold"` | The style for the module. | -| `disabled` | `false` | Disables the `vlang` module. | +| Option | Default | Description | +| ------------------- | -------------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"V "` | A format string representing the symbol of V | +| `detect_extensions` | `["v"]` | Which extensions should trigger this module. | +| `detect_files` | `["v.mod", "vpkg.json", ".vpkg-lock.json" ]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `style` | `"blue bold"` | The style for the module. | +| `disabled` | `false` | Disables the `vlang` module. | ### Variables diff --git a/docs/ckb-IR/config/README.md b/docs/ckb-IR/config/README.md index 49d98bc4..61f8fcfd 100644 --- a/docs/ckb-IR/config/README.md +++ b/docs/ckb-IR/config/README.md @@ -1478,7 +1478,13 @@ symbol = "🌟 " ## Jobs -The `jobs` module shows the current number of jobs running. The module will be shown only if there are background jobs running. The module will show the number of jobs running if there is more than 1 job, or more than the `threshold` config value, if it exists. If `threshold` is set to 0, then the module will also show when there are 0 jobs running. +The `jobs` module shows the current number of jobs running. The module will be shown only if there are background jobs running. The module will show the number of jobs running if there are at least 2 jobs, or more than the `number_threshold` config value, if it exists. The module will show a symbol if there is at least 1 job, or more than the `symbol_threshold` config value, if it exists. You can set both values to 0 in order to *always* show the symbol and number of jobs, even if there are 0 jobs running. + +The default functionality is: + +- 0 jobs -> Nothing is shown. +- 1 job -> `symbol` is shown. +- 2 jobs or more -> `symbol` + `number` are shown. ::: warning @@ -1486,15 +1492,26 @@ This module is not supported on tcsh and nu. ::: +::: warning + +The `threshold` option is deprecated, but if you want to use it, the module will show the number of jobs running if there is more than 1 job, or more than the `threshold` config value, if it exists. If `threshold` is set to 0, then the module will also show when there are 0 jobs running. + +::: + ### Options -| Option | Default | Description | -| ----------- | ----------------------------- | ------------------------------------------------ | -| `threshold` | `1` | Show number of jobs if exceeded. | -| `format` | `"[$symbol$number]($style) "` | The format for the module. | -| `symbol` | `"✦"` | A format string representing the number of jobs. | -| `style` | `"bold blue"` | The style for the module. | -| `disabled` | `false` | Disables the `jobs` module. | +| Option | Default | Description | +| ------------------ | ----------------------------- | ------------------------------------------------------------------------ | +| `threshold`\* | `1` | Show number of jobs if exceeded. | +| `symbol_threshold` | `1` | Show `symbol` if the job count is at least `symbol_threshold`. | +| `number_threshold` | `2` | Show the number of jobs if the job count is at least `number_threshold`. | +| `format` | `"[$symbol$number]($style) "` | The format for the module. | +| `symbol` | `"✦"` | The string used to represent the `symbol` variable. | +| `style` | `"bold blue"` | The style for the module. | +| `disabled` | `false` | Disables the `jobs` module. | + \*: This option is deprecated, please use the + +`number_threshold` and `symbol_threshold` options instead. ### Variables @@ -1513,7 +1530,8 @@ This module is not supported on tcsh and nu. [jobs] symbol = "+ " -threshold = 4 +number_threshold = 4 +symbol_threshold = 0 ``` ## Julia @@ -2884,15 +2902,16 @@ The `vlang` module shows you your currently installed version of V. By default t ### Options -| Option | Default | Description | -| ------------------- | -------------------------------------------- | -------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `symbol` | `"V "` | A format string representing the symbol of V | -| `detect_extensions` | `["v"]` | Which extensions should trigger this module. | -| `detect_files` | `["v.mod", "vpkg.json", ".vpkg-lock.json" ]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `style` | `"blue bold"` | The style for the module. | -| `disabled` | `false` | Disables the `vlang` module. | +| Option | Default | Description | +| ------------------- | -------------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"V "` | A format string representing the symbol of V | +| `detect_extensions` | `["v"]` | Which extensions should trigger this module. | +| `detect_files` | `["v.mod", "vpkg.json", ".vpkg-lock.json" ]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `style` | `"blue bold"` | The style for the module. | +| `disabled` | `false` | Disables the `vlang` module. | ### Variables diff --git a/docs/de-DE/README.md b/docs/de-DE/README.md index ea6c18c8..7d44bcf0 100644 --- a/docs/de-DE/README.md +++ b/docs/de-DE/README.md @@ -11,14 +11,14 @@ features: details: Läuft mit den beliebtesten Shells auf den beliebtesten Betriebssystemen. Überall einsetzbar! - title: Rust-Powered - details: Bringt die schnelligkeit und zuverlässigkeit von Rust in deinen Shell-prompt. + details: Bringt die Schnelligkeit und Zuverlässigkeit von Rust in deine Shell-Prompt. - title: Individualisierbar details: Jedes noch so kleine Detail kann nach Deinen Wünschen angepasst werden, um die Eingabeaufforderung so minimal oder funktionsreich zu gestalten, wie Du es möchtest. footer: ICS lizenziert | Copyright © 2019-heute Starship-Mitwirkende #Used for the description meta tag, for SEO metaTitle: "Starship: Cross-Shell Prompt" -description: Starship ist eine minimale, super schnelle, und extrem anpassbare Prompt für jede Shell! Shows the information you need, while staying sleek and minimal. Quick installation available for Bash, Fish, ZSH, Ion, Tcsh, Elvish, Nu, Xonsh, and PowerShell. +description: Starship ist eine minimale, super schnelle, und extrem anpassbare Prompt für jede Shell! Sie zeigt die Information, die man benötigt an, während sie schnell und minimal bleibt. Schnell-Installation verfügbar für Bash, Fish, ZSH, Ion, Tcsh, Elvish, Nu, Xonsh, und PowerShell. ---
@@ -30,7 +30,7 @@ description: Starship ist eine minimale, super schnelle, und extrem anpassbare P ### Voraussetzungen -- A [Nerd Font](https://www.nerdfonts.com/) installed and enabled in your terminal. +- Eine [Nerd Font](https://www.nerdfonts.com/) installiert und aktiviert in Ihrem Terminal. ### Schnellinstallation @@ -44,7 +44,7 @@ description: Starship ist eine minimale, super schnelle, und extrem anpassbare P ```sh sh -c "$(curl -fsSL https://starship.rs/install.sh)" ``` - To update the Starship itself, rerun the above script. It will replace the current version without touching Starship's configuration. + Um Starship selbst zu aktualisieren, lasse das Skript oben nochmal laufen. Es wird die vorhandene Version ersetzen, ohne die Konfiguration von Starship zu berühren. #### Installation mithilfe eines Paket-Managers @@ -99,7 +99,7 @@ description: Starship ist eine minimale, super schnelle, und extrem anpassbare P #### Powershell - Add the following to the end of `Microsoft.PowerShell_profile.ps1`. You can check the location of this file by querying the `$PROFILE` variable in PowerShell. Typically the path is `~\Documents\PowerShell\Microsoft.PowerShell_profile.ps1` or `~/.config/powershell/Microsoft.PowerShell_profile.ps1` on -Nix. + Füge das folgende zum Ende von `Microsoft.PowerShell_profile.ps1` hinzu. Sie können den Speicherort dieser Datei überprüfen, indem Sie die `$PROFILE` Variable in PowerShell abfragen. Normalerweise ist der Pfad `~\Documents\PowerShell\Microsoft.PowerShell_profile.ps1` oder `~/.config/powershell/Microsoft.PowerShell_profile.ps1` auf -Nix. ```sh Invoke-Expression (&starship init powershell) @@ -119,9 +119,9 @@ description: Starship ist eine minimale, super schnelle, und extrem anpassbare P #### Elvish - ::: warning Only elvish v0.15 or higher is supported. ::: + ::: warning Nur elvish v0.15 oder höher ist unterstützt. ::: - Add the following to the end of `~/.elvish/rc.elv`: + Trage folgendes am Ende von `~/.config/fish/rc.elv` ein: ```sh # ~/.elvish/rc.elv @@ -132,7 +132,7 @@ description: Starship ist eine minimale, super schnelle, und extrem anpassbare P #### Tcsh - Add the following to the end of `~/.tcshrc`: + Trage folgendes am Ende von `~/.bashrc` ein: ```sh # ~/.tcshrc diff --git a/docs/de-DE/config/README.md b/docs/de-DE/config/README.md index 05d70733..4a8100bf 100644 --- a/docs/de-DE/config/README.md +++ b/docs/de-DE/config/README.md @@ -1478,7 +1478,13 @@ symbol = "🌟 " ## Jobs -The `jobs` module shows the current number of jobs running. The module will be shown only if there are background jobs running. The module will show the number of jobs running if there is more than 1 job, or more than the `threshold` config value, if it exists. If `threshold` is set to 0, then the module will also show when there are 0 jobs running. +The `jobs` module shows the current number of jobs running. The module will be shown only if there are background jobs running. The module will show the number of jobs running if there are at least 2 jobs, or more than the `number_threshold` config value, if it exists. The module will show a symbol if there is at least 1 job, or more than the `symbol_threshold` config value, if it exists. You can set both values to 0 in order to *always* show the symbol and number of jobs, even if there are 0 jobs running. + +The default functionality is: + +- 0 jobs -> Nothing is shown. +- 1 job -> `symbol` is shown. +- 2 jobs or more -> `symbol` + `number` are shown. ::: Warnung @@ -1486,15 +1492,26 @@ This module is not supported on tcsh and nu. ::: +::: Warnung + +The `threshold` option is deprecated, but if you want to use it, the module will show the number of jobs running if there is more than 1 job, or more than the `threshold` config value, if it exists. If `threshold` is set to 0, then the module will also show when there are 0 jobs running. + +::: + ### Optionen -| Option | Standardwert | Beschreibung | -| ----------- | ----------------------------- | -------------------------------------------------------------------------------- | -| `threshold` | `1` | Zeigt die Anzahl der Jobs wenn der angegebene Schwellenwert überschritten wurde. | -| `format` | `"[$symbol$number]($style) "` | The format for the module. | -| `symbol` | `"✦"` | A format string representing the number of jobs. | -| `style` | `"bold blue"` | Stil für dieses Modul. | -| `disabled` | `false` | Deaktiviert das `jobs`-Modul. | +| Option | Standardwert | Beschreibung | +| ------------------ | ----------------------------- | -------------------------------------------------------------------------------- | +| `threshold`\* | `1` | Zeigt die Anzahl der Jobs wenn der angegebene Schwellenwert überschritten wurde. | +| `symbol_threshold` | `1` | Show `symbol` if the job count is at least `symbol_threshold`. | +| `number_threshold` | `2` | Show the number of jobs if the job count is at least `number_threshold`. | +| `format` | `"[$symbol$number]($style) "` | The format for the module. | +| `symbol` | `"✦"` | The string used to represent the `symbol` variable. | +| `style` | `"bold blue"` | Stil für dieses Modul. | +| `disabled` | `false` | Disables the `jobs` module. | + \*: This option is deprecated, please use the + +`number_threshold` and `symbol_threshold` options instead. ### Variables @@ -1513,7 +1530,8 @@ This module is not supported on tcsh and nu. [jobs] symbol = "+ " -threshold = 4 +number_threshold = 4 +symbol_threshold = 0 ``` ## Julia @@ -1816,7 +1834,7 @@ truncation_symbol = "" The `nim` module shows the currently installed version of [Nim](https://nim-lang.org/). By default the module will be shown if any of the following conditions are met: -- Das aktuelle Verzeichnis enthält eine `nim.cfg`-Datei +- The current directory contains a `nim.cfg` file - The current directory contains a file with the `.nim` extension - The current directory contains a file with the `.nims` extension - The current directory contains a file with the `.nimble` extension @@ -1896,10 +1914,10 @@ format = 'via [☃️ $state( \($name\))](bold blue) ' The `nodejs` module shows the currently installed version of [Node.js](https://nodejs.org/). By default the module will be shown if any of the following conditions are met: -- Das aktuelle Verzeichnis enthält eine `package.json`-Datei +- The current directory contains a `package.json` file - The current directory contains a `.node-version` file - The current directory contains a `.nvmrc` file -- Das aktuelle Verzeichnis enthält ein `node_modules`-Verzeichnis +- The current directory contains a `node_modules` directory - The current directory contains a file with the `.js`, `.mjs` or `.cjs` extension - The current directory contains a file with the `.ts` extension @@ -2112,7 +2130,7 @@ format = "via [🦪 $version]($style) " The `php` module shows the currently installed version of [PHP](https://www.php.net/). By default the module will be shown if any of the following conditions are met: -- Das aktuelle Verzeichnis enthält eine `composer.json`-Datei +- The current directory contains a `composer.json` file - The current directory contains a `.php-version` file - The current directory contains a `.php` extension @@ -2152,7 +2170,7 @@ format = "via [🔹 $version](147 bold) " The `purescript` module shows the currently installed version of [PureScript](https://www.purescript.org/) version. By default the module will be shown if any of the following conditions are met: -- Das aktuelle Verzeichnis enthält eine `spago.dhall`-Datei +- The current directory contains a `spago.dhall` file - The current directory contains a file with the `.purs` extension ### Optionen @@ -2195,15 +2213,15 @@ If `pyenv_version_name` is set to `true`, it will display the pyenv version name By default the module will be shown if any of the following conditions are met: -- Das aktuelle Verzeichnis enthält eine `.python-version`-Datei -- Das aktuelle Verzeichnis enthält eine `Pipfile`-Datei +- The current directory contains a `.python-version` file +- The current directory contains a `Pipfile` file - The current directory contains a `__init__.py` file -- Das aktuelle Verzeichnis enthält eine `pyproject.toml`-Datei -- Das aktuelle Verzeichnis enthält eine `requirements.txt`-Datei -- Das aktuelle Verzeichnis enthält eine `setup.py`-Datei -- Das aktuelle Verzeichnis enthält eine `tox.ini`-Datei -- Das aktuelle Verzeichnis enthält eine Datei mit der `.py`-Erweiterung. -- Ein virtualenv ist momentan aktiv +- The current directory contains a `pyproject.toml` file +- The current directory contains a `requirements.txt` file +- The current directory contains a `setup.py` file +- The current directory contains a `tox.ini` file +- The current directory contains a file with the `.py` extension. +- A virtual environment is currently activated ### Optionen @@ -2360,9 +2378,9 @@ symbol = "🔴 " By default the `ruby` module shows the currently installed version of [Ruby](https://www.ruby-lang.org/). The module will be shown if any of the following conditions are met: -- Das aktuelle Verzeichnis enthält eine `Gemfile`-Datei +- The current directory contains a `Gemfile` file - The current directory contains a `.ruby-version` file -- Das aktuelle Verzeichnis enthält eine `.rb`-Datei +- The current directory contains a `.rb` file ### Optionen @@ -2400,8 +2418,8 @@ symbol = "🔺 " By default the `rust` module shows the currently installed version of [Rust](https://www.rust-lang.org/). The module will be shown if any of the following conditions are met: -- Das aktuelle Verzeichnis enthält eine `Cargo.toml`-Datei -- Das aktuelle Verzeichnis enthält eine Datei mit der `.rs`-Erweiterung +- The current directory contains a `Cargo.toml` file +- The current directory contains a file with the `.rs` extension ### Optionen @@ -2700,7 +2718,7 @@ By default the Terraform version is not shown, since this is slow for current ve By default the module will be shown if any of the following conditions are met: -- Das aktuelle Verzeichnis enthält eine `.terraform`-Datei +- The current directory contains a `.terraform` folder - Current directory contains a file with the `.tf` or `.hcl` extensions ### Optionen @@ -2797,10 +2815,10 @@ time_range = "10:00:00-14:00:00" The `username` module shows active user's username. The module will be shown if any of the following conditions are met: -- Der aktuelle Benutzer ist root -- Der aktuelle Benutzer ist nicht derjenige, der derzeit angemeldet ist -- Der Benutzer ist über eine SSH-Sitzung verbunden -- Die Variale `show_always` ist auf `true` gesetzt +- The current user is root +- The current user isn't the same as the one that is logged in +- The user is currently connected as an SSH session +- The variable `show_always` is set to true ::: Tipp @@ -2884,15 +2902,16 @@ The `vlang` module shows you your currently installed version of V. By default t ### Optionen -| Option | Standardwert | Beschreibung | -| ------------------- | -------------------------------------------- | -------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `symbol` | `"V "` | A format string representing the symbol of V | -| `detect_extensions` | `["v"]` | Which extensions should trigger this module. | -| `detect_files` | `["v.mod", "vpkg.json", ".vpkg-lock.json" ]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `style` | `"blue bold"` | Stil für dieses Modul. | -| `disabled` | `false` | Disables the `vlang` module. | +| Option | Standardwert | Beschreibung | +| ------------------- | -------------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"V "` | A format string representing the symbol of V | +| `detect_extensions` | `["v"]` | Which extensions should trigger this module. | +| `detect_files` | `["v.mod", "vpkg.json", ".vpkg-lock.json" ]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `style` | `"blue bold"` | Stil für dieses Modul. | +| `disabled` | `false` | Disables the `vlang` module. | ### Variables diff --git a/docs/de-DE/faq/README.md b/docs/de-DE/faq/README.md index ca08a406..2f9b0665 100644 --- a/docs/de-DE/faq/README.md +++ b/docs/de-DE/faq/README.md @@ -5,7 +5,7 @@ - **Terminal Emulator**: [iTerm2](https://iterm2.com/) - **Theme**: Minimal - **Farbschema**: [Snazzy](https://github.com/sindresorhus/iterm2-snazzy) - - **Font**: [FiraCode Nerd Font](https://www.nerdfonts.com/font-downloads) + - **Schriftart**: [FiraCode Nerd Font](https://www.nerdfonts.com/font-downloads) - **Shell**: [Fish Shell](https://fishshell.com/) - **Konfiguration**: [Matchai's Dotfiles](https://github.com/matchai/dotfiles/blob/b6c6a701d0af8d145a8370288c00bb9f0648b5c2/.config/fish/config.fish) - **Prompt**: [Starship](https://starship.rs/) @@ -79,7 +79,7 @@ The first line should produce a [snake emoji](https://emojipedia.org/snake/), wh If either symbol fails to display correctly, your system is still misconfigured. Unfortunately, getting font configuration correct is sometimes difficult. Users on the Discord may be able to help. If both symbols display correctly, but you still don't see them in starship, [file a bug report!](https://github.com/starship/starship/issues/new/choose) -## How do I uninstall Starship? +## Wie deinstalliere ich Starship? Starship is just as easy to uninstall as it is to install in the first place. @@ -88,9 +88,9 @@ Starship is just as easy to uninstall as it is to install in the first place. If Starship was installed using a package manager, please refer to their docs for uninstallation instructions. -Wenn Starship mittels Script installiert wurde, der folgende Befehl entfernt Starship: +Wenn Starship mit Hilfe des Installationsscripts installiert wurde, entfernt der folgende Befehl Starship: ```sh -# Locate and delete the starship binary +# Starship binary suchen und löschen sh -c 'rm "$(which starship)"' ``` diff --git a/docs/de-DE/guide/README.md b/docs/de-DE/guide/README.md index 506cea67..f5e63db7 100644 --- a/docs/de-DE/guide/README.md +++ b/docs/de-DE/guide/README.md @@ -224,7 +224,7 @@ #### PowerShell - Add the following to the end of `Microsoft.PowerShell_profile.ps1`. You can check the location of this file by querying the `$PROFILE` variable in PowerShell. Typically the path is `~\Documents\PowerShell\Microsoft.PowerShell_profile.ps1` or `~/.config/powershell/Microsoft.PowerShell_profile.ps1` on -Nix. + Füge das folgende zum Ende von `Microsoft.PowerShell_profile.ps1` hinzu. Sie können den Speicherort dieser Datei überprüfen, indem Sie die `$PROFILE` Variable in PowerShell abfragen. Typically the path is `~\Documents\PowerShell\Microsoft.PowerShell_profile.ps1` or `~/.config/powershell/Microsoft.PowerShell_profile.ps1` on -Nix. ```powershell Invoke-Expression (&starship init powershell) diff --git a/docs/de-DE/installing/README.md b/docs/de-DE/installing/README.md index 43ea1775..1ffd1201 100644 --- a/docs/de-DE/installing/README.md +++ b/docs/de-DE/installing/README.md @@ -1,19 +1,19 @@ -# 🚀 Advanced Installation +# 🚀 Erweiterte Installation -Um starship zu installieren, musst du zwei Dinge tun: +Um Starship zu installieren, musst du zwei Dinge tun: 1. Holen Sie sich das **starship** Binary auf Ihren Computer -1. Tell your shell to use the starship binary as its prompt by modifying its init scripts +1. Sagen Sie ihrer Shell, dass sie das Starship-Binary als Prompt benutzt, indem sie die Initialisierungs-Skripte ändern -For most users, the instructions on [the main page](/guide/#🚀-installation) will work great. However, for some more specialized platforms, different instructions are needed. +Die Anweisungen auf [der Hauptseite](/guide/#🚀-installation) werden für die meisten Benutzer gut funktionieren. Für einige speziellere Plattformen werden jedoch andere Anweisungen benötigt. -There are so many platforms out there that they didn't fit into the main README.md file, so here are some installation instructions for other platforms from the community. Is yours not here? Please do add it here if you figure it out! +Es gibt so viele Plattformen, dass sie nicht in das Haupt-README passen, also hier einige Installationsanweisungen für andere Plattformen von der Community. Ist Ihre nicht hier? Bitte fügen Sie es hier hinzu, wenn Sie es herausfinden! ## [Chocolatey](https://chocolatey.org) ### Voraussetzungen -Head over to the [Chocolatey installation page](https://chocolatey.org/install) and follow the instructions to install Chocolatey. +Gehen Sie zur [Chocolatey's Installations-Seite](https://chocolatey.org/install) und folge den Anweisungen um Chocolatey zu installieren. ### Installation @@ -37,17 +37,17 @@ sh -c "$(curl -fsSL https://starship.rs/install.sh)" -- --bin-dir /data/data/com ## [Nix](https://nixos.wiki/wiki/Nix) -### Getting the Binary +### Das Binary holen -#### Imperatively +#### Imperativ ```sh nix-env -iA nixos.starship ``` -#### Declarative, single user, via [home-manager](https://github.com/nix-community/home-manager) +#### Deklarativ, Einzel-Benutzer, über [home-manager](https://github.com/nix-community/home-manager) -Enable the `programs.starship` module in your `home.nix` file, and add your settings +Aktivieren Sie das Modul `programs.starship` in Ihrer `home.nix`-Datei und fügen Sie Ihre Einstellungen hinzu ```nix { @@ -69,15 +69,15 @@ Enable the `programs.starship` module in your `home.nix` file, and add your sett } ``` -then run +und führen Sie dann folgendes aus ```sh home-manager switch ``` -#### Declarative, system-wide, with NixOS +#### Deklarativ, systemweit, mit NixOS -Add `pkgs.starship` to `environment.systemPackages` in your `configuration.nix`, then run +Fügen Sie `pkgs.starship` zu `environment.systemPackages` in Ihrer `configuration.nix` hinzu, und führen Sie folgendes aus ```sh sudo nixos-rebuild switch diff --git a/docs/es-ES/config/README.md b/docs/es-ES/config/README.md index 7445f4b7..16f7b871 100644 --- a/docs/es-ES/config/README.md +++ b/docs/es-ES/config/README.md @@ -1477,7 +1477,13 @@ symbol = "🌟 " ## Jobs -The `jobs` module shows the current number of jobs running. The module will be shown only if there are background jobs running. The module will show the number of jobs running if there is more than 1 job, or more than the `threshold` config value, if it exists. If `threshold` is set to 0, then the module will also show when there are 0 jobs running. +The `jobs` module shows the current number of jobs running. The module will be shown only if there are background jobs running. The module will show the number of jobs running if there are at least 2 jobs, or more than the `number_threshold` config value, if it exists. The module will show a symbol if there is at least 1 job, or more than the `symbol_threshold` config value, if it exists. You can set both values to 0 in order to *always* show the symbol and number of jobs, even if there are 0 jobs running. + +The default functionality is: + +- 0 jobs -> Nothing is shown. +- 1 job -> `symbol` is shown. +- 2 jobs or more -> `symbol` + `number` are shown. ::: aviso @@ -1485,15 +1491,26 @@ This module is not supported on tcsh and nu. ::: +::: aviso + +The `threshold` option is deprecated, but if you want to use it, the module will show the number of jobs running if there is more than 1 job, or more than the `threshold` config value, if it exists. If `threshold` is set to 0, then the module will also show when there are 0 jobs running. + +::: + ### Opciones -| Opción | Por defecto | Descripción | -| ----------- | ----------------------------- | --------------------------------------------------------- | -| `threshold` | `1` | Muestra el número de tareas si se exceden. | -| `format` | `"[$symbol$number]($style) "` | El formato del módulo. | -| `symbol` | `"✦"` | Una cadena de formato que representa el número de tareas. | -| `style` | `"bold blue"` | El estilo del módulo. | -| `disabled` | `false` | Desactiva el módulo `jobs`. | +| Opción | Por defecto | Descripción | +| ------------------ | ----------------------------- | ------------------------------------------------------------------------ | +| `threshold`\* | `1` | Muestra el número de tareas si se exceden. | +| `symbol_threshold` | `1` | Show `symbol` if the job count is at least `symbol_threshold`. | +| `number_threshold` | `2` | Show the number of jobs if the job count is at least `number_threshold`. | +| `format` | `"[$symbol$number]($style) "` | El formato del módulo. | +| `symbol` | `"✦"` | The string used to represent the `symbol` variable. | +| `style` | `"bold blue"` | El estilo del módulo. | +| `disabled` | `false` | Disables the `jobs` module. | + \*: This option is deprecated, please use the + +`number_threshold` and `symbol_threshold` options instead. ### Variables @@ -1512,16 +1529,17 @@ This module is not supported on tcsh and nu. [jobs] symbol = "+ " -threshold = 4 +number_threshold = 4 +symbol_threshold = 0 ``` ## Julia The `julia` module shows the currently installed version of [Julia](https://julialang.org/). Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: -- El directorio actual contiene un archivo `Project.toml` -- El directorio actual contiene un archivo `Manifest.toml` -- El directorio actual contiene un archivo con la extensión `.jl` +- The current directory contains a `Project.toml` file +- The current directory contains a `Manifest.toml` file +- The current directory contains a file with the `.jl` extension ### Opciones @@ -1559,7 +1577,7 @@ symbol = "∴ " The `kotlin` module shows the currently installed version of [Kotlin](https://kotlinlang.org/). Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: -- El directorio actual contiene un archivo `.kt` o `.kts` +- The current directory contains a `.kt` or a `.kts` file ### Opciones @@ -1691,9 +1709,9 @@ disabled = true The `lua` module shows the currently installed version of [Lua](http://www.lua.org/). Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: -- El directorio actual contiene un archivo `.lua-version` -- El directorio actual contiene un directorio `lua` -- El directorio actual contiene un archivo con la extensión `.lua` +- The current directory contains a `.lua-version` file +- The current directory contains a `lua` directory +- The current directory contains a file with the `.lua` extension ### Opciones @@ -1815,10 +1833,10 @@ truncation_symbol = "" The `nim` module shows the currently installed version of [Nim](https://nim-lang.org/). Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: -- El directorio actual contiene un archivo `nim.cfg` -- El directorio actual contiene un archivo con la extensión `.nim` -- El directorio actual contiene un archivo con la extensión `.nims` -- El directorio actual contiene un archivo con la extensión `.nimble` +- The current directory contains a `nim.cfg` file +- The current directory contains a file with the `.nim` extension +- The current directory contains a file with the `.nims` extension +- The current directory contains a file with the `.nimble` extension ### Opciones @@ -1895,12 +1913,12 @@ format = 'via [☃️ $state( \($name\))](bold blue) ' The `nodejs` module shows the currently installed version of [Node.js](https://nodejs.org/). Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: -- El directorio actual contiene un archivo `package.json` -- El directorio actual contiene un archivo `.node-version` +- The current directory contains a `package.json` file +- The current directory contains a `.node-version` file - The current directory contains a `.nvmrc` file -- El directorio actual contiene un directorio `node_modules` -- El directorio actual contiene un archivo con la extensión `.js`, `.mjs` o `.cjs` -- El directorio actual contiene un archivo con la extensión `.ts` +- The current directory contains a `node_modules` directory +- The current directory contains a file with the `.js`, `.mjs` or `.cjs` extension +- The current directory contains a file with the `.ts` extension ### Opciones @@ -1939,12 +1957,12 @@ format = "via [🤖 $version](bold green) " The `ocaml` module shows the currently installed version of [OCaml](https://ocaml.org/). Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: -- El directorio actual contiene un archivo con extensión `.opam` o directorio `_opam` -- El directorio actual contiene un directorio `esy.lock` -- El directorio actual contiene un archivo `dune` o `dune-project` -- El directorio actual contiene un archivo `jbuild` o `jbuild-ignore` -- El directorio actual contiene un archivo `.merlin` -- El directorio actual contiene un archivo con la extensión `.ml`, `.mli`, `.re` o `.rei` +- The current directory contains a file with `.opam` extension or `_opam` directory +- The current directory contains a `esy.lock` directory +- The current directory contains a `dune` or `dune-project` file +- The current directory contains a `jbuild` or `jbuild-ignore` file +- The current directory contains a `.merlin` file +- The current directory contains a file with `.ml`, `.mli`, `.re` or `.rei` extension ### Opciones @@ -2071,11 +2089,11 @@ format = "via [🎁 $version](208 bold) " The `perl` module shows the currently installed version of [Perl](https://www.perl.org/). Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: -- El directorio actual contiene un archivo `Makefile.PL` o `Build.PL` -- El directorio actual contiene un archivo `cpanfile` o `cpanfile.snapshot` -- El directorio actual contiene un archivo `META.json` o `META.yml` -- El directorio actual contiene un archivo `.perl-version` -- El directorio actual contiene un `.pl`, `.pm` o `.pod` +- The current directory contains a `Makefile.PL` or `Build.PL` file +- The current directory contains a `cpanfile` or `cpanfile.snapshot` file +- The current directory contains a `META.json` file or `META.yml` file +- The current directory contains a `.perl-version` file +- The current directory contains a `.pl`, `.pm` or `.pod` ### Opciones @@ -2111,9 +2129,9 @@ format = "via [🦪 $version]($style) " The `php` module shows the currently installed version of [PHP](https://www.php.net/). Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: -- El directorio actual contiene un archivo `composer.json` -- El directorio actual contiene un archivo `.php-version` -- El directorio actual contiene una extensión `.php` +- The current directory contains a `composer.json` file +- The current directory contains a `.php-version` file +- The current directory contains a `.php` extension ### Opciones @@ -2151,8 +2169,8 @@ format = "via [🔹 $version](147 bold) " The `purescript` module shows the currently installed version of [PureScript](https://www.purescript.org/) version. Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: -- El directorio actual contiene un archivo `spago.dhall` -- El directorio actual contiene un archivo con la extensión `.purs` +- The current directory contains a `spago.dhall` file +- The current directory contains a file with the `.purs` extension ### Opciones @@ -2194,15 +2212,15 @@ If `pyenv_version_name` is set to `true`, it will display the pyenv version name Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: -- El directorio actual contiene un archivo `.python-version` -- El directorio actual contiene un archivo `Pipfile` -- El directorio actual contiene un archivo `__init__.py` -- El directorio actual contiene un archivo `pyproject.toml` -- El directorio actual contiene un archivo `requirements.txt` -- El directorio actual contiene un archivo `setup.py` -- El directorio actual contiene un archivo `tox.ini` -- El directorio actual contiene un archivo con la extensión `.py`. -- Un entorno virtual está activado actualmente +- The current directory contains a `.python-version` file +- The current directory contains a `Pipfile` file +- The current directory contains a `__init__.py` file +- The current directory contains a `pyproject.toml` file +- The current directory contains a `requirements.txt` file +- The current directory contains a `setup.py` file +- The current directory contains a `tox.ini` file +- The current directory contains a file with the `.py` extension. +- A virtual environment is currently activated ### Opciones @@ -2359,9 +2377,9 @@ symbol = "🔴 " By default the `ruby` module shows the currently installed version of [Ruby](https://www.ruby-lang.org/). The module will be shown if any of the following conditions are met: -- El directorio actual contiene un archivo `Gemfile` -- El directorio actual contiene un archivo `.ruby-version` -- El directorio actual contiene un archivo `.rb` +- The current directory contains a `Gemfile` file +- The current directory contains a `.ruby-version` file +- The current directory contains a `.rb` file ### Opciones @@ -2399,8 +2417,8 @@ symbol = "🔺 " By default the `rust` module shows the currently installed version of [Rust](https://www.rust-lang.org/). The module will be shown if any of the following conditions are met: -- El directorio actual contiene un archivo `Cargo.toml` -- El directorio actual contiene un archivo con la extensión `.rs` +- The current directory contains a `Cargo.toml` file +- The current directory contains a file with the `.rs` extension ### Opciones @@ -2438,9 +2456,9 @@ format = "via [⚙️ $version](red bold)" The `scala` module shows the currently installed version of [Scala](https://www.scala-lang.org/). Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: -- El directorio actual contiene un archivo `build.sbt`, `.scalaenv` o `.sbtenv` -- El directorio actual contiene un archivo con la extensión `.scala` o `.sbt` -- El directorio actual contiene un directorio llamado `.metals` +- The current directory contains a `build.sbt`, `.scalaenv` or `.sbtenv` file +- The current directory contains a file with the `.scala` or `.sbt` extension +- The current directory contains a directory named `.metals` ### Opciones @@ -2652,8 +2670,8 @@ disabled = false By default the `swift` module shows the currently installed version of [Swift](https://swift.org/). The module will be shown if any of the following conditions are met: -- El directorio actual contiene un archivo `Package.swift` -- El directorio actual contiene un archivo con la extensión `.swift` +- The current directory contains a `Package.swift` file +- The current directory contains a file with the `.swift` extension ### Opciones @@ -2699,8 +2717,8 @@ By default the Terraform version is not shown, since this is slow for current ve Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: -- El directorio actual contiene una carpeta `.terraform` -- El directorio actual contiene un archivo con las extensiones `.tf` o `.hcl` +- The current directory contains a `.terraform` folder +- Current directory contains a file with the `.tf` or `.hcl` extensions ### Opciones @@ -2796,10 +2814,10 @@ time_range = "10:00:00-14:00:00" The `username` module shows active user's username. The module will be shown if any of the following conditions are met: -- El usuario actual es root -- El usuario actual no es el mismo que el que está conectado -- El usuario está actualmente conectado como una sesión SSH -- La variable `show_always` se establece en true +- The current user is root +- The current user isn't the same as the one that is logged in +- The user is currently connected as an SSH session +- The variable `show_always` is set to true ::: consejo @@ -2841,7 +2859,7 @@ show_always = true The `vagrant` module shows the currently installed version of [Vagrant](https://www.vagrantup.com/). Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: -- El directorio actual contiene un archivo `Vagrantfile` +- The current directory contains a `Vagrantfile` file ### Opciones @@ -2883,15 +2901,16 @@ The `vlang` module shows you your currently installed version of V. By default t ### Opciones -| Opción | Por defecto | Descripción | -| ------------------- | -------------------------------------------- | ---------------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. | -| `symbol` | `"V "` | A format string representing the symbol of V | -| `detect_extensions` | `["v"]` | Qué extensiones deberían activar este módulo. | -| `detect_files` | `["v.mod", "vpkg.json", ".vpkg-lock.json" ]` | Qué nombres de archivo deberían activar este módulo. | -| `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. | -| `style` | `"blue bold"` | El estilo del módulo. | -| `disabled` | `false` | Disables the `vlang` module. | +| Opción | Por defecto | Descripción | +| ------------------- | -------------------------------------------- | --------------------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. | +| `version_format` | `"v${raw}"` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"V "` | A format string representing the symbol of V | +| `detect_extensions` | `["v"]` | Qué extensiones deberían activar este módulo. | +| `detect_files` | `["v.mod", "vpkg.json", ".vpkg-lock.json" ]` | Qué nombres de archivo deberían activar este módulo. | +| `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. | +| `style` | `"blue bold"` | El estilo del módulo. | +| `disabled` | `false` | Disables the `vlang` module. | ### Variables @@ -2945,7 +2964,7 @@ format = "[🆅 $repo](bold blue) " By default the the `zig` module shows the currently installed version of [Zig](https://ziglang.org/). The module will be shown if any of the following conditions are met: -- El directorio actual contiene un archivo `.zig` +- The current directory contains a `.zig` file ### Opciones @@ -2985,11 +3004,11 @@ The `custom` modules show the output of some arbitrary commands. These modules will be shown if any of the following conditions are met: -- El directorio actual contiene un archivo cuyo nombre está en `files` -- El directorio actual contiene un directorio cuyo nombre está en `directories` -- El directorio actual contiene un archivo cuya extensión está en `extensions` -- El comando `when` devuelve 0 -- El sistema operativo actual (std::env::consts::OS) coincide con el campo `os` si está definido. +- The current directory contains a file whose name is in `files` +- The current directory contains a directory whose name is in `directories` +- The current directory contains a file whose extension is in `extensions` +- The `when` command returns 0 +- The current Operating System (std::env::consts::OS) matchs with `os` field if defined. ::: consejo @@ -3040,8 +3059,8 @@ The order in which custom modules are shown can be individually set by including `shell` accepts a non-empty list of strings, where: -- La primera cadena es la ruta al intérprete de comandos a usar para ejecutar el comando. -- Otros argumentos siguientes son pasados al shell. +- The first string is the path to the shell to use to execute the command. +- Other following arguments are passed to the shell. If unset, it will fallback to STARSHIP_SHELL and then to "sh" on Linux, and "cmd /C" on Windows. diff --git a/docs/fr-FR/config/README.md b/docs/fr-FR/config/README.md index b33b29e8..60959ce9 100644 --- a/docs/fr-FR/config/README.md +++ b/docs/fr-FR/config/README.md @@ -1478,7 +1478,13 @@ symbol = "🌟 " ## Jobs -The `jobs` module shows the current number of jobs running. The module will be shown only if there are background jobs running. The module will show the number of jobs running if there is more than 1 job, or more than the `threshold` config value, if it exists. If `threshold` is set to 0, then the module will also show when there are 0 jobs running. +The `jobs` module shows the current number of jobs running. The module will be shown only if there are background jobs running. The module will show the number of jobs running if there are at least 2 jobs, or more than the `number_threshold` config value, if it exists. The module will show a symbol if there is at least 1 job, or more than the `symbol_threshold` config value, if it exists. You can set both values to 0 in order to *always* show the symbol and number of jobs, even if there are 0 jobs running. + +The default functionality is: + +- 0 jobs -> Nothing is shown. +- 1 job -> `symbol` is shown. +- 2 jobs or more -> `symbol` + `number` are shown. ::: warning @@ -1486,15 +1492,26 @@ This module is not supported on tcsh and nu. ::: +::: warning + +The `threshold` option is deprecated, but if you want to use it, the module will show the number of jobs running if there is more than 1 job, or more than the `threshold` config value, if it exists. If `threshold` is set to 0, then the module will also show when there are 0 jobs running. + +::: + ### Options -| Option | Défaut | Description | -| ----------- | ----------------------------- | ------------------------------------------------------- | -| `threshold` | `1` | Afficher le nombre de jobs si dépassé. | -| `format` | `"[$symbol$number]($style) "` | Format du module. | -| `symbol` | `"✦"` | Une chaîne de caractères représentant nombre de tâches. | -| `style` | `"bold blue"` | Le style du module. | -| `disabled` | `false` | Désactive le module `jobs`. | +| Option | Défaut | Description | +| ------------------ | ----------------------------- | ------------------------------------------------------------------------ | +| `threshold`\* | `1` | Afficher le nombre de jobs si dépassé. | +| `symbol_threshold` | `1` | Show `symbol` if the job count is at least `symbol_threshold`. | +| `number_threshold` | `2` | Show the number of jobs if the job count is at least `number_threshold`. | +| `format` | `"[$symbol$number]($style) "` | Format du module. | +| `symbol` | `"✦"` | The string used to represent the `symbol` variable. | +| `style` | `"bold blue"` | Le style du module. | +| `disabled` | `false` | Disables the `jobs` module. | + \*: This option is deprecated, please use the + +`number_threshold` and `symbol_threshold` options instead. ### Variables @@ -1513,16 +1530,17 @@ This module is not supported on tcsh and nu. [jobs] symbol = "+ " -threshold = 4 +number_threshold = 4 +symbol_threshold = 0 ``` ## Julia The `julia` module shows the currently installed version of [Julia](https://julialang.org/). Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie: -- Le répertoire courant contient un fichier `Project.toml` -- Le répertoire courant contient un fichier `Manifest.toml` -- Le répertoire actuel contient un fichier avec l'extension `.jl` +- The current directory contains a `Project.toml` file +- The current directory contains a `Manifest.toml` file +- The current directory contains a file with the `.jl` extension ### Options @@ -1560,7 +1578,7 @@ symbol = "∴ " The `kotlin` module shows the currently installed version of [Kotlin](https://kotlinlang.org/). Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie: -- Le répertoire courant contient un fichier `.kt` ou `.kts` +- The current directory contains a `.kt` or a `.kts` file ### Options @@ -1692,9 +1710,9 @@ disabled = true The `lua` module shows the currently installed version of [Lua](http://www.lua.org/). Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie: -- Le répertoire courant contient un fichier `.lua-version` -- Le répertoire courant contient un répertoire `lua` -- Le répertoire actuel contient un fichier avec l'extension `.lua` +- The current directory contains a `.lua-version` file +- The current directory contains a `lua` directory +- The current directory contains a file with the `.lua` extension ### Options @@ -1816,10 +1834,10 @@ truncation_symbol = "" The `nim` module shows the currently installed version of [Nim](https://nim-lang.org/). Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie: -- Le répertoire courant contient un fichier `nim.cfg` -- Le répertoire actuel contient un fichier avec l'extension `.nim` -- Le répertoire actuel contient un fichier avec l'extension `.nims` -- Le répertoire actuel contient un fichier avec l'extension `.nimble` +- The current directory contains a `nim.cfg` file +- The current directory contains a file with the `.nim` extension +- The current directory contains a file with the `.nims` extension +- The current directory contains a file with the `.nimble` extension ### Options @@ -1896,12 +1914,12 @@ format = 'via [☃️ $state( \($name\))](bold blue) ' The `nodejs` module shows the currently installed version of [Node.js](https://nodejs.org/). Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie: -- Le répertoire courant contient un fichier `package.json` -- Le répertoire courant contient un fichier `.node-version` -- Le répertoire courant contient un fichier `.nvmrc` -- Le répertoire courant contient un répertoire `node_modules` -- Le répertoire actuel contient un fichier avec l'extension `.js`, `.mjs` ou `.cjs` -- Le répertoire actuel contient un fichier avec l'extension `.ts` +- The current directory contains a `package.json` file +- The current directory contains a `.node-version` file +- The current directory contains a `.nvmrc` file +- The current directory contains a `node_modules` directory +- The current directory contains a file with the `.js`, `.mjs` or `.cjs` extension +- The current directory contains a file with the `.ts` extension ### Options @@ -1940,12 +1958,12 @@ format = "via [🤖 $version](bold green) " The `ocaml` module shows the currently installed version of [OCaml](https://ocaml.org/). Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie: -- Le répertoire courant contient un fichier avec l'extension `.opam` ou le répertoire `_opam` -- Le répertoire courant contient un répertoire `esy.lock` -- Le répertoire courant contient un fichier `dune` ou `dune-project` -- Le répertoire courant contient un fichier `jbuild` ou `jbuild-ignore` -- Le répertoire courant contient un fichier `.merlin` -- Le répertoire actuel contient un fichier avec l'extension `.ml`, `.mli`, `.re` ou `.rei` +- The current directory contains a file with `.opam` extension or `_opam` directory +- The current directory contains a `esy.lock` directory +- The current directory contains a `dune` or `dune-project` file +- The current directory contains a `jbuild` or `jbuild-ignore` file +- The current directory contains a `.merlin` file +- The current directory contains a file with `.ml`, `.mli`, `.re` or `.rei` extension ### Options @@ -2072,11 +2090,11 @@ format = "via [🎁 $version](208 bold) " The `perl` module shows the currently installed version of [Perl](https://www.perl.org/). Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie: -- Le répertoire courant contient un fichier `Makefile.PL` ou `Build.PL` -- Le répertoire courant contient un fichier `cpanfile` ou `cpanfile.snapshot` -- Le répertoire courant contient un fichier `META.json` ou `META.yml` -- Le répertoire courant contient un fichier `.perl-version` -- Le répertoire courant contient un fichier `.pl`, `.pm` ou `.pod` +- The current directory contains a `Makefile.PL` or `Build.PL` file +- The current directory contains a `cpanfile` or `cpanfile.snapshot` file +- The current directory contains a `META.json` file or `META.yml` file +- The current directory contains a `.perl-version` file +- The current directory contains a `.pl`, `.pm` or `.pod` ### Options @@ -2112,9 +2130,9 @@ format = "via [🦪 $version]($style) " The `php` module shows the currently installed version of [PHP](https://www.php.net/). Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie: -- Le répertoire courant contient un fichier `composer.json` -- Le répertoire courant contient un fichier `.php-version` -- Le répertoire courant contient un fichier avec l'extension `.php` +- The current directory contains a `composer.json` file +- The current directory contains a `.php-version` file +- The current directory contains a `.php` extension ### Options @@ -2152,8 +2170,8 @@ format = "via [🔹 $version](147 bold) " The `purescript` module shows the currently installed version of [PureScript](https://www.purescript.org/) version. Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie: -- Le répertoire courant contient un fichier `spago.dhall` -- Le répertoire actuel contient un fichier avec l'extension `.purs` +- The current directory contains a `spago.dhall` file +- The current directory contains a file with the `.purs` extension ### Options @@ -2195,15 +2213,15 @@ If `pyenv_version_name` is set to `true`, it will display the pyenv version name Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie: -- Le répertoire courant contient un fichier `.python-version` -- Le répertoire courant contient un fichier `Pipfile` -- Le répertoire courant contient un fichier `__init__.py` -- Le répertoire courant contient un fichier `pyproject.toml` -- Le répertoire courant contient un fichier `requirements.txt` -- Le répertoire courant contient un fichier `setup.py` -- Le répertoire courant contient un fichier `tox.ini` -- Le répertoire actuel contient un fichier avec l'extension `.py`. -- Un environnement virtuel est actuellement activé +- The current directory contains a `.python-version` file +- The current directory contains a `Pipfile` file +- The current directory contains a `__init__.py` file +- The current directory contains a `pyproject.toml` file +- The current directory contains a `requirements.txt` file +- The current directory contains a `setup.py` file +- The current directory contains a `tox.ini` file +- The current directory contains a file with the `.py` extension. +- A virtual environment is currently activated ### Options @@ -2280,13 +2298,13 @@ python_binary = ["./venv/bin/python", "python", "python3", "python2"] The `rlang` module shows the currently installed version of R. The module will be shown if any of the following conditions are met: -- Le répertoire actuel contient un fichier avec l'extension `.R`. -- Le répertoire actuel contient un fichier avec l'extension `.Rd`. -- Le répertoire actuel contient un fichier avec l'extension `.Rmd`. -- Le répertoire actuel contient un fichier avec l'extension `.Rproj`. -- Le répertoire actuel contient un fichier avec l'extension `.Rsx`. -- Le répertoire courant contient un fichier `.Rprofile` -- Le répertoire courant contient un dossier `.Rproj.user` +- The current directory contains a file with the `.R` extension. +- The current directory contains a file with the `.Rd` extension. +- The current directory contains a file with the `.Rmd` extension. +- The current directory contains a file with the `.Rproj` extension. +- The current directory contains a file with the `.Rsx` extension. +- The current directory contains a `.Rprofile` file +- The current directory contains a `.Rproj.user` folder ### Options @@ -2322,7 +2340,7 @@ format = "with [📐 $version](blue bold) " By default the `red` module shows the currently installed version of [Red](https://www.red-lang.org/). The module will be shown if any of the following conditions are met: -- Le répertoire actuel contient un fichier avec l'extension `.red` ou `.reds` +- The current directory contains a file with `.red` or `.reds` extension ### Options @@ -2360,9 +2378,9 @@ symbol = "🔴 " By default the `ruby` module shows the currently installed version of [Ruby](https://www.ruby-lang.org/). The module will be shown if any of the following conditions are met: -- Le répertoire courant contient un fichier `Gemfile` -- Le répertoire courant contient un fichier `.ruby-version` -- Le répertoire courant contient un fichier `.rb` +- The current directory contains a `Gemfile` file +- The current directory contains a `.ruby-version` file +- The current directory contains a `.rb` file ### Options @@ -2400,8 +2418,8 @@ symbol = "🔺 " By default the `rust` module shows the currently installed version of [Rust](https://www.rust-lang.org/). The module will be shown if any of the following conditions are met: -- Le répertoire courant contient un fichier `Cargo.toml` -- Le répertoire actuel contient un fichier avec l'extension `.rs` +- The current directory contains a `Cargo.toml` file +- The current directory contains a file with the `.rs` extension ### Options @@ -2439,9 +2457,9 @@ format = "via [⚙️ $version](red bold)" The `scala` module shows the currently installed version of [Scala](https://www.scala-lang.org/). Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie: -- Le répertoire courant contient un fichier `build.sbt`, `.scalaenv` ou `.sbtenv` -- Le répertoire actuel contient un fichier avec l'extension `.scala` ou `.sbt` -- Le répertoire courant contient un répertoire nommé `.metals` +- The current directory contains a `build.sbt`, `.scalaenv` or `.sbtenv` file +- The current directory contains a file with the `.scala` or `.sbt` extension +- The current directory contains a directory named `.metals` ### Options @@ -2653,8 +2671,8 @@ disabled = false By default the `swift` module shows the currently installed version of [Swift](https://swift.org/). The module will be shown if any of the following conditions are met: -- Le répertoire courant contient un fichier `Package.swift` -- Le répertoire actuel contient un fichier avec l'extension `.swift` +- The current directory contains a `Package.swift` file +- The current directory contains a file with the `.swift` extension ### Options @@ -2700,8 +2718,8 @@ By default the Terraform version is not shown, since this is slow for current ve Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie: -- Le répertoire courant contient un dossier `.terraform` -- Le répertoire actuel contient un fichier avec l'extension `.tf` ou `.hcl` +- The current directory contains a `.terraform` folder +- Current directory contains a file with the `.tf` or `.hcl` extensions ### Options @@ -2797,10 +2815,10 @@ time_range = "10:00:00-14:00:00" The `username` module shows active user's username. The module will be shown if any of the following conditions are met: -- L'utilisateur courant est root -- L'utilisateur courant est différent de celui connecté -- L'utilisateur est actuellement connecté en tant que session SSH -- La variable `show_always` est définie à true +- The current user is root +- The current user isn't the same as the one that is logged in +- The user is currently connected as an SSH session +- The variable `show_always` is set to true ::: tip @@ -2842,7 +2860,7 @@ show_always = true The `vagrant` module shows the currently installed version of [Vagrant](https://www.vagrantup.com/). Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie: -- Le répertoire courant contient un fichier `Vagrantfile` +- The current directory contains a `Vagrantfile` file ### Options @@ -2879,20 +2897,21 @@ format = "via [⍱ $version](bold white) " ## VLang The `vlang` module shows you your currently installed version of V. By default the module will be shown if any of the following conditions are met: -- Le répertoire courant contient un fichier avec l'extension `.v` -- Le répertoire courant contient un fichier `v.mod`, `vpkg.json` ou `.vpkg-lock.json` +- The current directory contains a file with `.v` extension +- The current directory contains a `v.mod`, `vpkg.json` or `.vpkg-lock.json` file ### Options -| Option | Défaut | Description | -| ------------------- | -------------------------------------------- | ----------------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | Format du module. | -| `symbol` | `"V "` | Une chaîne de caractères représentant le symbole de V | -| `detect_extensions` | `["v"]` | Quelles extensions devraient activer ce module. | -| `detect_files` | `["v.mod", "vpkg.json", ".vpkg-lock.json" ]` | Quels fichiers devraient activer ce module. | -| `detect_folders` | `[]` | Quels dossiers devraient activer ce module. | -| `style` | `"blue bold"` | Le style du module. | -| `disabled` | `false` | Désactive le module `vlang`. | +| Option | Défaut | Description | +| ------------------- | -------------------------------------------- | ------------------------------------------------------------------------------------------ | +| `format` | `"via [$symbol($version )]($style)"` | Format du module. | +| `version_format` | `"v${raw}"` | Le format de la version. Les variables disponibles sont `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"V "` | A format string representing the symbol of V | +| `detect_extensions` | `["v"]` | Quelles extensions devraient activer ce module. | +| `detect_files` | `["v.mod", "vpkg.json", ".vpkg-lock.json" ]` | Quels fichiers devraient activer ce module. | +| `detect_folders` | `[]` | Quels dossiers devraient activer ce module. | +| `style` | `"blue bold"` | Le style du module. | +| `disabled` | `false` | Disables the `vlang` module. | ### Variables @@ -2946,7 +2965,7 @@ format = "[🆅 $repo](bold blue) " By default the the `zig` module shows the currently installed version of [Zig](https://ziglang.org/). The module will be shown if any of the following conditions are met: -- Le répertoire courant contient un fichier `.zig` +- The current directory contains a `.zig` file ### Options @@ -3041,7 +3060,7 @@ The order in which custom modules are shown can be individually set by including `shell` accepts a non-empty list of strings, where: -- La première chaîne est le chemin vers le shell à utiliser pour exécuter la commande. +- The first string is the path to the shell to use to execute the command. - Other following arguments are passed to the shell. If unset, it will fallback to STARSHIP_SHELL and then to "sh" on Linux, and "cmd /C" on Windows. diff --git a/docs/id-ID/README.md b/docs/id-ID/README.md new file mode 100644 index 00000000..dbd00c05 --- /dev/null +++ b/docs/id-ID/README.md @@ -0,0 +1,166 @@ +--- +home: true +heroImage: /logo.svg +heroText: +tagline: Prompt yang minimal, super cepat, dan dapat disesuaikan tanpa batas untuk shell apa pun! +actionText: Mulai +actionLink: ./guide/ +features: + - + title: Kompabilitas Yang Utama + details: Dapat bekerja di shells yang paling biasa dengan sistem operasi yang paling biasa. Bisa digunakan di mana saja! + - + title: Dibuat Dengan Rust + details: Menggunakan kecepatan dan keamaan dari Rust, untuk membuat prompt anda bekerja secepat mungkin dan dapat diandalkan. + - + title: Dapat Diatur + details: Semua detail kecil yang ada dapat kamu atur sesukamu, mungkin untuk membuat prompt yang seminimal mungkin atau kaya fitur seperti yang kamu inginkan. +footer: Berlisensi ISC | Hak Cipta © 2019-sekarang Kontributor Starship +#Used for the description meta tag, for SEO +metaTitle: "Starship: Prompt Lintas Shell" +description: Starship merupakan prompt yang minimal, super cepat, dan sangat bisa diatur untuk semua shell! Menampilkan info yang dibutuhkan, namun tetap bisa tampil ramping dan minimal. Instalasi sederhana tersedia untuk Bash, Fish, ZSH, Ion, Tcsh, Elvish, Nu, Xonsh, dan PowerShell. +--- + +
+ +
+ +### Prasyarat + +- [Nerd Font](https://www.nerdfonts.com/) yang telah terinstalasi dan telah diaktifkan di terminal. + +### Instalasi Sederhana + +1. Instalasi dengan menggunakan binary **starship**: + + + #### Pasang Versi Terbaru + + Dengan Shell: + + ```sh + sh -c "$(curl -fsSL https://starship.rs/install.sh)" + ``` + Untuk memperbarui Starship, jalankan kembali skrip di atas. Hal ini dapat memperbarui versi yang terpasang tanpa menyentuh konfigurasi Starship. + + + #### Pasang Melalui Package Manager + + Dengan [Homebrew](https://brew.sh/): + + ```sh + brew install starship + ``` + + Dengan [Scoop](https://scoop.sh): + + ```powershell + scoop install starship + ``` + +1. Tambahkan skrip init ke file konfigurasi Shell: + + + #### Bash + + Tambahkan skrip berikut pada baris akhir `~/.bashrc:`: + + ```sh + # ~/.bashrc + + eval "$(starship init bash)" + ``` + + + #### Fish + + Tambahkan skrip berikut pada baris akhir `~/.config/fish/config.fish`: + + ```sh + # ~/.config/fish/config.fish + + starship init fish | source + ``` + + + #### Zsh + + Tambahkan skrip berikut pada baris akhir `~/.zshrc`: + + ```sh + # ~/.zshrc + + eval "$(starship init zsh)" + ``` + + + #### Powershell + + Tambahkan skrip berikut pada baris akhir `Microsoft.PowerShell_profile.ps1`. Kamu dapat mengecek lokasi file tersebut dengan mencari tahu keberadaan variabel `$PROFILE` di dalam PowerShell. Biasanya, lokasi file tersebut berada di `~\Documents\PowerShell\Microsoft.PowerShell_profile.ps1` atau `~/.config/powershell/Microsoft.PowerShell_profile.ps1` pada -Nix. + + ```sh + Invoke-Expression (&starship init powershell) + ``` + + + #### Ion + + Tambahkan skrip berikut pada baris akhir `~/.config/ion/initrc`: + + ```sh + # ~/.config/ion/initrc + + eval $(starship init ion) + ``` + + + #### Elvish + + ::: warning Cuma elvish v0.15 atau yang lebih baru yang tengah didukung. ::: + + Tambahkan skrip berikut pada baris akhir `~/.elvish/rc.elv`: + + ```sh + # ~/.elvish/rc.elv + + eval (starship init elvish) + ``` + + + #### Tcsh + + Tambahkan skrip berikut pada baris akhir `~/.tcshrc`: + + ```sh + # ~/.tcshrc + + eval `starship init tcsh` + ``` + + + #### Nushell + + ::: peringatan Hal ini dapat berubah di kemudian hari. Hanya nu versi v0.33 atau lebih baru yang tengah didukung. ::: Tambahkan skrip berikut ke dalam file konfigurasi nu. Lokasi dari file ini dapat dicek dengan menjalankan `config path` pada nu. + + ```toml + startup = [ + "mkdir ~/.cache/starship", + "starship init nu | save ~/.cache/starship/init.nu", + "source ~/.cache/starship/init.nu" + ] + prompt = "starship_prompt" + ``` + + + #### Xonsh + + Tambahkan skrip berikut pada baris akhir `~/.xonshrc`: + + ```sh + # ~/.xonshrc + + execx($(starship init xonsh)) + ``` diff --git a/docs/id-ID/advanced-config/README.md b/docs/id-ID/advanced-config/README.md new file mode 100644 index 00000000..6abf856e --- /dev/null +++ b/docs/id-ID/advanced-config/README.md @@ -0,0 +1,95 @@ +# Konfigurasi Lanjutan + +Meskipun Starship tergolong sebagai shell yang serbaguna, terkadang kita butuh upaya yang lebih dari sekadar mengedit `starship.toml` untuk membuatnya menjalankan beberapa hal tertentu. Halaman ini merincikan beberapa teknik konfigurasi lanjutan yang digunakan oleh starship. + +::: peringatan + +Konfigurasi pada bagian ini dapat berubah saat pembaruan Starship rilis di kemudian hari nanti. + +::: + +## Kostumisasi Perintah pre-prompt dan pre-execution Pada Bash + +Bash tidak memiliki framework preexec/precmd yang tetap seperti kebanyakan shell pada umumnya. Oleh karena itu, sulit halnya untuk membuat hook yang dapat dikustomisasi sepenuhnya di dalam `bash`. Namun, Starship memberikan beberapa cara supaya kamu bisa memasukkan fungsimu sendiri ke dalam prosedur prompt-rendering: + +- Untuk menjalankan fungsi yang dikustomisasi tepat sebelum prompt, buatlah sebuah fungsi baru lalu berikan nama `starship_precmd_user_func` ke fungsi tersebut. Sebagai contoh, untuk menampilkan gambar roket sebelum prompt, kamu bisa melakukannya dengan cara + +```bash +function blastoff(){ + echo "🚀" +} +starship_precmd_user_func="blastoff" +``` + +- Untuk menjalankan fungsi buatan tepat sebelum commands berjalan, kamu bisa menggunakan [`DEBUG` trap mechanism](https://jichu4n.com/posts/debug-trap-and-prompt_command-in-bash/). Akan tetapi, kamu **harus** melakukan proses trap pada DEBUG signal *sebelum* menjalankan Starship! Starship bisa menyimpan nilai dari DEBUG trap, tapi jika trap diganti setelah starship berjalan, beberapa fungsi akan rusak. + +```bash +function blastoff(){ + echo "🚀" +} +trap blastoff DEBUG # Trap DEBUG *sebelum* menjalankan starship +eval $(starship init bash) +``` + +## Mengubah Judul Window + +Beberapa prompts shell dengan otomatis akan mengubah judul window-nya untukmu (mis. untuk merefleksikan direktori kerjamu). Fish bahkan mengaturnya sebagai bawaan. Starship tidak, tapi mudah saja untuk menambahkan fungsi tersebut ke dalam `bash` ataupun `zsh`. + +Pertama, buatlah fungsi untuk mengubah judul window (bekerja pada bash dan zsh): + +```bash +function set_win_title(){ + echo -ne "\033]0; JUDUL_WINDOW_MU \007" +} +``` + +Kamu bisa menggunakan variabel untuk mengkustomisasi judulnya (`$USER`, `$HOSTNAME`, dan `$PWD` adalah opsi yang populer). + +Di dalam `bash`, atur fungsi berikut menjadi fungsi precmd untuk starship: + +```bash +starship_precmd_user_func="set_win_title" +``` + +Dalam `zsh`, pada array `precmd_functions`, tambahkan: + +```bash +precmd_functions+=(set_win_title) +``` + +Kalau kamu suka hasilnya, tambahkan baris (`~/.bashrc` or `~/.zshrc`) ke dalam file konfigurasi shell-mu untuk membuatnya permanen. + +Sebagai contoh, kalau kamu mau menampilkan lokasi direktori pada judul label terminalmu, tambahkan snippet berikut ke dalam `~/.bashrc` atau `~/.zshrc`: + +```bash +function set_win_title(){ + echo -ne "\033]0; $(basename "$PWD") \007" +} +starship_precmd_user_func="set_win_title" +``` + +## Menata String + +Tataan pada strings merupakan sebuah kumpulan kata yang dipisahkan dengan spasi kosong. Kata-katanya tidak bersifat case sensitive (mis. `tebal` dan `TeBaL` dianggap sebagai string yang sama). Tiap-tiap kata berikut adalah opsinya: + + - `bold` + - `italic` + - `underline` + - `dimmed` + - `inverted` + - `bg:` + - `fg:` + - `` + - `none` + +yang mana `` merupakan sebuah penentu warna (dibahas di bawah). `fg:` dan `` untuk saat ini memiliki fungsi yang sama, meskipun bisa berubah di kemudian hari. `inverted` menggantikan warna pada latar depan dan belakang. Urutan kata pada string tidak jadi masalah. + +`none` bisa menimpa nilai token lainnya di dalam string jika Ia tidak termaksud dalam penentu warna pada `bg:` sebagai contoh, `fg:red none fg:blue` akan tetap menjadi string yang tidak memiliki penataan. `bg:none` menjadikan warna pada latar belakang sebagai warna bawaan. Jadi, nilai `fg:red bg:none` sama dengan `red` atau `fg:red` dan nilai `bg:green fg:red bg:none` juga sama dengan `fg:red` ataupun `red`. Mungkin akan jadi masalah untuk menggunakan `none` dengan token lainnya di kemudian hari. + +Penentuan warna bisa dilakukan dengan salah satu cara berikut: + + - Warna terminal pada umumnya terdiri dari: `black`, `red`, `green`, `blue`, `yellow`, `purple`, `cyan`, `white`. Untuk memperoleh varian warna yang lebih cerah, kamu dapat menggunakan token `bright-` (mis. `bright-white`). + - Menuliskannya dengan menggunakan `#` dan diikuti oleh enam digit angka hexadesimal. Spesifikasi [kode heksadesimal pada warna RGB](https://www.w3schools.com/colors/colors_hexadecimal.asp). + - Menggunakan bilangan antara 0-255. Spesifikasi [8-bit Kode Warna ANSI](https://i.stack.imgur.com/KTSQa.png). + +Jika warna yang dipakai pada latar depan/latar belakang banyak, maka warna yang terbaru pada string yang akan diprioritaskan. diff --git a/docs/id-ID/config/README.md b/docs/id-ID/config/README.md new file mode 100644 index 00000000..6594451e --- /dev/null +++ b/docs/id-ID/config/README.md @@ -0,0 +1,3103 @@ +# Konfigurasi + +Untuk memulai mengkonfigurasi starship, buatlah file berikut: `~/.config/starship.toml`. + +```sh +mkdir -p ~/.config && touch ~/.config/starship.toml +``` + +Seluruh konfigurasi starship dilakukan dalam file [TOML](https://github.com/toml-lang/toml) berikut: + +```toml +# Menambahkan baris kosong antar prompt shell +add_newline = true + +# Mengganti simbol "❯" pada prompt dengan simbol "➜" +[character] # Nama modul yang dikonfigurasi adalah "character" +success_symbol = "[➜](bold green)" # Segmen "success_symbol" diganti menjadi "➜" dengan warna "bold green" + +# Mengnonaktifkan paket modul, menyembunyikannya dari prompt secara utuh +[package] +disabled = true +``` + +Kamu bisa mengganti lokasi file konfigurasi bawaan dengan menggunakan environment variable dari `STARSHIP_CONFIG`: + +```sh +export STARSHIP_CONFIG=~/.starship/config.toml +``` + +Ekuivalen dalam PowerShell (Windows), tambahkan baris berikut pada `$PROFILE`: + +```powershell +$ENV:STARSHIP_CONFIG = "$HOME\.starship\config.toml" +``` + +### Logging + +Secara bawaan, starship mencatat peringatan dan eror ke dalam sebuah file bernama `~/.cache/starship/session_${STARSHIP_SESSION_KEY}.log`, yang mana session key file tersebut sama dengan instance terminalmu. Namun, hal tersebut dapat diubah dengan menggunakan environment variable dari `STARSHIP_CACHE` berikut: + +```sh +export STARSHIP_CONFIG=~/.starship/cache +``` + +Pada PowerShell (Windows), tambahkan baris berikut pada `$PROFILE`: + +```powershell +$ENV:STARSHIP_CACHE = "$HOME\AppData\Local\Temp" +``` + +### Terminologi + +**Modul**: Sebuah komponen pada prompt yang memberikan informasi berdasarkan info kontekstual sistem operasimu. Sebagai contoh, modul "nodejs" menampilkan versi Node.js yang tengah terpasang pada komputermu, jika direktorimu sedang berada pada proyek Node.js. + +**Variabel**: Sub-komponen yang terdiri dari informasi yang disediakan oleh modul. Sebagai contoh, variabel "version" dalam modul "nodejs" memuat versi Node.js saat ini. + +Secara konvensi, sebagian modul memiliki prefiks bawaan pada warna terminal (mis. `via` pada "nodejs") dan juga sebuah ruang kosong sebagai sufiks. + +### Format String + +Format string merupakan format yang sebuah modul gunakan untuk menampilkan semua variabelnya. Sebagian besar modul memiliki sebuah entri yang disebut `format` yang mengkonfigurasi format tampilan pada modul. Kamu bisa menggunakan teks, variabel, dan grup teks di dalam sebuah format string. + +#### Variabel + +Variabel memilki simbol `$` yang diikuti dengan nama variabelnya. Nama dari sebuah variabel hanya boleh berisikan huruf, angka, dan `_`. + +Sebagai contoh: + +- `$version` adalah format string dengan sebuah nama variabel `version`. +- `$git_branch$git_commit` merupakan sebuah format string dengan dua variabel bernama `git_branch` dan `git_commit`. +- `$git_branch $git_commit` memiliki dua variabel yang dipisahkan dengan sebuah spasi. + +#### Grup Teks + +Grup teks dibuat dengan dua bagian yang berbeda. + +Bagian pertama, yang mana diapit dalam sebuah `[]`, merupakan sebuah [format string](#format-strings). Kamu bisa menambahkan teks, variabel, atau bahkan grup teks bercabang di dalamnya. + +Pada bagian kedua, yang mana diapit dalam sebuah `()`, merupakan sebuah [penataan string](#style-strings). Bagian ini dapat digunakan untuk menata bagian pertama. + +Sebagai contoh: + +- `[on](red bold)` akan menampilkan string `on` dengan teks merah tebal. +- `[⌘ $version](bold green)` akan menampilkan simbol `⌘` yang diikuti oleh variabel yang berisikan `version`, dengan teks tebal berwarna hijau. +- `[a [b](red) c](green)` akan menampilkan `a b c` dengan `b` merah, dan `a` & `c` green. + +#### Menata String + +Sebagian besar modul starship memungkinkan kamu untuk mengkonfigurasi gaya tampilannya. Hal ini dilakukan dengan sebuah entri (biasanya `style`) yang konfigurasinya ditentukan oleh string. Berikut adalah beberapa contoh penataan pada string dan kegunaannya. Untuk detail sintaksis yang lebih lengkap, lihat [panduan konfigurasi lanjutan](/advanced-config/). + +- `"fg:green bg:blue"` mengeset teks berwana hijau pada latar biru +- `"bg:blue fg:bright-green"` mengeset teks hijau terang pada latar biru +- `"bold fg:27"` mengeset tebal teks dengan [ANSI color](https://i.stack.imgur.com/KTSQa.png) 27 +- `"underline bg:#bf5700"` mengeset teks bergaris bawah pada latar oranye menyala +- `"bold italic fg:purple"` mengeset teks ungu miring tebal +- `""` secara eksplisit menonaktifkan semua penataan gaya + +Perhatikan bagaimana nantinya penataanmu akan terlihat pada emulator terminalmu. Sebagai contoh, beberapa terminal emulator alih-alih membuat warnanya lebih terang, malah menebalkan teksnya, dan sebagian palet warna ada yang menggunakan nilai yang sama untuk warna normal dan terangnya. Dan juga, untuk memakai teks miring, terminalmu harus menunjang teks miring. + +#### Format String Bersyarat (Conditional) + +String dengan format bersyarat dibungkus dengan `(` dan `)` tidak akan dijalankan jika variabel di dalamnya kosong. + +Sebagai contoh: + +- `(@$region)` tidak akan menampilkan apapun jika nilai variabel `region` adalah `None` atau berupa string kosong, jika tidak, `@` diikuti dengan nilai dari region. +- `(sembarang)` akan selalu tidak menampilkan apapun karena tidak ada variabel yang dibungkus dalam kurung kurawal. +- Tatkala `$all` digunakan sebagai shortcut untuk `\[$a$b\]`, `($all)` tidak akan menampilkan apapun jika nilai `$a` dan `$b` adalah `None`. Berlaku juga dengan `(\[$a$b\] )`. + +#### Karakter Yang Bisa Dihindari (Escapable) + +Simbol-simbol berikut mempunyai kegunaan yang spesial dalam format srting. Jika kamu ingin menampilkan simbol-simbol berikut, kamu harus mengikatnya (escape) dengan garis miring terbalik (`\`). + +- \$ +- \\ +- [ +- ] +- ( +- ) + +Perhatikan bahwa `toml` memiliki [sintaksi bebasnya sendiri](https://github.com/toml-lang/toml#user-content-string). Disarankan halnya untukmu menggunakan string literal (`''`) dalam konfigurasimu. Jika kamu mau memakai string standar (`""`), ingatlah untuk mengikat garis miring terbalik `\`. + +Sebagai contoh, ketika kamu ingin menampilkan simbol `$` pada baris baru, konfigurasi berikut untuk `format` bersifat ekuivalen: + +```toml +# dengan string standar +format = "\n\\$" + +# dengan string standar multibaris +format = """ + +\\$""" + +# dengan string literal +format = ''' + +\$''' +``` + +## Prompt + +Berikut adalah opsi konfigurasi dari list yang bersifat prompt-wide. + +### Opsi + +| Opsi | Bawaan | Deskripsi | +| ----------------- | ------------------------------ | ---------------------------------------------------------------------------- | +| `fromat` | [link](#default-prompt-format) | Mengkonfigurasi format pada prompt. | +| `scan_timeout` | `30` | Batas waktu starpship untuk memindai file (dalam milidetik). | +| `command_timeout` | `500` | Batas waktu untuk perintah yang dieksekusi oleh starship (dalam militdetik). | +| `add_newline` | `true` | Memasukkan baris kosong antara prompt shell. | + +### Contoh + +```toml +# ~/.config/starship.toml + +# Menggunakan format yang dikustomisasi +format = """ +[┌───────────────────>](bold green) +[│](bold green)$directory$rust$package +[└─>](bold green) """ + +# Menunggu 10 milidetik untuk starship mencek file pada direktori terkini. +scan_timeout = 10 + +# Menonaktifkan baris kosong di awal prompt +add_newline = false +``` + +### Format Prompt Bawaan + +Aturan `format` bawaan digunakan untuk mendefinisikan format pada prompt, apabila kosong atau tidak ada `format` yang diberikan. Aturannya seperti yang ditunjukkan: + +```toml +format = "$all" + +# yang mana ekuivalen dengan +format = """ +$username\ +$hostname\ +$shlvl\ +$kubernetes\ +$directory\ +$vcsh\ +$git_branch\ +$git_commit\ +$git_state\ +$git_metrics\ +$git_status\ +$hg_branch\ +$docker_context\ +$package\ +$cmake\ +$dart\ +$deno\ +$dotnet\ +$elixir\ +$elm\ +$erlang\ +$golang\ +$helm\ +$java\ +$julia\ +$kotlin\ +$nim\ +$nodejs\ +$ocaml\ +$perl\ +$php\ +$purescript\ +$python\ +$red\ +$ruby\ +$rust\ +$scala\ +$swift\ +$terraform\ +$vlang\ +$vagrant\ +$zig\ +$nix_shell\ +$conda\ +$memory_usage\ +$aws\ +$gcloud\ +$openstack\ +$env_var\ +$crystal\ +$custom\ +$cmd_duration\ +$line_break\ +$lua\ +$jobs\ +$battery\ +$time\ +$status\ +$shell\ +$character""" +``` + +## AWS + +Module `aws` menampilkan region dan profil AWS terkini. Diperoleh dari variabel environment `AWS_REGION`, `AWS_DEFAULT_REGION`, dan `AWS_PROFILE` pada file `~/.aws/config`. Modul ini juga menampilkan penghitung waktu mundur kedaluwarsa ketika menggunakan temporer kredensial. + +Ketika menggunakan [aws-vault](https://github.com/99designs/aws-vault), profil dibaca dari variabel environment `AWS_VAULT` dan tanggal kedaluwarsanya dibaca dari variabel environment `AWS_SESSION_EXPIRATION`. + +Ketika menggunakan [awsu](https://github.com/kreuzwerker/awsu) profil dibaca dari variabel environment `AWSU_PROFILE`. + +Ketika menggunakan [AWSume](https://awsu.me) profil dibaca dari variabel environment `AWSUME_PROFILE` dan tanggal kedaluwarsanya dibaca dari variabel environment `AWSUME_EXPIRATION`. + +### Opsi + +| Opsi | Bawaan | Deskripsi | +| ------------------- | -------------------------------------------------------------------- | ---------------------------------------------------------------- | +| `format` | `'on [$symbol($profile )(\($region\) )(\[$duration\])]($style)'` | Format dari modul. | +| `symbol` | `"☁️ "` | Simbol yang digunakan sebelum menampilkan profil AWS terkini. | +| `region_aliases` | | Tabel alias dari region yang ditampilan selain nama AWS. | +| `style` | `"bold yellow"` | Gaya penataan untuk modul. | +| `expiration_symbol` | `X` | Simbol ditampilkan ketika temporer kredensial telah kedaluwarsa. | +| `disabled` | `false` | Menonaktifkan modul `AWS`. | + +### Variabel + +| Variabel | Contoh | Deskripsi | +| --------- | ---------------- | --------------------------------- | +| region | `ap-northeast-1` | Region AWS terkini | +| profile | `astronauts` | Profil AWS terkini | +| duration | `2h27m20s` | Durasi temporer kredensial | +| symbol | | Menyalin nilai dari opsi `symbol` | +| style\* | | Menyalin nilai dari opsi `style` | + +\*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string + +### Contoh + +#### Menampilkan semuanya + +```toml +# ~/.config/starship.toml + +[aws] +format = 'on [$symbol($profile )(\($region\) )]($style)' +style = "bold blue" +symbol = "🅰 " +[aws.region_aliases] +ap-southeast-2 = "au" +us-east-1 = "va" +``` + +#### Menampilkan region + +```toml +# ~/.config/starship.toml + +[aws] +format = "on [$symbol$region]($style) " +style = "bold blue" +symbol = "🅰 " +[aws.region_aliases] +ap-southeast-2 = "au" +us-east-1 = "va" +``` + +#### Menampilkan profil + +```toml +# ~/.config/starship.toml + +[aws] +format = "on [$symbol$profile]($style) " +style = "bold blue" +symbol = "🅰 " +``` + +## Baterai + +Modul `battery` menampilkan seberapa penuh baterai piranti terisi dan status pengisiannya. Modulnya hanya dapat terlihat ketika baterai dari pirantinya di bawah 10%. + +### Opsi + +| Opsi | Bawaan | Deskripsi | +| -------------------- | --------------------------------- | --------------------------------------------------------- | +| `full_symbol` | `" "` | Simbol dimunculkan ketika baterai penuh. | +| `charging_symbol` | `" "` | Simbol dimunculkan ketika baterai mengisi. | +| `discharging_symbol` | `" "` | Simbol dimunculkan ketika baterai terpakai. | +| `unknown_symbol` | `" "` | Simbol dimunculkan ketika keadaan baterai tidak dikenali. | +| `empty_symbol` | `" "` | Simbol dimunculkan ketika keadaan baterai kosong. | +| `format` | `"[$symbol$percentage]($style) "` | Format dari modul. | +| `display` | [link](#battery-display) | Menampilkan ambang dan gaya dari modul. | +| `disabled` | `false` | Menonaktifkan modul `baterai`. | + +### Contoh + +```toml +# ~/.config/starship.toml + +[battery] +full_symbol = "🔋 " +charging_symbol = "⚡️ " +discharging_symbol = "💀 " +``` + +### Tampilan Baterai + +Opsi konfigurasi `display` digunakan untuk menentukan kapan indikator baterai harus ditampilkan (threshold), simbol mana yang akan digunakan (symbol), dan bagaimana seharusnya itu terlihat (style). Jika tidak ada `display` yang diberikan. Aturannya seperti yang ditunjukkan: + +```toml +[[battery.display]] +threshold = 10 +style = "bold red" +``` + +Nilai bawaan untuk opsi `charging_symbol` dan `discharging_symbol` adalah nilai dari masing-masing opsi `charging_symbol` dan `discharging_symbol` dari nilai `battery`. + +#### Opsi + +Opsi dari `display` merupakan sebuah array dari tabel berikut. + +| Opsi | Bawaan | Deskripsi | +| -------------------- | ---------- | -------------------------------------------------------------------------------------------------------------------- | +| `threshold` | `10` | The upper bound for the display option. | +| `style` | `bold red` | The style used if the display option is in use. | +| `charging_symbol` | `-` | Simbol opsional ditampilan jika opsi tampilan sedang digunakan, bawaan untuk opsi `charging_symbol` dari baterai. | +| `discharging_symbol` | `-` | Simbol opsional ditampilan jika opsi tampilan sedang digunakan, bawaan untuk opsi `discharging_symbol` dari baterai. | + +#### Contoh + +```toml +[[battery.display]] # "bold red" untuk corak gaya dan discharging_symbol ketika kapasitasnya berada di antara 0% dan 10% +threshold = 10 +style = "bold red" + +[[battery.display]] # "bold yellow" untuk corak gaya dan simbol 💦 ketika kapasitasnya berada di antara 10% dan 30% +threshold = 30 +style = "bold yellow" +discharging_symbol = 💦 + +# ketika kapasitasnya di atas 30%, indikator baterai tidak akan ditampilkan + +``` + +## Karakter + +Modul `character` menampilkan sebuah karakter (biasanya anak panah) di samping teks pada terminalmu. + +Karakter dapat memberitahu kamu apakah perintah terakhir berhasil atau tidak. Karakter dapat memberitahumu dengan dua cara ini: + +- mengganti warna (`red`/`green`) +- mengganti bentuk (`❯`/`✖`) + +Secara bawaan karakter hanya dapat mengganti warna. Jika kamu juga ingin mengganti bentuknya, perhatikan [contoh](#with-custom-error-shape) berikut. + +::: peringatan + +`error_symbol` tidak didukung pada elvish dan nu shell. + +::: + +::: peringatan + +`vicmd_symbol` hanya didukung pada fish dan zsh. + +::: + +### Opsi + +| Opsi | Bawaan | Deskripsi | +| ---------------- | ------------------- | ------------------------------------------------------------------------------------------------- | +| `format` | `"$symbol "` | Format string yang digunakan sebelum masukan teks. | +| `success_symbol` | `"[❯](bold green)"` | Format string yang digunakan sebelum masukan teks jika perintah sebelumnya berhasil. | +| `error_symbol` | `"[❯](bold red)"` | Format string yang digunakan sebelum masukan teks jika perintah sebelumnya gagal. | +| `vicmd_symbol` | `"[❮](bold green)"` | Format string yang digunakan sebelum masukan teks jika shell sedang dalam vim dengan mode normal. | +| `disabled` | `false` | Menonaktifkan module `character`. | + +### Variabel + +| Variabel | Contoh | Deskripsi | +| -------- | ------ | ---------------------------------------------------------------------- | +| symbol | | Representasi dari `success_symbol`, `error_symbol` atau `vicmd_symbol` | + +### Contoh + +#### Dengan menggunakan corak eror yang dikustomisasi + +```toml +# ~/.config/starship.toml + +[character] +success_symbol = "[➜](bold green) " +error_symbol = "[✗](bold red) " +``` + +#### Tanpa menggunakan corak eror yang dikustomisasi + +```toml +# ~/.config/starship.toml + +[character] +success_symbol = "[➜](bold green) " +error_symbol = "[➜](bold red) " +``` + +#### Dengan menggunakan corak vim yang dikustomisasi + +```toml +# ~/.config/starship.toml + +[character] +vicmd_symbol = "[V](bold green) " +``` + +## CMake + +Modul `cmake` menampilkan versi terkini dari [CMake](https://cmake.org/) yang terpasang. Secara bawaan, modul akan aktif jika beberapa syarat berikut telah terpenuhi: + +- Direktori terkini berisikan sebuah file `CMakeLists.txt` +- Direktori terkini berisikan sebuah file `CMakeCache.txt` + +### Opsi + +| Opsi | Bawaan | Deskripsi | +| ------------------- | -------------------------------------- | ----------------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | Format dari modul. | +| `version_format` | `"v${raw}"` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"△ "` | Simbol yang digunakan sebelum versi cmake. | +| `detect_extensions` | `[]` | Ekstensi mana yang sebaiknya memicu modul ini | +| `detect_files` | `["CMakeLists.txt", "CMakeCache.txt"]` | filenames mana yang sebaiknya memicu modul ini | +| `detect_folders` | `[]` | Folder mana yang sebaiknya memicul modul ini | +| `style` | `"bold blue"` | Gaya penataan untuk modul. | +| `disabled` | `false` | Menonaktifkan modul `cmake`. | + +### Variabel + +| Variabel | Contoh | Deskripsi | +| --------- | --------- | --------------------------------- | +| version | `v3.17.3` | Versi dari cmake | +| symbol | | Menyalin nilai dari opsi `symbol` | +| style\* | | Menyalin nilai dari opsi `style` | + +\*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string + +## Command Duration + +Modul `cmd_duration` menampilkan seberapa lama perintah sebelumnya membutuhkan waktu untuk dilaksanakan. Modulnya hanya akan ditampilkan jika perintahnya membutuhkan waktu lebih dari dua detik, atau ada nilai dari konfigurasi `min_time`. + +::: jangan lakukan hook DEBUG trap dalam Bash + +Jia kamu menjalankan Starship di `bash`, jangan lakukan hook DEBUG trap setelah menjalankan `eval $(starship init $0)`, atau modulnya **akan** rusak. + +::: + +Pengguna Bash yang membutuhkan fungsi seperti preexec dapat menggunakan [kerangka kerja bash_preexec dari rcaloras](https://github.com/rcaloras/bash-preexec). Cukup dengan membuat array `preexec_functions` dan `precmd_functions` sebelum menjalankan `eval $(starship init $0)`, lalu lanjutkan seperti biasa. + +### Opsi + +| Opsi | Bawaan | Deskripsi | +| -------------------- | ----------------------------- | ---------------------------------------------------------------- | +| `min_tim` | `2_000` | Durasi terpendek untuk menampilkan waktu (dalam milidetik). | +| `show_milliseconds` | `false` | Tampilkan milidetik sebagai ganti detik untuk durasinya. | +| `format` | `"took [$duration]($style) "` | Format dari modul. | +| `style` | `"bold yellow"` | Gaya penataan untuk modul. | +| `disabled` | `false` | Menonaktifkan modul `cmd_duration`. | +| `show_notifications` | `false` | Menampilkan notifikasi layar ketika perintah selesai. | +| `min_time_to_notify` | `45_000` | Durasi terpendek untuk menampilkan notifikasi (dalam milidetik). | + +::: saran + +Menampilkan notifikasi layar memerlukan starship dikembangkan dengan dukungan dari `rust-notify`. Periksa apakah starship kamu mendukung notifikasi dengan menjalankan `STARSHIP_LOG=debug starship module cmd_duration -d 60000` ketika `show_notifications` diatur menjadi `true`. + +::: + +### Variabel + +| Variabel | Contoh | Deskripsi | +| --------- | -------- | -------------------------------------------------- | +| duration | `16m40s` | Waktu yang dibutuhkan untuk menyelesaikan perintah | +| style\* | | Menyalin nilai dari opsi `style` | + +\*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string + +### Contoh + +```toml +# ~/.config/starship.toml + +[cmd_duration] +min_time = 500 +format = "underwent [$duration](bold yellow)" +``` + +## Conda + +Modul `conda` menampilkan environment conda terkini, jika `$CONDA_DEFAULT_ENV` telah diatur. + +::: saran + +Hal ini tidak menahan pengubah (modifier) prompt dari conda sendiri, kamu mungkin bisa menjalankan `conda config --set changeps1 False`. + +::: + +### Opsi + +| Opsi | Bawaan | Deskripsi | +| ------------------- | -------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `truncation_length` | `1` | The number of directories the environment path should be truncated to, if the environment was created via `conda create -p [path]`. `0` means no truncation. Also see the [`directory`](#directory) module. | +| `symbol` | `"🅒 "` | The symbol used before the environment name. | +| `style` | `"bold green"` | Gaya penataan untuk modul. | +| `format` | `"via [$symbol$environment]($style) "` | Format dari modul. | +| `ignore_base` | `true` | Ignores `base` environment when activated. | +| `disabled` | `false` | Disables the `conda` module. | + +### Variabel + +| Variabel | Contoh | Deskripsi | +| ----------- | ------------ | --------------------------------- | +| environment | `astronauts` | The current conda environment | +| symbol | | Menyalin nilai dari opsi `symbol` | +| style\* | | Menyalin nilai dari opsi `style` | + +\*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string + +### Contoh + +```toml +# ~/.config/starship.toml + +[conda] +format = "[$symbol$environment](dimmed green) " +``` + +## Crystal + +The `crystal` module shows the currently installed version of [Crystal](https://crystal-lang.org/). By default the module will be shown if any of the following conditions are met: + +- The current directory contains a `shard.yml` file +- The current directory contains a `.cr` file + +### Opsi + +| Opsi | Bawaan | Deskripsi | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `symbol` | `"🔮 "` | The symbol used before displaying the version of crystal. | +| `format` | `"via [$symbol($version )]($style)"` | Format dari modul. | +| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `style` | `"bold red"` | Gaya penataan untuk modul. | +| `detect_extensions` | `["cr"]` | Which extensions should trigger this module. | +| `detect_files` | `["shard.yml"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `disabled` | `false` | Disables the `crystal` module. | + +### Variabel + +| Variabel | Contoh | Deskripsi | +| --------- | --------- | --------------------------------- | +| version | `v0.32.1` | The version of `crystal` | +| symbol | | Menyalin nilai dari opsi `symbol` | +| style\* | | Menyalin nilai dari opsi `style` | + +\*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string + +### Contoh + +```toml +# ~/.config/starship.toml + +[crystal] +format = "via [✨ $version](bold blue) " +``` + +## Dart + +The `dart` module shows the currently installed version of [Dart](https://dart.dev/). By default the module will be shown if any of the following conditions are met: + +- The current directory contains a file with `.dart` extension +- The current directory contains a `.dart_tool` directory +- The current directory contains a `pubspec.yaml`, `pubspec.yml` or `pubspec.lock` file + +### Opsi + +| Opsi | Bawaan | Deskripsi | +| ------------------- | ------------------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | Format dari modul. | +| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"🎯 "` | A format string representing the symbol of Dart | +| `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"` | Gaya penataan untuk modul. | +| `disabled` | `false` | Disables the `dart` module. | + +### Variabel + +| Variabel | Contoh | Deskripsi | +| --------- | -------- | --------------------------------- | +| version | `v2.8.4` | The version of `dart` | +| symbol | | Menyalin nilai dari opsi `symbol` | +| style\* | | Menyalin nilai dari opsi `style` | + +\*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string + +### Contoh + +```toml +# ~/.config/starship.toml + +[dart] +format = "via [🔰 $version](bold red) " +``` + +## Deno + +The `deno` module shows you your currently installed version of [Deno](https://deno.land/). By default the module will be shown if any of the following conditions are met: +- The current directory contains a `mod.ts`, `mod.js`, `deps.ts` or `deps.js` file + +### Opsi + +| Opsi | Bawaan | Deskripsi | +| ------------------- | -------------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | Format dari modul. | +| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"🦕 "` | A format string representing the symbol of Deno | +| `detect_extensions` | `[]` | Which extensions should trigger this module. | +| `detect_files` | `["mod.ts", "mod.js", "deps.ts", "deps.js"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `style` | `"green bold"` | Gaya penataan untuk modul. | +| `disabled` | `false` | Disables the `deno` module. | + +### Variabel + +| Variabel | Contoh | Deskripsi | +| --------- | -------- | --------------------------------- | +| version | `v1.8.3` | The version of `deno` | +| symbol | | Menyalin nilai dari opsi `symbol` | +| style\* | | Menyalin nilai dari opsi `style` | + +### Contoh + +```toml +# ~/.config/starship.toml + +[deno] +format = "via [🦕 $version](green bold) " +``` + +## 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. + +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. + +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`. + +### Opsi + +| Opsi | Bawaan | Deskripsi | +| ------------------- | -------------------------------------------------- | -------------------------------------------------------------------------------- | +| `truncation_length` | `3` | The number of parent folders that the current directory should be truncated to. | +| `truncate_to_repo` | `true` | Whether or not to truncate to the root of the git repo that you're currently in. | +| `format` | `"[$path]($style)[$read_only]($read_only_style) "` | Format dari modul. | +| `style` | `"bold cyan"` | Gaya penataan untuk modul. | +| `disabled` | `false` | Disables the `directory` module. | +| `read_only` | `"🔒"` | The symbol indicating current directory is read only. | +| `read_only_style` | `"red"` | The style for the read only symbol. | +| `truncation_symbol` | `""` | The symbol to prefix to truncated paths. eg: "…/" | +| `home_symbol` | `"~"` | The symbol indicating home directory. | + +
+This module has a few advanced configuration options that control how the directory is displayed. + +| Advanced Option | Bawaan | Deskripsi | +| --------------------------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `substitutions` | | A table of substitutions to be made to the path. | +| `fish_style_pwd_dir_length` | `0` | The number of characters to use when applying fish shell pwd path logic. | +| `use_logical_path` | `true` | If `true` render the logical path sourced from the shell via `PWD` or `--logical-path`. If `false` instead render the physical filesystem path with symlinks resolved. | + +`substitutions` allows you to define arbitrary replacements for literal strings that occur in the path, for example long network prefixes or development directories (i.e. Java). Note that this will disable the fish style PWD. + +```toml +[directory.substitutions] +"/Volumes/network/path" = "/net" +"src/com/long/java/path" = "mypath" +``` + +`fish_style_pwd_dir_length` interacts with the standard truncation options in a way that can be surprising at first: if it's non-zero, the components of the path that would normally be truncated are instead displayed with that many characters. For example, the path `/built/this/city/on/rock/and/roll`, which would normally be displayed as 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`. + +
+ +### Variabel + +| Variabel | Contoh | Deskripsi | +| --------- | --------------------- | -------------------------------- | +| path | `"D:/Projects"` | The current directory path | +| style\* | `"black bold dimmed"` | Menyalin nilai dari opsi `style` | + +\*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string + +### Contoh + +```toml +# ~/.config/starship.toml + +[directory] +truncation_length = 8 +truncation_symbol = "…/" +``` + +## Docker Context + +The `docker_context` module shows the currently active [Docker context](https://docs.docker.com/engine/context/working-with-contexts/) if it's not set to `default` or if the `DOCKER_HOST` or `DOCKER_CONTEXT` environment variables are set (as they are meant to override the context in use). + +### Opsi + +| Opsi | Bawaan | Deskripsi | +| ------------------- | ------------------------------------------------------------- | --------------------------------------------------------------------------------- | +| `format` | `"via [$symbol$context]($style) "` | Format dari modul. | +| `symbol` | `"🐳 "` | The symbol used before displaying the Docker context. | +| `only_with_files` | `true` | Only show when there's a match | +| `detect_extensions` | `[]` | Which extensions should trigger this module (needs `only_with_files` to be true). | +| `detect_files` | `["docker-compose.yml", "docker-compose.yaml", "Dockerfile"]` | Which filenames should trigger this module (needs `only_with_files` to be true). | +| `detect_folders` | `[]` | Which folders should trigger this module (needs `only_with_files` to be true). | +| `style` | `"blue bold"` | Gaya penataan untuk modul. | +| `disabled` | `false` | Disables the `docker_context` module. | + +### Variabel + +| Variabel | Contoh | Deskripsi | +| --------- | -------------- | --------------------------------- | +| context | `test_context` | The current docker context | +| symbol | | Menyalin nilai dari opsi `symbol` | +| style\* | | Menyalin nilai dari opsi `style` | + +\*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string + +### Contoh + +```toml +# ~/.config/starship.toml + +[docker_context] +format = "via [🐋 $context](blue bold)" +``` + +## Dotnet + +The `dotnet` module shows the relevant version of the [.NET Core SDK](https://dotnet.microsoft.com/) for the current directory. 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. + +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: + +- `global.json` +- `project.json` +- `Directory.Build.props` +- `Directory.Build.targets` +- `Packages.props` +- `*.csproj` +- `*.fsproj` +- `*.xproj` + +You'll also need the .NET Core SDK installed in order to use it correctly. + +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. + +The module will also show the Target Framework Moniker () when there is a csproj file in the current directory. + +### Opsi + +| Opsi | Bawaan | Deskripsi | +| ------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )(🎯 $tfm )]($style)"` | Format dari modul. | +| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `".NET "` | The symbol used before displaying the version of dotnet. | +| `heuristic` | `true` | Use faster version detection to keep starship snappy. | +| `detect_extensions` | `["csproj", "fsproj", "xproj"]` | Which extensions should trigger this module. | +| `detect_files` | `["global.json", "project.json", "Directory.Build.props", "Directory.Build.targets", "Packages.props"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this modules. | +| `style` | `"bold blue"` | Gaya penataan untuk modul. | +| `disabled` | `false` | Disables the `dotnet` module. | + +### Variabel + +| Variabel | Contoh | Deskripsi | +| --------- | ---------------- | ------------------------------------------------------------------ | +| version | `v3.1.201` | The version of `dotnet` sdk | +| tfm | `netstandard2.0` | The Target Framework Moniker that the current project is targeting | +| symbol | | Menyalin nilai dari opsi `symbol` | +| style\* | | Menyalin nilai dari opsi `style` | + +\*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string + +### Contoh + +```toml +# ~/.config/starship.toml + +[dotnet] +symbol = "🥅 " +style = "green" +heuristic = false +``` + +## Elixir + +The `elixir` module shows the currently installed version of [Elixir](https://elixir-lang.org/) and [Erlang/OTP](https://erlang.org/doc/). By default the module will be shown if any of the following conditions are met: + +- The current directory contains a `mix.exs` file. + +### Opsi + +| Opsi | Bawaan | Deskripsi | +| ------------------- | ----------------------------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `'via [$symbol($version \(OTP $otp_version\) )]($style)'` | The format for the module elixir. | +| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"💧 "` | The symbol used before displaying the version of Elixir/Erlang. | +| `detect_extensions` | `[]` | Which extensions should trigger this module. | +| `detect_files` | `["mix.exs"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this modules. | +| `style` | `"bold purple"` | Gaya penataan untuk modul. | +| `disabled` | `false` | Disables the `elixir` module. | + +### Variabel + +| Variabel | Contoh | Deskripsi | +| ----------- | ------- | --------------------------------- | +| version | `v1.10` | The version of `elixir` | +| otp_version | | The otp version of `elixir` | +| symbol | | Menyalin nilai dari opsi `symbol` | +| style\* | | Menyalin nilai dari opsi `style` | + +\*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string + +### Contoh + +```toml +# ~/.config/starship.toml + +[elixir] +symbol = "🔮 " +``` + +## Elm + +The `elm` module shows the currently installed version of [Elm](https://elm-lang.org/). By default the module will be shown if any of the following conditions are met: + +- The current directory contains a `elm.json` file +- The current directory contains a `elm-package.json` file +- The current directory contains a `.elm-version` file +- The current directory contains a `elm-stuff` folder +- The current directory contains a `*.elm` files + +### Opsi + +| Opsi | Bawaan | Deskripsi | +| ------------------- | -------------------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | Format dari modul. | +| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"🌳 "` | A format string representing the symbol of Elm. | +| `detect_extensions` | `["elm"]` | Which extensions should trigger this module. | +| `detect_files` | `["elm.json", "elm-package.json", ".elm-version"]` | Which filenames should trigger this module. | +| `detect_folders` | `["elm-stuff"]` | Which folders should trigger this modules. | +| `style` | `"cyan bold"` | Gaya penataan untuk modul. | +| `disabled` | `false` | Disables the `elm` module. | + +### Variabel + +| Variabel | Contoh | Deskripsi | +| --------- | --------- | --------------------------------- | +| version | `v0.19.1` | The version of `elm` | +| symbol | | Menyalin nilai dari opsi `symbol` | +| style\* | | Menyalin nilai dari opsi `style` | + +\*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string + +### Contoh + +```toml +# ~/.config/starship.toml + +[elm] +format = "via [ $version](cyan bold) " +``` + +## Environment Variable + +The `env_var` module displays the current value of a selected environment variables. The module will be shown only if any of the following conditions are met: + +- The `variable` configuration option matches an existing environment variable +- The `variable` configuration option is not defined, but the `default` configuration option is + + +::: tip Multiple environmental variables can be displayed by using a `.`. (see example) If the `variable` configuration option is not set, the module will display value of variable under the name of text after the `.` character. + +Example: following configuration will display value of USER environment variable +```toml +# ~/.config/starship.toml + +[env_var.USER] +default = "unknown user" +``` +::: + +### Opsi + +| Opsi | Bawaan | Deskripsi | +| ---------- | ------------------------------ | ---------------------------------------------------------------------------- | +| `symbol` | | The symbol used before displaying the variable value. | +| `variable` | | The environment variable to be displayed. | +| `default` | | The default value to be displayed when the selected variable is not defined. | +| `format` | `"with [$env_value]($style) "` | Format dari modul. | +| `disabled` | `false` | Disables the `env_var` module. | + +### Variabel + +| Variabel | Contoh | Deskripsi | +| --------- | ------------------------------------------- | ------------------------------------------ | +| env_value | `Windows NT` (if _variable_ would be `$OS`) | The environment value of option `variable` | +| symbol | | Menyalin nilai dari opsi `symbol` | +| style\* | `black bold dimmed` | Menyalin nilai dari opsi `style` | + +\*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string + +### Contoh + +```toml +# ~/.config/starship.toml + +[env_var] +variable = "SHELL" +default = "unknown shell" +``` + +Displaying multiple environmental variables: +```toml +# ~/.config/starship.toml + +[env_var.SHELL] +variable = "SHELL" +default = "unknown shell" +[env_var.USER] +default = "unknown user" +``` + +## Erlang + +The `erlang` module shows the currently installed version of [Erlang/OTP](https://erlang.org/doc/). By default the module will be shown if any of the following conditions are met: + +- The current directory contains a `rebar.config` file. +- The current directory contains a `erlang.mk` file. + +### Opsi + +| Opsi | Bawaan | Deskripsi | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | Format dari modul. | +| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `" "` | The symbol used before displaying the version of erlang. | +| `style` | `"bold red"` | Gaya penataan untuk modul. | +| `detect_extensions` | `[]` | Which extensions should trigger this module. | +| `detect_files` | `["rebar.config", "elang.mk"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this modules. | +| `disabled` | `false` | Disables the `erlang` module. | + +### Variabel + +| Variabel | Contoh | Deskripsi | +| --------- | --------- | --------------------------------- | +| version | `v22.1.3` | The version of `erlang` | +| symbol | | Menyalin nilai dari opsi `symbol` | +| style\* | | Menyalin nilai dari opsi `style` | + +\*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string + +### Contoh + +```toml +# ~/.config/starship.toml + +[erlang] +format = "via [e $version](bold red) " +``` + +## Google Cloud (`gcloud`) + +The `gcloud` module shows the current configuration for [`gcloud`](https://cloud.google.com/sdk/gcloud) CLI. This is based on the `~/.config/gcloud/active_config` file and the `~/.config/gcloud/configurations/config_{CONFIG NAME}` file and the `CLOUDSDK_CONFIG` env var. + +### Opsi + +| Opsi | Bawaan | Deskripsi | +| ---------------- | ---------------------------------------------------------- | --------------------------------------------------------------- | +| `format` | `'on [$symbol$account(@$domain)(\($region\))]($style) '` | Format dari modul. | +| `symbol` | `"☁️ "` | The symbol used before displaying the current GCP profile. | +| `region_aliases` | | Table of region aliases to display in addition to the GCP name. | +| `style` | `"bold blue"` | Gaya penataan untuk modul. | +| `disabled` | `false` | Disables the `gcloud` module. | + +### Variabel + +| Variabel | Contoh | Deskripsi | +| --------- | ------------- | ------------------------------------------------------------------ | +| region | `us-central1` | The current GCP region | +| account | `foo` | The current GCP profile | +| domain | `example.com` | The current GCP profile domain | +| project | | The current GCP project | +| active | `default` | The active config name written in `~/.config/gcloud/active_config` | +| symbol | | Menyalin nilai dari opsi `symbol` | +| style\* | | Menyalin nilai dari opsi `style` | + +\*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string + +### Contoh + +#### Display account and project + +```toml +# ~/.config/starship.toml + +[gcloud] +format = 'on [$symbol$account(@$domain)(\($project\))]($style) ' +``` + +#### Display active config name only + +```toml +# ~/.config/starship.toml + +[gcloud] +format = "[$symbol$active]($style) " +style = "bold yellow" +``` + +#### Display account and aliased region + +```toml +# ~/.config/starship.toml + +[gcloud] +symbol = "️🇬️ " +[gcloud.region_aliases] +us-central1 = "uc1" +asia-northeast1 = "an1" +``` + +## Git Branch + +The `git_branch` module shows the active branch of the repo in your current directory. + +### Opsi + +| Opsi | Bawaan | Deskripsi | +| -------------------- | -------------------------------- | ---------------------------------------------------------------------------------------- | +| `always_show_remote` | `false` | Shows the remote tracking branch name, even if it is equal to the local branch name. | +| `format` | `"on [$symbol$branch]($style) "` | Format dari modul. Use `"$branch"` to refer to the current branch name. | +| `symbol` | `" "` | A format string representing the symbol of git branch. | +| `style` | `"bold purple"` | Gaya penataan untuk modul. | +| `truncation_length` | `2^63 - 1` | Truncates a git branch to `N` graphemes. | +| `truncation_symbol` | `"…"` | The symbol used to indicate a branch name was truncated. You can use `""` for no symbol. | +| `only_attached` | `false` | Only show the branch name when not in a detached `HEAD` state. | +| `disabled` | `false` | Disables the `git_branch` module. | + +### Variabel + +| Variabel | Contoh | Deskripsi | +| ------------- | -------- | ------------------------------------------------------------------------------------------------------ | +| branch | `master` | The current branch name, falls back to `HEAD` if there's no current branch (e.g. git detached `HEAD`). | +| remote_name | `origin` | The remote name. | +| remote_branch | `master` | The name of the branch tracked on `remote_name`. | +| symbol | | Menyalin nilai dari opsi `symbol` | +| style\* | | Menyalin nilai dari opsi `style` | + +\*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string + +### Contoh + +```toml +# ~/.config/starship.toml + +[git_branch] +symbol = "🌱 " +truncation_length = 4 +truncation_symbol = "" +``` + +## Git Commit + +The `git_commit` module shows the current commit hash and also the tag (if any) of the repo in your current directory. + +### Opsi + +| Opsi | Bawaan | Deskripsi | +| -------------------- | ---------------------------------- | ------------------------------------------------------- | +| `commit_hash_length` | `7` | The length of the displayed git commit hash. | +| `format` | `"[\\($hash$tag\\)]($style) "` | Format dari modul. | +| `style` | `"bold green"` | Gaya penataan untuk modul. | +| `only_detached` | `true` | Only show git commit hash when in detached `HEAD` state | +| `tag_disabled` | `true` | Disables showing tag info in `git_commit` module. | +| `tag_symbol` | `" 🏷 "` | Tag symbol prefixing the info shown | +| `disabled` | `false` | Disables the `git_commit` module. | + +### Variabel + +| Variabel | Contoh | Deskripsi | +| --------- | --------- | -------------------------------- | +| hash | `b703eb3` | The current git commit hash | +| style\* | | Menyalin nilai dari opsi `style` | + +\*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string + +### Contoh + +```toml +# ~/.config/starship.toml + +[git_commit] +commit_hash_length = 4 +tag_symbol = "🔖 " +``` + +## Git State + +The `git_state` module will show in directories which are part of a git repository, and where there is an operation in progress, such as: _REBASING_, _BISECTING_, etc. If there is progress information (e.g., REBASING 3/10), that information will be shown too. + +### Opsi + +| Opsi | Bawaan | Deskripsi | +| -------------- | --------------------------------------------------------------- | --------------------------------------------------------------------------------------- | +| `rebase` | `"REBASING"` | A format string displayed when a `rebase` is in progress. | +| `merge` | `"MERGING"` | A format string displayed when a `merge` is in progress. | +| `revert` | `"REVERTING"` | A format string displayed when a `revert` is in progress. | +| `cherry_pick` | `"CHERRY-PICKING"` | A format string displayed when a `cherry-pick` is in progress. | +| `bisect` | `"BISECTING"` | A format string displayed when a `bisect` is in progress. | +| `am` | `"AM"` | A format string displayed when an `apply-mailbox` (`git am`) is in progress. | +| `am_or_rebase` | `"AM/REBASE"` | A format string displayed when an ambiguous `apply-mailbox` or `rebase` is in progress. | +| `style` | `"bold yellow"` | Gaya penataan untuk modul. | +| `format` | `'\([$state( $progress_current/$progress_total)]($style)\) '` | Format dari modul. | +| `disabled` | `false` | Disables the `git_state` module. | + +### Variabel + +| Variabel | Contoh | Deskripsi | +| ---------------- | ---------- | -------------------------------- | +| state | `REBASING` | The current state of the repo | +| progress_current | `1` | The current operation progress | +| progress_total | `2` | The total operation progress | +| style\* | | Menyalin nilai dari opsi `style` | + +\*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string + +### Contoh + +```toml +# ~/.config/starship.toml + +[git_state] +format = '[\($state( $progress_current of $progress_total)\)]($style) ' +cherry_pick = "[🍒 PICKING](bold red)" +``` + +## Git Metrics + +The `git_metrics` module will show the number of added and deleted lines in the current git repository. + +::: saran + +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + +::: + +### Opsi + +| Opsi | Bawaan | Deskripsi | +| --------------- | -------------------------------------------------------- | ---------------------------------- | +| `added_style` | `"bold green"` | The style for the added count. | +| `deleted_style` | `"bold red"` | The style for the deleted count. | +| `format` | `'[+$added]($added_style) [-$deleted]($deleted_style) '` | Format dari modul. | +| `disabled` | `true` | Disables the `git_metrics` module. | + +### Variabel + +| Variabel | Contoh | Deskripsi | +| ----------------- | ------ | ------------------------------------------- | +| added | `1` | The current number of added lines | +| deleted | `2` | The current number of deleted lines | +| added_style\* | | Mirrors the value of option `added_style` | +| deleted_style\* | | Mirrors the value of option `deleted_style` | + +\*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string + +### Contoh + +```toml +# ~/.config/starship.toml + +[git_metrics] +added_style = "bold blue" +format = '[+$added]($added_style)/[-$deleted]($deleted_style) ' +``` + +## Git Status + +The `git_status` module shows symbols representing the state of the repo in your current directory. + +### Opsi + +| Opsi | Bawaan | Deskripsi | +| ------------ | ----------------------------------------------- | ----------------------------------- | +| `format` | `'([\[$all_status$ahead_behind\]]($style) )'` | The default format for `git_status` | +| `conflicted` | `"="` | This branch has merge conflicts. | +| `ahead` | `"⇡"` | The format of `ahead` | +| `behind` | `"⇣"` | The format of `behind` | +| `diverged` | `"⇕"` | The format of `diverged` | +| `up_to_date` | `""` | The format of `up_to_date` | +| `untracked` | `"?"` | The format of `untracked` | +| `stashed` | `"$"` | The format of `stashed` | +| `modified` | `"!"` | The format of `modified` | +| `staged` | `"+"` | The format of `staged` | +| `renamed` | `"»"` | The format of `renamed` | +| `deleted` | `"✘"` | The format of `deleted` | +| `style` | `"bold red"` | Gaya penataan untuk modul. | +| `disabled` | `false` | Disables the `git_status` module. | + +### Variabel + +The following variables can be used in `format`: + +| Variabel | Deskripsi | +| -------------- | ------------------------------------------------------------------------------------------------------------- | +| `all_status` | Shortcut for`$conflicted$stashed$deleted$renamed$modified$staged$untracked` | +| `ahead_behind` | Displays `diverged`, `ahead`, `behind` or `up_to_date` format string based on the current status of the repo. | +| `conflicted` | Displays `conflicted` when this branch has merge conflicts. | +| `untracked` | Displays `untracked` when there are untracked files in the working directory. | +| `stashed` | Displays `stashed` when a stash exists for the local repository. | +| `modified` | Displays `modified` when there are file modifications in the working directory. | +| `staged` | Displays `staged` when a new file has been added to the staging area. | +| `renamed` | Displays `renamed` when a renamed file has been added to the staging area. | +| `deleted` | Displays `deleted` when a file's deletion has been added to the staging area. | +| style\* | Menyalin nilai dari opsi `style` | + +\*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string + +The following variables can be used in `diverged`: + +| Variabel | Deskripsi | +| -------------- | ---------------------------------------------- | +| `ahead_count` | Number of commits ahead of the tracking branch | +| `behind_count` | Number of commits behind the tracking branch | + +The following variables can be used in `conflicted`, `ahead`, `behind`, `untracked`, `stashed`, `modified`, `staged`, `renamed` and `deleted`: + +| Variabel | Deskripsi | +| -------- | ------------------------ | +| `count` | Show the number of files | + +### Contoh + +```toml +# ~/.config/starship.toml + +[git_status] +conflicted = "🏳" +ahead = "🏎💨" +behind = "😰" +diverged = "😵" +up_to_date = "✓" +untracked = "🤷‍" +stashed = "📦" +modified = "📝" +staged = '[++\($count\)](green)' +renamed = "👅" +deleted = "🗑" +``` + +Show ahead/behind count of the branch being tracked + +```toml +# ~/.config/starship.toml + +[git_status] +ahead = "⇡${count}" +diverged = "⇕⇡${ahead_count}⇣${behind_count}" +behind = "⇣${count}" +``` + +## Golang + +The `golang` module shows the currently installed version of [Golang](https://golang.org/). By default the module will be shown if any of the following conditions are met: + +- The current directory contains a `go.mod` file +- The current directory contains a `go.sum` file +- The current directory contains a `glide.yaml` file +- The current directory contains a `Gopkg.yml` file +- The current directory contains a `Gopkg.lock` file +- The current directory contains a `.go-version` file +- The current directory contains a `Godeps` directory +- The current directory contains a file with the `.go` extension + +### Opsi + +| Opsi | Bawaan | Deskripsi | +| ------------------- | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | Format dari modul. | +| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"🐹 "` | A format string representing the symbol of Go. | +| `detect_extensions` | `["go"]` | Which extensions should trigger this module. | +| `detect_files` | `["go.mod", "go.sum", "glide.yaml", "Gopkg.yml", "Gopkg.lock", ".go-version"]` | Which filenames should trigger this module. | +| `detect_folders` | `["Godeps"]` | Which folders should trigger this module. | +| `style` | `"bold cyan"` | Gaya penataan untuk modul. | +| `disabled` | `false` | Disables the `golang` module. | + +### Variabel + +| Variabel | Contoh | Deskripsi | +| --------- | --------- | --------------------------------- | +| version | `v1.12.1` | The version of `go` | +| symbol | | Menyalin nilai dari opsi `symbol` | +| style\* | | Menyalin nilai dari opsi `style` | + +\*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string + +### Contoh + +```toml +# ~/.config/starship.toml + +[golang] +format = "via [🏎💨 $version](bold cyan) " +``` + +## Helm + +The `helm` module shows the currently installed version of [Helm](https://helm.sh/). By default the module will be shown if any of the following conditions are met: + +- The current directory contains a `helmfile.yaml` file +- The current directory contains a `Chart.yaml` file + +### Opsi + +| Opsi | Bawaan | Deskripsi | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | Format dari modul. | +| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `detect_extensions` | `[]` | Which extensions should trigger this module. | +| `detect_files` | `["helmfile.yaml", "Chart.yaml"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this modules. | +| `symbol` | `"⎈ "` | A format string representing the symbol of Helm. | +| `style` | `"bold white"` | Gaya penataan untuk modul. | +| `disabled` | `false` | Disables the `helm` module. | + +### Variabel + +| Variabel | Contoh | Deskripsi | +| --------- | -------- | --------------------------------- | +| version | `v3.1.1` | The version of `helm` | +| symbol | | Menyalin nilai dari opsi `symbol` | +| style\* | | Menyalin nilai dari opsi `style` | + +\*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string + +### Contoh + +```toml +# ~/.config/starship.toml + +[helm] +format = "via [⎈ $version](bold white) " +``` + +## Hostname + +The `hostname` module shows the system hostname. + +### Opsi + +| Opsi | Bawaan | Deskripsi | +| ---------- | --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | +| `ssh_only` | `true` | Only show hostname when connected to an SSH session. | +| `trim_at` | `"."` | String that the hostname is cut off at, after the first match. `"."` will stop after the first dot. `""` will disable any truncation | +| `format` | `"[$hostname]($style) in "` | Format dari modul. | +| `style` | `"bold dimmed green"` | Gaya penataan untuk modul. | +| `disabled` | `false` | Disables the `hostname` module. | + +### Variabel + +| Variabel | Contoh | Deskripsi | +| --------- | ------ | --------------------------------- | +| symbol | | Menyalin nilai dari opsi `symbol` | +| style\* | | Menyalin nilai dari opsi `style` | + +\*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string + +### Contoh + +```toml +# ~/.config/starship.toml + +[hostname] +ssh_only = false +format = "on [$hostname](bold red) " +trim_at = ".companyname.com" +disabled = false +``` + +## Java + +The `java` module shows the currently installed version of [Java](https://www.oracle.com/java/). By default the module will be shown if any of the following conditions are met: + +- The current directory contains a `pom.xml`, `build.gradle.kts`, `build.sbt`, `.java-version`, `.deps.edn`, `project.clj`, or `build.boot` file +- The current directory contains a file with the `.java`, `.class`, `.gradle`, `.jar`, `.clj`, or `.cljc` extension + +### Opsi + +| Opsi | Bawaan | Deskripsi | +| ------------------- | --------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `"via [${symbol}(${version} )]($style)"` | Format dari modul. | +| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `detect_extensions` | `["java", "class", "gradle", "jar", "cljs", "cljc"]` | Which extensions should trigger this module. | +| `detect_files` | `["pom.xml", "build.gradle.kts", "build.sbt", ".java-version", ".deps.edn", "project.clj", "build.boot"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this modules. | +| `symbol` | `"☕ "` | A format string representing the symbol of Java | +| `style` | `"red dimmed"` | Gaya penataan untuk modul. | +| `disabled` | `false` | Disables the `java` module. | + +### Variabel + +| Variabel | Contoh | Deskripsi | +| --------- | ------ | --------------------------------- | +| version | `v14` | The version of `java` | +| symbol | | Menyalin nilai dari opsi `symbol` | +| style\* | | Menyalin nilai dari opsi `style` | + +\*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string + +### Contoh + +```toml +# ~/.config/starship.toml + +[java] +symbol = "🌟 " +``` + +## Jobs + +The `jobs` module shows the current number of jobs running. The module will be shown only if there are background jobs running. The module will show the number of jobs running if there are at least 2 jobs, or more than the `number_threshold` config value, if it exists. The module will show a symbol if there is at least 1 job, or more than the `symbol_threshold` config value, if it exists. You can set both values to 0 in order to *always* show the symbol and number of jobs, even if there are 0 jobs running. + +The default functionality is: + +- 0 jobs -> Nothing is shown. +- 1 job -> `symbol` is shown. +- 2 jobs or more -> `symbol` + `number` are shown. + +::: peringatan + +This module is not supported on tcsh and nu. + +::: + +::: peringatan + +The `threshold` option is deprecated, but if you want to use it, the module will show the number of jobs running if there is more than 1 job, or more than the `threshold` config value, if it exists. If `threshold` is set to 0, then the module will also show when there are 0 jobs running. + +::: + +### Opsi + +| Opsi | Bawaan | Deskripsi | +| ------------------ | ----------------------------- | ------------------------------------------------------------------------ | +| `threshold`\* | `1` | Show number of jobs if exceeded. | +| `symbol_threshold` | `1` | Show `symbol` if the job count is at least `symbol_threshold`. | +| `number_threshold` | `2` | Show the number of jobs if the job count is at least `number_threshold`. | +| `format` | `"[$symbol$number]($style) "` | Format dari modul. | +| `symbol` | `"✦"` | The string used to represent the `symbol` variable. | +| `style` | `"bold blue"` | Gaya penataan untuk modul. | +| `disabled` | `false` | Disables the `jobs` module. | + \*: This option is deprecated, please use the + +`number_threshold` and `symbol_threshold` options instead. + +### Variabel + +| Variabel | Contoh | Deskripsi | +| --------- | ------ | --------------------------------- | +| number | `1` | The number of jobs | +| symbol | | Menyalin nilai dari opsi `symbol` | +| style\* | | Menyalin nilai dari opsi `style` | + +\*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string + +### Contoh + +```toml +# ~/.config/starship.toml + +[jobs] +symbol = "+ " +number_threshold = 4 +symbol_threshold = 0 +``` + +## Julia + +The `julia` module shows the currently installed version of [Julia](https://julialang.org/). By default the module will be shown if any of the following conditions are met: + +- The current directory contains a `Project.toml` file +- The current directory contains a `Manifest.toml` file +- The current directory contains a file with the `.jl` extension + +### Opsi + +| Opsi | Bawaan | Deskripsi | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | Format dari modul. | +| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `detect_extensions` | `["jl"]` | Which extensions should trigger this module. | +| `detect_files` | `["Project.toml", "Manifest.toml"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this modules. | +| `symbol` | `"ஃ "` | A format string representing the symbol of Julia. | +| `style` | `"bold purple"` | Gaya penataan untuk modul. | +| `disabled` | `false` | Disables the `julia` module. | + +### Variabel + +| Variabel | Contoh | Deskripsi | +| --------- | -------- | --------------------------------- | +| version | `v1.4.0` | The version of `julia` | +| symbol | | Menyalin nilai dari opsi `symbol` | +| style\* | | Menyalin nilai dari opsi `style` | + +\*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string + +### Contoh + +```toml +# ~/.config/starship.toml + +[julia] +symbol = "∴ " +``` + +## Kotlin + +The `kotlin` module shows the currently installed version of [Kotlin](https://kotlinlang.org/). By default the module will be shown if any of the following conditions are met: + +- The current directory contains a `.kt` or a `.kts` file + +### Opsi + +| Opsi | Bawaan | Deskripsi | +| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | Format dari modul. | +| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `detect_extensions` | `["kt", "kts"]` | Which extensions should trigger this module. | +| `detect_files` | `[]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this modules. | +| `symbol` | `"🅺 "` | A format string representing the symbol of Kotlin. | +| `style` | `"bold blue"` | Gaya penataan untuk modul. | +| `kotlin_binary` | `"kotlin"` | Configures the kotlin binary that Starship executes when getting the version. | +| `disabled` | `false` | Disables the `kotlin` module. | + +### Variabel + +| Variabel | Contoh | Deskripsi | +| --------- | --------- | --------------------------------- | +| version | `v1.4.21` | The version of `kotlin` | +| symbol | | Menyalin nilai dari opsi `symbol` | +| style\* | | Menyalin nilai dari opsi `style` | + +\*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string + +### Contoh + +```toml +# ~/.config/starship.toml + +[kotlin] +symbol = "🅺 " +``` + +```toml +# ~/.config/starship.toml + +[kotlin] +# Uses the Kotlin Compiler binary to get the installed version +kotlin_binary = "kotlinc" +``` + +## Kubernetes + +Displays the current [Kubernetes context](https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/#context) name and, if set, the namespace from the kubeconfig file. The namespace needs to be set in the kubeconfig file, this can be done via `kubectl config set-context starship-cluster --namespace astronaut`. If the `$KUBECONFIG` env var is set the module will use that if not it will use the `~/.kube/config`. + +::: saran + +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + +::: + +### Opsi + +| Opsi | Bawaan | Deskripsi | +| ----------------- | ---------------------------------------------------- | --------------------------------------------------------------------- | +| `symbol` | `"☸ "` | A format string representing the symbol displayed before the Cluster. | +| `format` | `'[$symbol$context( \($namespace\))]($style) in '` | Format dari modul. | +| `style` | `"cyan bold"` | Gaya penataan untuk modul. | +| `context_aliases` | | Table of context aliases to display. | +| `disabled` | `true` | Disables the `kubernetes` module. | + +### Variabel + +| Variabel | Contoh | Deskripsi | +| --------- | -------------------- | ---------------------------------------- | +| context | `starship-cluster` | The current kubernetes context | +| namespace | `starship-namespace` | If set, the current kubernetes namespace | +| symbol | | Menyalin nilai dari opsi `symbol` | +| style\* | | Menyalin nilai dari opsi `style` | + +\*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string + +### Contoh + +```toml +# ~/.config/starship.toml + +[kubernetes] +format = 'on [⛵ $context \($namespace\)](dimmed green) ' +disabled = false +[kubernetes.context_aliases] +"dev.local.cluster.k8s" = "dev" +".*/openshift-cluster/.*" = "openshift" +"gke_.*_(?P[\\w-]+)" = "gke-$cluster" +``` + +#### Regex Matching + +Additional to simple aliasing, `context_aliases` also supports extended matching and renaming using regular expressions. + +The regular expression must match on the entire kube context, capture groups can be referenced using `$name` and `$N` in the replacement. This is more explained in the [regex crate](https://docs.rs/regex/1.5.4/regex/struct.Regex.html#method.replace) documentation. + +Long and automatically generated cluster names can be identified and shortened using regular expressions: + +```toml +[kubernetes.context_aliases] +# OpenShift contexts carry the namespace and user in the kube context: `namespace/name/user`: +".*/openshift-cluster/.*" = "openshift" +# Or better, to rename every OpenShift cluster at once: +".*/(?P[\\w-]+)/.*" = "$cluster" + +# Contexts from GKE, AWS and other cloud providers usually carry additional information, like the region/zone. +# The following entry matches on the GKE format (`gke_projectname_zone_cluster-name`) +# and renames every matching kube context into a more readable format (`gke-cluster-name`): +"gke_.*_(?P[\\w-]+)" = "gke-$cluster" +``` + +## Line Break + +The `line_break` module separates the prompt into two lines. + +### Opsi + +| Opsi | Bawaan | Deskripsi | +| ---------- | ------- | ------------------------------------------------------------------ | +| `disabled` | `false` | Disables the `line_break` module, making the prompt a single line. | + +### Contoh + +```toml +# ~/.config/starship.toml + +[line_break] +disabled = true +``` + +## Lua + +The `lua` module shows the currently installed version of [Lua](http://www.lua.org/). By default the module will be shown if any of the following conditions are met: + +- The current directory contains a `.lua-version` file +- The current directory contains a `lua` directory +- The current directory contains a file with the `.lua` extension + +### Opsi + +| Opsi | Bawaan | Deskripsi | +| ------------------- | ------------------------------------ | -------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | Format dari modul. | +| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"🌙 "` | A format string representing the symbol of Lua. | +| `detect_extensions` | `["lua"]` | Which extensions should trigger this module. | +| `detect_files` | `[".lua-version"]` | Which filenames should trigger this module. | +| `detect_folders` | `["lua"]` | Which folders should trigger this module. | +| `style` | `"bold blue"` | Gaya penataan untuk modul. | +| `lua_binary` | `"lua"` | Configures the lua binary that Starship executes when getting the version. | +| `disabled` | `false` | Disables the `lua` module. | + +### Variabel + +| Variabel | Contoh | Deskripsi | +| --------- | -------- | --------------------------------- | +| version | `v5.4.0` | The version of `lua` | +| symbol | | Menyalin nilai dari opsi `symbol` | +| style\* | | Menyalin nilai dari opsi `style` | + +\*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string + +### Contoh + +```toml +# ~/.config/starship.toml + +[lua] +format = "via [🌕 $version](bold blue) " +``` + +## Memory Usage + +The `memory_usage` module shows current system memory and swap usage. + +By default the swap usage is displayed if the total system swap is non-zero. + +::: saran + +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + +::: + +### Opsi + +| Opsi | Bawaan | Deskripsi | +| ----------- | ----------------------------------------------- | -------------------------------------------------------- | +| `threshold` | `75` | Hide the memory usage unless it exceeds this percentage. | +| `format` | `"via $symbol [${ram}( \| ${swap})]($style) "` | Format dari modul. | +| `symbol` | `"🐏"` | The symbol used before displaying the memory usage. | +| `style` | `"bold dimmed white"` | Gaya penataan untuk modul. | +| `disabled` | `true` | Disables the `memory_usage` module. | + +### Variabel + +| Variabel | Contoh | Deskripsi | +| ---------------- | ------------- | ------------------------------------------------------------------ | +| ram | `31GiB/65GiB` | The usage/total RAM of the current system memory. | +| ram_pct | `48%` | The percentage of the current system memory. | +| swap\*\* | `1GiB/4GiB` | The swap memory size of the current system swap memory file. | +| swap_pct\*\* | `77%` | The swap memory percentage of the current system swap memory file. | +| symbol | `🐏` | Menyalin nilai dari opsi `symbol` | +| style\* | | Menyalin nilai dari opsi `style` | + +\*: This variable can only be used as a part of a style string \*\*: The SWAP file information is only displayed if detected on the current system + +### Contoh + +```toml +# ~/.config/starship.toml + +[memory_usage] +disabled = false +threshold = -1 +symbol = " " +style = "bold dimmed green" +``` + +## Mercurial Branch + +The `hg_branch` module shows the active branch of the repo in your current directory. + +### Opsi + +| Opsi | Bawaan | Deskripsi | +| ------------------- | -------------------------------- | -------------------------------------------------------------------------------------------- | +| `symbol` | `" "` | The symbol used before the hg bookmark or branch name of the repo in your current directory. | +| `style` | `"bold purple"` | Gaya penataan untuk modul. | +| `format` | `"on [$symbol$branch]($style) "` | Format dari modul. | +| `truncation_length` | `2^63 - 1` | Truncates the hg branch name to `N` graphemes | +| `truncation_symbol` | `"…"` | The symbol used to indicate a branch name was truncated. | +| `disabled` | `true` | Disables the `hg_branch` module. | + +### Variabel + +| Variabel | Contoh | Deskripsi | +| --------- | -------- | --------------------------------- | +| branch | `master` | The active mercurial branch | +| symbol | | Menyalin nilai dari opsi `symbol` | +| style\* | | Menyalin nilai dari opsi `style` | + +\*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string + +### Contoh + +```toml +# ~/.config/starship.toml + +[hg_branch] +format = "on [🌱 $branch](bold purple)" +truncation_length = 4 +truncation_symbol = "" +``` + +## Nim + +The `nim` module shows the currently installed version of [Nim](https://nim-lang.org/). By default the module will be shown if any of the following conditions are met: + +- The current directory contains a `nim.cfg` file +- The current directory contains a file with the `.nim` extension +- The current directory contains a file with the `.nims` extension +- The current directory contains a file with the `.nimble` extension + +### Opsi + +| Opsi | Bawaan | Deskripsi | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module | +| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"👑 "` | The symbol used before displaying the version of Nim. | +| `detect_extensions` | `["nim", "nims", "nimble"]` | Which extensions should trigger this module. | +| `detect_files` | `["nim.cfg"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `style` | `"bold yellow"` | Gaya penataan untuk modul. | +| `disabled` | `false` | Disables the `nim` module. | + +### Variabel + +| Variabel | Contoh | Deskripsi | +| --------- | -------- | --------------------------------- | +| version | `v1.2.0` | The version of `nimc` | +| symbol | | Menyalin nilai dari opsi `symbol` | +| style\* | | Menyalin nilai dari opsi `style` | + +\*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string + +### Contoh + +```toml +# ~/.config/starship.toml + +[nim] +style = "yellow" +symbol = "🎣 " +``` + +## Nix-shell + +The `nix_shell` module shows the [nix-shell](https://nixos.org/guides/nix-pills/developing-with-nix-shell.html) environment. The module will be shown when inside a nix-shell environment. + +### Opsi + +| Opsi | Bawaan | Deskripsi | +| ------------ | ---------------------------------------------- | ----------------------------------------------------- | +| `format` | `'via [$symbol$state( \($name\))]($style) '` | Format dari modul. | +| `symbol` | `"❄️ "` | A format string representing the symbol of nix-shell. | +| `style` | `"bold blue"` | Gaya penataan untuk modul. | +| `impure_msg` | `"impure"` | A format string shown when the shell is impure. | +| `pure_msg` | `"pure"` | A format string shown when the shell is pure. | +| `disabled` | `false` | Disables the `nix_shell` module. | + +### Variabel + +| Variabel | Contoh | Deskripsi | +| --------- | ------- | --------------------------------- | +| state | `pure` | The state of the nix-shell | +| name | `lorri` | The name of the nix-shell | +| symbol | | Menyalin nilai dari opsi `symbol` | +| style\* | | Menyalin nilai dari opsi `style` | + +\*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string + +### Contoh + +```toml +# ~/.config/starship.toml + +[nix_shell] +disabled = true +impure_msg = "[impure shell](bold red)" +pure_msg = "[pure shell](bold green)" +format = 'via [☃️ $state( \($name\))](bold blue) ' +``` + +## Node.js + +The `nodejs` module shows the currently installed version of [Node.js](https://nodejs.org/). By default the module will be shown if any of the following conditions are met: + +- The current directory contains a `package.json` file +- The current directory contains a `.node-version` file +- The current directory contains a `.nvmrc` file +- The current directory contains a `node_modules` directory +- The current directory contains a file with the `.js`, `.mjs` or `.cjs` extension +- The current directory contains a file with the `.ts` extension + +### Opsi + +| Opsi | Bawaan | Deskripsi | +| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | Format dari modul. | +| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `" "` | A format string representing the symbol of Node.js. | +| `detect_extensions` | `["js", "mjs", "cjs", "ts"]` | Which extensions should trigger this module. | +| `detect_files` | `["package.json", ".node-version"]` | Which filenames should trigger this module. | +| `detect_folders` | `["node_modules"]` | Which folders should trigger this module. | +| `style` | `"bold green"` | Gaya penataan untuk modul. | +| `disabled` | `false` | Disables the `nodejs` module. | +| `not_capable_style` | `bold red` | The style for the module when an engines property in package.json does not match the Node.js version. | + +### Variabel + +| Variabel | Contoh | Deskripsi | +| --------- | ---------- | --------------------------------- | +| version | `v13.12.0` | The version of `node` | +| symbol | | Menyalin nilai dari opsi `symbol` | +| style\* | | Menyalin nilai dari opsi `style` | + +\*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string + +### Contoh + +```toml +# ~/.config/starship.toml + +[nodejs] +format = "via [🤖 $version](bold green) " +``` + +## OCaml + +The `ocaml` module shows the currently installed version of [OCaml](https://ocaml.org/). By default the module will be shown if any of the following conditions are met: + +- The current directory contains a file with `.opam` extension or `_opam` directory +- The current directory contains a `esy.lock` directory +- The current directory contains a `dune` or `dune-project` file +- The current directory contains a `jbuild` or `jbuild-ignore` file +- The current directory contains a `.merlin` file +- The current directory contains a file with `.ml`, `.mli`, `.re` or `.rei` extension + +### Opsi + +| Opsi | Bawaan | Deskripsi | +| ------------------------- | -------------------------------------------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )(\($switch_indicator$switch_name\) )]($style)"` | The format string for the module. | +| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"🐫 "` | The symbol used before displaying the version of OCaml. | +| `global_switch_indicator` | `""` | The format string used to represent global OPAM switch. | +| `local_switch_indicator` | `"*"` | The format string used to represent local OPAM switch. | +| `detect_extensions` | `["opam", "ml", "mli", "re", "rei"]` | Which extensions should trigger this module. | +| `detect_files` | `["dune", "dune-project", "jbuild", "jbuild-ignore", ".merlin"]` | Which filenames should trigger this module. | +| `detect_folders` | `["_opam", "esy.lock"]` | Which folders should trigger this module. | +| `style` | `"bold yellow"` | Gaya penataan untuk modul. | +| `disabled` | `false` | Disables the `ocaml` module. | + +### Variabel + +| Variabel | Contoh | Deskripsi | +| ---------------- | ------------ | ----------------------------------------------------------------- | +| version | `v4.10.0` | The version of `ocaml` | +| switch_name | `my-project` | The active OPAM switch | +| switch_indicator | | Mirrors the value of `indicator` for currently active OPAM switch | +| symbol | | Menyalin nilai dari opsi `symbol` | +| style\* | | Menyalin nilai dari opsi `style` | + +\*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string + +### Contoh + +```toml +# ~/.config/starship.toml + +[ocaml] +format = "via [🐪 $version]($style) " +``` + +## OpenStack + +The `openstack` module shows the current OpenStack cloud and project. The module only active when the `OS_CLOUD` env var is set, in which case it will read `clouds.yaml` file from any of the [default locations](https://docs.openstack.org/python-openstackclient/latest/configuration/index.html#configuration-files). to fetch the current project in use. + +### Opsi + +| Opsi | Bawaan | Deskripsi | +| ---------- | --------------------------------------------------- | -------------------------------------------------------------- | +| `format` | `"on [$symbol$cloud(\\($project\\))]($style) "` | Format dari modul. | +| `symbol` | `"☁️ "` | The symbol used before displaying the current OpenStack cloud. | +| `style` | `"bold yellow"` | Gaya penataan untuk modul. | +| `disabled` | `false` | Disables the `openstack` module. | + +### Variabel + +| Variabel | Contoh | Deskripsi | +| --------- | ------ | --------------------------------- | +| cloud | `corp` | The current OpenStack cloud | +| project | `dev` | The current OpenStack project | +| symbol | | Menyalin nilai dari opsi `symbol` | +| style\* | | Menyalin nilai dari opsi `style` | + +\*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string + +### Contoh + +```toml +# ~/.config/starship.toml + +[openstack] +format = "on [$symbol$cloud(\\($project\\))]($style) " +style = "bold yellow" +symbol = "☁️ " +``` + +## Package Version + +The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `composer`, `gradle`, `julia`, `mix` and `helm` packages. + +- [**npm**](https://docs.npmjs.com/cli/commands/npm) – The `npm` package version is extracted from the `package.json` present in the current directory +- [**cargo**](https://doc.rust-lang.org/cargo/) – The `cargo` package version is extracted from the `Cargo.toml` present in the current directory +- [**nimble**](https://github.com/nim-lang/nimble) - The `nimble` package version is extracted from the `*.nimble` file present in the current directory with the `nimble dump` command +- [**poetry**](https://python-poetry.org/) – The `poetry` package version is extracted from the `pyproject.toml` present in the current directory +- [**python**](https://www.python.org) - The `python` package version is extracted from the `setup.cfg` present in the current directory +- [**composer**](https://getcomposer.org/) – The `composer` package version is extracted from the `composer.json` present in the current directory +- [**gradle**](https://gradle.org/) – The `gradle` package version is extracted from the `build.gradle` present +- [**julia**](https://docs.julialang.org/en/v1/stdlib/Pkg/) - The package version is extracted from the `Project.toml` present +- [**mix**](https://hexdocs.pm/mix/) - The `mix` package version is extracted from the `mix.exs` present +- [**helm**](https://helm.sh/docs/helm/helm_package/) - The `helm` chart version is extracted from the `Chart.yaml` present +- [**maven**](https://maven.apache.org/) - The `maven` package version is extracted from the `pom.xml` present +- [**meson**](https://mesonbuild.com/) - The `meson` package version is extracted from the `meson.build` present +- [**vlang**](https://vlang.io) - The `vlang` package version is extracted from the `v.mod` present + +> ⚠️ The version being shown is that of the package whose source code is in your current directory, not your package manager. + +### Opsi + +| Opsi | Bawaan | Deskripsi | +| ----------------- | --------------------------------- | ------------------------------------------------------------------------- | +| `format` | `"is [$symbol$version]($style) "` | Format dari modul. | +| `symbol` | `"📦 "` | The symbol used before displaying the version the package. | +| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `style` | `"bold 208"` | Gaya penataan untuk modul. | +| `display_private` | `false` | Enable displaying version for packages marked as private. | +| `disabled` | `false` | Disables the `package` module. | + +### Variabel + +| Variabel | Contoh | Deskripsi | +| --------- | -------- | --------------------------------- | +| version | `v1.0.0` | The version of your package | +| symbol | | Menyalin nilai dari opsi `symbol` | +| style\* | | Menyalin nilai dari opsi `style` | + +\*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string + +### Contoh + +```toml +# ~/.config/starship.toml + +[package] +format = "via [🎁 $version](208 bold) " +``` + +## Perl + +The `perl` module shows the currently installed version of [Perl](https://www.perl.org/). By default the module will be shown if any of the following conditions are met: + +- The current directory contains a `Makefile.PL` or `Build.PL` file +- The current directory contains a `cpanfile` or `cpanfile.snapshot` file +- The current directory contains a `META.json` file or `META.yml` file +- The current directory contains a `.perl-version` file +- The current directory contains a `.pl`, `.pm` or `.pod` + +### Opsi + +| Opsi | Bawaan | Deskripsi | +| ------------------- | -------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. | +| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl | +| `detect_extensions` | `["pl", "pm", "pod"]` | Which extensions should trigger this module. | +| `detect_files` | `["Makefile.PL", "Build.PL", "cpanfile", "cpanfile.snapshot", "META.json", "META.yml", ".perl-version"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `style` | `"bold 149"` | Gaya penataan untuk modul. | +| `disabled` | `false` | Disables the `perl` module. | + +### Variabel + +| Variabel | Contoh | Deskripsi | +| --------- | --------- | --------------------------------- | +| version | `v5.26.1` | The version of `perl` | +| symbol | | Menyalin nilai dari opsi `symbol` | +| style\* | | Menyalin nilai dari opsi `style` | + +### Contoh + +```toml +# ~/.config/starship.toml + +[perl] +format = "via [🦪 $version]($style) " +``` + +## PHP + +The `php` module shows the currently installed version of [PHP](https://www.php.net/). By default the module will be shown if any of the following conditions are met: + +- The current directory contains a `composer.json` file +- The current directory contains a `.php-version` file +- The current directory contains a `.php` extension + +### Opsi + +| Opsi | Bawaan | Deskripsi | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | Format dari modul. | +| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"🐘 "` | The symbol used before displaying the version of PHP. | +| `detect_extensions` | `["php"]` | Which extensions should trigger this module. | +| `detect_files` | `["composer.json", ".php-version"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `style` | `"147 bold"` | Gaya penataan untuk modul. | +| `disabled` | `false` | Disables the `php` module. | + +### Variabel + +| Variabel | Contoh | Deskripsi | +| --------- | -------- | --------------------------------- | +| version | `v7.3.8` | The version of `php` | +| symbol | | Menyalin nilai dari opsi `symbol` | +| style\* | | Menyalin nilai dari opsi `style` | + +\*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string + +### Contoh + +```toml +# ~/.config/starship.toml + +[php] +format = "via [🔹 $version](147 bold) " +``` + +## PureScript + +The `purescript` module shows the currently installed version of [PureScript](https://www.purescript.org/) version. By default the module will be shown if any of the following conditions are met: + +- The current directory contains a `spago.dhall` file +- The current directory contains a file with the `.purs` extension + +### Opsi + +| Opsi | Bawaan | Deskripsi | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | Format dari modul. | +| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"<=> "` | The symbol used before displaying the version of PureScript. | +| `detect_extensions` | `["purs"]` | 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"` | Gaya penataan untuk modul. | +| `disabled` | `false` | Disables the `purescript` module. | + +### Variabel + +| Variabel | Contoh | Deskripsi | +| --------- | -------- | --------------------------------- | +| version | `0.13.5` | The version of `purescript` | +| symbol | | Menyalin nilai dari opsi `symbol` | +| style\* | | Menyalin nilai dari opsi `style` | + +\*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string + +### Contoh + +```toml +# ~/.config/starship.toml + +[purescript] +format = "via [$symbol$version](bold white)" +``` + +## Python + +The `python` module shows the currently installed version of [Python](https://www.python.org/) and the current [Python virtual environment](https://docs.python.org/tutorial/venv.html) if one is activated. + +If `pyenv_version_name` is set to `true`, it will display the pyenv version name. Otherwise, it will display the version number from `python --version`. + +By default the module will be shown if any of the following conditions are met: + +- The current directory contains a `.python-version` file +- The current directory contains a `Pipfile` file +- The current directory contains a `__init__.py` file +- The current directory contains a `pyproject.toml` file +- The current directory contains a `requirements.txt` file +- The current directory contains a `setup.py` file +- The current directory contains a `tox.ini` file +- The current directory contains a file with the `.py` extension. +- A virtual environment is currently activated + +### Opsi + +| Opsi | Bawaan | Deskripsi | +| -------------------- | ------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------- | +| `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\) )]($style)'` | Format dari modul. | +| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"🐍 "` | A format string representing the symbol of Python | +| `style` | `"yellow bold"` | Gaya penataan untuk modul. | +| `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"]` | Ekstensi mana yang sebaiknya memicu modul ini | +| `detect_files` | `[".python-version", "Pipfile", "__init__.py", "pyproject.toml", "requirements.txt", "setup.py", "tox.ini"]` | filenames mana yang sebaiknya memicu modul ini | +| `detect_folders` | `[]` | Folder mana yang sebaiknya memicul modul ini | +| `disabled` | `false` | Disables the `python` module. | + +::: saran + +The `python_binary` variable accepts either a string or a list of strings. Starship will try executing each binary until it gets a result. Note you can only change the binary that Starship executes to get the version of Python not the arguments that are used. + +The default values and order for `python_binary` was chosen to first identify the Python version in a virtualenv/conda environments (which currently still add a `python`, no matter if it points to `python3` or `python2`). This has the side effect that if you still have a system Python 2 installed, it may be picked up before any Python 3 (at least on Linux Distros that always symlink `/usr/bin/python` to Python 2). If you do not work with Python 2 anymore but cannot remove the system Python 2, changing this to `"python3"` will hide any Python version 2, see example below. + +::: + +### Variabel + +| Variabel | Contoh | Deskripsi | +| ------------ | --------------- | ------------------------------------------ | +| version | `"v3.8.1"` | The version of `python` | +| symbol | `"🐍 "` | Menyalin nilai dari opsi `symbol` | +| style | `"yellow bold"` | Menyalin nilai dari opsi `style` | +| pyenv_prefix | `"pyenv "` | Mirrors the value of option `pyenv_prefix` | +| virtualenv | `"venv"` | The current `virtualenv` name | + +### Contoh + +```toml +# ~/.config/starship.toml + +[python] +symbol = "👾 " +pyenv_version_name = true +``` + +```toml +# ~/.config/starship.toml + +[python] +# Only use the `python3` binary to get the version. +python_binary = "python3" +``` + +```toml +# ~/.config/starship.toml + +[python] +# Don't trigger for files with the py extension +detect_extensions = [] +``` + +```toml +# ~/.config/starship.toml + +[python] +# Display the version of python from inside a local venv. +# +# Note this will only work when the venv is inside the project and it will only +# work in the directory that contains the venv dir but maybe this is ok? +python_binary = ["./venv/bin/python", "python", "python3", "python2"] +``` + +## R + +The `rlang` module shows the currently installed version of R. The module will be shown if any of the following conditions are met: + +- The current directory contains a file with the `.R` extension. +- The current directory contains a file with the `.Rd` extension. +- The current directory contains a file with the `.Rmd` extension. +- The current directory contains a file with the `.Rproj` extension. +- The current directory contains a file with the `.Rsx` extension. +- The current directory contains a `.Rprofile` file +- The current directory contains a `.Rproj.user` folder + +### Opsi + +| Opsi | Bawaan | Deskripsi | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | Format dari modul. | +| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"📐"` | A format string representing the symbol of R. | +| `style` | `"blue bold"` | Gaya penataan untuk modul. | +| `detect_extensions` | `["R", "Rd", "Rmd", "Rproj", "Rsx"]` | Ekstensi mana yang sebaiknya memicu modul ini | +| `detect_files` | `[".Rprofile"]` | filenames mana yang sebaiknya memicu modul ini | +| `detect_folders` | `[".Rproj.user"]` | Folder mana yang sebaiknya memicul modul ini | +| `disabled` | `false` | Disables the `r` module. | + +### Variabel + +| Variabel | Contoh | Deskripsi | +| -------- | ------------- | --------------------------------- | +| version | `v4.0.5` | The version of `R` | +| symbol | | Menyalin nilai dari opsi `symbol` | +| style | `"blue bold"` | Menyalin nilai dari opsi `style` | + +### Contoh + +```toml +# ~/.config/starship.toml + +[rlang] +format = "with [📐 $version](blue bold) " +``` + +## Red + +By default the `red` module shows the currently installed version of [Red](https://www.red-lang.org/). The module will be shown if any of the following conditions are met: + +- The current directory contains a file with `.red` or `.reds` extension + +### Opsi + +| Opsi | Bawaan | Deskripsi | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | Format dari modul. | +| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"🔺 "` | A format string representing the symbol of Red. | +| `detect_extensions` | `["red"]` | Which extensions should trigger this module. | +| `detect_files` | `[]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `style` | `"red bold"` | Gaya penataan untuk modul. | +| `disabled` | `false` | Disables the `red` module. | + +### Variabel + +| Variabel | Contoh | Deskripsi | +| --------- | -------- | --------------------------------- | +| version | `v2.5.1` | The version of `red` | +| symbol | | Menyalin nilai dari opsi `symbol` | +| style\* | | Menyalin nilai dari opsi `style` | + +\*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string + +### Contoh + +```toml +# ~/.config/starship.toml + +[red] +symbol = "🔴 " +``` + +## Ruby + +By default the `ruby` module shows the currently installed version of [Ruby](https://www.ruby-lang.org/). The module will be shown if any of the following conditions are met: + +- The current directory contains a `Gemfile` file +- The current directory contains a `.ruby-version` file +- The current directory contains a `.rb` file + +### Opsi + +| Opsi | Bawaan | Deskripsi | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | Format dari modul. | +| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"💎 "` | A format string representing the symbol of Ruby. | +| `detect_extensions` | `["rb"]` | Which extensions should trigger this module. | +| `detect_files` | `["Gemfile", ".ruby-version"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `style` | `"bold red"` | Gaya penataan untuk modul. | +| `disabled` | `false` | Disables the `ruby` module. | + +### Variabel + +| Variabel | Contoh | Deskripsi | +| --------- | -------- | --------------------------------- | +| version | `v2.5.1` | The version of `ruby` | +| symbol | | Menyalin nilai dari opsi `symbol` | +| style\* | | Menyalin nilai dari opsi `style` | + +\*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string + +### Contoh + +```toml +# ~/.config/starship.toml + +[ruby] +symbol = "🔺 " +``` + +## Rust + +By default the `rust` module shows the currently installed version of [Rust](https://www.rust-lang.org/). The module will be shown if any of the following conditions are met: + +- The current directory contains a `Cargo.toml` file +- The current directory contains a file with the `.rs` extension + +### Opsi + +| Opsi | Bawaan | Deskripsi | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | Format dari modul. | +| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"🦀 "` | A format string representing the symbol of Rust | +| `detect_extensions` | `["rs"]` | Which extensions should trigger this module. | +| `detect_files` | `["Cargo.toml"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `style` | `"bold red"` | Gaya penataan untuk modul. | +| `disabled` | `false` | Disables the `rust` module. | + +### Variabel + +| Variabel | Contoh | Deskripsi | +| --------- | ----------------- | --------------------------------- | +| version | `v1.43.0-nightly` | The version of `rustc` | +| symbol | | Menyalin nilai dari opsi `symbol` | +| style\* | | Menyalin nilai dari opsi `style` | + +\*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string + +### Contoh + +```toml +# ~/.config/starship.toml + +[rust] +format = "via [⚙️ $version](red bold)" +``` + +## Scala + +The `scala` module shows the currently installed version of [Scala](https://www.scala-lang.org/). By default the module will be shown if any of the following conditions are met: + +- The current directory contains a `build.sbt`, `.scalaenv` or `.sbtenv` file +- The current directory contains a file with the `.scala` or `.sbt` extension +- The current directory contains a directory named `.metals` + +### Opsi + +| Opsi | Bawaan | Deskripsi | +| ------------------- | ---------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `"via [${symbol}(${version} )]($style)"` | Format dari modul. | +| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `detect_extensions` | `["sbt", "scala"]` | Which extensions should trigger this module. | +| `detect_files` | `[".scalaenv", ".sbtenv", "build.sbt"]` | Which filenames should trigger this module. | +| `detect_folders` | `[".metals"]` | Which folders should trigger this modules. | +| `symbol` | `"🆂 "` | A format string representing the symbol of Scala. | +| `style` | `"red dimmed"` | Gaya penataan untuk modul. | +| `disabled` | `false` | Disables the `scala` module. | + +### Variabel + +| Variabel | Contoh | Deskripsi | +| --------- | -------- | --------------------------------- | +| version | `2.13.5` | The version of `scala` | +| symbol | | Menyalin nilai dari opsi `symbol` | +| style\* | | Menyalin nilai dari opsi `style` | + +\*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string + +### Contoh + +```toml +# ~/.config/starship.toml + +[scala] +symbol = "🌟 " +``` + +## Shell + +The `shell` module shows an indicator for currently used shell. + +::: saran + +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + +::: + +### Opsi + +| Opsi | Bawaan | Deskripsi | +| ---------------------- | ------------ | ------------------------------------------------------------ | +| `bash_indicator` | `bsh` | A format string used to represent bash. | +| `fish_indicator` | `fsh` | A format string used to represent fish. | +| `zsh_indicator` | `zsh` | A format string used to represent zsh. | +| `powershell_indicator` | `psh` | A format string used to represent powershell. | +| `ion_indicator` | `ion` | A format string used to represent ion. | +| `elvish_indicator` | `esh` | A format string used to represent elvish. | +| `tcsh_indicator` | `tsh` | A format string used to represent tcsh. | +| `xonsh_indicator` | `xsh` | A format string used to represent xonsh. | +| `unknown_indicator` | | The default value to be displayed when the shell is unknown. | +| `format` | `$indicator` | Format dari modul. | +| `disabled` | `true` | Disables the `shell` module. | + +### Variabel + +| Variabel | Bawaan | Deskripsi | +| --------- | ------ | ---------------------------------------------------------- | +| indicator | | Mirrors the value of `indicator` for currently used shell. | + +### Contoh + +```toml +# ~/.config/starship.toml + +[shell] +fish_indicator = "" +powershell_indicator = "_" +unknown_indicator = "mystery shell" +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. + +### Opsi + +| Opsi | Bawaan | Deskripsi | +| ----------- | ---------------------------- | ------------------------------------------------------------- | +| `threshold` | `2` | Display threshold. | +| `format` | `"[$symbol$shlvl]($style) "` | Format dari modul. | +| `symbol` | `"↕️ "` | The symbol used to represent the `SHLVL`. | +| `repeat` | `false` | Causes `symbol` to be repeated by the current `SHLVL` amount. | +| `style` | `"bold yellow"` | Gaya penataan untuk modul. | +| `disabled` | `true` | Disables the `shlvl` module. | + +### Variabel + +| Variabel | Contoh | Deskripsi | +| --------- | ------ | --------------------------------- | +| shlvl | `3` | The current value of `SHLVL` | +| symbol | | Menyalin nilai dari opsi `symbol` | +| style\* | | Menyalin nilai dari opsi `style` | + +\*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string + +### Contoh + +```toml +# ~/.config/starship.toml + +[shlvl] +disabled = false +format = "$shlvl level(s) down" +threshold = 3 +``` + +## Singularity + +The `singularity` module shows the current [Singularity](https://sylabs.io/singularity/) image, if inside a container and `$SINGULARITY_NAME` is set. + +### Opsi + +| Opsi | Bawaan | Deskripsi | +| ---------- | -------------------------------- | ------------------------------------------------ | +| `format` | `'[$symbol\[$env\]]($style) '` | Format dari modul. | +| `symbol` | `""` | A format string displayed before the image name. | +| `style` | `"bold dimmed blue"` | Gaya penataan untuk modul. | +| `disabled` | `false` | Disables the `singularity` module. | + +### Variabel + +| Variabel | Contoh | Deskripsi | +| --------- | ------------ | --------------------------------- | +| env | `centos.img` | The current Singularity image | +| symbol | | Menyalin nilai dari opsi `symbol` | +| style\* | | Menyalin nilai dari opsi `style` | + +\*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string + +### Contoh + +```toml +# ~/.config/starship.toml + +[singularity] +format = '[📦 \[$env\]]($style) ' +``` + +## Status + +The `status` module displays the exit code of the previous command. The module will be shown only if the exit code is not `0`. + +::: saran + +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + +::: + +::: warning This module is not supported on elvish and nu shell. ::: + +### Opsi + +| Opsi | Bawaan | Deskripsi | +| ----------------------- | ------------------------------------------------------------------------------------ | ------------------------------------------------------- | +| `format` | `"[$symbol$status]($style) "` | The format of the module | +| `symbol` | `"✖"` | The symbol displayed on program error | +| `success_symbol` | `"✔️"` | The symbol displayed on program success | +| `not_executable_symbol` | `"🚫"` | The symbol displayed when file isn't executable | +| `not_found_symbol` | `"🔍"` | The symbol displayed when the command can't be found | +| `sigint_symbol` | `"🧱"` | The symbol displayed on SIGINT (Ctrl + c) | +| `signal_symbol` | `"⚡"` | The symbol displayed on any signal | +| `style` | `"bold red"` | Gaya penataan untuk modul. | +| `recognize_signal_code` | `true` | Enable signal mapping from exit code | +| `map_symbol` | `false` | Enable symbols mapping from exit code | +| `pipestatus` | `false` | Enable pipestatus reporting | +| `pipestatus_separator` | `|` | The symbol that separate in pipe program exit codes | +| `pipestatus_format` | `\\[$pipestatus\\] => [$symbol$common_meaning$signal_name$maybe_int]($style)` | The format of the module when the command is a pipeline | +| `disabled` | `true` | Disables the `status` module. | + +### Variabel + +| Variabel | Contoh | Deskripsi | +| -------------- | ------- | ------------------------------------------------------------------------------------------- | +| status | `127` | The exit code of the last command | +| int | `127` | The exit code of the last command | +| common_meaning | `ERROR` | Meaning of the code if not a signal | +| signal_number | `9` | Signal number corresponding to the exit code, only if signalled | +| signal_name | `KILL` | Name of the signal corresponding to the exit code, only if signalled | +| maybe_int | `7` | Contains the exit code number when no meaning has been found | +| pipestatus | | Rendering of in pipeline programs's exit codes, this is only available in pipestatus_format | +| symbol | | Menyalin nilai dari opsi `symbol` | +| style\* | | Menyalin nilai dari opsi `style` | + +\*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string + +### Contoh + +```toml + +# ~/.config/starship.toml + +[status] +style = "bg:blue" +symbol = "🔴" +format = '[\[$symbol $common_meaning$signal_name$maybe_int\]]($style) ' +map_symbol = true +disabled = false + +``` + +## Swift + +By default the `swift` module shows the currently installed version of [Swift](https://swift.org/). The module will be shown if any of the following conditions are met: + +- The current directory contains a `Package.swift` file +- The current directory contains a file with the `.swift` extension + +### Opsi + +| Opsi | Bawaan | Deskripsi | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | Format dari modul. | +| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"🐦 "` | A format string representing the symbol of Swift | +| `detect_extensions` | `["swift"]` | 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"` | Gaya penataan untuk modul. | +| `disabled` | `false` | Disables the `swift` module. | + +### Variabel + +| Variabel | Contoh | Deskripsi | +| --------- | -------- | --------------------------------- | +| version | `v5.2.4` | The version of `swift` | +| symbol | | Menyalin nilai dari opsi `symbol` | +| style\* | | Menyalin nilai dari opsi `style` | + +\*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string + +### Contoh + +```toml +# ~/.config/starship.toml + +[swift] +format = "via [🏎 $version](red bold)" +``` + +## Terraform + +The `terraform` module shows the currently selected [Terraform workspace](https://www.terraform.io/docs/language/state/workspaces.html) and version. + +::: saran + +By default the Terraform version is not shown, since this is slow for current versions of Terraform when a lot of plugins are in use. If you still want to enable it, [follow the example shown below](#with-terraform-version). + +::: + +By default the module will be shown if any of the following conditions are met: + +- The current directory contains a `.terraform` folder +- Current directory contains a file with the `.tf` or `.hcl` extensions + +### Opsi + +| Opsi | Bawaan | Deskripsi | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol$workspace]($style) "` | The format string for the module. | +| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"💠"` | A format string shown before the terraform workspace. | +| `detect_extensions` | `["tf", "hcl"]` | Which extensions should trigger this module. | +| `detect_files` | `[]` | Which filenames should trigger this module. | +| `detect_folders` | `[".terraform"]` | Which folders should trigger this module. | +| `style` | `"bold 105"` | Gaya penataan untuk modul. | +| `disabled` | `false` | Disables the `terraform` module. | + +### Variabel + +| Variabel | Contoh | Deskripsi | +| --------- | ---------- | --------------------------------- | +| version | `v0.12.24` | The version of `terraform` | +| workspace | `default` | The current Terraform workspace | +| symbol | | Menyalin nilai dari opsi `symbol` | +| style\* | | Menyalin nilai dari opsi `style` | + +\*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string + +### Contoh + +#### With Terraform Version + +```toml +# ~/.config/starship.toml + +[terraform] +format = "[🏎💨 $version$workspace]($style) " +``` + +#### Without Terraform version + +```toml +# ~/.config/starship.toml + +[terraform] +format = "[🏎💨 $workspace]($style) " +``` + +## Time + +The `time` module shows the current **local** time. The `format` configuration value is used by the [`chrono`](https://crates.io/crates/chrono) crate to control how the time is displayed. Take a look [at the chrono strftime docs](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) to see what options are available. + +::: saran + +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + +::: + +### Opsi + +| Opsi | Bawaan | Deskripsi | +| ----------------- | ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | +| `format` | `"at [$time]($style) "` | The format string for the module. | +| `use_12hr` | `false` | Enables 12 hour formatting | +| `time_format` | see below | The [chrono format string](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) used to format the time. | +| `style` | `"bold yellow"` | The style for the module time | +| `utc_time_offset` | `"local"` | Sets the UTC offset to use. Range from -24 < x < 24. Allows floats to accommodate 30/45 minute timezone offsets. | +| `disabled` | `true` | Disables the `time` module. | +| `time_range` | `"-"` | Sets the time range during which the module will be shown. Times must be specified in 24-hours format | + +If `use_12hr` is `true`, then `time_format` defaults to `"%r"`. Otherwise, it defaults to `"%T"`. Manually setting `time_format` will override the `use_12hr` setting. + +### Variabel + +| Variabel | Contoh | Deskripsi | +| --------- | ---------- | -------------------------------- | +| time | `13:08:10` | The current time. | +| style\* | | Menyalin nilai dari opsi `style` | + +\*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string + +### Contoh + +```toml +# ~/.config/starship.toml + +[time] +disabled = false +format = '🕙[\[ $time \]]($style) ' +time_format = "%T" +utc_time_offset = "-5" +time_range = "10:00:00-14:00:00" +``` + +## Username + +The `username` module shows active user's username. The module will be shown if any of the following conditions are met: + +- The current user is root +- The current user isn't the same as the one that is logged in +- The user is currently connected as an SSH session +- The variable `show_always` is set to true + +::: saran + +SSH connection is detected by checking environment variables `SSH_CONNECTION`, `SSH_CLIENT`, and `SSH_TTY`. If your SSH host does not set up these variables, one workaround is to set one of them with a dummy value. + +::: + +### Opsi + +| Opsi | Bawaan | Deskripsi | +| ------------- | ----------------------- | ------------------------------------- | +| `style_root` | `"bold red"` | The style used when the user is root. | +| `style_user` | `"bold yellow"` | The style used for non-root users. | +| `format` | `"[$user]($style) in "` | Format dari modul. | +| `show_always` | `false` | Always shows the `username` module. | +| `disabled` | `false` | Disables the `username` module. | + +### Variabel + +| Variabel | Contoh | Deskripsi | +| -------- | ------------ | ------------------------------------------------------------------------------------------- | +| `style` | `"red bold"` | Mirrors the value of option `style_root` when root is logged in and `style_user` otherwise. | +| `user` | `"matchai"` | The currently logged-in user ID. | + +### Contoh + +```toml +# ~/.config/starship.toml + +[username] +style_user = "white bold" +style_root = "black bold" +format = "user: [$user]($style) " +disabled = false +show_always = true +``` + +## Vagrant + +The `vagrant` module shows the currently installed version of [Vagrant](https://www.vagrantup.com/). By default the module will be shown if any of the following conditions are met: + +- The current directory contains a `Vagrantfile` file + +### Opsi + +| Opsi | Bawaan | Deskripsi | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | Format dari modul. | +| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"⍱ "` | A format string representing the symbol of Vagrant. | +| `detect_extensions` | `[]` | Which extensions should trigger this module. | +| `detect_files` | `["Vagrantfile"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `style` | `"cyan bold"` | Gaya penataan untuk modul. | +| `disabled` | `false` | Disables the `vagrant` module. | + +### Variabel + +| Variabel | Contoh | Deskripsi | +| --------- | ---------------- | --------------------------------- | +| version | `Vagrant 2.2.10` | The version of `Vagrant` | +| symbol | | Menyalin nilai dari opsi `symbol` | +| style\* | | Menyalin nilai dari opsi `style` | + +\*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string + +### Contoh + +```toml +# ~/.config/starship.toml + +[vagrant] +format = "via [⍱ $version](bold white) " +``` + +## VLang + +The `vlang` module shows you your currently installed version of V. By default the module will be shown if any of the following conditions are met: +- The current directory contains a file with `.v` extension +- The current directory contains a `v.mod`, `vpkg.json` or `.vpkg-lock.json` file + +### Opsi + +| Opsi | Bawaan | Deskripsi | +| ------------------- | -------------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | Format dari modul. | +| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"V "` | A format string representing the symbol of V | +| `detect_extensions` | `["v"]` | Which extensions should trigger this module. | +| `detect_files` | `["v.mod", "vpkg.json", ".vpkg-lock.json" ]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `style` | `"blue bold"` | Gaya penataan untuk modul. | +| `disabled` | `false` | Disables the `vlang` module. | + +### Variabel + +| Variabel | Contoh | Deskripsi | +| --------- | ------ | --------------------------------- | +| version | `v0.2` | The version of `v` | +| symbol | | Menyalin nilai dari opsi `symbol` | +| style\* | | Menyalin nilai dari opsi `style` | + +### Contoh + +```toml +# ~/.config/starship.toml +[v] +format = "via [V $version](blue bold) " +``` + +## VCSH + +The `vcsh` module displays the current active [VCSH](https://github.com/RichiH/vcsh) repository. The module will be shown only if a repository is currently in use. + +### Opsi + +| Opsi | Bawaan | Deskripsi | +| ---------- | -------------------------------- | ------------------------------------------------------ | +| `symbol` | | The symbol used before displaying the repository name. | +| `style` | `"bold yellow"` | Gaya penataan untuk modul. | +| `format` | `"vcsh [$symbol$repo]($style) "` | Format dari modul. | +| `disabled` | `false` | Disables the `vcsh` module. | + +### Variabel + +| Variabel | Contoh | Deskripsi | +| --------- | ------------------------------------------- | --------------------------------- | +| repo | `dotfiles` if in a VCSH repo named dotfiles | The active repository name | +| symbol | | Menyalin nilai dari opsi `symbol` | +| style\* | `black bold dimmed` | Menyalin nilai dari opsi `style` | + +\*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string + +### Contoh + +```toml +# ~/.config/starship.toml + +[vcsh] +format = "[🆅 $repo](bold blue) " +``` + +## Zig + +By default the the `zig` module shows the currently installed version of [Zig](https://ziglang.org/). The module will be shown if any of the following conditions are met: + +- The current directory contains a `.zig` file + +### Opsi + +| Opsi | Bawaan | Deskripsi | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | Format dari modul. | +| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"↯ "` | The symbol used before displaying the version of Zig. | +| `style` | `"bold yellow"` | Gaya penataan untuk modul. | +| `disabled` | `false` | Disables the `zig` module. | +| `detect_extensions` | `["zig"]` | Which extensions should trigger this module. | +| `detect_files` | `[]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | + +### Variabel + +| Variabel | Contoh | Deskripsi | +| --------- | -------- | --------------------------------- | +| version | `v0.6.0` | The version of `zig` | +| symbol | | Menyalin nilai dari opsi `symbol` | +| style\* | | Menyalin nilai dari opsi `style` | + +\*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string + +### Contoh + +```toml +# ~/.config/starship.toml + +[zig] +symbol = "⚡️ " +``` + +## Custom commands + +The `custom` modules show the output of some arbitrary commands. + +These modules will be shown if any of the following conditions are met: + +- The current directory contains a file whose name is in `files` +- The current directory contains a directory whose name is in `directories` +- The current directory contains a file whose extension is in `extensions` +- The `when` command returns 0 +- The current Operating System (std::env::consts::OS) matchs with `os` field if defined. + +::: saran + +Multiple custom modules can be defined by using a `.`. + +::: + +::: saran + +The order in which custom modules are shown can be individually set by including `${custom.foo}` in the top level `format` (as it includes a dot, you need to use `${...}`). By default, the `custom` module will simply show all custom modules in the order they were defined. + +::: + +::: saran + +[Issue #1252](https://github.com/starship/starship/discussions/1252) contains examples of custom modules. If you have an interesting example not covered there, feel free to share it there! + +::: + +### Opsi + +| Opsi | Bawaan | Deskripsi | +| ------------- | ------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `command` | | The command whose output should be printed. The command will be passed on stdin to the shell. | +| `when` | | 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` | | [See below](#custom-command-shell) | +| `description` | `""` | 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. | +| `symbol` | `""` | The symbol used before displaying the command output. | +| `style` | `"bold green"` | Gaya penataan untuk modul. | +| `format` | `"[$symbol($output )]($style)"` | Format dari modul. | +| `disabled` | `false` | Disables this `custom` module. | +| `os` | | Operating System name on which the module will be shown (unix, linux, macos, windows, ... ) [See possible values](https://doc.rust-lang.org/std/env/consts/constant.OS.html). | + +### Variabel + +| Variabel | Deskripsi | +| --------- | -------------------------------------- | +| output | The output of shell command in `shell` | +| symbol | Menyalin nilai dari opsi `symbol` | +| style\* | Menyalin nilai dari opsi `style` | + +\*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string + +#### Custom command shell + +`shell` accepts a non-empty list of strings, where: + +- The first string is the path to the shell to use to execute the command. +- Other following arguments are passed to the shell. + +If unset, it will fallback to STARSHIP_SHELL and then to "sh" on Linux, and "cmd /C" on Windows. + +The `command` will be passed in on stdin. + +If `shell` is not given or only contains one element and Starship detects PowerShell will be used, the following arguments will automatically be added: `-NoProfile -Command -`. This behavior can be avoided by explicitly passing arguments to the shell, e.g. + +```toml +shell = ["pwsh", "-Command", "-"] +``` + +::: warning Make sure your custom shell configuration exits gracefully + +If you set a custom command, make sure that the default Shell used by starship will properly execute the command with a graceful exit (via the `shell` option). + +For example, PowerShell requires the `-Command` parameter to execute a one liner. Omitting this parameter might throw starship into a recursive loop where the shell might try to load a full profile environment with starship itself again and hence re-execute the custom command, getting into a never ending loop. + +Parameters similar to `-NoProfile` in PowerShell are recommended for other shells as well to avoid extra loading time of a custom profile on every starship invocation. + +Automatic detection of shells and proper parameters addition are currently implemented, but it's possible that not all shells are covered. [Please open an issue](https://github.com/starship/starship/issues/new/choose) with shell details and starship configuration if you hit such scenario. + +::: + +### Contoh + +```toml +# ~/.config/starship.toml + +[custom.foo] +command = "echo foo" # shows output of command +files = ["foo"] # can specify filters +when = """ test "$HOME" == "$PWD" """ +format = " transcending [$output]($style)" + +[custom.time] +command = "time /T" +files = ["*.pst"] +shell = ["pwsh.exe", "-NoProfile", "-Command", "-"] +``` diff --git a/docs/id-ID/faq/README.md b/docs/id-ID/faq/README.md new file mode 100644 index 00000000..fa45b6fb --- /dev/null +++ b/docs/id-ID/faq/README.md @@ -0,0 +1,96 @@ +# Pertanyaan Umum (FAQ) + +## What is the configuration used in the demo GIF? + +- **Terminal Emulator**: [iTerm2](https://iterm2.com/) + - **Theme**: Minimal + - **Color Scheme**: [Snazzy](https://github.com/sindresorhus/iterm2-snazzy) + - **Font**: [FiraCode Nerd Font](https://www.nerdfonts.com/font-downloads) +- **Shell**: [Fish Shell](https://fishshell.com/) + - **Configuration**: [matchai's Dotfiles](https://github.com/matchai/dotfiles/blob/b6c6a701d0af8d145a8370288c00bb9f0648b5c2/.config/fish/config.fish) + - **Prompt**: [Starship](https://starship.rs/) + +## How do I get command completion as shown in the demo GIF? + +Completion support, or autocomplete, is provided by your shell of choice. In the case of the demo, the demo was done with [Fish Shell](https://fishshell.com/), which provides completions by default. If you use Z Shell (zsh), I'd suggest taking a look at [zsh-autosuggestions](https://github.com/zsh-users/zsh-autosuggestions). + +## Do top level `format` and `.disabled` do the same thing? + +Yes, they can both be used to disable modules in the prompt. If all you plan to do is disable modules, `.disabled` is the preferred way to do so for these reasons: + +- Disabling modules is more explicit than omitting them from the top level `format` +- Newly created modules will be added to the prompt as Starship is updated + +## The docs say Starship is cross-shell. Why isn't my preferred shell supported? + +The way Starship is built, it should be possible to add support for virtually any shell. The starship binary is stateless and shell agnostic, so as long as your shell supports prompt customization and shell expansion, Starship can be used. + +Here's a small example getting Starship working with bash: + +```sh +# Get the status code from the last command executed +STATUS=$? + +# Get the number of jobs running. +NUM_JOBS=$(jobs -p | wc -l) + +# Set the prompt to the output of `starship prompt` +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. + +For a list of all flags accepted by `starship prompt`, use the following command: + +```sh +starship prompt --help +``` + +The prompt will use as much context as is provided, but no flags are "required". + +## How do I run Starship on Linux distributions with older versions of glibc? + +If you get an error like "_version 'GLIBC_2.18' not found (required by starship)_" when using the prebuilt binary (for example, on CentOS 6 or 7), you can use a binary compiled with `musl` instead of `glibc`: + +```sh +sh -c "$(curl -fsSL https://starship.rs/install.sh)" -- --platform unknown-linux-musl +``` + +## I see symbols I don't understand or expect, what do they mean? + +If you see symbols that you don't recognise you can use `starship explain` to explain the currently showing modules. + +## Why don't I see a glyph symbol in my prompt? + +The most common cause of this is system misconfiguration. Some Linux distros in particular do not come with font support out-of-the-box. You need to ensure that: + +- Your locale is set to a UTF-8 value, like `de_DE.UTF-8` or `ja_JP.UTF-8`. If `LC_ALL` is not a UTF-8 value, [you will need to change it](https://www.tecmint.com/set-system-locales-in-linux/). +- You have an emoji font installed. Most systems come with an emoji font by default, but some (notably Arch Linux) do not. You can usually install one through your system's package manager--[noto emoji](https://www.google.com/get/noto/help/emoji/) is a popular choice. +- You are using a [Nerd Font](https://www.nerdfonts.com/). + +To test your system, run the following commands in a terminal: + +```sh +echo -e "\xf0\x9f\x90\x8d" +echo -e "\xee\x82\xa0" +``` + +The first line should produce a [snake emoji](https://emojipedia.org/snake/), while the second should produce a [powerline branch symbol (e0a0)](https://github.com/ryanoasis/powerline-extra-symbols#glyphs). + +If either symbol fails to display correctly, your system is still misconfigured. Unfortunately, getting font configuration correct is sometimes difficult. Users on the Discord may be able to help. If both symbols display correctly, but you still don't see them in starship, [file a bug report!](https://github.com/starship/starship/issues/new/choose) + +## How do I uninstall Starship? + +Starship is just as easy to uninstall as it is to install in the first place. + +1. Remove any lines in your shell config (e.g. `~/.bashrc`) used to initialize Starship. +1. Delete the Starship binary. + +If Starship was installed using a package manager, please refer to their docs for uninstallation instructions. + +If Starship was installed using the install script, the following command will delete the binary: + +```sh +# Locate and delete the starship binary +sh -c 'rm "$(which starship)"' +``` diff --git a/docs/id-ID/guide/README.md b/docs/id-ID/guide/README.md new file mode 100644 index 00000000..dcb209ae --- /dev/null +++ b/docs/id-ID/guide/README.md @@ -0,0 +1,344 @@ +

+ Starship – Cross-shell prompt +

+ +

+ GitHub Actions workflow status + Crates.io version + Packaging status
+ Chat on Discord + Follow @StarshipPrompt on Twitter +

+ +

+ Website + · + Installation + · + Configuration +

+ +

+ English +   + 日本語 +   + 繁體中文 +   + Русский +   + Deutsch +   + 简体中文 +   + Español +   + Français +   + Tiếng Việt +

+ +

+ +Starship with iTerm2 and the Snazzy theme + +**The minimal, blazing-fast, and infinitely customizable prompt for any shell!** + +- **Fast:** it's fast – _really really_ fast! 🚀 +- **Customizable:** configure every aspect of your prompt. +- **Universal:** works on any shell, on any operating system. +- **Intelligent:** shows relevant information at a glance. +- **Feature rich:** support for all your favorite tools. +- **Easy:** quick to install – start using it in minutes. + +

+Explore the Starship docs  ▶ +

+ + + +## 🚀 Installation + +### Prerequisites + +- A [Nerd Font](https://www.nerdfonts.com/) installed and enabled in your terminal (for example, try the [Fira Code Nerd Font](https://www.nerdfonts.com/font-downloads)). + +### Getting Started + +**Note**: due to the proliferation of different platforms, only a subset of supported platforms are shown below. Can't see yours? Have a look at the [extra platform instructions](https://starship.rs/installing/). + +1. Install the **starship** binary: + + + #### Install Latest Version + + + ##### From prebuilt binary, with Shell: + + ```sh + sh -c "$(curl -fsSL https://starship.rs/install.sh)" + ``` + To update the Starship itself, rerun the above script. It will replace the current version without touching Starship's configuration. + + + **Note** - The defaults of the install script can be overridden see the built-in help. + + ```sh + sh -c "$(curl -fsSL https://starship.rs/install.sh)" -- --help + ``` + + + #### Install via Package Manager + + + ##### Example: [Homebrew](https://brew.sh/): + + ```sh + brew install starship + ``` + + + ##### With [Scoop](https://scoop.sh): + + ```powershell + scoop install starship + ``` + +2. Add the init script to your shell's config file: + + + #### Bash + + Add the following to the end of `~/.bashrc`: + + ```sh + # ~/.bashrc + + eval "$(starship init bash)" + ``` + + + #### Fish + + Add the following to the end of `~/.config/fish/config.fish`: + + ```sh + # ~/.config/fish/config.fish + + starship init fish | source + ``` + + + #### Zsh + + Add the following to the end of `~/.zshrc`: + + ```sh + # ~/.zshrc + + eval "$(starship init zsh)" + ``` + + + #### PowerShell + + Tambahkan skrip berikut pada baris akhir `Microsoft.PowerShell_profile.ps1`. Kamu dapat mengecek lokasi file tersebut dengan mencari tahu keberadaan variabel `$PROFILE` di dalam PowerShell. Typically the path is `~\Documents\PowerShell\Microsoft.PowerShell_profile.ps1` or `~/.config/powershell/Microsoft.PowerShell_profile.ps1` on -Nix. + + ```powershell + Invoke-Expression (&starship init powershell) + ``` + + + #### Ion + + Add the following to the end of `~/.config/ion/initrc`: + + ```sh + # ~/.config/ion/initrc + + eval $(starship init ion) + ``` + + + #### Elvish + + **Warning** Only elvish v0.15 or higher is supported. Add the following to the end of `~/.elvish/rc.elv`: + + ```sh + # ~/.elvish/rc.elv + + eval (starship init elvish) + ``` + + + #### Tcsh + + Add the following to the end of `~/.tcshrc`: + + ```sh + # ~/.tcshrc + + eval `starship init tcsh` + ``` + + + #### Xonsh + + Tambahkan skrip berikut pada baris akhir `~/.xonshrc`: + + ```sh + # ~/.xonshrc + + execx($(starship init xonsh)) + ``` + + + #### Nushell + + **Warning** This will change in the future. Hanya nu versi v0.33 atau lebih baru yang tengah didukung. Add the following to your nu config file. Lokasi dari file ini dapat dicek dengan menjalankan `config path` pada nu. + + ```toml + startup = [ + "mkdir ~/.cache/starship", + "starship init nu | save ~/.cache/starship/init.nu", + "source ~/.cache/starship/init.nu" + ] + prompt = "starship_prompt" + ``` + +## 🤝 Contributing + +We are always looking for contributors of **all skill levels**! If you're looking to ease your way into the project, try out a [good first issue](https://github.com/starship/starship/labels/🌱%20good%20first%20issue). + +If you are fluent in a non-English language, we greatly appreciate any help keeping our docs translated and up-to-date in other languages. If you would like to help, translations can be contributed on the [Starship Crowdin](https://translate.starship.rs/). + +If you are interested in helping contribute to starship, please take a look at our [Contributing Guide](https://github.com/starship/starship/blob/master/CONTRIBUTING.md). Also, feel free to drop into our [Discord server](https://discord.gg/8Jzqu3T) and say hi. 👋 + +### Code Contributors + +This project exists thanks to all the people who contribute. [[Contribute](https://github.com/starship/starship/blob/master/CONTRIBUTING.md)]. + + +### Financial Contributors + +Become a financial contributor and help us sustain our community. [[Contribute](https://opencollective.com/starship/contribute)] + +#### Individuals + + + +#### Organizations + +Support this project with your organization. Your logo will show up here with a link to your website. [[Contribute](https://opencollective.com/starship/contribute)] + + + + + + + + + + + + +## 💭 Inspired By + +Please check out these previous works that helped inspire the creation of starship. 🙏 + +- **[denysdovhan/spaceship-prompt](https://github.com/denysdovhan/spaceship-prompt)** - A ZSH prompt for astronauts. + +- **[denysdovhan/robbyrussell-node](https://github.com/denysdovhan/robbyrussell-node)** - Cross-shell robbyrussell theme written in JavaScript. + +- **[reujab/silver](https://github.com/reujab/silver)** - A cross-shell customizable powerline-like prompt with icons. + +

+
+ Starship rocket icon +

+ +## 📝 License + +Copyright © 2019-present, [Starship Contributors](https://github.com/starship/starship/graphs/contributors).
This project is [ISC](https://github.com/starship/starship/blob/master/LICENSE) licensed. diff --git a/docs/id-ID/installing/README.md b/docs/id-ID/installing/README.md new file mode 100644 index 00000000..6bb76850 --- /dev/null +++ b/docs/id-ID/installing/README.md @@ -0,0 +1,84 @@ +# 🚀 Advanced Installation + +To install starship, you need to do two things: + +1. Get the **starship** binary onto your computer +1. Tell your shell to use the starship binary as its prompt by modifying its init scripts + +For most users, the instructions on [the main page](/guide/#🚀-installation) will work great. However, for some more specialized platforms, different instructions are needed. + +There are so many platforms out there that they didn't fit into the main README.md file, so here are some installation instructions for other platforms from the community. Is yours not here? Please do add it here if you figure it out! + +## [Chocolatey](https://chocolatey.org) + +### Prerequisites + +Head over to the [Chocolatey installation page](https://chocolatey.org/install) and follow the instructions to install Chocolatey. + +### Installation + +```powershell +choco install starship +``` + +## [termux](https://termux.com) + +### Prerequisites + +```sh +pkg install getconf +``` + +### Installation + +```sh +sh -c "$(curl -fsSL https://starship.rs/install.sh)" -- --bin-dir /data/data/com.termux/files/usr/bin +``` + +## [Nix](https://nixos.wiki/wiki/Nix) + +### Getting the Binary + +#### Imperatively + +```sh +nix-env -iA nixos.starship +``` + +#### 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 + +```nix +{ + programs.starship = { + enable = true; + enableZshIntegration = true; + # Configuration written to ~/.config/starship.toml + settings = { + # add_newline = false; + + # character = { + # success_symbol = "[➜](bold green)"; + # error_symbol = "[➜](bold red)"; + # }; + + # package.disabled = true; + }; + }; +} +``` + +then run + +```sh +home-manager switch +``` + +#### Declarative, system-wide, with NixOS + +Add `pkgs.starship` to `environment.systemPackages` in your `configuration.nix`, then run + +```sh +sudo nixos-rebuild switch +``` diff --git a/docs/id-ID/migrating-to-0.45.0/README.md b/docs/id-ID/migrating-to-0.45.0/README.md new file mode 100644 index 00000000..9ae7a6ea --- /dev/null +++ b/docs/id-ID/migrating-to-0.45.0/README.md @@ -0,0 +1,267 @@ +# Migrating to 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. + +This guide is intended to walk you through the breaking changes. + +## `prompt_order` has been replaced by a root-level `format` + +Previously to v0.45.0, `prompt_order` would accept an array of module names in the order which they should be rendered by Starship. + +Starship v0.45.0 instead accepts a `format` value, allowing for customization of the prompt outside of the modules themselves. + +**Example pre-v0.45.0 configuration** + +```toml +prompt_order = [ + "username", + "hostname", + "directory", + "git_branch", + "git_commit", + "git_state", + "git_status", + "cmd_duration", + "custom", + "line_break", + "jobs", + "battery", + "time", + "character", +] +``` + +**Example v0.45.0 configuration** + +```toml +format = """\ + $username\ + $hostname\ + $directory\ + $git_branch\ + $git_commit\ + $git_state\ + $git_status\ + $cmd_duration\ + $custom\ + $line_break\ + $jobs\ + $battery\ + $time\ + $character\ + """ +``` + +## Module `prefix` and `suffix` have been replaced by `format` + +Previously to v0.45.0, some modules would accept `prefix` and/or `suffix` in order to stylize the way that modules are rendered. + +Starship v0.45.0 instead accepts a `format` value, allowing for further customization of how modules are rendered. Instead of defining a prefix and suffix for the context-based variables, the variables can now be substituted from within a format string, which represents the module's output. + +**Example pre-v0.45.0 configuration** + +```toml +[cmd_duration] +prefix = "took " +``` + +**Example v0.45.0 configuration** + +```toml +[cmd_duration] +# $duration – The command duration (e.g. "15s") +# $style – The default style of the module (e.g. "bold yellow") +format = "took [$duration]($style) " +``` + +### Affected Modules + +#### Karakter + +| Removed Property | Replacement | +| ----------------------- | ---------------- | +| `symbol` | `success_symbol` | +| `use_symbol_for_status` | `error_symbol` | +| `style_success` | `success_symbol` | +| `style_failure` | `error_symbol` | + +**Changes to the Default Configuration** + +```diff +[character] +-- symbol = "❯" +-- error_symbol = "✖" +-- use_symbol_for_status = true +-- vicmd_symbol = "❮" +++ success_symbol = "[❯](bold green)" +++ error_symbol = "[❯](bold red)" +++ vicmd_symbol = "[❮](bold green)" +``` + +Previously, the `use_symbol_for_status` property was used to configure the prompt to show the `error_symbol` when the last command resulted in a non-zero status code. + +With the release of v0.45.0, we now always use `error_symbol` after non-zero status codes, unifying `use_symbol_for_status` and `error_symbol` properties. + +To configure the prompt to use the older `use_symbol_for_status = true` configuration, add the following to your config file: + +```toml +[character] +error_symbol = "[✖](bold red)" +``` + +*Note:* The `character` element automatically adds a space after, so unlike the other `format` strings, we specifically do not add one in the above examples. + +#### Command Duration + +| Removed Property | Replacement | +| ---------------- | ----------- | +| `prefix` | `format` | + +**Changes to the Default Configuration** + +```diff +[cmd_duration] +-- prefix = "took " +++ format = "took [$duration]($style) " +``` + +#### Directory + +| Removed Property | Replacement | +| ---------------- | ----------- | +| `prefix` | `format` | + +**Changes to the Default Configuration** + +```diff +[directory] +-- prefix = "in " +++ format = "[$path]($style)[$read_only]($read_only_style) " +``` + +#### Environment Variable + +| Removed Property | Replacement | +| ---------------- | ----------- | +| `prefix` | `format` | +| `suffix` | `format` | + +**Changes to the Default Configuration** + +```diff +[env_var] +-- prefix = "" +-- suffix = "" +++ format = "with [$env_value]($style) " +``` + +#### Git Commit + +| Removed Property | Replacement | +| ---------------- | ----------- | +| `prefix` | `format` | +| `suffix` | `format` | + +**Changes to the Default Configuration** + +```diff +[git_commit] +-- prefix = "(" +-- suffix = ")" +++ format = '[\($hash\)]($style) ' +``` + +#### Git Status + +| Removed Property | Replacement | +| ----------------- | ----------- | +| `prefix` | `format` | +| `suffix` | `format` | +| `show_sync_count` | `format` | + +**Changes to the Default Configuration** + +```diff +[git_status] +-- prefix = "[" +-- suffix = "]" +-- show_sync_count = false +++ format = '([\[$all_status$ahead_behind\]]($style) )' +``` + +Previously, the `show_sync_count` property was used to configure the prompt to show the number of commits the branch was ahead or behind the remote branch. + +With the release of v0.45.0, this has been replaced with three separate properties, `ahead`, `behind`, and `diverged`. + +To configure the prompt to use the older `show_sync_count = true` configuration, set the following to your config file: + +```toml +[git_status] +ahead = "⇡${count}" +diverged = "⇕⇡${ahead_count}⇣${behind_count}" +behind = "⇣${count}" +``` + +#### Hostname + +| Removed Property | Replacement | +| ---------------- | ----------- | +| `prefix` | `format` | +| `suffix` | `format` | + +**Changes to the Default Configuration** + +```diff +[hostname] +-- prefix = "" +-- suffix = "" +++ format = "[$hostname]($style) in " +``` + +#### Singularity + +| Removed Property | Replacement | +| ---------------- | ----------- | +| `label` | `format` | +| `prefix` | `format` | +| `suffix` | `format` | + +**Changes to the Default Configuration** + +```diff +[singularity] +-- prefix = "" +-- suffix = "" +++ format = '[$symbol\[$env\]]($style) ' +``` + +#### Time + +| Removed Property | Replacement | +| ---------------- | ------------- | +| `format` | `time_format` | + +**Changes to the Default Configuration** + +```diff +[time] +-- format = "🕙[ %T ]" +++ time_format = "%T" +++ format = "at 🕙[$time]($style) " +``` + +#### Custom Commands + +| Removed Property | Replacement | +| ---------------- | ----------- | +| `prefix` | `format` | +| `suffix` | `format` | + +**Changes to the Default Configuration** + +```diff +[custom.example] +-- prefix = "" +-- suffix = "" +++ format = "[$symbol$output]($style) " +``` diff --git a/docs/id-ID/presets/README.md b/docs/id-ID/presets/README.md new file mode 100644 index 00000000..4bb28248 --- /dev/null +++ b/docs/id-ID/presets/README.md @@ -0,0 +1,455 @@ +# Presets + +Here is a collection of community-submitted configuration presets for Starship. If you have a preset to share, please [submit a PR](https://github.com/starship/starship/edit/master/docs/presets/README.md) updating this file! 😊 + +## Nerd Font Symbols + +This preset doesn't change anything except for the symbols used for each module. If emojis aren't your thing, this might catch your eye! + +![Screenshot of Nerd Font Symbols preset](/presets/nerd-font-symbols.png) + +### Prerequisites + +- A [Nerd Font](https://www.nerdfonts.com/) installed and enabled in your terminal (the example uses Fira Code Nerd Font) + +### Konfigurasi + +```toml +[aws] +symbol = " " + +[conda] +symbol = " " + +[dart] +symbol = " " + +[directory] +read_only = " " + +[docker_context] +symbol = " " + +[elixir] +symbol = " " + +[elm] +symbol = " " + +[git_branch] +symbol = " " + +[golang] +symbol = " " + +[hg_branch] +symbol = " " + +[java] +symbol = " " + +[julia] +symbol = " " + +[memory_usage] +symbol = " " + +[nim] +symbol = " " + +[nix_shell] +symbol = " " + +[package] +symbol = " " + +[perl] +symbol = " " + +[php] +symbol = " " + +[python] +symbol = " " + +[ruby] +symbol = " " + +[rust] +symbol = " " + +[scala] +symbol = " " + +[shlvl] +symbol = " " + +[swift] +symbol = "ﯣ " +``` + +## Bracketed Segments + +This preset changes the format of all the built-in modules to show their segment in brackets instead of using the default Starship wording ("via", "on", etc.). + +Before: + +![Screenshot of default Starship configuration](/presets/bracketed-segments-before.png) + +After: + +![Screenshot of Bracketed Segments preset](/presets/bracketed-segments-after.png) + +### Konfigurasi + +```toml +[aws] +format = '\[[$symbol($profile)(\($region\))(\[$duration\])]($style)\]' + +[cmake] +format = '\[[$symbol($version)]($style)\]' + +[cmd_duration] +format = '\[[⏱ $duration ]($style)\]' + +[conda] +format = '\[[$symbol$environment]($style)\]' + +[crystal] +format = '\[[$symbol($version)]($style)\]' + +[dart] +format = '\[[$symbol($version)]($style)\]' + +[deno] +format = '\[[$symbol($version)]($style)\]' + +[docker_context] +format = '\[[$symbol$context]($style)\]' + +[dotnet] +format = '\[[$symbol($version)(🎯 $tfm)]($style)\]' + +[elixir] +format = '\[[$symbol($version \(OTP $otp_version\))]($style)\]' + +[elm] +format = '\[[$symbol($version)]($style)\]' + +[erlang] +format = '\[[$symbol($version)]($style)\]' + +[gcloud] +format = '\[[$symbol$account(@$domain)(\($region\))]($style)\]' + +[git_branch] +format = '\[[$symbol$branch]($style)\]' + +[git_status] +format = '([\[$all_status$ahead_behind\]]($style))' + +[golang] +format = '\[[$symbol($version)]($style)\]' + +[helm] +format = '\[[$symbol($version)]($style)\]' + +[hg_branch] +format = '\[[$symbol$branch]($style)\]' + +[java] +format = '\[[$symbol($version)]($style)\]' + +[julia] +format = '\[[$symbol($version)]($style)\]' + +[kotlin] +format = '\[[$symbol($version)]($style)\]' + +[kubernetes] +format = '\[[$symbol$context( \($namespace\))]($style)\]' + +[lua] +format = '\[[$symbol($version)]($style)\]' + +[memory_usage] +format = '\[$symbol[$ram( | $swap)]($style)\]' + +[nim] +format = '\[[$symbol($version)]($style)\]' + +[nix_shell] +format = '\[[$symbol$state( \($name\))]($style)\]' + +[nodejs] +format = '\[[$symbol($version)]($style)\]' + +[ocaml] +format = '\[[$symbol($version)(\($switch_indicator$switch_name\))]($style)\]' + +[openstack] +format = '\[[$symbol$cloud(\($project\))]($style)\]' + +[package] +format = '\[[$symbol$version]($style)\]' + +[perl] +format = '\[[$symbol($version)]($style)\]' + +[php] +format = '\[[$symbol($version)]($style)\]' + +[purescript] +format = '\[[$symbol($version)]($style)\]' + +[python] +format = '\[[${symbol}${pyenv_prefix}(${version})(\($virtualenv\))]($style)\]' + +[red] +format = '\[[$symbol($version)]($style)\]' + +[ruby] +format = '\[[$symbol($version)]($style)\]' + +[rust] +format = '\[[$symbol($version)]($style)\]' + +[scala] +format = '\[[$symbol($version)]($style)\]' + +[swift] +format = '\[[$symbol($version)]($style)\]' + +[terraform] +format = '\[[$symbol$workspace]($style)\]' + +[time] +format = '\[[$time]($style)\]' + +[username] +format = '\[[$user]($style)\]' + +[vagrant] +format = '\[[$symbol($version)]($style)\]' + +[vlang] +format = '\[[$symbol($version)]($style)\]' + +[zig] +format = '\[[$symbol($version)]($style)\]' +``` + +## Plain Text Symbols + +This preset changes the symbols into plain text. If your terminal/font could not render the NerdFonts/emojis, maybe you could try this preset! + +Before (default setting with Fixedsys font): + +![Screenshot of default Starship configuration with Fixedsys font](/presets/plain-text-symbols-before.png) + +After (Plain Text Symbols): + +![Screenshot of Plain Text Symbols preset](/presets/plain-text-symbols-after.png) + +### Konfigurasi + +```toml +[character] +success_symbol = "[>](bold green)" +error_symbol = "[x](bold red)" +vicmd_symbol = "[<](bold green)" + +[git_commit] +tag_symbol = " tag " + +[git_status] +ahead = ">" +behind = "<" +diverged = "<>" +renamed = "r" +deleted = "x" + +[aws] +symbol = "aws " + +[conda] +symbol = "conda " + +[crystal] +symbol = "cr " + +[cmake] +symbol = "cmake " + +[dart] +symbol = "dart " + +[deno] +symbol = "deno " + +[dotnet] +symbol = ".NET " + +[directory] +read_only = " ro" + +[docker_context] +symbol = "docker " + +[elixir] +symbol = "exs " + +[elm] +symbol = "elm " + +[git_branch] +symbol = "git " + +[golang] +symbol = "go " + +[hg_branch] +symbol = "hg " + +[java] +symbol = "java " + +[julia] +symbol = "jl " + +[kotlin] +symbol = "kt " + +[nodejs] +symbol = "nodejs " + +[memory_usage] +symbol = "memory " + +[nim] +symbol = "nim " + +[nix_shell] +symbol = "nix " + +[ocaml] +symbol = "ml " + +[package] +symbol = "pkg " + +[perl] +symbol = "pl " + +[php] +symbol = "php " + +[purescript] +symbol = "purs " + +[python] +symbol = "py " + +[ruby] +symbol = "rb " + +[rust] +symbol = "rs " + +[scala] +symbol = "scala " + +[swift] +symbol = "swift " +``` + +## Hide Runtime Versions + +This preset hides the version of language runtimes. If you work in containers or virtualized environments, this one is for you! + +![Screenshot of Hide Runtime Versions preset](/presets/hide-runtime-versions.png) + +### Konfigurasi + +```toml +[cmake] +format = "via [$symbol]($style)" + +[crystal] +format = "via [$symbol]($style)" + +[dart] +format = "via [$symbol]($style)" + +[deno] +format = "via [$symbol]($style)" + +[dotnet] +format = "[$symbol(🎯 $tfm )]($style)" + +[elixir] +format = 'via [$symbol]($style)' + +[elm] +format = 'via [$symbol]($style)' + +[erlang] +format = 'via [$symbol]($style)' + +[golang] +format = 'via [$symbol]($style)' + +[helm] +format = 'via [$symbol]($style)' + +[julia] +format = 'via [$symbol]($style)' + +[kotlin] +format = 'via [$symbol]($style)' + +[lua] +format = 'via [$symbol]($style)' + +[nim] +format = 'via [$symbol]($style)' + +[nodejs] +format = 'via [$symbol]($style)' + +[ocaml] +format = 'via [$symbol(\($switch_indicator$switch_name\) )]($style)' + +[perl] +format = 'via [$symbol]($style)' + +[php] +format = 'via [$symbol]($style)' + +[purescript] +format = 'via [$symbol]($style)' + +[red] +format = 'via [$symbol]($style)' + +[rlang] +format = 'via [$symbol]($style)' + +[ruby] +format = 'via [$symbol]($style)' + +[rust] +format = 'via [$symbol]($style)' + +[swift] +format = 'via [$symbol]($style)' + +[vagrant] +format = 'via [$symbol]($style)' + +[vlang] +format = 'via [$symbol]($style)' + +[zig] +format = 'via [$symbol]($style)' +``` diff --git a/docs/it-IT/config/README.md b/docs/it-IT/config/README.md index 59aa29bf..7885b026 100644 --- a/docs/it-IT/config/README.md +++ b/docs/it-IT/config/README.md @@ -1478,7 +1478,13 @@ symbol = "🌟 " ## Jobs -The `jobs` module shows the current number of jobs running. The module will be shown only if there are background jobs running. The module will show the number of jobs running if there is more than 1 job, or more than the `threshold` config value, if it exists. If `threshold` is set to 0, then the module will also show when there are 0 jobs running. +The `jobs` module shows the current number of jobs running. The module will be shown only if there are background jobs running. The module will show the number of jobs running if there are at least 2 jobs, or more than the `number_threshold` config value, if it exists. The module will show a symbol if there is at least 1 job, or more than the `symbol_threshold` config value, if it exists. You can set both values to 0 in order to *always* show the symbol and number of jobs, even if there are 0 jobs running. + +The default functionality is: + +- 0 jobs -> Nothing is shown. +- 1 job -> `symbol` is shown. +- 2 jobs or more -> `symbol` + `number` are shown. ::: warning @@ -1486,15 +1492,26 @@ This module is not supported on tcsh and nu. ::: +::: warning + +The `threshold` option is deprecated, but if you want to use it, the module will show the number of jobs running if there is more than 1 job, or more than the `threshold` config value, if it exists. If `threshold` is set to 0, then the module will also show when there are 0 jobs running. + +::: + ### Options -| Option | Default | Description | -| ----------- | ----------------------------- | ------------------------------------------------ | -| `threshold` | `1` | Show number of jobs if exceeded. | -| `format` | `"[$symbol$number]($style) "` | The format for the module. | -| `symbol` | `"✦"` | A format string representing the number of jobs. | -| `style` | `"bold blue"` | The style for the module. | -| `disabled` | `false` | Disables the `jobs` module. | +| Option | Default | Description | +| ------------------ | ----------------------------- | ------------------------------------------------------------------------ | +| `threshold`\* | `1` | Show number of jobs if exceeded. | +| `symbol_threshold` | `1` | Show `symbol` if the job count is at least `symbol_threshold`. | +| `number_threshold` | `2` | Show the number of jobs if the job count is at least `number_threshold`. | +| `format` | `"[$symbol$number]($style) "` | The format for the module. | +| `symbol` | `"✦"` | The string used to represent the `symbol` variable. | +| `style` | `"bold blue"` | The style for the module. | +| `disabled` | `false` | Disables the `jobs` module. | + \*: This option is deprecated, please use the + +`number_threshold` and `symbol_threshold` options instead. ### Variables @@ -1513,7 +1530,8 @@ This module is not supported on tcsh and nu. [jobs] symbol = "+ " -threshold = 4 +number_threshold = 4 +symbol_threshold = 0 ``` ## Julia @@ -2884,15 +2902,16 @@ The `vlang` module shows you your currently installed version of V. By default t ### Options -| Option | Default | Description | -| ------------------- | -------------------------------------------- | -------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `symbol` | `"V "` | A format string representing the symbol of V | -| `detect_extensions` | `["v"]` | Which extensions should trigger this module. | -| `detect_files` | `["v.mod", "vpkg.json", ".vpkg-lock.json" ]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `style` | `"blue bold"` | The style for the module. | -| `disabled` | `false` | Disables the `vlang` module. | +| Option | Default | Description | +| ------------------- | -------------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"V "` | A format string representing the symbol of V | +| `detect_extensions` | `["v"]` | Which extensions should trigger this module. | +| `detect_files` | `["v.mod", "vpkg.json", ".vpkg-lock.json" ]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `style` | `"blue bold"` | The style for the module. | +| `disabled` | `false` | Disables the `vlang` module. | ### Variables diff --git a/docs/ja-JP/config/README.md b/docs/ja-JP/config/README.md index 195372cd..8b720d24 100644 --- a/docs/ja-JP/config/README.md +++ b/docs/ja-JP/config/README.md @@ -35,7 +35,7 @@ $ENV:STARSHIP_CONFIG = "$HOME\.starship\config.toml" ### ロギング -デフォルトでは、Starship は警告やエラーログを `~/.cache/starship/session_${STARSHIP_SESSION_KEY}.log` という名前のファイルに出力します。このセッションキーはターミナルのインスタンスに相当します。しかし、これは `STARSHIP_CACHE` という環境変数を使って変更できます: しかし、これは `STARSHIP_CACHE` という環境変数を使って変更できます: +デフォルトでは、Starship は警告やエラーログを `~/.cache/starship/session_${STARSHIP_SESSION_KEY}.log` という名前のファイルに出力します。このセッションキーはターミナルのインスタンスに相当します。 しかし、これは `STARSHIP_CACHE` という環境変数を使って変更できます: ```sh export STARSHIP_CACHE=~/.starship/cache @@ -1479,7 +1479,13 @@ symbol = "🌟 " ## ジョブ -The `jobs` module shows the current number of jobs running. The module will be shown only if there are background jobs running. The module will show the number of jobs running if there is more than 1 job, or more than the `threshold` config value, if it exists. If `threshold` is set to 0, then the module will also show when there are 0 jobs running. +The `jobs` module shows the current number of jobs running. The module will be shown only if there are background jobs running. The module will show the number of jobs running if there are at least 2 jobs, or more than the `number_threshold` config value, if it exists. The module will show a symbol if there is at least 1 job, or more than the `symbol_threshold` config value, if it exists. You can set both values to 0 in order to *always* show the symbol and number of jobs, even if there are 0 jobs running. + +The default functionality is: + +- 0 jobs -> Nothing is shown. +- 1 job -> `symbol` is shown. +- 2 jobs or more -> `symbol` + `number` are shown. ::: warning @@ -1487,15 +1493,26 @@ This module is not supported on tcsh and nu. ::: +::: warning + +The `threshold` option is deprecated, but if you want to use it, the module will show the number of jobs running if there is more than 1 job, or more than the `threshold` config value, if it exists. If `threshold` is set to 0, then the module will also show when there are 0 jobs running. + +::: + ### オプション -| オプション | デフォルト | 説明 | -| ----------- | ----------------------------- | ------------------- | -| `threshold` | `1` | 超過した場合、ジョブの数を表示します。 | -| `format` | `"[$symbol$number]($style) "` | moduleのフォーマットです。 | -| `symbol` | `"✦"` | ジョブの数を表すフォーマット文字列 | -| `style` | `"bold blue"` | モジュールのスタイルです。 | -| `disabled` | `false` | `jobs`モジュールを無効にします。 | +| オプション | デフォルト | 説明 | +| ------------------ | ----------------------------- | ------------------------------------------------------------------------ | +| `threshold`\* | `1` | 超過した場合、ジョブの数を表示します。 | +| `symbol_threshold` | `1` | Show `symbol` if the job count is at least `symbol_threshold`. | +| `number_threshold` | `2` | Show the number of jobs if the job count is at least `number_threshold`. | +| `format` | `"[$symbol$number]($style) "` | moduleのフォーマットです。 | +| `symbol` | `"✦"` | The string used to represent the `symbol` variable. | +| `style` | `"bold blue"` | モジュールのスタイルです。 | +| `disabled` | `false` | Disables the `jobs` module. | + \*: This option is deprecated, please use the + +`number_threshold` and `symbol_threshold` options instead. ### 変数 @@ -1514,16 +1531,17 @@ This module is not supported on tcsh and nu. [jobs] symbol = "+ " -threshold = 4 +number_threshold = 4 +symbol_threshold = 0 ``` ## Julia The `julia` module shows the currently installed version of [Julia](https://julialang.org/). デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 -- カレントディレクトリに`Project.toml`ファイルが含まれている -- カレントディレクトリに`Manifest.toml`ファイルが含まれている -- カレントディレクトリに`.jl`の拡張子のファイルが含まれている +- The current directory contains a `Project.toml` file +- The current directory contains a `Manifest.toml` file +- The current directory contains a file with the `.jl` extension ### オプション @@ -1561,7 +1579,7 @@ symbol = "∴ " The `kotlin` module shows the currently installed version of [Kotlin](https://kotlinlang.org/). デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 -- カレントディレクトリに`.kt`もしくは`.kts`ファイルが含まれている +- The current directory contains a `.kt` or a `.kts` file ### オプション @@ -1817,7 +1835,7 @@ truncation_symbol = "" The `nim` module shows the currently installed version of [Nim](https://nim-lang.org/). デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 -- カレントディレクトリに`nim.cfg`ファイルが含まれている +- The current directory contains a `nim.cfg` file - The current directory contains a file with the `.nim` extension - The current directory contains a file with the `.nims` extension - The current directory contains a file with the `.nimble` extension @@ -1897,10 +1915,10 @@ format = 'via [☃️ $state( \($name\))](bold blue) ' The `nodejs` module shows the currently installed version of [Node.js](https://nodejs.org/). デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 -- カレントディレクトリに`package.json`ファイルが含まれている +- The current directory contains a `package.json` file - The current directory contains a `.node-version` file - The current directory contains a `.nvmrc` file -- カレントディレクトリに`node_modules`ディレクトリが含まれている +- The current directory contains a `node_modules` directory - The current directory contains a file with the `.js`, `.mjs` or `.cjs` extension - The current directory contains a file with the `.ts` extension @@ -2113,7 +2131,7 @@ format = "via [🦪 $version]($style) " The `php` module shows the currently installed version of [PHP](https://www.php.net/). デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 -- カレントディレクトリに`composer.json`ファイルが含まれている +- The current directory contains a `composer.json` file - The current directory contains a `.php-version` file - The current directory contains a `.php` extension @@ -2153,7 +2171,7 @@ format = "via [🔹 $version](147 bold) " The `purescript` module shows the currently installed version of [PureScript](https://www.purescript.org/) version. デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 -- カレントディレクトリに`spago.dhall`ファイルが含まれている +- The current directory contains a `spago.dhall` file - The current directory contains a file with the `.purs` extension ### オプション @@ -2196,15 +2214,15 @@ If `pyenv_version_name` is set to `true`, it will display the pyenv version name デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 -- カレントディレクトリに`.python-version`ファイルが含まれている -- カレントディレクトリに`Pipfile`ファイルが含まれている +- The current directory contains a `.python-version` file +- The current directory contains a `Pipfile` file - The current directory contains a `__init__.py` file -- カレントディレクトリに`pyproject.toml`ファイルが含まれている -- カレントディレクトリに`requirements.txt`ファイルが含まれている -- カレントディレクトリに`setup.py`ファイルが含まれている -- カレントディレクトリに`tox.ini`ファイルが含まれている -- カレントディレクトリに`.py`の拡張子のファイルが含まれている. -- 仮想環境がアクティブである +- The current directory contains a `pyproject.toml` file +- The current directory contains a `requirements.txt` file +- The current directory contains a `setup.py` file +- The current directory contains a `tox.ini` file +- The current directory contains a file with the `.py` extension. +- A virtual environment is currently activated ### オプション @@ -2361,9 +2379,9 @@ symbol = "🔴 " By default the `ruby` module shows the currently installed version of [Ruby](https://www.ruby-lang.org/). The module will be shown if any of the following conditions are met: -- カレントディレクトリに`Gemfile`ファイルが含まれている +- The current directory contains a `Gemfile` file - The current directory contains a `.ruby-version` file -- カレントディレクトリに`.rb`の拡張子のファイルが含まれている +- The current directory contains a `.rb` file ### オプション @@ -2401,8 +2419,8 @@ symbol = "🔺 " By default the `rust` module shows the currently installed version of [Rust](https://www.rust-lang.org/). The module will be shown if any of the following conditions are met: -- カレントディレクトリに`Cargo.toml`ファイルが含まれている -- カレントディレクトリに`.rs`の拡張子のファイルが含まれている +- The current directory contains a `Cargo.toml` file +- The current directory contains a file with the `.rs` extension ### オプション @@ -2701,7 +2719,7 @@ By default the Terraform version is not shown, since this is slow for current ve デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 -- カレントディレクトリに`.terraform`フォルダが含まれている +- The current directory contains a `.terraform` folder - Current directory contains a file with the `.tf` or `.hcl` extensions ### オプション @@ -2798,10 +2816,10 @@ time_range = "10:00:00-14:00:00" The `username` module shows active user's username. The module will be shown if any of the following conditions are met: -- カレントユーザーがroot -- カレントユーザーが、ログインしているユーザーとは異なる -- ユーザーがSSHセッションとして接続されている -- `show_always`変数がtrueに設定されている +- The current user is root +- The current user isn't the same as the one that is logged in +- The user is currently connected as an SSH session +- The variable `show_always` is set to true ::: tip @@ -2885,15 +2903,16 @@ The `vlang` module shows you your currently installed version of V. By default t ### オプション -| オプション | デフォルト | 説明 | -| ------------------- | -------------------------------------------- | -------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | moduleのフォーマットです。 | -| `symbol` | `"V "` | A format string representing the symbol of V | -| `detect_extensions` | `["v"]` | どの拡張子がこのモジュールをアクティブにするか | -| `detect_files` | `["v.mod", "vpkg.json", ".vpkg-lock.json" ]` | どのファイル名がこのモジュールをアクティブにするか | -| `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか | -| `style` | `"blue bold"` | モジュールのスタイルです。 | -| `disabled` | `false` | Disables the `vlang` module. | +| オプション | デフォルト | 説明 | +| ------------------- | -------------------------------------------- | ------------------------------------------------------ | +| `format` | `"via [$symbol($version )]($style)"` | moduleのフォーマットです。 | +| `version_format` | `"v${raw}"` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 | +| `symbol` | `"V "` | A format string representing the symbol of V | +| `detect_extensions` | `["v"]` | どの拡張子がこのモジュールをアクティブにするか | +| `detect_files` | `["v.mod", "vpkg.json", ".vpkg-lock.json" ]` | どのファイル名がこのモジュールをアクティブにするか | +| `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか | +| `style` | `"blue bold"` | モジュールのスタイルです。 | +| `disabled` | `false` | Disables the `vlang` module. | ### 変数 diff --git a/docs/ko-KR/config/README.md b/docs/ko-KR/config/README.md index 49d98bc4..61f8fcfd 100644 --- a/docs/ko-KR/config/README.md +++ b/docs/ko-KR/config/README.md @@ -1478,7 +1478,13 @@ symbol = "🌟 " ## Jobs -The `jobs` module shows the current number of jobs running. The module will be shown only if there are background jobs running. The module will show the number of jobs running if there is more than 1 job, or more than the `threshold` config value, if it exists. If `threshold` is set to 0, then the module will also show when there are 0 jobs running. +The `jobs` module shows the current number of jobs running. The module will be shown only if there are background jobs running. The module will show the number of jobs running if there are at least 2 jobs, or more than the `number_threshold` config value, if it exists. The module will show a symbol if there is at least 1 job, or more than the `symbol_threshold` config value, if it exists. You can set both values to 0 in order to *always* show the symbol and number of jobs, even if there are 0 jobs running. + +The default functionality is: + +- 0 jobs -> Nothing is shown. +- 1 job -> `symbol` is shown. +- 2 jobs or more -> `symbol` + `number` are shown. ::: warning @@ -1486,15 +1492,26 @@ This module is not supported on tcsh and nu. ::: +::: warning + +The `threshold` option is deprecated, but if you want to use it, the module will show the number of jobs running if there is more than 1 job, or more than the `threshold` config value, if it exists. If `threshold` is set to 0, then the module will also show when there are 0 jobs running. + +::: + ### Options -| Option | Default | Description | -| ----------- | ----------------------------- | ------------------------------------------------ | -| `threshold` | `1` | Show number of jobs if exceeded. | -| `format` | `"[$symbol$number]($style) "` | The format for the module. | -| `symbol` | `"✦"` | A format string representing the number of jobs. | -| `style` | `"bold blue"` | The style for the module. | -| `disabled` | `false` | Disables the `jobs` module. | +| Option | Default | Description | +| ------------------ | ----------------------------- | ------------------------------------------------------------------------ | +| `threshold`\* | `1` | Show number of jobs if exceeded. | +| `symbol_threshold` | `1` | Show `symbol` if the job count is at least `symbol_threshold`. | +| `number_threshold` | `2` | Show the number of jobs if the job count is at least `number_threshold`. | +| `format` | `"[$symbol$number]($style) "` | The format for the module. | +| `symbol` | `"✦"` | The string used to represent the `symbol` variable. | +| `style` | `"bold blue"` | The style for the module. | +| `disabled` | `false` | Disables the `jobs` module. | + \*: This option is deprecated, please use the + +`number_threshold` and `symbol_threshold` options instead. ### Variables @@ -1513,7 +1530,8 @@ This module is not supported on tcsh and nu. [jobs] symbol = "+ " -threshold = 4 +number_threshold = 4 +symbol_threshold = 0 ``` ## Julia @@ -2884,15 +2902,16 @@ The `vlang` module shows you your currently installed version of V. By default t ### Options -| Option | Default | Description | -| ------------------- | -------------------------------------------- | -------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `symbol` | `"V "` | A format string representing the symbol of V | -| `detect_extensions` | `["v"]` | Which extensions should trigger this module. | -| `detect_files` | `["v.mod", "vpkg.json", ".vpkg-lock.json" ]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `style` | `"blue bold"` | The style for the module. | -| `disabled` | `false` | Disables the `vlang` module. | +| Option | Default | Description | +| ------------------- | -------------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"V "` | A format string representing the symbol of V | +| `detect_extensions` | `["v"]` | Which extensions should trigger this module. | +| `detect_files` | `["v.mod", "vpkg.json", ".vpkg-lock.json" ]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `style` | `"blue bold"` | The style for the module. | +| `disabled` | `false` | Disables the `vlang` module. | ### Variables diff --git a/docs/nl-NL/README.md b/docs/nl-NL/README.md index 6b4bbaef..0ce91ba3 100644 --- a/docs/nl-NL/README.md +++ b/docs/nl-NL/README.md @@ -2,7 +2,7 @@ home: true heroImage: /logo.svg heroText: -tagline: The minimal, blazing-fast, and infinitely customizable prompt for any shell! +tagline: De minimalistische, razend snelle en oneindig aanpasbare prompt voor elke shell! actionText: Get Started → actionLink: ./guide/ features: @@ -28,26 +28,26 @@ description: Starship is the minimal, blazing fast, and extremely customizable p
-### Prerequisites +### Benodigdheden - A [Nerd Font](https://www.nerdfonts.com/) installed and enabled in your terminal. ### Quick Install -1. Install the **starship** binary: +1. Installeer de **Starship** binary: - #### Install Latest Version + #### Installeer de nieuwste versie With Shell: ```sh sh -c "$(curl -fsSL https://starship.rs/install.sh)" ``` - To update the Starship itself, rerun the above script. It will replace the current version without touching Starship's configuration. + Om Starship zelf bij te werken, voer je het bovenstaande script opnieuw uit. Deze vervangt de huidige versie zonder de configuratie van Starship aan te passen. - #### Install via Package Manager + #### Installeren via pakketbeheerder With [Homebrew](https://brew.sh/): @@ -55,18 +55,18 @@ description: Starship is the minimal, blazing fast, and extremely customizable p brew install starship ``` - With [Scoop](https://scoop.sh): + Met [Scoop](https://scoop.sh): ```powershell scoop install starship ``` -1. Add the init script to your shell's config file: +1. Voeg het initscript toe aan het configuratiebestand van uw shell: #### Bash - Add the following to the end of `~/.bashrc`: + Voeg het volgende toe aan het einde van `~/.bashrc`: ```sh # ~/.bashrc diff --git a/docs/nl-NL/config/README.md b/docs/nl-NL/config/README.md index 49d98bc4..61f8fcfd 100644 --- a/docs/nl-NL/config/README.md +++ b/docs/nl-NL/config/README.md @@ -1478,7 +1478,13 @@ symbol = "🌟 " ## Jobs -The `jobs` module shows the current number of jobs running. The module will be shown only if there are background jobs running. The module will show the number of jobs running if there is more than 1 job, or more than the `threshold` config value, if it exists. If `threshold` is set to 0, then the module will also show when there are 0 jobs running. +The `jobs` module shows the current number of jobs running. The module will be shown only if there are background jobs running. The module will show the number of jobs running if there are at least 2 jobs, or more than the `number_threshold` config value, if it exists. The module will show a symbol if there is at least 1 job, or more than the `symbol_threshold` config value, if it exists. You can set both values to 0 in order to *always* show the symbol and number of jobs, even if there are 0 jobs running. + +The default functionality is: + +- 0 jobs -> Nothing is shown. +- 1 job -> `symbol` is shown. +- 2 jobs or more -> `symbol` + `number` are shown. ::: warning @@ -1486,15 +1492,26 @@ This module is not supported on tcsh and nu. ::: +::: warning + +The `threshold` option is deprecated, but if you want to use it, the module will show the number of jobs running if there is more than 1 job, or more than the `threshold` config value, if it exists. If `threshold` is set to 0, then the module will also show when there are 0 jobs running. + +::: + ### Options -| Option | Default | Description | -| ----------- | ----------------------------- | ------------------------------------------------ | -| `threshold` | `1` | Show number of jobs if exceeded. | -| `format` | `"[$symbol$number]($style) "` | The format for the module. | -| `symbol` | `"✦"` | A format string representing the number of jobs. | -| `style` | `"bold blue"` | The style for the module. | -| `disabled` | `false` | Disables the `jobs` module. | +| Option | Default | Description | +| ------------------ | ----------------------------- | ------------------------------------------------------------------------ | +| `threshold`\* | `1` | Show number of jobs if exceeded. | +| `symbol_threshold` | `1` | Show `symbol` if the job count is at least `symbol_threshold`. | +| `number_threshold` | `2` | Show the number of jobs if the job count is at least `number_threshold`. | +| `format` | `"[$symbol$number]($style) "` | The format for the module. | +| `symbol` | `"✦"` | The string used to represent the `symbol` variable. | +| `style` | `"bold blue"` | The style for the module. | +| `disabled` | `false` | Disables the `jobs` module. | + \*: This option is deprecated, please use the + +`number_threshold` and `symbol_threshold` options instead. ### Variables @@ -1513,7 +1530,8 @@ This module is not supported on tcsh and nu. [jobs] symbol = "+ " -threshold = 4 +number_threshold = 4 +symbol_threshold = 0 ``` ## Julia @@ -2884,15 +2902,16 @@ The `vlang` module shows you your currently installed version of V. By default t ### Options -| Option | Default | Description | -| ------------------- | -------------------------------------------- | -------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `symbol` | `"V "` | A format string representing the symbol of V | -| `detect_extensions` | `["v"]` | Which extensions should trigger this module. | -| `detect_files` | `["v.mod", "vpkg.json", ".vpkg-lock.json" ]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `style` | `"blue bold"` | The style for the module. | -| `disabled` | `false` | Disables the `vlang` module. | +| Option | Default | Description | +| ------------------- | -------------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"V "` | A format string representing the symbol of V | +| `detect_extensions` | `["v"]` | Which extensions should trigger this module. | +| `detect_files` | `["v.mod", "vpkg.json", ".vpkg-lock.json" ]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `style` | `"blue bold"` | The style for the module. | +| `disabled` | `false` | Disables the `vlang` module. | ### Variables diff --git a/docs/nl-NL/guide/README.md b/docs/nl-NL/guide/README.md index 5641182f..f9d9916b 100644 --- a/docs/nl-NL/guide/README.md +++ b/docs/nl-NL/guide/README.md @@ -2,7 +2,7 @@ Starship – Cross-shell prompt

@@ -10,36 +10,34 @@ GitHub Actions workflow status Crates.io version Packaging status
Chat on Discord Follow @StarshipPrompt on Twitter

Website - · - Installation - · - Configuration + Installatie + Configuratie

@@ -119,79 +117,79 @@ Starship with iTerm2 and the Snazzy theme -**The minimal, blazing-fast, and infinitely customizable prompt for any shell!** +**De minimalistische, razend snelle en oneindig aanpasbare prompt voor elke shell!** -- **Fast:** it's fast – _really really_ fast! 🚀 -- **Customizable:** configure every aspect of your prompt. -- **Universal:** works on any shell, on any operating system. -- **Intelligent:** shows relevant information at a glance. -- **Feature rich:** support for all your favorite tools. -- **Easy:** quick to install – start using it in minutes. +- **Snel:** het is snel -_echt heel erg_ snel! 🚀 +- **Aanpasbaar:** configureer elk aspect van je prompt. +- **Universeel:** werkt op elke shell, op elk besturingssysteem. +- **Intelligent:** toont relevante informatie in een oogopslag. +- **Rijk aan functies:** ondersteuning voor al je favoriete tools. +- **Makkelijk:** snel te installeren - begin in een handomdraai met het te gebruiken.

-Explore the Starship docs  ▶ +Verken de Starship-documentatie  ▶

-## 🚀 Installation +## 🚀 Installatie -### Prerequisites +### Benodigdheden -- A [Nerd Font](https://www.nerdfonts.com/) installed and enabled in your terminal (for example, try the [Fira Code Nerd Font](https://www.nerdfonts.com/font-downloads)). +- Een [Nerd Font](https://www.nerdfonts.com/) is geïnstalleerd en ingeschakeld in je terminal (bijvoorbeeld probeer het [Fira Code Nerd Font](https://www.nerdfonts.com/font-downloads)). -### Getting Started +### Aan de slag -**Note**: due to the proliferation of different platforms, only a subset of supported platforms are shown below. Can't see yours? Have a look at the [extra platform instructions](https://starship.rs/installing/). +**Opmerking:**: als gevolg van de groei van verschillende platforms, worden slechts bepaalde ondersteunde platforms hieronder weergegeven. Staat de jouwe er niet tussen? Neem een kijkje in de [extra platforminstructies](https://starship.rs/installing/). -1. Install the **starship** binary: +1. Installeer de **Starship** binary: - #### Install Latest Version + #### Installeer de nieuwste versie - ##### From prebuilt binary, with Shell: + ##### Vooraf gebouwde binary, met shell: ```sh sh -c "$(curl -fsSL https://starship.rs/install.sh)" ``` - To update the Starship itself, rerun the above script. It will replace the current version without touching Starship's configuration. + Om Starship zelf bij te werken, voer je het bovenstaande script opnieuw uit. Deze vervangt de huidige versie zonder de configuratie van Starship aan te passen. - **Note** - The defaults of the install script can be overridden see the built-in help. + **Opmerking** - De standaardinstellingen van het installatiescript kunnen overschreven worden; zie de ingebouwde hulp. ```sh sh -c "$(curl -fsSL https://starship.rs/install.sh)" -- --help ``` - #### Install via Package Manager + #### Installeren via pakketbeheerder - ##### Example: [Homebrew](https://brew.sh/): + ##### Voorbeeld: [Homebrew](https://brew.sh/): ```sh brew install starship ``` - ##### With [Scoop](https://scoop.sh): + ##### Met [Scoop](https://scoop.sh): ```powershell scoop install starship ``` -2. Add the init script to your shell's config file: +2. Voeg het initscript toe aan het configuratiebestand van uw shell: #### Bash - Add the following to the end of `~/.bashrc`: + Voeg het volgende toe aan het einde van `~/.bashrc`: ```sh # ~/.bashrc diff --git a/docs/nl-NL/installing/README.md b/docs/nl-NL/installing/README.md index 6bb76850..c29416f0 100644 --- a/docs/nl-NL/installing/README.md +++ b/docs/nl-NL/installing/README.md @@ -11,7 +11,7 @@ There are so many platforms out there that they didn't fit into the main README. ## [Chocolatey](https://chocolatey.org) -### Prerequisites +### Benodigdheden Head over to the [Chocolatey installation page](https://chocolatey.org/install) and follow the instructions to install Chocolatey. @@ -23,7 +23,7 @@ choco install starship ## [termux](https://termux.com) -### Prerequisites +### Benodigdheden ```sh pkg install getconf diff --git a/docs/nl-NL/presets/README.md b/docs/nl-NL/presets/README.md index c6cc6f60..ae5d0176 100644 --- a/docs/nl-NL/presets/README.md +++ b/docs/nl-NL/presets/README.md @@ -8,7 +8,7 @@ This preset doesn't change anything except for the symbols used for each module. ![Screenshot of Nerd Font Symbols preset](/presets/nerd-font-symbols.png) -### Prerequisites +### Benodigdheden - A [Nerd Font](https://www.nerdfonts.com/) installed and enabled in your terminal (the example uses Fira Code Nerd Font) diff --git a/docs/pl-PL/config/README.md b/docs/pl-PL/config/README.md index 49d98bc4..61f8fcfd 100644 --- a/docs/pl-PL/config/README.md +++ b/docs/pl-PL/config/README.md @@ -1478,7 +1478,13 @@ symbol = "🌟 " ## Jobs -The `jobs` module shows the current number of jobs running. The module will be shown only if there are background jobs running. The module will show the number of jobs running if there is more than 1 job, or more than the `threshold` config value, if it exists. If `threshold` is set to 0, then the module will also show when there are 0 jobs running. +The `jobs` module shows the current number of jobs running. The module will be shown only if there are background jobs running. The module will show the number of jobs running if there are at least 2 jobs, or more than the `number_threshold` config value, if it exists. The module will show a symbol if there is at least 1 job, or more than the `symbol_threshold` config value, if it exists. You can set both values to 0 in order to *always* show the symbol and number of jobs, even if there are 0 jobs running. + +The default functionality is: + +- 0 jobs -> Nothing is shown. +- 1 job -> `symbol` is shown. +- 2 jobs or more -> `symbol` + `number` are shown. ::: warning @@ -1486,15 +1492,26 @@ This module is not supported on tcsh and nu. ::: +::: warning + +The `threshold` option is deprecated, but if you want to use it, the module will show the number of jobs running if there is more than 1 job, or more than the `threshold` config value, if it exists. If `threshold` is set to 0, then the module will also show when there are 0 jobs running. + +::: + ### Options -| Option | Default | Description | -| ----------- | ----------------------------- | ------------------------------------------------ | -| `threshold` | `1` | Show number of jobs if exceeded. | -| `format` | `"[$symbol$number]($style) "` | The format for the module. | -| `symbol` | `"✦"` | A format string representing the number of jobs. | -| `style` | `"bold blue"` | The style for the module. | -| `disabled` | `false` | Disables the `jobs` module. | +| Option | Default | Description | +| ------------------ | ----------------------------- | ------------------------------------------------------------------------ | +| `threshold`\* | `1` | Show number of jobs if exceeded. | +| `symbol_threshold` | `1` | Show `symbol` if the job count is at least `symbol_threshold`. | +| `number_threshold` | `2` | Show the number of jobs if the job count is at least `number_threshold`. | +| `format` | `"[$symbol$number]($style) "` | The format for the module. | +| `symbol` | `"✦"` | The string used to represent the `symbol` variable. | +| `style` | `"bold blue"` | The style for the module. | +| `disabled` | `false` | Disables the `jobs` module. | + \*: This option is deprecated, please use the + +`number_threshold` and `symbol_threshold` options instead. ### Variables @@ -1513,7 +1530,8 @@ This module is not supported on tcsh and nu. [jobs] symbol = "+ " -threshold = 4 +number_threshold = 4 +symbol_threshold = 0 ``` ## Julia @@ -2884,15 +2902,16 @@ The `vlang` module shows you your currently installed version of V. By default t ### Options -| Option | Default | Description | -| ------------------- | -------------------------------------------- | -------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `symbol` | `"V "` | A format string representing the symbol of V | -| `detect_extensions` | `["v"]` | Which extensions should trigger this module. | -| `detect_files` | `["v.mod", "vpkg.json", ".vpkg-lock.json" ]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `style` | `"blue bold"` | The style for the module. | -| `disabled` | `false` | Disables the `vlang` module. | +| Option | Default | Description | +| ------------------- | -------------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"V "` | A format string representing the symbol of V | +| `detect_extensions` | `["v"]` | Which extensions should trigger this module. | +| `detect_files` | `["v.mod", "vpkg.json", ".vpkg-lock.json" ]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `style` | `"blue bold"` | The style for the module. | +| `disabled` | `false` | Disables the `vlang` module. | ### Variables diff --git a/docs/pt-BR/config/README.md b/docs/pt-BR/config/README.md index b64d11e1..e45755df 100644 --- a/docs/pt-BR/config/README.md +++ b/docs/pt-BR/config/README.md @@ -782,9 +782,9 @@ format = "via [🐋 $context](blue bold)" ## Dotnet -The `dotnet` module shows the relevant version of the [.NET Core SDK](https://dotnet.microsoft.com/) for the current directory. 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. +O módulo `dotnet` exibe a versão relevante do [.NET Core SDK](https://dotnet.microsoft.com/) para a pasta atual. Se o SDK foi fixado na pasta atual, a versão será exibida. Caso contrario será exibida a ultima versão instalada do 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 padrão o módulo vai apenas exibir no seu prompt quando um ou mais dos seguintes arquivos estiverem presente no diretório: - `global.json` - `project.json` @@ -795,25 +795,25 @@ 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. +Você também precisa do .NET Core SDK instalado para usá-lo corretamente. -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 usa seu próprio mecanismo de detecção de versão. Normalmente é duas vezes mais rápido que executar `dotnet --version`, mas pode exibir uma versão errado se o projeto .NET tiver o layout de diretório incomum. Se a precisão é mais importante que velocidade, você pode desabilitar o mecanismo definindo `heuristic = false` nas opções do modulo. -The module will also show the Target Framework Moniker () when there is a csproj file in the current directory. +O módulo também vai exibir o Target Framework Moniker () quando o diretório atual tiver o arquivo csproj. ### Opções -| Opções | Padrão | Descrição | -| ------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- | -| `format` | `"via [$symbol($version )(🎯 $tfm )]($style)"` | O formato do módulo. | -| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | -| `symbol` | `".NET "` | The symbol used before displaying the version of dotnet. | -| `heuristic` | `true` | Use faster version detection to keep starship snappy. | -| `detect_extensions` | `["csproj", "fsproj", "xproj"]` | Which extensions should trigger this module. | -| `detect_files` | `["global.json", "project.json", "Directory.Build.props", "Directory.Build.targets", "Packages.props"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this modules. | -| `style` | `"bold blue"` | O estilo do módulo. | -| `disabled` | `false` | Disables the `dotnet` module. | +| Opções | Padrão | Descrição | +| ------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------ | +| `format` | `"via [$symbol($version )(🎯 $tfm )]($style)"` | O formato do módulo. | +| `version_format` | `"v${raw}"` | O formato da versão. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` | +| `symbol` | `".NET "` | O simbolo usado antes de exibir a versão do dotnet. | +| `heuristic` | `true` | Usa a versão de detecção rápida do starship snappy. | +| `detect_extensions` | `["csproj", "fsproj", "xproj"]` | Quais extensões devem ativar este módulo. | +| `detect_files` | `["global.json", "project.json", "Directory.Build.props", "Directory.Build.targets", "Packages.props"]` | Quais nomes de arquivos devem ativar este módulo. | +| `detect_folders` | `[]` | Quais pastas devem ativar este módulo. | +| `style` | `"bold blue"` | O estilo do módulo. | +| `disabled` | `false` | Desabilita o módulo `dotnet`. | ### Variáveis @@ -839,29 +839,29 @@ heuristic = false ## Elixir -The `elixir` module shows the currently installed version of [Elixir](https://elixir-lang.org/) and [Erlang/OTP](https://erlang.org/doc/). Por padrão o módulo vai exibir se uma das condições a seguir for atendida: +O módulo `elixir` exibe a versão instalada do [Elixir](https://elixir-lang.org/) e [Erlang/OTP](https://erlang.org/doc/). Por padrão o módulo vai exibir se uma das condições a seguir for atendida: -- The current directory contains a `mix.exs` file. +- O diretório atual contem um arquivo `mix.exs`. ### Opções -| Opções | Padrão | Descrição | -| ------------------- | ----------------------------------------------------------- | ------------------------------------------------------------------------- | -| `format` | `'via [$symbol($version \(OTP $otp_version\) )]($style)'` | The format for the module elixir. | -| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | -| `symbol` | `"💧 "` | The symbol used before displaying the version of Elixir/Erlang. | -| `detect_extensions` | `[]` | Which extensions should trigger this module. | -| `detect_files` | `["mix.exs"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this modules. | -| `style` | `"bold purple"` | O estilo do módulo. | -| `disabled` | `false` | Disables the `elixir` module. | +| Opções | Padrão | Descrição | +| ------------------- | ----------------------------------------------------------- | ------------------------------------------------------------------------------------ | +| `format` | `'via [$symbol($version \(OTP $otp_version\) )]($style)'` | O formato do módulo elixir. | +| `version_format` | `"v${raw}"` | O formato da versão. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"💧 "` | O simbolo usado antes de exibir a versão do Elixir/Erlang. | +| `detect_extensions` | `[]` | Quais extensões devem ativar este módulo. | +| `detect_files` | `["mix.exs"]` | Quais nomes de arquivos devem ativar este módulo. | +| `detect_folders` | `[]` | Quais pastas devem ativar este módulo. | +| `style` | `"bold purple"` | O estilo do módulo. | +| `disabled` | `false` | Desabilita o módulo `elixir`. | ### Variáveis | Variável | Exemplo | Descrição | | ----------- | ------- | --------------------------------- | -| version | `v1.10` | The version of `elixir` | -| otp_version | | The otp version of `elixir` | +| version | `v1.10` | A versão do `elixir` | +| otp_version | | A versão otp do `elixir` | | symbol | | Espelha o valor da opção `symbol` | | style\* | | Espelha o valor da opção `style` | @@ -878,32 +878,32 @@ symbol = "🔮 " ## Elm -The `elm` module shows the currently installed version of [Elm](https://elm-lang.org/). Por padrão o módulo vai exibir se uma das condições a seguir for atendida: +O módulo `elm` exibe a versão instalada do [Elm](https://elm-lang.org/). Por padrão o módulo vai exibir se uma das condições a seguir for atendida: -- The current directory contains a `elm.json` file -- The current directory contains a `elm-package.json` file -- The current directory contains a `.elm-version` file -- The current directory contains a `elm-stuff` folder -- The current directory contains a `*.elm` files +- O diretório atual contem um arquivo `elm.json` +- O diretório atual contem o arquivo `elm-package.json` +- O diretório atual contem um arquivo `.elm-version` +- O diretório atual contem uma pasta `elm-stuff` +- O diretório contem arquivos `*.elm` ### Opções -| Opções | Padrão | Descrição | -| ------------------- | -------------------------------------------------- | ------------------------------------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | O formato do módulo. | -| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | -| `symbol` | `"🌳 "` | A format string representing the symbol of Elm. | -| `detect_extensions` | `["elm"]` | Which extensions should trigger this module. | -| `detect_files` | `["elm.json", "elm-package.json", ".elm-version"]` | Which filenames should trigger this module. | -| `detect_folders` | `["elm-stuff"]` | Which folders should trigger this modules. | -| `style` | `"cyan bold"` | O estilo do módulo. | -| `disabled` | `false` | Disables the `elm` module. | +| Opções | Padrão | Descrição | +| ------------------- | -------------------------------------------------- | ------------------------------------------------------------------------------------ | +| `format` | `"via [$symbol($version )]($style)"` | O formato do módulo. | +| `version_format` | `"v${raw}"` | O formato da versão. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"🌳 "` | O formato de string que representa o simbolo do Elm. | +| `detect_extensions` | `["elm"]` | Quais extensões devem ativar este módulo. | +| `detect_files` | `["elm.json", "elm-package.json", ".elm-version"]` | Quais nomes de arquivos devem ativar este módulo. | +| `detect_folders` | `["elm-stuff"]` | Quais pastas devem ativar este módulo. | +| `style` | `"cyan bold"` | O estilo do módulo. | +| `disabled` | `false` | Desabilita o módulo `elm`. | ### Variáveis | Variável | Exemplo | Descrição | | --------- | --------- | --------------------------------- | -| version | `v0.19.1` | The version of `elm` | +| version | `v0.19.1` | A versão do `elm` | | symbol | | Espelha o valor da opção `symbol` | | style\* | | Espelha o valor da opção `style` | @@ -912,23 +912,21 @@ The `elm` module shows the currently installed version of [Elm](https://elm-lang ### Exemplo ```toml -# ~/.config/starship.toml - [elm] format = "via [ $version](cyan bold) " ``` ## Variáveis de Ambiente -The `env_var` module displays the current value of a selected environment variables. The module will be shown only if any of the following conditions are met: +O módulo `env_var` exibe o valor atual de uma variável de ambiente selecionada. O módulo vai exibir somente se algumas das condições a seguir for atendida: -- The `variable` configuration option matches an existing environment variable -- The `variable` configuration option is not defined, but the `default` configuration option is +- A opção de configuração da `variable` corresponde a uma variável existente +- A configuração `variable` não está definida, mas a `default` está -::: tip Multiple environmental variables can be displayed by using a `.`. (see example) If the `variable` configuration option is not set, the module will display value of variable under the name of text after the `.` character. +::: tip Varias variáveis podem ser exibidas usando um `.`. (Veja o exemplo) se a configuração `variable` não é definida, o módulo irá exibir o valor da variável após o caractere `.`. -Example: following configuration will display value of USER environment variable +Exemplo: a configuração a seguir irá mostrar o valor da variável de ambiente USER ```toml # ~/.config/starship.toml @@ -939,21 +937,21 @@ default = "unknown user" ### Opções -| Opções | Padrão | Descrição | -| ---------- | ------------------------------ | ---------------------------------------------------------------------------- | -| `symbol` | | The symbol used before displaying the variable value. | -| `variable` | | The environment variable to be displayed. | -| `default` | | The default value to be displayed when the selected variable is not defined. | -| `format` | `"with [$env_value]($style) "` | O formato do módulo. | -| `disabled` | `false` | Disables the `env_var` module. | +| Opções | Padrão | Descrição | +| ---------- | ------------------------------ | ------------------------------------------------------------------------------ | +| `symbol` | | O simbolo usado antes de exibir o valor da variável. | +| `variable` | | A variável de ambiente a ser exibida. | +| `default` | | O valor padrão para exibir quando a variável selecionada não estiver definida. | +| `format` | `"with [$env_value]($style) "` | O formato do módulo. | +| `disabled` | `false` | Desabilita o módulo `env_var`. | ### Variáveis -| Variável | Exemplo | Descrição | -| --------- | ------------------------------------------- | ------------------------------------------ | -| env_value | `Windows NT` (if _variable_ would be `$OS`) | The environment value of option `variable` | -| symbol | | Espelha o valor da opção `symbol` | -| style\* | `black bold dimmed` | Espelha o valor da opção `style` | +| Variável | Exemplo | Descrição | +| --------- | ------------------------------------------- | --------------------------------------- | +| env_value | `Windows NT` (if _variable_ would be `$OS`) | O valor de ambiente da opção `variable` | +| symbol | | Espelha o valor da opção `symbol` | +| style\* | `black bold dimmed` | Espelha o valor da opção `style` | \*: Essa variável só pode ser usada como parte de uma string de estilo @@ -967,7 +965,7 @@ variable = "SHELL" default = "unknown shell" ``` -Displaying multiple environmental variables: +Exibindo múltiplas variáveis de ambiente: ```toml # ~/.config/starship.toml @@ -980,29 +978,29 @@ default = "unknown user" ## Erlang -The `erlang` module shows the currently installed version of [Erlang/OTP](https://erlang.org/doc/). Por padrão o módulo vai exibir se uma das condições a seguir for atendida: +O módulo de `erlang` exibe a versão atual instalada do [Erlang/OTP](https://erlang.org/doc/). Por padrão o módulo vai exibir se uma das condições a seguir for atendida: -- The current directory contains a `rebar.config` file. -- The current directory contains a `erlang.mk` file. +- O diretório atual contem um arquivo `rebar.config`. +- O diretório atual contem um arquivo `erlang.mk`. ### Opções -| Opções | Padrão | Descrição | -| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | O formato do módulo. | -| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | -| `symbol` | `" "` | The symbol used before displaying the version of erlang. | -| `style` | `"bold red"` | O estilo do módulo. | -| `detect_extensions` | `[]` | Which extensions should trigger this module. | -| `detect_files` | `["rebar.config", "elang.mk"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this modules. | -| `disabled` | `false` | Disables the `erlang` module. | +| Opções | Padrão | Descrição | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------ | +| `format` | `"via [$symbol($version )]($style)"` | O formato do módulo. | +| `version_format` | `"v${raw}"` | O formato da versão. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` | +| `symbol` | `" "` | O simbolo usado antes de exibir a versão do erlang. | +| `style` | `"bold red"` | O estilo do módulo. | +| `detect_extensions` | `[]` | Quais extensões devem ativar este módulo. | +| `detect_files` | `["rebar.config", "elang.mk"]` | Quais nomes de arquivos devem ativar este módulo. | +| `detect_folders` | `[]` | Quais pastas devem ativar este módulo. | +| `disabled` | `false` | Desabilita o módulo `erlang`. | ### Variáveis | Variável | Exemplo | Descrição | | --------- | --------- | --------------------------------- | -| version | `v22.1.3` | The version of `erlang` | +| version | `v22.1.3` | A versão do `erlang` | | symbol | | Espelha o valor da opção `symbol` | | style\* | | Espelha o valor da opção `style` | @@ -1023,23 +1021,23 @@ The `gcloud` module shows the current configuration for [`gcloud`](https://cloud ### Opções -| Opções | Padrão | Descrição | -| ---------------- | ---------------------------------------------------------- | --------------------------------------------------------------- | -| `format` | `'on [$symbol$account(@$domain)(\($region\))]($style) '` | O formato do módulo. | -| `symbol` | `"☁️ "` | The symbol used before displaying the current GCP profile. | -| `region_aliases` | | Table of region aliases to display in addition to the GCP name. | -| `style` | `"bold blue"` | O estilo do módulo. | -| `disabled` | `false` | Disables the `gcloud` module. | +| Opções | Padrão | Descrição | +| ---------------- | ---------------------------------------------------------- | ------------------------------------------------------------ | +| `format` | `'on [$symbol$account(@$domain)(\($region\))]($style) '` | O formato do módulo. | +| `symbol` | `"☁️ "` | O simbolo usado antes de exibir o perfil atual do GCP. | +| `region_aliases` | | Tabela de aliases de região para exibir além do nome do GCP. | +| `style` | `"bold blue"` | O estilo do módulo. | +| `disabled` | `false` | Desabilita o módulo `gcloud`. | ### Variáveis | Variável | Exemplo | Descrição | | --------- | ------------- | ------------------------------------------------------------------ | -| region | `us-central1` | The current GCP region | -| account | `foo` | The current GCP profile | -| domain | `example.com` | The current GCP profile domain | -| project | | The current GCP project | -| active | `default` | The active config name written in `~/.config/gcloud/active_config` | +| region | `us-central1` | A região atual do GCP | +| account | `foo` | O perfil atual do GCP | +| domain | `example.com` | O perfil de domínio atual do GCP | +| project | | O projeto atual do GCP | +| active | `default` | O nome da configuração escrita em `~/.config/gcloud/active_config` | | symbol | | Espelha o valor da opção `symbol` | | style\* | | Espelha o valor da opção `style` | @@ -1047,7 +1045,7 @@ The `gcloud` module shows the current configuration for [`gcloud`](https://cloud ### Exemplos -#### Display account and project +#### Exibe conta e projeto ```toml # ~/.config/starship.toml @@ -1056,7 +1054,7 @@ The `gcloud` module shows the current configuration for [`gcloud`](https://cloud format = 'on [$symbol$account(@$domain)(\($project\))]($style) ' ``` -#### Display active config name only +#### Exibe apenas o nome da configuração ativa ```toml # ~/.config/starship.toml @@ -1066,7 +1064,7 @@ format = "[$symbol$active]($style) " style = "bold yellow" ``` -#### Display account and aliased region +#### Exibir conta e região ```toml # ~/.config/starship.toml @@ -1080,30 +1078,30 @@ asia-northeast1 = "an1" ## Git Branch -The `git_branch` module shows the active branch of the repo in your current directory. +O módulo `git_branch` exibe o branch ativo do repositório no diretório atual. ### Opções -| Opções | Padrão | Descrição | -| -------------------- | -------------------------------- | ---------------------------------------------------------------------------------------- | -| `always_show_remote` | `false` | Shows the remote tracking branch name, even if it is equal to the local branch name. | -| `format` | `"on [$symbol$branch]($style) "` | O formato do módulo. Use `"$branch"` to refer to the current branch name. | -| `symbol` | `" "` | A format string representing the symbol of git branch. | -| `style` | `"bold purple"` | O estilo do módulo. | -| `truncation_length` | `2^63 - 1` | Truncates a git branch to `N` graphemes. | -| `truncation_symbol` | `"…"` | The symbol used to indicate a branch name was truncated. You can use `""` for no symbol. | -| `only_attached` | `false` | Only show the branch name when not in a detached `HEAD` state. | -| `disabled` | `false` | Disables the `git_branch` module. | +| Opções | Padrão | Descrição | +| -------------------- | -------------------------------- | ------------------------------------------------------------------------------------------------- | +| `always_show_remote` | `false` | Exibe o nome do braço remoto, mesmo se ele for igual ao nome do braço local. | +| `format` | `"on [$symbol$branch]($style) "` | O formato do módulo. Use `"$branch"` para se referir ao nome do braço atual. | +| `symbol` | `" "` | Um formato de string que representa o simbolo do git branch. | +| `style` | `"bold purple"` | O estilo do módulo. | +| `truncation_length` | `2^63 - 1` | Truncates um braço do git para `N` caracteres. | +| `truncation_symbol` | `"…"` | O simbolo usado para indicar que o nome braço foi truncado. Você pode usar `""` para sem simbolo. | +| `only_attached` | `false` | Apenas exibe o nome do braço quando o estado não for detached `HEAD`. | +| `disabled` | `false` | Desabilita o módulo `git_branch`. | ### Variáveis -| Variável | Exemplo | Descrição | -| ------------- | -------- | ------------------------------------------------------------------------------------------------------ | -| branch | `master` | The current branch name, falls back to `HEAD` if there's no current branch (e.g. git detached `HEAD`). | -| remote_name | `origin` | The remote name. | -| remote_branch | `master` | The name of the branch tracked on `remote_name`. | -| symbol | | Espelha o valor da opção `symbol` | -| style\* | | Espelha o valor da opção `style` | +| Variável | Exemplo | Descrição | +| ------------- | -------- | ------------------------------------------------------------------------------------------------- | +| branch | `master` | O nome do braço atual, retornará para `HEAD` se não tiver braço atual (e.x: git detached `HEAD`). | +| remote_name | `origin` | O nome do remoto. | +| remote_branch | `master` | O nome do braço rastreado no `remote_name`. | +| symbol | | Espelha o valor da opção `symbol` | +| style\* | | Espelha o valor da opção `style` | \*: Essa variável só pode ser usada como parte de uma string de estilo @@ -1120,25 +1118,25 @@ truncation_symbol = "" ## Git commit -The `git_commit` module shows the current commit hash and also the tag (if any) of the repo in your current directory. +O módulo `git_commit` exibe o hash do comiit atual e também a tag (se existir) do repositório no diretório atual. ### Opções -| Opções | Padrão | Descrição | -| -------------------- | ---------------------------------- | ------------------------------------------------------- | -| `commit_hash_length` | `7` | The length of the displayed git commit hash. | -| `format` | `"[\\($hash$tag\\)]($style) "` | O formato do módulo. | -| `style` | `"bold green"` | O estilo do módulo. | -| `only_detached` | `true` | Only show git commit hash when in detached `HEAD` state | -| `tag_disabled` | `true` | Disables showing tag info in `git_commit` module. | -| `tag_symbol` | `" 🏷 "` | Tag symbol prefixing the info shown | -| `disabled` | `false` | Disables the `git_commit` module. | +| Opções | Padrão | Descrição | +| -------------------- | ---------------------------------- | ------------------------------------------------------------------ | +| `commit_hash_length` | `7` | O tamanho do git commit hash para ser exibido. | +| `format` | `"[\\($hash$tag\\)]($style) "` | O formato do módulo. | +| `style` | `"bold green"` | O estilo do módulo. | +| `only_detached` | `true` | Apenas exibe o git commit hash quando o estado for detached `HEAD` | +| `tag_disabled` | `true` | Desabilita a exibição da informação da tag no módulo `git_commit`. | +| `tag_symbol` | `" 🏷 "` | Simbolo da tag prefixado na informação a ser exibida | +| `disabled` | `false` | Desabilita o módulo `git_commit`. | ### Variáveis | Variável | Exemplo | Descrição | | --------- | --------- | -------------------------------- | -| hash | `b703eb3` | The current git commit hash | +| hash | `b703eb3` | A hash atual do git commit | | style\* | | Espelha o valor da opção `style` | \*: Essa variável só pode ser usada como parte de uma string de estilo @@ -1155,31 +1153,31 @@ tag_symbol = "🔖 " ## Git State -The `git_state` module will show in directories which are part of a git repository, and where there is an operation in progress, such as: _REBASING_, _BISECTING_, etc. If there is progress information (e.g., REBASING 3/10), that information will be shown too. +O módulo `git_state` vai exibir nos diretorios que fazem parte de um repositorio git e onde existe uma operação em progresso, como: _REBASING_, _BISECTING_, etc. Se houver informação de progresso (e.x: REBASING 3/10). esta informação será exibida também. ### Opções -| Opções | Padrão | Descrição | -| -------------- | --------------------------------------------------------------- | --------------------------------------------------------------------------------------- | -| `rebase` | `"REBASING"` | A format string displayed when a `rebase` is in progress. | -| `merge` | `"MERGING"` | A format string displayed when a `merge` is in progress. | -| `revert` | `"REVERTING"` | A format string displayed when a `revert` is in progress. | -| `cherry_pick` | `"CHERRY-PICKING"` | A format string displayed when a `cherry-pick` is in progress. | -| `bisect` | `"BISECTING"` | A format string displayed when a `bisect` is in progress. | -| `am` | `"AM"` | A format string displayed when an `apply-mailbox` (`git am`) is in progress. | -| `am_or_rebase` | `"AM/REBASE"` | A format string displayed when an ambiguous `apply-mailbox` or `rebase` is in progress. | -| `style` | `"bold yellow"` | O estilo do módulo. | -| `format` | `'\([$state( $progress_current/$progress_total)]($style)\) '` | O formato do módulo. | -| `disabled` | `false` | Disables the `git_state` module. | +| Opções | Padrão | Descrição | +| -------------- | --------------------------------------------------------------- | ------------------------------------------------------------------------------------ | +| `rebase` | `"REBASING"` | O formato de string exibida quando um `rebase` esta em progresso. | +| `merge` | `"MERGING"` | O formato de string exibida quando um `merge` esta em progresso. | +| `revert` | `"REVERTING"` | O formato de string exibida quando um `revert` esta em progresso. | +| `cherry_pick` | `"CHERRY-PICKING"` | O formato de string exibida quando um `cherry-pick` esta em progresso. | +| `bisect` | `"BISECTING"` | O formato de string exibida quando um `bisect` esta em progresso. | +| `am` | `"AM"` | O formato de string exibida quando um `apply-mailbox` (`git am`) esta em progresso. | +| `am_or_rebase` | `"AM/REBASE"` | O formato de string exibida quando um `apply-mailbox` or `rebase` esta em progresso. | +| `style` | `"bold yellow"` | O estilo do módulo. | +| `format` | `'\([$state( $progress_current/$progress_total)]($style)\) '` | O formato do módulo. | +| `disabled` | `false` | Desabilita o módulo `git_state`. | ### Variáveis -| Variável | Exemplo | Descrição | -| ---------------- | ---------- | -------------------------------- | -| state | `REBASING` | The current state of the repo | -| progress_current | `1` | The current operation progress | -| progress_total | `2` | The total operation progress | -| style\* | | Espelha o valor da opção `style` | +| Variável | Exemplo | Descrição | +| ---------------- | ---------- | -------------------------------------- | +| state | `REBASING` | O estado atual do repo | +| progress_current | `1` | O progresso da operação atual | +| progress_total | `2` | O total do progresso da operação atual | +| style\* | | Espelha o valor da opção `style` | \*: Essa variável só pode ser usada como parte de uma string de estilo @@ -1195,31 +1193,31 @@ cherry_pick = "[🍒 PICKING](bold red)" ## Git Metrics -The `git_metrics` module will show the number of added and deleted lines in the current git repository. +O módulo `git_metrics` vai exibir o número de adições e exclusões de linhas no repositório git atual. ::: tip -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. +Este módulo é desabilitado por padrão. Para ativa-lo, defina `disabled` para `false` no seu arquivo de configuração. ::: ### Opções -| Opções | Padrão | Descrição | -| --------------- | -------------------------------------------------------- | ---------------------------------- | -| `added_style` | `"bold green"` | The style for the added count. | -| `deleted_style` | `"bold red"` | The style for the deleted count. | -| `format` | `'[+$added]($added_style) [-$deleted]($deleted_style) '` | O formato do módulo. | -| `disabled` | `true` | Disables the `git_metrics` module. | +| Opções | Padrão | Descrição | +| --------------- | -------------------------------------------------------- | -------------------------------------- | +| `added_style` | `"bold green"` | O estilo para a contagem de adições. | +| `deleted_style` | `"bold red"` | O estilo para a contagem de exclusões. | +| `format` | `'[+$added]($added_style) [-$deleted]($deleted_style) '` | O formato do módulo. | +| `disabled` | `true` | Desabilita o módulo `git_metrics`. | ### Variáveis -| Variável | Exemplo | Descrição | -| ----------------- | ------- | ------------------------------------------- | -| added | `1` | The current number of added lines | -| deleted | `2` | The current number of deleted lines | -| added_style\* | | Mirrors the value of option `added_style` | -| deleted_style\* | | Mirrors the value of option `deleted_style` | +| Variável | Exemplo | Descrição | +| ----------------- | ------- | --------------------------------------- | +| added | `1` | O número atual de linhas adicionadas | +| deleted | `2` | O número atual de linhas excluidas | +| added_style\* | | Espelha o valor da opção `added_style` | +| deleted_style\* | | Espelha o valor da opção`deleted_style` | \*: Essa variável só pode ser usada como parte de uma string de estilo @@ -1378,7 +1376,7 @@ The `helm` module shows the currently installed version of [Helm](https://helm.s | `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `detect_extensions` | `[]` | Which extensions should trigger this module. | | `detect_files` | `["helmfile.yaml", "Chart.yaml"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this modules. | +| `detect_folders` | `[]` | Quais pastas devem ativar este módulo. | | `symbol` | `"⎈ "` | A format string representing the symbol of Helm. | | `style` | `"bold white"` | O estilo do módulo. | | `disabled` | `false` | Disables the `helm` module. | @@ -1452,7 +1450,7 @@ The `java` module shows the currently installed version of [Java](https://www.or | `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `detect_extensions` | `["java", "class", "gradle", "jar", "cljs", "cljc"]` | Which extensions should trigger this module. | | `detect_files` | `["pom.xml", "build.gradle.kts", "build.sbt", ".java-version", ".deps.edn", "project.clj", "build.boot"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this modules. | +| `detect_folders` | `[]` | Quais pastas devem ativar este módulo. | | `symbol` | `"☕ "` | A format string representing the symbol of Java | | `style` | `"red dimmed"` | O estilo do módulo. | | `disabled` | `false` | Disables the `java` module. | @@ -1478,7 +1476,13 @@ symbol = "🌟 " ## Jobs -The `jobs` module shows the current number of jobs running. The module will be shown only if there are background jobs running. The module will show the number of jobs running if there is more than 1 job, or more than the `threshold` config value, if it exists. If `threshold` is set to 0, then the module will also show when there are 0 jobs running. +The `jobs` module shows the current number of jobs running. The module will be shown only if there are background jobs running. The module will show the number of jobs running if there are at least 2 jobs, or more than the `number_threshold` config value, if it exists. The module will show a symbol if there is at least 1 job, or more than the `symbol_threshold` config value, if it exists. You can set both values to 0 in order to *always* show the symbol and number of jobs, even if there are 0 jobs running. + +The default functionality is: + +- 0 jobs -> Nothing is shown. +- 1 job -> `symbol` is shown. +- 2 jobs or more -> `symbol` + `number` are shown. ::: warning @@ -1486,15 +1490,26 @@ This module is not supported on tcsh and nu. ::: +::: warning + +The `threshold` option is deprecated, but if you want to use it, the module will show the number of jobs running if there is more than 1 job, or more than the `threshold` config value, if it exists. If `threshold` is set to 0, then the module will also show when there are 0 jobs running. + +::: + ### Opções -| Opções | Padrão | Descrição | -| ----------- | ----------------------------- | ------------------------------------------------ | -| `threshold` | `1` | Show number of jobs if exceeded. | -| `format` | `"[$symbol$number]($style) "` | O formato do módulo. | -| `symbol` | `"✦"` | A format string representing the number of jobs. | -| `style` | `"bold blue"` | O estilo do módulo. | -| `disabled` | `false` | Disables the `jobs` module. | +| Opções | Padrão | Descrição | +| ------------------ | ----------------------------- | ------------------------------------------------------------------------ | +| `threshold`\* | `1` | Show number of jobs if exceeded. | +| `symbol_threshold` | `1` | Show `symbol` if the job count is at least `symbol_threshold`. | +| `number_threshold` | `2` | Show the number of jobs if the job count is at least `number_threshold`. | +| `format` | `"[$symbol$number]($style) "` | O formato do módulo. | +| `symbol` | `"✦"` | The string used to represent the `symbol` variable. | +| `style` | `"bold blue"` | O estilo do módulo. | +| `disabled` | `false` | Disables the `jobs` module. | + \*: This option is deprecated, please use the + +`number_threshold` and `symbol_threshold` options instead. ### Variáveis @@ -1513,7 +1528,8 @@ This module is not supported on tcsh and nu. [jobs] symbol = "+ " -threshold = 4 +number_threshold = 4 +symbol_threshold = 0 ``` ## Julia @@ -1532,7 +1548,7 @@ The `julia` module shows the currently installed version of [Julia](https://juli | `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `detect_extensions` | `["jl"]` | Which extensions should trigger this module. | | `detect_files` | `["Project.toml", "Manifest.toml"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this modules. | +| `detect_folders` | `[]` | Quais pastas devem ativar este módulo. | | `symbol` | `"ஃ "` | A format string representing the symbol of Julia. | | `style` | `"bold purple"` | O estilo do módulo. | | `disabled` | `false` | Disables the `julia` module. | @@ -1570,7 +1586,7 @@ The `kotlin` module shows the currently installed version of [Kotlin](https://ko | `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `detect_extensions` | `["kt", "kts"]` | Which extensions should trigger this module. | | `detect_files` | `[]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this modules. | +| `detect_folders` | `[]` | Quais pastas devem ativar este módulo. | | `symbol` | `"🅺 "` | A format string representing the symbol of Kotlin. | | `style` | `"bold blue"` | O estilo do módulo. | | `kotlin_binary` | `"kotlin"` | Configures the kotlin binary that Starship executes when getting the version. | @@ -1609,7 +1625,7 @@ Displays the current [Kubernetes context](https://kubernetes.io/docs/concepts/co ::: tip -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. +Este módulo é desabilitado por padrão. Para ativa-lo, defina `disabled` para `false` no seu arquivo de configuração. ::: @@ -1737,7 +1753,7 @@ By default the swap usage is displayed if the total system swap is non-zero. ::: tip -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. +Este módulo é desabilitado por padrão. Para ativa-lo, defina `disabled` para `false` no seu arquivo de configuração. ::: @@ -1788,7 +1804,7 @@ The `hg_branch` module shows the active branch of the repo in your current direc | `style` | `"bold purple"` | O estilo do módulo. | | `format` | `"on [$symbol$branch]($style) "` | O formato do módulo. | | `truncation_length` | `2^63 - 1` | Truncates the hg branch name to `N` graphemes | -| `truncation_symbol` | `"…"` | The symbol used to indicate a branch name was truncated. | +| `truncation_symbol` | `"…"` | O simbolo usado para indicar que o nome braço foi truncado. | | `disabled` | `true` | Disables the `hg_branch` module. | ### Variáveis @@ -2451,7 +2467,7 @@ The `scala` module shows the currently installed version of [Scala](https://www. | `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `detect_extensions` | `["sbt", "scala"]` | Which extensions should trigger this module. | | `detect_files` | `[".scalaenv", ".sbtenv", "build.sbt"]` | Which filenames should trigger this module. | -| `detect_folders` | `[".metals"]` | Which folders should trigger this modules. | +| `detect_folders` | `[".metals"]` | Quais pastas devem ativar este módulo. | | `symbol` | `"🆂 "` | A format string representing the symbol of Scala. | | `style` | `"red dimmed"` | O estilo do módulo. | | `disabled` | `false` | Disables the `scala` module. | @@ -2481,7 +2497,7 @@ The `shell` module shows an indicator for currently used shell. ::: tip -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. +Este módulo é desabilitado por padrão. Para ativa-lo, defina `disabled` para `false` no seu arquivo de configuração. ::: @@ -2593,7 +2609,7 @@ The `status` module displays the exit code of the previous command. The module w ::: tip -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. +Este módulo é desabilitado por padrão. Para ativa-lo, defina `disabled` para `false` no seu arquivo de configuração. ::: @@ -2753,7 +2769,7 @@ The `time` module shows the current **local** time. The `format` configuration v ::: tip -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. +Este módulo é desabilitado por padrão. Para ativa-lo, defina `disabled` para `false` no seu arquivo de configuração. ::: @@ -2884,15 +2900,16 @@ The `vlang` module shows you your currently installed version of V. By default t ### Opções -| Opções | Padrão | Descrição | -| ------------------- | -------------------------------------------- | -------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | O formato do módulo. | -| `symbol` | `"V "` | A format string representing the symbol of V | -| `detect_extensions` | `["v"]` | Which extensions should trigger this module. | -| `detect_files` | `["v.mod", "vpkg.json", ".vpkg-lock.json" ]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `style` | `"blue bold"` | O estilo do módulo. | -| `disabled` | `false` | Disables the `vlang` module. | +| Opções | Padrão | Descrição | +| ------------------- | -------------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | O formato do módulo. | +| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"V "` | A format string representing the symbol of V | +| `detect_extensions` | `["v"]` | Which extensions should trigger this module. | +| `detect_files` | `["v.mod", "vpkg.json", ".vpkg-lock.json" ]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `style` | `"blue bold"` | O estilo do módulo. | +| `disabled` | `false` | Disables the `vlang` module. | ### Variáveis @@ -2992,13 +3009,13 @@ These modules will be shown if any of the following conditions are met: - The `when` command returns 0 - The current Operating System (std::env::consts::OS) matchs with `os` field if defined. -::: Dica +::: tip Multiple custom modules can be defined by using a `.`. ::: -::: Dica +::: tip The order in which custom modules are shown can be individually set by including `${custom.foo}` in the top level `format` (as it includes a dot, you need to use `${...}`). By default, the `custom` module will simply show all custom modules in the order they were defined. diff --git a/docs/pt-PT/config/README.md b/docs/pt-PT/config/README.md index 49d98bc4..61f8fcfd 100644 --- a/docs/pt-PT/config/README.md +++ b/docs/pt-PT/config/README.md @@ -1478,7 +1478,13 @@ symbol = "🌟 " ## Jobs -The `jobs` module shows the current number of jobs running. The module will be shown only if there are background jobs running. The module will show the number of jobs running if there is more than 1 job, or more than the `threshold` config value, if it exists. If `threshold` is set to 0, then the module will also show when there are 0 jobs running. +The `jobs` module shows the current number of jobs running. The module will be shown only if there are background jobs running. The module will show the number of jobs running if there are at least 2 jobs, or more than the `number_threshold` config value, if it exists. The module will show a symbol if there is at least 1 job, or more than the `symbol_threshold` config value, if it exists. You can set both values to 0 in order to *always* show the symbol and number of jobs, even if there are 0 jobs running. + +The default functionality is: + +- 0 jobs -> Nothing is shown. +- 1 job -> `symbol` is shown. +- 2 jobs or more -> `symbol` + `number` are shown. ::: warning @@ -1486,15 +1492,26 @@ This module is not supported on tcsh and nu. ::: +::: warning + +The `threshold` option is deprecated, but if you want to use it, the module will show the number of jobs running if there is more than 1 job, or more than the `threshold` config value, if it exists. If `threshold` is set to 0, then the module will also show when there are 0 jobs running. + +::: + ### Options -| Option | Default | Description | -| ----------- | ----------------------------- | ------------------------------------------------ | -| `threshold` | `1` | Show number of jobs if exceeded. | -| `format` | `"[$symbol$number]($style) "` | The format for the module. | -| `symbol` | `"✦"` | A format string representing the number of jobs. | -| `style` | `"bold blue"` | The style for the module. | -| `disabled` | `false` | Disables the `jobs` module. | +| Option | Default | Description | +| ------------------ | ----------------------------- | ------------------------------------------------------------------------ | +| `threshold`\* | `1` | Show number of jobs if exceeded. | +| `symbol_threshold` | `1` | Show `symbol` if the job count is at least `symbol_threshold`. | +| `number_threshold` | `2` | Show the number of jobs if the job count is at least `number_threshold`. | +| `format` | `"[$symbol$number]($style) "` | The format for the module. | +| `symbol` | `"✦"` | The string used to represent the `symbol` variable. | +| `style` | `"bold blue"` | The style for the module. | +| `disabled` | `false` | Disables the `jobs` module. | + \*: This option is deprecated, please use the + +`number_threshold` and `symbol_threshold` options instead. ### Variables @@ -1513,7 +1530,8 @@ This module is not supported on tcsh and nu. [jobs] symbol = "+ " -threshold = 4 +number_threshold = 4 +symbol_threshold = 0 ``` ## Julia @@ -2884,15 +2902,16 @@ The `vlang` module shows you your currently installed version of V. By default t ### Options -| Option | Default | Description | -| ------------------- | -------------------------------------------- | -------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `symbol` | `"V "` | A format string representing the symbol of V | -| `detect_extensions` | `["v"]` | Which extensions should trigger this module. | -| `detect_files` | `["v.mod", "vpkg.json", ".vpkg-lock.json" ]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `style` | `"blue bold"` | The style for the module. | -| `disabled` | `false` | Disables the `vlang` module. | +| Option | Default | Description | +| ------------------- | -------------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"V "` | A format string representing the symbol of V | +| `detect_extensions` | `["v"]` | Which extensions should trigger this module. | +| `detect_files` | `["v.mod", "vpkg.json", ".vpkg-lock.json" ]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `style` | `"blue bold"` | The style for the module. | +| `disabled` | `false` | Disables the `vlang` module. | ### Variables diff --git a/docs/ru-RU/config/README.md b/docs/ru-RU/config/README.md index 0725bdb5..486d543c 100644 --- a/docs/ru-RU/config/README.md +++ b/docs/ru-RU/config/README.md @@ -1478,7 +1478,13 @@ symbol = "🌟 " ## Задачи -The `jobs` module shows the current number of jobs running. The module will be shown only if there are background jobs running. The module will show the number of jobs running if there is more than 1 job, or more than the `threshold` config value, if it exists. If `threshold` is set to 0, then the module will also show when there are 0 jobs running. +The `jobs` module shows the current number of jobs running. The module will be shown only if there are background jobs running. The module will show the number of jobs running if there are at least 2 jobs, or more than the `number_threshold` config value, if it exists. The module will show a symbol if there is at least 1 job, or more than the `symbol_threshold` config value, if it exists. You can set both values to 0 in order to *always* show the symbol and number of jobs, even if there are 0 jobs running. + +The default functionality is: + +- 0 jobs -> Nothing is shown. +- 1 job -> `symbol` is shown. +- 2 jobs or more -> `symbol` + `number` are shown. ::: warning @@ -1486,15 +1492,26 @@ This module is not supported on tcsh and nu. ::: +::: warning + +The `threshold` option is deprecated, but if you want to use it, the module will show the number of jobs running if there is more than 1 job, or more than the `threshold` config value, if it exists. If `threshold` is set to 0, then the module will also show when there are 0 jobs running. + +::: + ### Опции -| Параметр | По умолчанию | Описание | -| ----------- | ----------------------------- | ------------------------------------------------ | -| `threshold` | `1` | Показывать количество задач, если превышено. | -| `format` | `"[$symbol$number]($style) "` | Формат модуля. | -| `symbol` | `"✦"` | A format string representing the number of jobs. | -| `style` | `"bold blue"` | Стиль модуля. | -| `disabled` | `false` | Отключает модуль `jobs`. | +| Параметр | По умолчанию | Описание | +| ------------------ | ----------------------------- | ------------------------------------------------------------------------ | +| `threshold`\* | `1` | Показывать количество задач, если превышено. | +| `symbol_threshold` | `1` | Show `symbol` if the job count is at least `symbol_threshold`. | +| `number_threshold` | `2` | Show the number of jobs if the job count is at least `number_threshold`. | +| `format` | `"[$symbol$number]($style) "` | Формат модуля. | +| `symbol` | `"✦"` | The string used to represent the `symbol` variable. | +| `style` | `"bold blue"` | Стиль модуля. | +| `disabled` | `false` | Disables the `jobs` module. | + \*: This option is deprecated, please use the + +`number_threshold` and `symbol_threshold` options instead. ### Переменные @@ -1513,7 +1530,8 @@ This module is not supported on tcsh and nu. [jobs] symbol = "+ " -threshold = 4 +number_threshold = 4 +symbol_threshold = 0 ``` ## Julia @@ -1816,7 +1834,7 @@ truncation_symbol = "" The `nim` module shows the currently installed version of [Nim](https://nim-lang.org/). By default the module will be shown if any of the following conditions are met: -- Текущий каталог содержит файл `nim.cfg` +- The current directory contains a `nim.cfg` file - The current directory contains a file with the `.nim` extension - The current directory contains a file with the `.nims` extension - The current directory contains a file with the `.nimble` extension @@ -1896,10 +1914,10 @@ format = 'via [☃️ $state( \($name\))](bold blue) ' The `nodejs` module shows the currently installed version of [Node.js](https://nodejs.org/). By default the module will be shown if any of the following conditions are met: -- Текущий каталог содержит файл `package.json` +- The current directory contains a `package.json` file - The current directory contains a `.node-version` file - The current directory contains a `.nvmrc` file -- Текущий каталог содержит каталог `node_modules` +- The current directory contains a `node_modules` directory - The current directory contains a file with the `.js`, `.mjs` or `.cjs` extension - The current directory contains a file with the `.ts` extension @@ -2112,8 +2130,8 @@ format = "via [🦪 $version]($style) " The `php` module shows the currently installed version of [PHP](https://www.php.net/). By default the module will be shown if any of the following conditions are met: -- Текущий каталог содержит файл `composer.json` -- Текущий каталог содержит файл `.php-version` +- The current directory contains a `composer.json` file +- The current directory contains a `.php-version` file - The current directory contains a `.php` extension ### Опции @@ -2152,7 +2170,7 @@ format = "via [🔹 $version](147 bold) " The `purescript` module shows the currently installed version of [PureScript](https://www.purescript.org/) version. By default the module will be shown if any of the following conditions are met: -- Текущий каталог содержит файл `spago.dhall` +- The current directory contains a `spago.dhall` file - The current directory contains a file with the `.purs` extension ### Опции @@ -2195,15 +2213,15 @@ If `pyenv_version_name` is set to `true`, it will display the pyenv version name By default the module will be shown if any of the following conditions are met: -- Текущий каталог содержит файл `.python-version` -- Текущий каталог содержит файл `Pipfile` +- The current directory contains a `.python-version` file +- The current directory contains a `Pipfile` file - The current directory contains a `__init__.py` file -- Текущий каталог содержит файл `pyproject.toml` -- Текущий каталог содержит файл `requirements.txt` -- Текущий каталог содержит файл `setup.py` -- Текущий каталог содержит файл `tox.ini` -- Текущий каталог содержит файл с расширением `.py`. -- Виртуальная среда в данный момент активирована +- The current directory contains a `pyproject.toml` file +- The current directory contains a `requirements.txt` file +- The current directory contains a `setup.py` file +- The current directory contains a `tox.ini` file +- The current directory contains a file with the `.py` extension. +- A virtual environment is currently activated ### Опции @@ -2360,9 +2378,9 @@ symbol = "🔴 " By default the `ruby` module shows the currently installed version of [Ruby](https://www.ruby-lang.org/). The module will be shown if any of the following conditions are met: -- Текущий каталог содержит файл `Gemfile` -- Текущий каталог содержит файл `.ruby-version` -- Текущий каталог содержит файл `.rb` +- The current directory contains a `Gemfile` file +- The current directory contains a `.ruby-version` file +- The current directory contains a `.rb` file ### Опции @@ -2400,8 +2418,8 @@ symbol = "🔺 " By default the `rust` module shows the currently installed version of [Rust](https://www.rust-lang.org/). The module will be shown if any of the following conditions are met: -- Текущий каталог содержит файл `Cargo.toml` -- Текущий каталог содержит файл с расширением `.rs` +- The current directory contains a `Cargo.toml` file +- The current directory contains a file with the `.rs` extension ### Опции @@ -2700,7 +2718,7 @@ By default the Terraform version is not shown, since this is slow for current ve By default the module will be shown if any of the following conditions are met: -- Текущий каталог содержит папку `.terraform` +- The current directory contains a `.terraform` folder - Current directory contains a file with the `.tf` or `.hcl` extensions ### Опции @@ -2797,10 +2815,10 @@ time_range = "10:00:00-14:00:00" The `username` module shows active user's username. The module will be shown if any of the following conditions are met: -- Текущий пользователь - root -- Текущий пользователь отличается от залогиненного -- Пользователь подключен к SSH-сессии -- Переменная `show_always` равна true +- The current user is root +- The current user isn't the same as the one that is logged in +- The user is currently connected as an SSH session +- The variable `show_always` is set to true ::: tip @@ -2884,15 +2902,16 @@ The `vlang` module shows you your currently installed version of V. By default t ### Опции -| Параметр | По умолчанию | Описание | -| ------------------- | -------------------------------------------- | -------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | Формат модуля. | -| `symbol` | `"V "` | A format string representing the symbol of V | -| `detect_extensions` | `["v"]` | Which extensions should trigger this module. | -| `detect_files` | `["v.mod", "vpkg.json", ".vpkg-lock.json" ]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `style` | `"blue bold"` | Стиль модуля. | -| `disabled` | `false` | Disables the `vlang` module. | +| Параметр | По умолчанию | Описание | +| ------------------- | -------------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | Формат модуля. | +| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"V "` | A format string representing the symbol of V | +| `detect_extensions` | `["v"]` | Which extensions should trigger this module. | +| `detect_files` | `["v.mod", "vpkg.json", ".vpkg-lock.json" ]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `style` | `"blue bold"` | Стиль модуля. | +| `disabled` | `false` | Disables the `vlang` module. | ### Переменные diff --git a/docs/tr-TR/config/README.md b/docs/tr-TR/config/README.md index 93962c27..3d994b90 100644 --- a/docs/tr-TR/config/README.md +++ b/docs/tr-TR/config/README.md @@ -1478,7 +1478,13 @@ symbol = "🌟 " ## Jobs -The `jobs` module shows the current number of jobs running. The module will be shown only if there are background jobs running. The module will show the number of jobs running if there is more than 1 job, or more than the `threshold` config value, if it exists. If `threshold` is set to 0, then the module will also show when there are 0 jobs running. +The `jobs` module shows the current number of jobs running. The module will be shown only if there are background jobs running. The module will show the number of jobs running if there are at least 2 jobs, or more than the `number_threshold` config value, if it exists. The module will show a symbol if there is at least 1 job, or more than the `symbol_threshold` config value, if it exists. You can set both values to 0 in order to *always* show the symbol and number of jobs, even if there are 0 jobs running. + +The default functionality is: + +- 0 jobs -> Nothing is shown. +- 1 job -> `symbol` is shown. +- 2 jobs or more -> `symbol` + `number` are shown. ::: uyarı @@ -1486,15 +1492,26 @@ This module is not supported on tcsh and nu. ::: +::: uyarı + +The `threshold` option is deprecated, but if you want to use it, the module will show the number of jobs running if there is more than 1 job, or more than the `threshold` config value, if it exists. If `threshold` is set to 0, then the module will also show when there are 0 jobs running. + +::: + ### Options -| Option | Default | Description | -| ----------- | ----------------------------- | ------------------------------------------------ | -| `threshold` | `1` | Show number of jobs if exceeded. | -| `format` | `"[$symbol$number]($style) "` | The format for the module. | -| `symbol` | `"✦"` | A format string representing the number of jobs. | -| `style` | `"bold blue"` | The style for the module. | -| `disabled` | `false` | Disables the `jobs` module. | +| Option | Default | Description | +| ------------------ | ----------------------------- | ------------------------------------------------------------------------ | +| `threshold`\* | `1` | Show number of jobs if exceeded. | +| `symbol_threshold` | `1` | Show `symbol` if the job count is at least `symbol_threshold`. | +| `number_threshold` | `2` | Show the number of jobs if the job count is at least `number_threshold`. | +| `format` | `"[$symbol$number]($style) "` | The format for the module. | +| `symbol` | `"✦"` | The string used to represent the `symbol` variable. | +| `style` | `"bold blue"` | The style for the module. | +| `disabled` | `false` | Disables the `jobs` module. | + \*: This option is deprecated, please use the + +`number_threshold` and `symbol_threshold` options instead. ### Variables @@ -1513,7 +1530,8 @@ This module is not supported on tcsh and nu. [jobs] symbol = "+ " -threshold = 4 +number_threshold = 4 +symbol_threshold = 0 ``` ## Julia @@ -2884,15 +2902,16 @@ The `vlang` module shows you your currently installed version of V. By default t ### Options -| Option | Default | Description | -| ------------------- | -------------------------------------------- | -------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `symbol` | `"V "` | A format string representing the symbol of V | -| `detect_extensions` | `["v"]` | Which extensions should trigger this module. | -| `detect_files` | `["v.mod", "vpkg.json", ".vpkg-lock.json" ]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `style` | `"blue bold"` | The style for the module. | -| `disabled` | `false` | Disables the `vlang` module. | +| Option | Default | Description | +| ------------------- | -------------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"V "` | A format string representing the symbol of V | +| `detect_extensions` | `["v"]` | Which extensions should trigger this module. | +| `detect_files` | `["v.mod", "vpkg.json", ".vpkg-lock.json" ]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `style` | `"blue bold"` | The style for the module. | +| `disabled` | `false` | Disables the `vlang` module. | ### Variables diff --git a/docs/vi-VN/README.md b/docs/vi-VN/README.md index 0d4c6540..7036fb9e 100644 --- a/docs/vi-VN/README.md +++ b/docs/vi-VN/README.md @@ -44,7 +44,7 @@ description: Starship là prompt nhỏ, cực nhanh, và khả năng tuỳ biế ```sh sh -c "$(curl -fsSL https://starship.rs/install.sh)" ``` - To update the Starship itself, rerun the above script. It will replace the current version without touching Starship's configuration. + Để cập nhật chính Starship, hãy chạy lại đoạn script bên trên. Nó sẽ thay thế phiên bản hiện tại mà không hề thay đổi gì những cài đặt của Starship trước đó. #### Cài đặt thông qua Trình quản lí gói diff --git a/docs/vi-VN/advanced-config/README.md b/docs/vi-VN/advanced-config/README.md index c0bcdff1..63b4bd19 100644 --- a/docs/vi-VN/advanced-config/README.md +++ b/docs/vi-VN/advanced-config/README.md @@ -73,10 +73,10 @@ starship_precmd_user_func="set_win_title" Chuỗi kiểu là một danh sách các từ, được phân cách bởi khoảng trắng. Các từ là không phân biệt hoa thường (ví dụ. `bold` và `Bold` là hai chuỗi tương đương). Mỗi từ có thể là một trong các từ sau: - `bold` - - `italic` - - `underline` - - `dimmed` - - `inverted` + - `nghiêng` + - `gạch dưới` + - `làm tối đi` + - `đảo ngược` - `bg:` - `fg:` - `` diff --git a/docs/vi-VN/config/README.md b/docs/vi-VN/config/README.md index 8755e24b..1eeb9b5b 100644 --- a/docs/vi-VN/config/README.md +++ b/docs/vi-VN/config/README.md @@ -1478,7 +1478,13 @@ symbol = "🌟 " ## Jobs -The `jobs` module shows the current number of jobs running. The module will be shown only if there are background jobs running. The module will show the number of jobs running if there is more than 1 job, or more than the `threshold` config value, if it exists. If `threshold` is set to 0, then the module will also show when there are 0 jobs running. +The `jobs` module shows the current number of jobs running. The module will be shown only if there are background jobs running. The module will show the number of jobs running if there are at least 2 jobs, or more than the `number_threshold` config value, if it exists. The module will show a symbol if there is at least 1 job, or more than the `symbol_threshold` config value, if it exists. You can set both values to 0 in order to *always* show the symbol and number of jobs, even if there are 0 jobs running. + +The default functionality is: + +- 0 jobs -> Nothing is shown. +- 1 job -> `symbol` is shown. +- 2 jobs or more -> `symbol` + `number` are shown. ::: cảnh báo @@ -1486,15 +1492,26 @@ This module is not supported on tcsh and nu. ::: +::: cảnh báo + +The `threshold` option is deprecated, but if you want to use it, the module will show the number of jobs running if there is more than 1 job, or more than the `threshold` config value, if it exists. If `threshold` is set to 0, then the module will also show when there are 0 jobs running. + +::: + ### Các tuỳ chọn -| Tuỳ chọn | Mặc định | Mô tả | -| ----------- | ----------------------------- | -------------------------------------------- | -| `threshold` | `1` | Cho biết số lượng jobs nếu nó vượt quá. | -| `format` | `"[$symbol$number]($style) "` | Định dạng cho module. | -| `symbol` | `"✦"` | Một format string đại diện cho số lượng job. | -| `style` | `"bold blue"` | Kiểu cho module. | -| `disabled` | `false` | Vô hiệu `jobs` module. | +| Tuỳ chọn | Mặc định | Mô tả | +| ------------------ | ----------------------------- | ------------------------------------------------------------------------ | +| `threshold`\* | `1` | Cho biết số lượng jobs nếu nó vượt quá. | +| `symbol_threshold` | `1` | Show `symbol` if the job count is at least `symbol_threshold`. | +| `number_threshold` | `2` | Show the number of jobs if the job count is at least `number_threshold`. | +| `format` | `"[$symbol$number]($style) "` | Định dạng cho module. | +| `symbol` | `"✦"` | The string used to represent the `symbol` variable. | +| `style` | `"bold blue"` | Kiểu cho module. | +| `disabled` | `false` | Disables the `jobs` module. | + \*: This option is deprecated, please use the + +`number_threshold` and `symbol_threshold` options instead. ### Các biến @@ -1513,16 +1530,17 @@ This module is not supported on tcsh and nu. [jobs] symbol = "+ " -threshold = 4 +number_threshold = 4 +symbol_threshold = 0 ``` ## Julia The `julia` module shows the currently installed version of [Julia](https://julialang.org/). Mặc định module sẽ được hiển thị nếu có bất kì điều kiện nào dưới đây thoả mãn: -- Thư mục hiện tại chứa một tệp tin `Project.toml` -- Thư mục hiện tại chứa một tập tin `Manifest.toml` -- Thư mục hiện tại chứa một tệp tin với phần mở rộng `.jl` +- The current directory contains a `Project.toml` file +- The current directory contains a `Manifest.toml` file +- The current directory contains a file with the `.jl` extension ### Các tuỳ chọn @@ -1560,7 +1578,7 @@ symbol = "∴ " The `kotlin` module shows the currently installed version of [Kotlin](https://kotlinlang.org/). Mặc định module sẽ được hiển thị nếu có bất kì điều kiện nào dưới đây thoả mãn: -- Thư mục hiện tại chứa một tệp tin `.kt` hoặc một tệp tin `.kts` +- The current directory contains a `.kt` or a `.kts` file ### Các tuỳ chọn @@ -1816,7 +1834,7 @@ truncation_symbol = "" The `nim` module shows the currently installed version of [Nim](https://nim-lang.org/). Mặc định module sẽ được hiển thị nếu có bất kì điều kiện nào dưới đây thoả mãn: -- Đường dẫn hiện tại chứa một tập tin `nim.cfg` +- The current directory contains a `nim.cfg` file - The current directory contains a file with the `.nim` extension - The current directory contains a file with the `.nims` extension - The current directory contains a file with the `.nimble` extension @@ -1896,7 +1914,7 @@ format = 'via [☃️ $state( \($name\))](bold blue) ' The `nodejs` module shows the currently installed version of [Node.js](https://nodejs.org/). Mặc định module sẽ được hiển thị nếu có bất kì điều kiện nào dưới đây thoả mãn: -- Đường dẫn hiện tại chứa một tập tin `package.json` +- The current directory contains a `package.json` file - The current directory contains a `.node-version` file - The current directory contains a `.nvmrc` file - The current directory contains a `node_modules` directory @@ -2112,7 +2130,7 @@ format = "via [🦪 $version]($style) " The `php` module shows the currently installed version of [PHP](https://www.php.net/). Mặc định module sẽ được hiển thị nếu có bất kì điều kiện nào dưới đây thoả mãn: -- Đường dẫn hiện tại chứa một tập tin `composer.json` +- The current directory contains a `composer.json` file - The current directory contains a `.php-version` file - The current directory contains a `.php` extension @@ -2152,7 +2170,7 @@ format = "via [🔹 $version](147 bold) " The `purescript` module shows the currently installed version of [PureScript](https://www.purescript.org/) version. Mặc định module sẽ được hiển thị nếu có bất kì điều kiện nào dưới đây thoả mãn: -- Đường dẫn hiện tại chứa một tập tin `spago.dhall` +- The current directory contains a `spago.dhall` file - The current directory contains a file with the `.purs` extension ### Các tuỳ chọn @@ -2198,10 +2216,10 @@ Mặc định module sẽ được hiển thị nếu có bất kì điều ki - The current directory contains a `.python-version` file - The current directory contains a `Pipfile` file - The current directory contains a `__init__.py` file -- Đường dẫn hiện tại chứa một tập tin `pyproject.toml` -- Đường dẫn hiện tại chứa một tập tin `requirements.txt` -- Đường dẫn hiện tại chứa một tập tin `setup.py` -- Đường dẫn hiện tại chứa một tập tin `tox.ini` +- The current directory contains a `pyproject.toml` file +- The current directory contains a `requirements.txt` file +- The current directory contains a `setup.py` file +- The current directory contains a `tox.ini` file - The current directory contains a file with the `.py` extension. - A virtual environment is currently activated @@ -2884,15 +2902,16 @@ The `vlang` module shows you your currently installed version of V. By default t ### Các tuỳ chọn -| Tuỳ chọn | Mặc định | Mô tả | -| ------------------- | -------------------------------------------- | --------------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | Định dạng cho module. | -| `symbol` | `"V "` | A format string representing the symbol of V | -| `detect_extensions` | `["v"]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. | -| `detect_files` | `["v.mod", "vpkg.json", ".vpkg-lock.json" ]` | Tên tệp nào sẽ kích hoạt mô-đun này. | -| `detect_folders` | `[]` | Những thư mục nào sẽ kích hoạt mô-đun này. | -| `style` | `"blue bold"` | Kiểu cho module. | -| `disabled` | `false` | Disables the `vlang` module. | +| Tuỳ chọn | Mặc định | Mô tả | +| ------------------- | -------------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | Định dạng cho module. | +| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"V "` | A format string representing the symbol of V | +| `detect_extensions` | `["v"]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. | +| `detect_files` | `["v.mod", "vpkg.json", ".vpkg-lock.json" ]` | Tên tệp nào sẽ kích hoạt mô-đun này. | +| `detect_folders` | `[]` | Những thư mục nào sẽ kích hoạt mô-đun này. | +| `style` | `"blue bold"` | Kiểu cho module. | +| `disabled` | `false` | Disables the `vlang` module. | ### Các biến diff --git a/docs/vi-VN/guide/README.md b/docs/vi-VN/guide/README.md index 70b090c0..ce39f2c9 100644 --- a/docs/vi-VN/guide/README.md +++ b/docs/vi-VN/guide/README.md @@ -160,10 +160,10 @@ ```sh sh -c "$(curl -fsSL https://starship.rs/install.sh)" ``` - To update the Starship itself, rerun the above script. It will replace the current version without touching Starship's configuration. + Để cập nhật chính Starship, hãy chạy lại đoạn script bên trên. Nó sẽ thay thế phiên bản hiện tại mà không hề thay đổi gì những cài đặt của Starship trước đó. - **Note** - The defaults of the install script can be overridden see the built-in help. + **Ghi chú** - Script cài đặt mặc định có thể bị ghi đè. ```sh sh -c "$(curl -fsSL https://starship.rs/install.sh)" -- --help @@ -266,7 +266,7 @@ #### Xonsh - Add the following to the end of `~/.xonshrc`: + Thêm dòng này vào cuối của file `~/.xonshrc`: ```sh # ~/.xonshrc @@ -277,7 +277,7 @@ #### Nushell - **Warning** This will change in the future. Only nu version v0.33 or higher is supported. Add the following to your nu config file. You can check the location of this file by running `config path` in nu. + **Cảnh báo ** Cái này có thể bị thay đổi trong tương lai. Chỉ có nu phiên bản v. 033 hoặc cao hơn được hỗ trợ. Thêm dòng sau vào file cấu hình nu. Bạn có thể kiểm tra vị trí của cái file này bằng cách chạy `đường dẫn cấu hình` trong nu. ```toml startup = [ diff --git a/docs/zh-CN/config/README.md b/docs/zh-CN/config/README.md index ae48f388..d0f7e28d 100644 --- a/docs/zh-CN/config/README.md +++ b/docs/zh-CN/config/README.md @@ -1478,7 +1478,13 @@ symbol = "🌟 " ## Jobs -The `jobs` module shows the current number of jobs running. The module will be shown only if there are background jobs running. The module will show the number of jobs running if there is more than 1 job, or more than the `threshold` config value, if it exists. If `threshold` is set to 0, then the module will also show when there are 0 jobs running. +The `jobs` module shows the current number of jobs running. The module will be shown only if there are background jobs running. The module will show the number of jobs running if there are at least 2 jobs, or more than the `number_threshold` config value, if it exists. The module will show a symbol if there is at least 1 job, or more than the `symbol_threshold` config value, if it exists. You can set both values to 0 in order to *always* show the symbol and number of jobs, even if there are 0 jobs running. + +The default functionality is: + +- 0 jobs -> Nothing is shown. +- 1 job -> `symbol` is shown. +- 2 jobs or more -> `symbol` + `number` are shown. ::: warning @@ -1486,15 +1492,26 @@ This module is not supported on tcsh and nu. ::: +::: warning + +The `threshold` option is deprecated, but if you want to use it, the module will show the number of jobs running if there is more than 1 job, or more than the `threshold` config value, if it exists. If `threshold` is set to 0, then the module will also show when there are 0 jobs running. + +::: + ### 配置项 -| Option | 默认值 | 描述 | -| ----------- | ----------------------------- | ------------------------------------------------ | -| `threshold` | `1` | 如果超过此字段的值,显示任务数量。 | -| `format` | `"[$symbol$number]($style) "` | 组件格式化模板。 | -| `symbol` | `"✦"` | A format string representing the number of jobs. | -| `style` | `"bold blue"` | 此组件的样式。 | -| `disabled` | `false` | 禁用 `jobs` 组件。 | +| Option | 默认值 | 描述 | +| ------------------ | ----------------------------- | ------------------------------------------------------------------------ | +| `threshold`\* | `1` | 如果超过此字段的值,显示任务数量。 | +| `symbol_threshold` | `1` | Show `symbol` if the job count is at least `symbol_threshold`. | +| `number_threshold` | `2` | Show the number of jobs if the job count is at least `number_threshold`. | +| `format` | `"[$symbol$number]($style) "` | 组件格式化模板。 | +| `symbol` | `"✦"` | The string used to represent the `symbol` variable. | +| `style` | `"bold blue"` | 此组件的样式。 | +| `disabled` | `false` | Disables the `jobs` module. | + \*: This option is deprecated, please use the + +`number_threshold` and `symbol_threshold` options instead. ### Variables @@ -1513,7 +1530,8 @@ This module is not supported on tcsh and nu. [jobs] symbol = "+ " -threshold = 4 +number_threshold = 4 +symbol_threshold = 0 ``` ## Julia @@ -1816,7 +1834,7 @@ truncation_symbol = "" The `nim` module shows the currently installed version of [Nim](https://nim-lang.org/). By default the module will be shown if any of the following conditions are met: -- 当前目录包含一个 `nim.cfg` 文件 +- The current directory contains a `nim.cfg` file - The current directory contains a file with the `.nim` extension - The current directory contains a file with the `.nims` extension - The current directory contains a file with the `.nimble` extension @@ -1896,10 +1914,10 @@ format = 'via [☃️ $state( \($name\))](bold blue) ' The `nodejs` module shows the currently installed version of [Node.js](https://nodejs.org/). By default the module will be shown if any of the following conditions are met: -- 当前目录包含 `package.json` 文件 +- The current directory contains a `package.json` file - The current directory contains a `.node-version` file - The current directory contains a `.nvmrc` file -- 当前目录包含 `node_modules` 目录 +- The current directory contains a `node_modules` directory - The current directory contains a file with the `.js`, `.mjs` or `.cjs` extension - The current directory contains a file with the `.ts` extension @@ -2112,7 +2130,7 @@ format = "via [🦪 $version]($style) " The `php` module shows the currently installed version of [PHP](https://www.php.net/). By default the module will be shown if any of the following conditions are met: -- 当前目录包含一个 `composer.json` 文件 +- The current directory contains a `composer.json` file - The current directory contains a `.php-version` file - The current directory contains a `.php` extension @@ -2152,7 +2170,7 @@ format = "via [🔹 $version](147 bold) " The `purescript` module shows the currently installed version of [PureScript](https://www.purescript.org/) version. By default the module will be shown if any of the following conditions are met: -- 当前目录包含一个 `spago.dhall` 文件 +- The current directory contains a `spago.dhall` file - The current directory contains a file with the `.purs` extension ### 配置项 @@ -2195,15 +2213,15 @@ If `pyenv_version_name` is set to `true`, it will display the pyenv version name By default the module will be shown if any of the following conditions are met: -- 当前目录包含 `.python-version` 文件 -- 当前目录包含 `Pipfile` 文件 -- 当前目录包含一个名为`__init__.py`的文件 -- 当前目录包含 `pyproject.toml` 文件 -- 当前目录包含 `requirements.txt` 文件 -- 当前目录包含一个 `setup.py` 文件 -- 当前目录包含一个 `tox.ini` 文件 -- 当前目录包含一个使用 `.py` 扩展名的文件. -- 当前处于一个活跃的 python 虚拟环境中 +- The current directory contains a `.python-version` file +- The current directory contains a `Pipfile` file +- The current directory contains a `__init__.py` file +- The current directory contains a `pyproject.toml` file +- The current directory contains a `requirements.txt` file +- The current directory contains a `setup.py` file +- The current directory contains a `tox.ini` file +- The current directory contains a file with the `.py` extension. +- A virtual environment is currently activated ### 配置项 @@ -2360,9 +2378,9 @@ symbol = "🔴 " By default the `ruby` module shows the currently installed version of [Ruby](https://www.ruby-lang.org/). The module will be shown if any of the following conditions are met: -- 当前目录包含 `Gemfile` 文件 +- The current directory contains a `Gemfile` file - The current directory contains a `.ruby-version` file -- 当前目录包含 `.rb` 文件 +- The current directory contains a `.rb` file ### 配置项 @@ -2400,8 +2418,8 @@ symbol = "🔺 " By default the `rust` module shows the currently installed version of [Rust](https://www.rust-lang.org/). The module will be shown if any of the following conditions are met: -- 当前目录包含 `Cargo.toml` 文件 -- 当前目录包含一个使用 `.rs` 扩展名的文件 +- The current directory contains a `Cargo.toml` file +- The current directory contains a file with the `.rs` extension ### 配置项 @@ -2700,7 +2718,7 @@ By default the Terraform version is not shown, since this is slow for current ve By default the module will be shown if any of the following conditions are met: -- 当前目录包含 `.terraform` 目录 +- The current directory contains a `.terraform` folder - Current directory contains a file with the `.tf` or `.hcl` extensions ### 配置项 @@ -2797,10 +2815,10 @@ time_range = "10:00:00-14:00:00" The `username` module shows active user's username. The module will be shown if any of the following conditions are met: -- 当前用户是 root -- 当前用户与登录用户不相同 -- 用户正通过 SSH 会话连接访问 -- 字段 `show_always` 被设置为 true +- The current user is root +- The current user isn't the same as the one that is logged in +- The user is currently connected as an SSH session +- The variable `show_always` is set to true ::: tip @@ -2884,15 +2902,16 @@ The `vlang` module shows you your currently installed version of V. By default t ### 配置项 -| Option | 默认值 | 描述 | -| ------------------- | -------------------------------------------- | -------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 | -| `symbol` | `"V "` | A format string representing the symbol of V | -| `detect_extensions` | `["v"]` | Which extensions should trigger this module. | -| `detect_files` | `["v.mod", "vpkg.json", ".vpkg-lock.json" ]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `style` | `"blue bold"` | 此组件的样式。 | -| `disabled` | `false` | Disables the `vlang` module. | +| Option | 默认值 | 描述 | +| ------------------- | -------------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 | +| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"V "` | A format string representing the symbol of V | +| `detect_extensions` | `["v"]` | Which extensions should trigger this module. | +| `detect_files` | `["v.mod", "vpkg.json", ".vpkg-lock.json" ]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `style` | `"blue bold"` | 此组件的样式。 | +| `disabled` | `false` | Disables the `vlang` module. | ### Variables diff --git a/docs/zh-TW/advanced-config/README.md b/docs/zh-TW/advanced-config/README.md index a2ea379c..712c3553 100644 --- a/docs/zh-TW/advanced-config/README.md +++ b/docs/zh-TW/advanced-config/README.md @@ -57,7 +57,7 @@ starship_precmd_user_func="set_win_title" precmd_functions+=(set_win_title) ``` -If you like the result, add these lines to your shell configuration file (`~/.bashrc` or `~/.zshrc`) to make it permanent. +如果你喜歡這個結果,把這幾行加入你的 shell 設定檔中(`~/.bashrc` or `~/.zsrhc`)來將此設為永久設定。 For example, if you want to display your current directory in your terminal tab title, add the following snippet to your `~/.bashrc` or `~/.zshrc`: @@ -73,7 +73,7 @@ starship_precmd_user_func="set_win_title" 風格字串是一個以空白分開的單詞清單。 單字並不會區分大小寫(換句話說,`bold` 與 `BoLd` 是被當作兩個相同的字串)。 每個單詞可以是下列其中之一: - `bold` - - `italic` + - `斜體字` - `underline` - `dimmed` - `inverted` diff --git a/docs/zh-TW/config/README.md b/docs/zh-TW/config/README.md index f4cb254b..33091749 100644 --- a/docs/zh-TW/config/README.md +++ b/docs/zh-TW/config/README.md @@ -1478,7 +1478,13 @@ symbol = "🌟 " ## 工作 -The `jobs` module shows the current number of jobs running. The module will be shown only if there are background jobs running. The module will show the number of jobs running if there is more than 1 job, or more than the `threshold` config value, if it exists. If `threshold` is set to 0, then the module will also show when there are 0 jobs running. +The `jobs` module shows the current number of jobs running. The module will be shown only if there are background jobs running. The module will show the number of jobs running if there are at least 2 jobs, or more than the `number_threshold` config value, if it exists. The module will show a symbol if there is at least 1 job, or more than the `symbol_threshold` config value, if it exists. You can set both values to 0 in order to *always* show the symbol and number of jobs, even if there are 0 jobs running. + +The default functionality is: + +- 0 jobs -> Nothing is shown. +- 1 job -> `symbol` is shown. +- 2 jobs or more -> `symbol` + `number` are shown. ::: warning @@ -1486,15 +1492,26 @@ This module is not supported on tcsh and nu. ::: +::: warning + +The `threshold` option is deprecated, but if you want to use it, the module will show the number of jobs running if there is more than 1 job, or more than the `threshold` config value, if it exists. If `threshold` is set to 0, then the module will also show when there are 0 jobs running. + +::: + ### 選項 -| Option | 預設 | 說明 | -| ----------- | ----------------------------- | ------------------------------------------------ | -| `threshold` | `1` | 在超過指定值時顯示工作數量。 | -| `format` | `"[$symbol$number]($style) "` | The format for the module. | -| `symbol` | `"✦"` | A format string representing the number of jobs. | -| `style` | `"bold blue"` | 這個模組的風格。 | -| `disabled` | `false` | 停用 `jobs` 模組。 | +| Option | 預設 | 說明 | +| ------------------ | ----------------------------- | ------------------------------------------------------------------------ | +| `threshold`\* | `1` | 在超過指定值時顯示工作數量。 | +| `symbol_threshold` | `1` | Show `symbol` if the job count is at least `symbol_threshold`. | +| `number_threshold` | `2` | Show the number of jobs if the job count is at least `number_threshold`. | +| `format` | `"[$symbol$number]($style) "` | The format for the module. | +| `symbol` | `"✦"` | The string used to represent the `symbol` variable. | +| `style` | `"bold blue"` | 這個模組的風格。 | +| `disabled` | `false` | Disables the `jobs` module. | + \*: This option is deprecated, please use the + +`number_threshold` and `symbol_threshold` options instead. ### Variables @@ -1513,7 +1530,8 @@ This module is not supported on tcsh and nu. [jobs] symbol = "+ " -threshold = 4 +number_threshold = 4 +symbol_threshold = 0 ``` ## Julia @@ -1816,7 +1834,7 @@ truncation_symbol = "" The `nim` module shows the currently installed version of [Nim](https://nim-lang.org/). By default the module will be shown if any of the following conditions are met: -- 現在資料夾中包含一個 `nim.cfg` 檔案 +- The current directory contains a `nim.cfg` file - The current directory contains a file with the `.nim` extension - The current directory contains a file with the `.nims` extension - The current directory contains a file with the `.nimble` extension @@ -1896,10 +1914,10 @@ format = 'via [☃️ $state( \($name\))](bold blue) ' The `nodejs` module shows the currently installed version of [Node.js](https://nodejs.org/). By default the module will be shown if any of the following conditions are met: -- 現在資料夾中包含一個 `package.json` 檔案 +- The current directory contains a `package.json` file - The current directory contains a `.node-version` file - The current directory contains a `.nvmrc` file -- 現在資料夾中包含一個 `node_modules` 資料夾 +- The current directory contains a `node_modules` directory - The current directory contains a file with the `.js`, `.mjs` or `.cjs` extension - The current directory contains a file with the `.ts` extension @@ -2112,7 +2130,7 @@ format = "via [🦪 $version]($style) " The `php` module shows the currently installed version of [PHP](https://www.php.net/). By default the module will be shown if any of the following conditions are met: -- 現在資料夾中包含一個 `composer.json` 檔案 +- The current directory contains a `composer.json` file - The current directory contains a `.php-version` file - The current directory contains a `.php` extension @@ -2152,7 +2170,7 @@ format = "via [🔹 $version](147 bold) " The `purescript` module shows the currently installed version of [PureScript](https://www.purescript.org/) version. By default the module will be shown if any of the following conditions are met: -- 現在資料夾中包含一個 `spago.dhall` 檔案 +- The current directory contains a `spago.dhall` file - The current directory contains a file with the `.purs` extension ### 選項 @@ -2195,14 +2213,14 @@ If `pyenv_version_name` is set to `true`, it will display the pyenv version name By default the module will be shown if any of the following conditions are met: -- 目前資料夾中有一個 `.python-version` 檔案 -- 目前資料夾中有一個 `Pipfile` 檔案 +- The current directory contains a `.python-version` file +- The current directory contains a `Pipfile` file - The current directory contains a `__init__.py` file -- 目前資料夾中有一個 `pyproject.toml` 檔案 -- 目前資料夾中有一個 `requirements.txt` 檔案 -- 現在資料夾中包含一個 `setup.py` 檔案 -- 目前資料夾中有一個 `tox.ini` 檔案 -- 目前資料夾中有一個 `.py` 副檔名的檔案. +- The current directory contains a `pyproject.toml` file +- The current directory contains a `requirements.txt` file +- The current directory contains a `setup.py` file +- The current directory contains a `tox.ini` file +- The current directory contains a file with the `.py` extension. - A virtual environment is currently activated ### 選項 @@ -2360,9 +2378,9 @@ symbol = "🔴 " By default the `ruby` module shows the currently installed version of [Ruby](https://www.ruby-lang.org/). The module will be shown if any of the following conditions are met: -- 目前資料夾中有一個 `Gemfile` 檔案 +- The current directory contains a `Gemfile` file - The current directory contains a `.ruby-version` file -- 目前資料夾中有一個 `.rb` 檔案 +- The current directory contains a `.rb` file ### 選項 @@ -2400,8 +2418,8 @@ symbol = "🔺 " By default the `rust` module shows the currently installed version of [Rust](https://www.rust-lang.org/). The module will be shown if any of the following conditions are met: -- 目前資料夾中有一個 `Cargo.toml` 檔案 -- 現在資料夾中包含一個檔案具有 `.rs` 副檔名 +- The current directory contains a `Cargo.toml` file +- The current directory contains a file with the `.rs` extension ### 選項 @@ -2797,10 +2815,10 @@ time_range = "10:00:00-14:00:00" The `username` module shows active user's username. The module will be shown if any of the following conditions are met: -- 目前使用者為 root -- 目前使用者並非登入時的使用者 -- 使用者透過 SSH session 進行連線 -- 變數 `show_always` 被設為 true +- The current user is root +- The current user isn't the same as the one that is logged in +- The user is currently connected as an SSH session +- The variable `show_always` is set to true ::: tip @@ -2884,15 +2902,16 @@ The `vlang` module shows you your currently installed version of V. By default t ### 選項 -| Option | 預設 | 說明 | -| ------------------- | -------------------------------------------- | -------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `symbol` | `"V "` | A format string representing the symbol of V | -| `detect_extensions` | `["v"]` | Which extensions should trigger this module. | -| `detect_files` | `["v.mod", "vpkg.json", ".vpkg-lock.json" ]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `style` | `"blue bold"` | 這個模組的風格。 | -| `disabled` | `false` | Disables the `vlang` module. | +| Option | 預設 | 說明 | +| ------------------- | -------------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"V "` | A format string representing the symbol of V | +| `detect_extensions` | `["v"]` | Which extensions should trigger this module. | +| `detect_files` | `["v.mod", "vpkg.json", ".vpkg-lock.json" ]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `style` | `"blue bold"` | 這個模組的風格。 | +| `disabled` | `false` | Disables the `vlang` module. | ### Variables