diff --git a/docs/de-DE/config/README.md b/docs/de-DE/config/README.md
index 188284ca..c03407f6 100644
--- a/docs/de-DE/config/README.md
+++ b/docs/de-DE/config/README.md
@@ -103,6 +103,7 @@ prompt_order = [
"dotnet",
"elixir",
"elm",
+ "erlang",
"golang",
"haskell",
"java",
@@ -120,6 +121,7 @@ prompt_order = [
"env_var",
"crystal",
"cmd_duration",
+ "custom",
"line_break",
"jobs",
"battery",
@@ -482,6 +484,28 @@ The `elm` module shows the currently installed version of Elm. Das Modul wird nu
symbol = " "
```
+## Erlang
+
+The `erlang` module shows the currently installed version of Erlang/OTP. Das Modul wird nur dann angezeigt, wenn eine der folgenden Bedingungen zutrifft:
+
+- The current directory contains a `rebar.config` file.
+- The current directory contains a `erlang.mk` file.
+
+### Optionen
+
+| Variable | Standardwert | Beschreibung |
+| ---------- | ------------ | -------------------------------------------------------- |
+| `symbol` | `"🖧 "` | The symbol used before displaying the version of Erlang. |
+| `disabled` | `false` | Disables the `erlang` module. |
+
+### Beispiel
+
+```toml
+# ~/.config/starship.toml
+
+[erlang]
+symbol = "e "
+```
## Umgebungsvariablen
The `env_var` module displays the current value of a selected environment variable. The module will be shown only if any of the following conditions are met:
@@ -679,7 +703,7 @@ symbol = "🏎💨 "
```
## Haskell
-The `haskell` module shows the currently installed version of Haskell Stack version. Das Modul wird nur dann angezeigt, wenn eine der folgenden Bedingungen zutrifft:
+The `haskell` module shows the currently installed version of Haskell Stack version. Das Modul wird gezeigt, wenn mindestens einer der folgenden Punkte erfüllt ist:
- Das aktuelle Verzeichnis enthält eine `stack.yaml`-Datei
@@ -731,7 +755,7 @@ disabled = false
## Java
-Das `java` Modul zeigt die derzeit installierte Version von Java an. Das Modul wird nur dann angezeigt, wenn eine der folgenden Bedingungen zutrifft:
+Das `java` Modul zeigt die derzeit installierte Version von Java an. Das Modul wird gezeigt, wenn mindestens einer der folgenden Punkte erfüllt ist:
- The current directory contains a `pom.xml`, `build.gradle.kts`, `build.sbt` or `.java-version` file
- The current directory contains a file with the `.java`, `.class`, `.gradle` or `.jar` extension
@@ -778,7 +802,7 @@ threshold = 4
## Julia
-The `julia` module shows the currently installed version of Julia. Das Modul wird nur dann angezeigt, wenn eine der folgenden Bedingungen zutrifft:
+The `julia` module shows the currently installed version of Julia. Das Modul wird gezeigt, wenn mindestens einer der folgenden Punkte erfüllt ist:
- The current directory contains a `Project.toml` file
- The current directory contains a `Manifest.toml` file
@@ -788,7 +812,7 @@ The `julia` module shows the currently installed version of Julia. Das Modul wir
| Variable | Standardwert | Beschreibung |
| ---------- | --------------- | ------------------------------------------------------- |
-| `symbol` | `"∴ "` | The symbol used before displaying the version of Julia. |
+| `symbol` | `"ஃ "` | The symbol used before displaying the version of Julia. |
| `style` | `"bold purple"` | Stil für dieses Modul. |
| `disabled` | `false` | Disables the `julia` module. |
@@ -798,13 +822,13 @@ The `julia` module shows the currently installed version of Julia. Das Modul wir
# ~/.config/starship.toml
[julia]
-symbol = "👸 "
+symbol = "∴ "
```
## Kubernetes
Displays the current Kubernetes 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`.
-::: tip
+::: Tipp
Dieses Modul ist standardmäßig deaktiviert. Setze in deiner Konfiguration `disabled` auf `false` um es zu aktivieren.
@@ -857,7 +881,7 @@ Das `memory_usage` Modul zeigt den aktuellen Systemspeicher und die swap-Nutzung
Standardmäßig wird die swap-Nutzung angezeigt, wenn der gesamte System-swap nicht Null ist.
-::: tip
+::: Tipp
Dieses Modul ist standardmäßig deaktiviert. Setze in deiner Konfiguration `disabled` auf `false` um es zu aktivieren.
@@ -921,13 +945,14 @@ Das `nix_shell`-Modul zeigt die nix-shell Umgebung an. Das Modul wird angezeigt,
### Optionen
-| Variable | Standardwert | Beschreibung |
-| ------------ | ------------ | ---------------------------------- |
-| `use_name` | `false` | Namen der nix-Shell anzeigen. |
-| `impure_msg` | `"impure"` | Passt die "impure"-Nachricht an. |
-| `pure_msg` | `"pure"` | Passt die "pure"-Nachricht an. |
-| `style` | `"bold red"` | Stil für dieses Modul. |
-| `disabled` | `false` | Deaktiviert das `nix_shell`-Modul. |
+| Variable | Standardwert | Beschreibung |
+| ------------ | ------------- | ------------------------------------------------- |
+| `use_name` | `false` | Namen der nix-Shell anzeigen. |
+| `impure_msg` | `"impure"` | Passt die "impure"-Nachricht an. |
+| `pure_msg` | `"pure"` | Passt die "pure"-Nachricht an. |
+| `symbol` | `"❄️ "` | The symbol used before displaying the shell name. |
+| `style` | `"bold blue"` | Stil für dieses Modul. |
+| `disabled` | `false` | Deaktiviert das `nix_shell`-Modul. |
### Beispiel
@@ -939,11 +964,12 @@ disabled = true
use_name = true
impure_msg = "impure shell"
pure_msg = "pure shell"
+symbol = "☃️ "
```
## NodeJS
-Das `nodejs` Modul zeigt die derzeit installierte Version von NodeJS. Das Modul wird nur dann angezeigt, wenn eine der folgenden Bedingungen zutrifft:
+Das `nodejs`-Modul zeigt die aktuell installierte Version von NodeJS. Das Modul wird gezeigt, wenn mindestens einer der folgenden Punkte erfüllt ist:
- Das aktuelle Verzeichnis enthält eine `package.json`-Datei
- The current directory contains a `.node-version` file
@@ -969,7 +995,7 @@ symbol = "🤖 "
## Paketversion
-Das `Package` Modul wird angezeigt, wenn das aktuelle Verzeichnis das Repository für ein Paket ist, und zeigt dessen aktuelle Version an. The module currently supports `npm`, `cargo`, `poetry`, `composer`, and `gradle` packages.
+Das `Package` Modul wird angezeigt, wenn das aktuelle Verzeichnis das Repository für ein Paket ist, und zeigt dessen aktuelle Version an. The module currently supports `npm`, `cargo`, `poetry`, `composer`, `gradle`, `julia` and `mix` packages.
- **npm** – Die `npm` Paketversion wird aus dem `package.json` gelesen, das sich im aktuellen Verzeichnis befindet
- **Cargo** – Die `Cargo` Paketversion wird aus dem `Cargo.toml` gelesen, das sich im aktuellen Verzeichnis befindet
@@ -977,16 +1003,18 @@ Das `Package` Modul wird angezeigt, wenn das aktuelle Verzeichnis das Repository
- **composer** – The `composer` package version is extracted from the `composer.json` present in the current directory
- **gradle** – The `gradle` package version is extracted from the `build.gradle` present
- **julia** - The package version is extracted from the `Project.toml` present
+- **mix** - The `mix` package version is extracted from the `mix.exs` present
> ⚠️ Die angezeigte Version ist die des Pakets, dessen Quellcode im Verzeichnis liegt, nicht die des Paketmanagers.
### Optionen
-| Variable | Standardwert | Beschreibung |
-| ---------- | ------------ | ----------------------------------------------- |
-| `symbol` | `"📦 "` | Symbol das vor der Paketversion angezeigt wird. |
-| `style` | `"bold red"` | Stil für dieses Modul. |
-| `disabled` | `false` | Deaktiviert das `package`-Modul. |
+| Variable | Standartwert | Beschreibung |
+| ----------------- | ------------ | --------------------------------------------------------- |
+| `symbol` | `"📦 "` | Symbol das vor der Paketversion angezeigt wird. |
+| `style` | `"bold red"` | Stil für dieses Modul. |
+| `display_private` | `false` | Enable displaying version for packages marked as private. |
+| `disabled` | `false` | Deaktiviert das `package`-Modul. |
### Beispiel
@@ -999,7 +1027,7 @@ symbol = "🎁 "
## PHP
-Das `php`-Modul zeigt die aktuell installierte Version von PHP. Das Modul wird nur dann angezeigt, wenn eine der folgenden Bedingungen zutrifft:
+Das `php`-Modul zeigt die aktuell installierte Version von PHP. Das Modul wird gezeigt, wenn mindestens einer der folgenden Punkte erfüllt ist:
- Das aktuelle Verzeichnis enthält eine `composer.json`-Datei
- The current directory contains a `.php-version` file
@@ -1007,7 +1035,7 @@ Das `php`-Modul zeigt die aktuell installierte Version von PHP. Das Modul wird n
### Optionen
-| Variable | Standartwert | Beschreibung |
+| Variable | Standardwert | Beschreibung |
| ---------- | ------------ | ---------------------------------------------- |
| `symbol` | `"🐘 "` | Symbol das vor der PHP-Version angezeigt wird. |
| `style` | `"bold red"` | Stil für dieses Modul. |
@@ -1030,25 +1058,28 @@ Wenn `pyenv_version_name` auf `true` gesetzt ist, wird die version der pyenv ang
Andernfalls wird die gleiche Versionsnummer angezeigt wie `python --version`, sowie der Name des aktuellen virtualenvs, wenn eines aktiv ist.
-Das Modul wird nur dann angezeigt, wenn eine der folgenden Bedingungen zutrifft:
+Das Modul wird gezeigt, wenn mindestens einer der folgenden Punkte erfüllt ist:
- Das aktuelle Verzeichnis enthält eine `.python-version`-Datei
- Das aktuelle Verzeichnis enthält eine `requirements.txt`-Datei
- Das aktuelle Verzeichnis enthält eine `pyproject.toml`-Datei
-- Das aktuelle Verzeichnis enthält eine Datei mit der `.py`-Erweiterung
+- The current directory contains a file with the `.py` extension (and `scan_for_pyfiles` is true)
- Das aktuelle Verzeichnis enthält eine `Pipfile`-Datei
- Das aktuelle Verzeichnis enthält eine `tox.ini`-Datei
+- Das aktuelle Verzeichnis enthält eine `setup.py`-Datei
+- The current directory contains a `__init__.py` file
- Ein virtualenv ist momentan aktiv
### Optionen
-| Variable | Standardwert | Beschreibung |
-| -------------------- | --------------- | ------------------------------------------------------------------- |
-| `symbol` | `"🐍 "` | Symbol das vor der Python-Version angezeigt wird. |
-| `pyenv_version_name` | `false` | Verwende `pyenv` um die Python-Versionzu beziehen. |
-| `pyenv_prefix` | `"pyenv "` | Prefix zur Anzeige der pyenv-Version (Standard: `pyenv MY_VERSION`) |
-| `style` | `"bold yellow"` | Stil für dieses Modul. |
-| `disabled` | `false` | Deaktiviert das `python`-Modul. |
+| Variable | Standardwert | Beschreibung |
+| -------------------- | --------------- | -------------------------------------------------------------------------- |
+| `symbol` | `"🐍 "` | Symbol das vor der Python-Version angezeigt wird. |
+| `pyenv_version_name` | `false` | Verwende `pyenv` um die Python-Versionzu beziehen. |
+| `pyenv_prefix` | `"pyenv "` | Prefix zur Anzeige der pyenv-Version (Standard: `pyenv MY_VERSION`) |
+| `scan_for_pyfiles` | `true` | If false, Python files in the current directory will not show this module. |
+| `style` | `"bold yellow"` | Stil für dieses Modul. |
+| `disabled` | `false` | Deaktiviert das `python`-Modul. |
### Beispiel
@@ -1088,7 +1119,7 @@ symbol = "🔺 "
## Rust
-Das `rust` Modul zeigt die derzeit installierte Version von Rust an. Das Modul wird nur dann angezeigt, wenn eine der folgenden Bedingungen zutrifft:
+Das `rust` Modul zeigt die derzeit installierte Version von Rust an. Das Modul wird gezeigt, wenn mindestens einer der folgenden Punkte erfüllt ist:
- Das aktuelle Verzeichnis enthält eine `Cargo.toml`-Datei
- Das aktuelle Verzeichnis enthält eine Datei mit der `.rs`-Erweiterung
@@ -1114,8 +1145,6 @@ symbol = "⚙️ "
The `singularity` module shows the current singularity image, if inside a container and `$SINGULARITY_NAME` is set.
-:::
-
### Optionen
| Variable | Standardwert | Beschreibung |
@@ -1138,7 +1167,7 @@ symbol = "📦 "
## Terraform
-Das `Terraform` Modul zeigt den aktuell ausgewählten terraform Arbeitsbereich und die Version an. Standardmäßig wird die Terraform-Version nicht angezeigt, da dies bei aktuellen Versionen von Terraform langsam ist, wenn viele Plugins verwendet werden. Das Modul wird nur dann angezeigt, wenn eine der folgenden Bedingungen zutrifft:
+Das `Terraform` Modul zeigt den aktuell ausgewählten terraform Arbeitsbereich und die Version an. Standardmäßig wird die Terraform-Version nicht angezeigt, da dies bei aktuellen Versionen von Terraform langsam ist, wenn viele Plugins verwendet werden. Das Modul wird gezeigt, wenn mindestens einer der folgenden Punkte erfüllt ist:
- Das aktuelle Verzeichnis enthält eine `.terraform`-Datei
- Das aktuelle Verzeichnis enthält eine Datei mit der `.tf`-Erweiterung
@@ -1161,11 +1190,11 @@ Das `Terraform` Modul zeigt den aktuell ausgewählten terraform Arbeitsbereich u
symbol = "🏎💨 "
```
-## Uhrzeit
+## Zeit
Das `time` Modul zeigt die aktuelle **lokale** Zeit an. Der `format` Wert wird von der crate [`chrono`](https://crates.io/crates/chrono) benutzt um die Zeit zu formatieren. Schau dir [die chrono strftime Dokumentation](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) an, um die möglichen Optionen zu sehen.
-::: tip
+::: Tipp
Dieses Modul ist standardmäßig deaktiviert. Setze in deiner Konfiguration `disabled` auf `false` um es zu aktivieren.
@@ -1173,15 +1202,15 @@ Dieses Modul ist standardmäßig deaktiviert. Setze in deiner Konfiguration `dis
### Optionen
-| Variable | Standardwert | Beschreibung |
-| ----------------- | --------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
-| `use_12hr` | `false` | Aktiviert die Formatierung der Uhrzeit im 12-Stunden-Format. |
-| `format` | Siehe unten | Das Format zum Anzeigen der Uhrzeit in [chrono-Formatierung](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html). |
-| `style` | `"bold yellow"` | Stil für dieses Modul. |
-| `utc_time_offset` | `"local"` | Legt das UTC-Offset fest, das verwendet werden soll. Reicht von -24 < x < 24. Allows floats to accommodate 30/45 minute timezone offsets. |
-| `disabled` | `true` | Deaktiviert das `time`-Modul. |
+| Variable | Standardwert | Beschreibung |
+| ----------------- | --------------- | ----------------------------------------------------------------------------------------------------------------------------- |
+| `use_12hr` | `false` | Aktiviert 12-Stunden-Format |
+| `format` | siehe unten | Das Format zum Anzeigen der Uhrzeit in [chrono-Formatierung](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html). |
+| `style` | `"bold yellow"` | Stil für dieses Modul |
+| `utc_time_offset` | `"local"` | Verwendetes Zeitzonen-Offset. Liegt zwischen -24 < x < 24. Allows floats to accommodate 30/45 minute timezone offsets. |
+| `disabled` | `true` | Deaktiviert das `time`-Modul. |
-Wird `use_12hr` auf `true` gestellt, so wird `format` automatisch auf `"%r"` gesetzt. Ansonsten ist der Standardwert hierfür `"%T"`. Wird hingegen `format` gesetzt, so überschreibt dies die Einstellung `use_12hr`.
+Wird `use_12hr` auf `true` gestellt, nimmt `format` automatisch den Wert `"%r"` an. Andernfalls ist es standardmäßig `"%T"`. Wird hingegen `format` gesetzt, so überschreibt dies die Einstellung `use_12hr`.
### Beispiel
@@ -1194,23 +1223,23 @@ format = "🕙[ %T ]"
utc_time_offset = "-5"
```
-## Benutzername
+## Username
-Das Modul `username` zeigt den Benutzernamen des aktiven Benutzers. Das Modul wird nur dann angezeigt, wenn eine der folgenden Bedingungen zutrifft:
+Das `username` Modul zeigt den Namen des aktiven Benutzers. Das Modul wird gezeigt, wenn mindestens einer der folgenden Punkte erfüllt ist:
- 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
+- Der aktuelle Benutzer ist nicht der eingeloggte Benutzer
+- Der Benutzer ist aktuell via SSH verbunden
+- Die Variable `show_always` ist auf true gesetzt
### Optionen
-| Variable | Standardwert | Beschreibung |
-| ------------- | --------------- | --------------------------------- |
-| `style_root` | `"bold red"` | Stil beim root-Benutzer. |
-| `style_user` | `"bold yellow"` | Stil bei allen anderen Benutzern. |
-| `show_always` | `false` | `username`-Modul immer anzeigen. |
-| `disabled` | `false` | Deaktiviert das `username`-Modul. |
+| Variable | Standartwert | Beschreibung |
+| ------------- | --------------- | ---------------------------------------------- |
+| `style_root` | `"bold red"` | Stil wenn der Benutzer unter root läuft. |
+| `style_user` | `"bold yellow"` | Stil wenn der Benutzer nicht unter root läuft. |
+| `show_always` | `false` | Immer das `username` Modul anzeigen. |
+| `disabled` | `false` | Deavktiviert das `username` Modul. |
### Beispiel
@@ -1220,3 +1249,54 @@ Das Modul `username` zeigt den Benutzernamen des aktiven Benutzers. Das Modul wi
[username]
disabled = true
```
+
+## 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
+
+::: Tipp
+
+Multiple custom modules can be defined by using a `.`.
+
+:::
+
+::: Tipp
+
+The order in which custom modules are shown can be individually set by setting `custom.foo` in `prompt_order`. By default, the `custom` module will simply show all custom modules in the order they were defined.
+
+:::
+
+### Optionen
+
+| Variable | Standartwert | Beschreibung |
+| -------------- | ------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
+| `command` | | The command whose output should be printed. |
+| `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` | | The path to the shell to use to execute the command. If unset, it will fallback to STARSHIP_SHELL and then to "sh". |
+| `beschreibung` | `""` | 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"` | Stil für dieses Modul. |
+| `prefix` | `""` | Prefix to display immediately before the command output. |
+| `suffix` | `""` | Suffix to display immediately after the command output. |
+| `disabled` | `false` | Disables this `custom` module. |
+
+### Beispiel
+
+```toml
+# ~/.config/starship.toml
+
+[custom.foo]
+command = "echo foo" # shows output of command
+files = ["foo"] # can specify filters
+when = """ test "$HOME" == "$PWD" """
+prefix = " transcending "
+```
diff --git a/docs/de-DE/faq/README.md b/docs/de-DE/faq/README.md
index 7301bfc0..2080aad1 100644
--- a/docs/de-DE/faq/README.md
+++ b/docs/de-DE/faq/README.md
@@ -43,3 +43,11 @@ starship prompt --help
```
Die Eingabeaufforderung verwendet so viel Kontext wie möglich, aber keine Flagge ist "notwendig".
+
+## 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
+curl -fsSL https://starship.rs/install.sh | bash -s -- --platform unknown-linux-musl
+```
diff --git a/docs/de-DE/guide/README.md b/docs/de-DE/guide/README.md
index 4ee65c13..b493c9a9 100644
--- a/docs/de-DE/guide/README.md
+++ b/docs/de-DE/guide/README.md
@@ -32,7 +32,7 @@
+
+
## 🚀 Installation
### Voraussetzungen
@@ -250,7 +252,7 @@ Support this project with your organization. Your logo will show up here with a
## 💭 Inspiriert durch
-Please check out these previous works that helped inspire the creation of starship. 🙏
+Checkt bitte diese älteren Projekte, die das Entstehen von Starhip inspiriert haben. 🙏
- **[denysdovhan/spaceship-prompt](https://github.com/denysdovhan/spaceship-prompt)** - Ein ZSH-Prompt für Astronauten.
@@ -260,9 +262,9 @@ Please check out these previous works that helped inspire the creation of starsh
diff --git a/docs/es-ES/advanced-config/README.md b/docs/es-ES/advanced-config/README.md
index a0f57501..3e13e25c 100644
--- a/docs/es-ES/advanced-config/README.md
+++ b/docs/es-ES/advanced-config/README.md
@@ -59,7 +59,7 @@ precmd_functions+=(set_win_title)
If you like the result, add these lines to your shell configuration file (`~/.bashrc` or `~/.zsrhc`) to make it permanent.
-## Style Strings
+## Dar estilo a cadenas de texto
Style strings are a list of words, separated by whitespace. The words are not case sensitive (i.e. `bold` and `BoLd` are considered the same string). Each word can be one of the following:
diff --git a/docs/es-ES/config/README.md b/docs/es-ES/config/README.md
index 0d0b4569..e661ffa9 100644
--- a/docs/es-ES/config/README.md
+++ b/docs/es-ES/config/README.md
@@ -2,90 +2,90 @@
::: tip
-🔥 Configuration is currently being worked on. Many new configuration options will be available in coming releases.
+🔥 Este apartado está bajo construcción. Habrá nuevas opciones de configuración disponibles en próximas versiones.
:::
-To get started configuring starship, create the following file: `~/.config/starship.toml`.
+Para iniciar la configuración de starship, crea el siguiente fichero: `~/.config.toml`.
```sh
$ mkdir -p ~/.config && touch ~/.config/starship.toml
```
-All configuration for starship is done in this [TOML](https://github.com/toml-lang/toml) file:
+Toda la configuración de starship se incluye en este fichero [TOML](https://github.com/toml-lang/toml):
```toml
-# Don't print a new line at the start of the prompt
+# Evita imprimir una nueva linea al comiendo del símbolo del sistema
add_newline = false
-# Replace the "❯" symbol in the prompt with "➜"
-[character] # The name of the module we are configuring is "character"
-symbol = "➜" # The "symbol" segment is being set to "➜"
+# Reemplaza en el símbolo del sistema el carácter "❯" por "➜"
+[character] # El nombre del módulo que estamos configurando es "character"
+symbol = "➜" # El segmento "symbol" se actualiza por "➜"
-# Disable the package module, hiding it from the prompt completely
+# Desactiva el gestor de paquetes, ocultándolo del símbolo de sistema por completo
[package]
disabled = true
```
-You can change default `starship.toml` file location with `STARSHIP_CONFIG` environment variable:
+Puedes modificar la ubicación por defecto del fichero `starship.toml` con la variable de entorno `STARSHIP_CONFIG`:
```sh
export STARSHIP_CONFIG=~/.starship
```
### Terminology
-**Module**: A component in the prompt giving information based on contextual information from your OS. For example, the "nodejs" module shows the version of NodeJS that is currently installed on your computer, if your current directory is a NodeJS project.
+**Módulo**: un componente en el símbolo de sistema que provee de información basada en información contextual de tu sistema operativo. Por ejemplo, el módulo "nodejs" muestra la versión de NodeJS que tienes actualmente instalada en tu ordenador, si el directorio actual es un proyecto NodeJS.
-**Segment**: Smaller sub-components that compose a module. For example, the "symbol" segment in the "nodejs" module contains the character that is shown before the version number (⬢ by default).
+**Segmento**: sub-componentes más pequeños que forman un módulo. Por ejemplo, el segmento "symbol" en el módulo "nodejs" contiene el carácter que se muestra antes del número de versión (⬢ por defecto).
-Here is the representation of the node module. In the following example, "symbol" and "version" are segments within it. Every module also has a prefix and suffix that are the default terminal color.
+A continuación mostramos la representación del módulo "node". En el siguiente ejemplo, "symbol" y "version" son segmentos que lo contienen. Cada módulo tiene además un prefijo y un sufijo que indican el color por defecto en el terminal.
```
[prefix] [symbol] [version] [suffix]
"via " "⬢" "v10.4.1" ""
```
-### Style Strings
+### Dar estilo a cadenas de texto
-Most modules in starship allow you to configure their display styles. This is done with an entry (usually called `style`) which is a string specifying the configuration. Here are some examples of style strings along with what they do. For details on the full syntax, consult the [advanced config guide](/advanced-config/).
+La mayoría de los módulos de starship permiten configurar los estilos de su cadenas texto. Esto se consigue con una entrada (normalmente llamada `style` - estilo) que no es más que un texto donde se especifica la configuración. A continuación mostramos algunos ejemplos de textos estilados junto con su funcionalidad. Para más detalles sobre la sintaxis completa, consulta [la guía de configuración avanzada](/advanced-config/).
-- `"fg:green bg:blue"` sets green text on a blue background
-- `"bg:blue fg:bright-green"` sets bright green text on a blue background
-- `"bold fg:27"` sets bold text with [ANSI color](https://i.stack.imgur.com/KTSQa.png) 27
-- `"underline bg:#bf5700"` sets underlined text on a burnt orange background
-- `"bold italic fg:purple"` sets bold italic purple text
-- `""` explicitly disables all styling
+- `"fg:green bg:blue"` pone texto verde sobre un fondo azul
+- `"bg:blue fg:bright-green"` pone texto verde claro sobre un fondo azul
+- `"bold fg:27"` pone texto en negrita con [color ANSI](https://i.stack.imgur.com/KTSQa.png) 27
+- `"underline bg:#bf5700"` subraya el texto sobre un fondo naranja oscuro
+- `"bold italic fg:purple"` pone texto color morado, en negrita y cursiva
+- `""` desactiva explícitamente cualquier estilo
-Note that what styling looks like will be controlled by your terminal emulator. For example, some terminal emulators will brighten the colors instead of bolding text, and some color themes use the same values for the normal and bright colors. Also, to get italic text, your terminal must support italics.
+Nótese que el estilo es similar a como se controlaría por el emulador de su terminal. Por ejemplo, algunos emuladores de terminal harán los colores más brillantes en lugar de más gruesos, y algunos temas usan los mismos valores para texto normal y colores brillantes. Además, para mostrar textos en cursiva tu terminal debe tener soporte para hacerlo.
-## Prompt
+## Símbolo del sistema
-This is the list of prompt-wide configuration options.
+Esta es la lista de opciones de configuración.
-### Options
+### Opciones
-| Variable | Default | Description |
-| -------------- | ----------------------------- | ------------------------------------------------------ |
-| `add_newline` | `true` | Add a new line before the start of the prompt. |
-| `prompt_order` | [link](#default-prompt-order) | Configure the order in which the prompt module occurs. |
-| `scan_timeout` | `30` | Timeout for starship to scan files (in milliseconds). |
+| Variable | Por defecto | Descripción |
+| -------------- | ----------------------------- | ------------------------------------------------------------------------------- |
+| `add_newline` | `true` | Añade una nueva línea antes del símbolo de sistema. |
+| `prompt_order` | [link](#default-prompt-order) | Configura el orden en el que se muestran los módulos en el símbolo del sistema. |
+| `scan_timeout` | `30` | Tiempo de espera tras el que starship escanea archivos (en milisegundos). |
-### Example
+### Ejemplo
```toml
# ~/.config/starship.toml
-# Disable the newline at the start of the prompt
+# Desactiva el salto de línea al comienzo del símbolo de sistema
add_newline = false
-# Overwrite a default_prompt_order and use custom prompt_order
+# Sobrescribe el orden por defecto de los módulos
prompt_order=["rust","line_break","package","line_break","character"]
-# Wait 10 milliseconds for starship to check files under the current directory.
+# Starship espera 10 ms para comprobar los archivos del directorio actual.
scan_timeout = 10
```
-### Default Prompt Order
+### Ordenación por defecto
-The default `prompt_order` is used to define the order in which modules are shown in the prompt, if empty or no `prompt_order` is provided. The default is as shown:
+El `prompt_order` por defecto se usa para definir el orden en el que los módulos se muestran en la línea de comandos, en caso de que esté vacío o no existe `prompt_order`. El valor por defecto es el siguiente:
```toml
prompt_order = [
@@ -103,6 +103,7 @@ prompt_order = [
"dotnet",
"elixir",
"elm",
+ "erlang",
"golang",
"haskell",
"java",
@@ -120,6 +121,7 @@ prompt_order = [
"env_var",
"crystal",
"cmd_duration",
+ "custom",
"line_break",
"jobs",
"battery",
@@ -130,21 +132,21 @@ prompt_order = [
## AWS
-The `aws` module shows the current AWS region and profile. This is based on `AWS_REGION`, `AWS_DEFAULT_REGION`, and `AWS_PROFILE` env var with `~/.aws/config` file.
+El módulo `aws` muestra la región actual de AWS y el perfil. Éste se basa en las variables de entorno `AWS_REGION`, `AWS_DEFAULT_REGION`, y `AWS_PROFILE` del fichero `~/.aws/config`.
-When using [aws-vault](https://github.com/99designs/aws-vault) the profile is read from the `AWS_VAULT` env var.
+Cuando uses [aws-vault](https://github.com/99designs/aws-vault) el perfil se obtiene de la variable de entorno `AWS_VAULT`.
-### Options
+### Opciones
-| Variable | Default | Description |
-| ----------------- | --------------- | --------------------------------------------------------------------------- |
-| `symbol` | `"☁️ "` | The symbol used before displaying the current AWS profile. |
-| `displayed_items` | `all` | Choose which item to display. Possible values: [`all`, `profile`, `region`] |
-| `region_aliases` | | Table of region aliases to display in addition to the AWS name. |
-| `style` | `"bold yellow"` | The style for the module. |
-| `disabled` | `false` | Disables the `AWS` module. |
+| Variable | Por defecto | Descripción |
+| ----------------- | --------------- | ------------------------------------------------------------- |
+| `symbol` | `"☁️ "` | El símbolo que se muestra antes del perfil de AWS. |
+| `displayed_items` | `all` | Elige qué item mostrar. Valores: [`all`, `profile`, `region`] |
+| `region_aliases` | | Tabla de alias de región para mostrar además del nombre AWS. |
+| `style` | `"bold yellow"` | El estilo del módulo. |
+| `disabled` | `false` | Desactiva el módulo AWS. |
-### Example
+### Ejemplo
```toml
# ~/.config/starship.toml
@@ -160,22 +162,22 @@ us-east-1 = "va"
## Battery
-The `battery` module shows how charged the device's battery is and its current charging status. The module is only visible when the device's battery is below 10%.
+El módulo `battery` muestra la cantidad de batería y si está cargando o no. El módulo es solo visible cuando la batería está por debajo del 10%.
-### Options
+### Opciones
-| Variable | Default | Description |
+| Variable | Por defecto | Descripción |
| -------------------- | ------------------------ | ------------------------------------------------- |
-| `full_symbol` | `"•"` | The symbol shown when the battery is full. |
-| `charging_symbol` | `"⇡"` | The symbol shown when the battery is charging. |
-| `discharging_symbol` | `"⇣"` | The symbol shown when the battery is discharging. |
-| `display` | [link](#battery-display) | Display threshold and style for the module. |
-| `disabled` | `false` | Disables the `battery` module. |
+| `full_symbol` | `"•"` | Se muestra cuando la batería está cargada. |
+| `charging_symbol` | `"⇡"` | Se muestra cuando la batería está cargando. |
+| `discharging_symbol` | `"⇣"` | Se muestra cuando la batería se está descargando. |
+| `display` | [link](#battery-display) | Define cuándo mostrar el indicador y el estilo. |
+| `disabled` | `false` | Desactiva el módulo `battery`. |
-There are also options for some uncommon battery states.
+Hay otras opciones para algunos estados de la batería menos comunes.
-| Variable | Description |
+| Variable | Descripción |
| ---------------- | --------------------------------------------------- |
| `unknown_symbol` | The symbol shown when the battery state is unknown. |
| `empty_symbol` | The symbol shown when the battery state is empty. |
@@ -184,7 +186,7 @@ Note: Battery indicator will be hidden if the status is `unknown` or `empty` unl
-### Example
+### Ejemplo
```toml
# ~/.config/starship.toml
@@ -195,9 +197,9 @@ charging_symbol = "⚡️"
discharging_symbol = "💀"
```
-### Battery Display
+### Indicador de batería
-The `display` configuration option is used to define when the battery indicator should be shown (threshold) and what it looks like (style). If no `display` is provided. The default is as shown:
+La configuración de la opción `display` es usada para definir cuándo se debe mostrar el indicador de batería y cómo debe mostrarse. Si no se provee ningún valor para `display` el valor por defecto es el siguiente:
```toml
[[battery.display]]
@@ -205,49 +207,49 @@ threshold = 10
style = "bold red"
```
-#### Options
+#### Opciones
-The `display` option is an array of the following table.
+La opción `display` es un array de la siguiente tabla.
-| Variable | Description |
-| ----------- | ----------------------------------------------- |
-| `threshold` | The upper bound for the display option. |
-| `style` | The style used if the display option is in use. |
+| Variable | Descripción |
+| ----------- | --------------------------------------------------------------- |
+| `threshold` | El umbral para la opción de visualización. |
+| `style` | El estilo usado cuando si la opción <0>display0> está activa. |
-#### Example
+#### Ejemplo
```toml
-[[battery.display]] # "bold red" style when capacity is between 0% and 10%
+[[battery.display]] # "bold red" cuando la carga está entre 0% y 10%
threshold = 10
style = "bold red"
-[[battery.display]] # "bold yellow" style when capacity is between 10% and 30%
+[[battery.display]] # "bold yellow" cuando la carga está entre 10% y 30%
threshold = 30
style = "bold yellow"
-# when capacity is over 30%, the battery indicator will not be displayed
+# cuando la carga está por encima del 30% el indicador no se mostrará
```
## Character
-The `character` module shows a character (usually an arrow) beside where the text is entered in your terminal.
+El módulo `character` muestra un carater (normalmente una flecha) tras el texto que introduces en el terminal.
-The character will tell you whether the last command was successful or not. It can do this in two ways: by changing color (red/green) or by changing its shape (❯/✖). The latter will only be done if `use_symbol_for_status` is set to `true`.
+El carácter te dirá si el último comando funcionó o no. Se puede hacer de dos formas: cambiando el color (rojo/verde) o cambiando su forma (❯/✖). Esto último solo se puede hacer si `use_symbol_for_status` tiene como valor `true`.
-### Options
+### Opciones
-| Variable | Default | Description |
-| ----------------------- | -------------- | ----------------------------------------------------------------------------------- |
-| `symbol` | `"❯"` | The symbol used before the text input in the prompt. |
-| `error_symbol` | `"✖"` | The symbol used before text input if the previous command failed. |
-| `use_symbol_for_status` | `false` | Indicate error status by changing the symbol. |
-| `vicmd_symbol` | `"❮"` | The symbol used before the text input in the prompt if shell is in vim normal mode. |
-| `style_success` | `"bold green"` | The style used if the last command was successful. |
-| `style_failure` | `"bold red"` | The style used if the last command failed. |
-| `disabled` | `false` | Disables the `character` module. |
+| Variable | Por defecto | Descripción |
+| ----------------------- | -------------- | ----------------------------------------------------------------------------------------------------------------------------- |
+| `symbol` | `"❯"` | El símbolo usado antes de la entrada de texto en el símbolo del sistema. |
+| `error_symbol` | `"✖"` | El símbolo usado antes de la entrada de texto si el comando anterior falló. |
+| `use_symbol_for_status` | `false` | Indica el estado del error usando un símbolo. |
+| `vicmd_symbol` | `"❮"` | El símbolo usado antes de la entrada de texto en el símbolo del sistema si el intérprete de comandos está en modo vim normal. |
+| `style_success` | `"bold green"` | Estilo usado si el último comando se ejecutó con éxito. |
+| `style_failure` | `"bold red"` | Estilo usado si el último comando falló. |
+| `disabled` | `false` | Desactiva el módulo `character`. |
-### Example
+### Ejemplo
```toml
# ~/.config/starship.toml
@@ -258,29 +260,29 @@ error_symbol = "✗"
use_symbol_for_status = true
```
-## Command Duration
+## Tiempo de ejecución
-The `cmd_duration` module shows how long the last command took to execute. The module will be shown only if the command took longer than two seconds, or the `min_time` config value, if it exists.
+El módulo `cmd_duration` muestra cuánto tiempo tardó el último comando en ejecutarse. El módulo se mostrará solo si el comando llevó dos segundos o más, o el valor de `min_time`, si existe.
-::: warning Do not hook the DEBUG trap in Bash
+::: warning No utilizar DEBUG en Bash
-If you are running Starship in `bash`, do not hook the `DEBUG` trap after running `eval $(starship init $0)`, or this module **will** break.
+Si estás usando Starship con `bash`, no uses `DEBUG` después de ejecutar `eval $(starship init $0)`, o el módulo **se romperá**.
:::
-Bash users who need preexec-like functionality can use [rcaloras's bash_preexec framework](https://github.com/rcaloras/bash-preexec). Simply define the arrays `preexec_functions` and `precmd_functions` before running `eval $(starship init $0)`, and then proceed as normal.
+Los usuarios de bash que necesiten la funcionalidad preexec-like pueden usar el framework rcaloras's bash_preexec. Simplemente define los arrays preexec_functions y precmd_functions antes de ejecutar eval $(starship init $0), y continúa con normalidad. Basta con definir los arrays `preexec_functions` y `precmd_functions` antes de ejecutar `eval $(starship init $0)`, y luego proceder como siempre.
-### Options
+### Opciones
-| Variable | Default | Description |
-| ------------------- | --------------- | ---------------------------------------------------------- |
-| `min_time` | `2_000` | Shortest duration to show time for (in milliseconds). |
-| `show_milliseconds` | `false` | Show milliseconds in addition to seconds for the duration. |
-| `prefix` | `took` | Prefix to display immediately before the command duration. |
-| `style` | `"bold yellow"` | The style for the module. |
-| `disabled` | `false` | Disables the `cmd_duration` module. |
+| Variable | Por defecto | Descripción |
+| ------------------- | --------------- | --------------------------------------------------------------------- |
+| `min_time` | `2_000` | Duración mínima para mostrar el tiempo de ejecución (en milisegundos) |
+| `show_milliseconds` | `false` | Muestra la duración con precisión en milisegundos. |
+| `prefix` | `took` | Prefijo que se muestra antes del tiempo de ejecución. |
+| `style` | `"bold yellow"` | El estilo del módulo. |
+| `disabled` | `false` | Desactiva el módulo `cmd_duration`. |
-### Example
+### Ejemplo
```toml
# ~/.config/starship.toml
@@ -292,24 +294,24 @@ prefix = "underwent "
## Conda
-The `conda` module shows the current conda environment, if `$CONDA_DEFAULT_ENV` is set.
+El módulo `conda` muestra el actual entorno conda, si la variable `$CONDA_DEFAULT_ENV` existe.
::: tip
-This does not suppress conda's own prompt modifier, you may want to run `conda config --set changeps1 False`.
+Esto no modifica el propio símbolo de sistema de conda. En caso de querer suprimirlo, ejecuta `conda config --set changeps1 False`.
:::
-### Options
+### Opciones
-| Variable | Default | Description |
-| ------------------- | -------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `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` | `"C "` | The symbol used before the environment name. |
-| `style` | `"bold green"` | The style for the module. |
-| `disabled` | `false` | Disables the `conda` module. |
+| Variable | Por defecto | Descripción |
+| ------------------- | -------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `truncation_length` | `1` | El número de directorios a los que se debe truncar la variable de entorno, si el entorno fue creado usando `conda create -p [path]`. `0` significa sin truncamiento. Mirar también el módulo [`directory`](#directory). |
+| `symbol` | `"C "` | El símbolo usado antes del nombre del entorno. |
+| `style` | `"bold green"` | El estilo del módulo. |
+| `disabled` | `false` | Desactiva el módulo `conda`. |
-### Example
+### Ejemplo
```toml
# ~/.config/starship.toml
@@ -320,20 +322,20 @@ style = "dimmed green"
## Crystal
-The `crystal` module shows the currently installed version of Crystal. The module will be shown if any of the following conditions are met:
+El módulo `crystal` muestra la versión actual de Crystal. El módulo se muestra si algunas de las siguientes condiciones se cumplen:
-- The current directory contains a `shard.yml` file
-- The current directory contains a `.cr` file
+- El directorio actual contiene un fichero `shard.yml`
+- El directorio actual contiene un fichero `.cr`
-### Options
+### Opciones
-| Variable | Default | Description |
-| ---------- | ------------ | --------------------------------------------------------- |
-| `symbol` | `"🔮 "` | The symbol used before displaying the version of crystal. |
-| `style` | `"bold red"` | The style for the module. |
-| `disabled` | `false` | Disables the `crystal` module. |
+| Variable | Por defecto | Descripción |
+| ---------- | ------------ | --------------------------------------------- |
+| `symbol` | `"🔮 "` | Símbolo usado antes de la versión de Crystal. |
+| `style` | `"bold red"` | El estilo del módulo. |
+| `disabled` | `false` | Desactiva el módulo `crystal`. |
-### Example
+### Ejemplo
```toml
# ~/.config/starship.toml
@@ -345,35 +347,35 @@ style = "bold blue"
## Directory
-The `directory` module shows the path to your current directory, truncated to three parent folders. Your directory will also be truncated to the root of the git repo that you're currently in.
+El módulo `directory` muestra la ruta hasta el directorio actual, mostrando tres directorios padre como máximo. Tu directorio se truncará a la raíz del repositorio git en el que estés.
-When using the fish style pwd option, instead of hiding the path that is truncated, you will see a shortened name of each directory based on the number you enable for the option.
+Cuando usas el estilo fish de la opción pwd, en lugar de ocultar la ruta truncada, verás una versión acortada del nombre de cada directorio basada en el número que activa la opción.
-For example, given `~/Dev/Nix/nixpkgs/pkgs` where `nixpkgs` is the repo root, and the option set to `1`. You will now see `~/D/N/nixpkgs/pkgs`, whereas before it would have been `nixpkgs/pkgs`.
+Por ejemplo, dado `~/Dev/Nix/nixpkgs/pkgs` donde `nixpkgs` es la raíz del repositorio y el valor de la opción es `1`. En ese caso, verás `~/D/N/nixpkgs/pkgs`, cuando antes hubiera sido `nixpkgs/pkgs`.
-### Options
+### Opciones
-| Variable | Default | Description |
-| ------------------- | ------------- | -------------------------------------------------------------------------------- |
-| `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. |
-| `prefix` | `"in "` | Prefix to display immediately before the directory. |
-| `style` | `"bold cyan"` | The style for the module. |
-| `disabled` | `false` | Disables the `directory` module. |
+| Variable | Por defecto | Descripción |
+| ------------------- | ------------- | ------------------------------------------------------------------------------ |
+| `truncation_length` | `3` | El número de directorios padre a los que se debe truncar el directorio actual. |
+| `truncate_to_repo` | `true` | Trunca o no hasta la raíz del repositorio git en el que estés. |
+| `prefix` | `"in "` | Prefijo que se muestra inmediatamente antes del directorio. |
+| `style` | `"bold cyan"` | El estilo del módulo. |
+| `disabled` | `false` | Desactiva el módulo `directory`. |
-This module has a few advanced configuration options that control how the directory is displayed.
+Este módulo tiene algunas opciones avanzadas de configuración que controlan cómo se muestra el directorio.
-| Variable | Default | Description |
-| --------------------------- | ------- | ---------------------------------------------------------------------------------------- |
-| `fish_style_pwd_dir_length` | `0` | The number of characters to use when applying fish shell pwd path logic. |
-| `use_logical_path` | `true` | Displays the logical path provided by the shell (`PWD`) instead of the path from the OS. |
+| Variable | Por defecto | Descripción |
+| --------------------------- | ----------- | ---------------------------------------------------------------------------------------- |
+| `fish_style_pwd_dir_length` | `0` | The number of characters to use when applying fish shell pwd path logic. |
+| `use_logical_path` | `true` | Displays the logical path provided by the shell (`PWD`) instead of the path from the OS. |
`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`.
-### Example
+### Ejemplo
```toml
# ~/.config/starship.toml
@@ -382,20 +384,20 @@ For example, given `~/Dev/Nix/nixpkgs/pkgs` where `nixpkgs` is the repo root, an
truncation_length = 8
```
-## Docker Context
+## Docker context
-The `docker_context` module shows the currently active [Docker context](https://docs.docker.com/engine/context/working-with-contexts/) if it's not set to `default`.
+El módulo `docker_context` muestra el [Docker context](https://docs.docker.com/engine/context/working-with-contexts/) activo si no está a `default`.
-### Options
+### Opciones
-| Variable | Default | Description |
-| ----------------- | ------------- | --------------------------------------------------------------------------------------- |
-| `symbol` | `"🐳 "` | The symbol used before displaying the Docker context . |
-| `only_with_files` | `false` | Only show when there's a `docker-compose.yml` or `Dockerfile` in the current directory. |
-| `style` | `"bold blue"` | The style for the module. |
-| `disabled` | `true` | Disables the `docker_context` module. |
+| Variable | Por defecto | Descripción |
+| ----------------- | ------------- | -------------------------------------------------------------------------------------------------- |
+| `symbol` | `"🐳 "` | Símbolo usado antes de mostrar el Docker context. |
+| `only_with_files` | `false` | Solo lo muestra cuando hay un archivo `docker-compose.yml` o `Dockerfile` en el directorio actual. |
+| `style` | `"bold blue"` | El estilo del módulo. |
+| `disabled` | `true` | Desactiva el módulo `docker_context`. |
-### Example
+### Ejemplo
```toml
# ~/.config/starship.toml
@@ -412,16 +414,16 @@ This module will only be shown in your prompt when one of the following files ar
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.
-### Options
+### Opciones
-| Variable | Default | Description |
+| Variable | Por defecto | Descripción |
| ----------- | ------------- | -------------------------------------------------------- |
| `symbol` | `"•NET "` | The symbol used before displaying the version of dotnet. |
| `heuristic` | `true` | Use faster version detection to keep starship snappy. |
-| `style` | `"bold blue"` | The style for the module. |
+| `style` | `"bold blue"` | El estilo del módulo. |
| `disabled` | `false` | Disables the `dotnet` module. |
-### Example
+### Ejemplo
```toml
# ~/.config/starship.toml
@@ -434,18 +436,18 @@ heuristic = false
## Elixir
-The `elixir` module shows the currently installed version of Elixir and Erlang/OTP. The module will be shown if any of the following conditions are met:
+The `elixir` module shows the currently installed version of Elixir and Erlang/OTP. El módulo se muestra si algunas de las siguientes condiciones se cumplen:
-- The current directory contains a `mix.exs` file.
+- El directorio actual contiene un fichero `mix.exs`.
-### Options
+### Opciones
-| Variable | Default | Description |
-| ---------- | ------- | --------------------------------------------------------------- |
-| `symbol` | `"💧 "` | The symbol used before displaying the version of Elixir/Erlang. |
-| `disabled` | `false` | Disables the `elixir` module. |
+| Variable | Por defecto | Descripción |
+| ---------- | ----------- | --------------------------------------------------------------- |
+| `symbol` | `"💧 "` | The symbol used before displaying the version of Elixir/Erlang. |
+| `disabled` | `false` | Disables the `elixir` module. |
-### Example
+### Ejemplo
```toml
# ~/.config/starship.toml
@@ -456,24 +458,24 @@ symbol = "🔮 "
## Elm
-The `elm` module shows the currently installed version of Elm. The module will be shown if any of the following conditions are met:
+The `elm` module shows the currently installed version of Elm. El módulo se muestra si algunas de las siguientes condiciones se cumplen:
-- The current directory contains a `elm.json` file
-- The current directory contains a `elm-package.json` file
+- El directorio actual contiene un fichero `elm.json`
+- El directorio actual contiene un fichero `elm-package.json`
- The current directory contains a `.elm-version` file
- The current directory contains a `elm-stuff` folder
- The current directory contains a `*.elm` files
-### Options
+### Opciones
-| Variable | Default | Description |
+| Variable | Por defecto | Descripción |
| ---------- | ------------- | ----------------------------------------------------- |
| `symbol` | `"🌳 "` | The symbol used before displaying the version of Elm. |
-| `style` | `"bold cyan"` | The style for the module. |
+| `style` | `"bold cyan"` | El estilo del módulo. |
| `disabled` | `false` | Disables the `elm` module. |
-### Example
+### Ejemplo
```toml
# ~/.config/starship.toml
@@ -482,26 +484,48 @@ The `elm` module shows the currently installed version of Elm. The module will b
symbol = " "
```
-## Environment Variable
+## Erlang
+
+The `erlang` module shows the currently installed version of Erlang/OTP. El módulo se muestra si algunas de las siguientes condiciones se cumplen:
+
+- The current directory contains a `rebar.config` file.
+- The current directory contains a `erlang.mk` file.
+
+### Opciones
+
+| Variable | Por defecto | Descripción |
+| ---------- | ----------- | -------------------------------------------------------- |
+| `symbol` | `"🖧 "` | The symbol used before displaying the version of Erlang. |
+| `disabled` | `false` | Disables the `erlang` module. |
+
+### Ejemplo
+
+```toml
+# ~/.config/starship.toml
+
+[erlang]
+symbol = "e "
+```
+## Variable de entorno
The `env_var` module displays the current value of a selected environment variable. 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
-### Options
+### Opciones
-| Variable | Default | Description |
-| ---------- | ---------------- | ---------------------------------------------------------------------------- |
-| `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. |
-| `prefix` | `""` | Prefix to display immediately before the variable value. |
-| `suffix` | `""` | Suffix to display immediately after the variable value. |
-| `style` | `"dimmed black"` | The style for the module. |
-| `disabled` | `false` | Disables the `env_var` module. |
+| Variable | Por defecto | Descripción |
+| ------------- | ---------------- | ---------------------------------------------------------------------------- |
+| `symbol` | | The symbol used before displaying the variable value. |
+| `variable` | | The environment variable to be displayed. |
+| `por defecto` | | The default value to be displayed when the selected variable is not defined. |
+| `prefix` | `""` | Prefix to display immediately before the variable value. |
+| `suffix` | `""` | Suffix to display immediately after the variable value. |
+| `style` | `"dimmed black"` | El estilo del módulo. |
+| `disabled` | `false` | Disables the `env_var` module. |
-### Example
+### Ejemplo
```toml
# ~/.config/starship.toml
@@ -515,17 +539,17 @@ default = "unknown shell"
The `git_branch` module shows the active branch of the repo in your current directory.
-### Options
+### Opciones
-| Variable | Default | Description |
+| Variable | Por defecto | Descripción |
| ------------------- | --------------- | ------------------------------------------------------------------------------------- |
| `symbol` | `" "` | The symbol used before the branch name of the repo in your current directory. |
| `truncation_length` | `2^63 - 1` | Truncates a git branch to X graphemes |
| `truncation_symbol` | `"…"` | The symbol used to indicate a branch name was truncated. You can use "" for no symbol |
-| `style` | `"bold purple"` | The style for the module. |
+| `style` | `"bold purple"` | El estilo del módulo. |
| `disabled` | `false` | Disables the `git_branch` module. |
-### Example
+### Ejemplo
```toml
# ~/.config/starship.toml
@@ -536,22 +560,22 @@ truncation_length = 4
truncation_symbol = ""
```
-## Git Commit
+## Git commit
The `git_commit` module shows the current commit hash of the repo in your current directory.
-### Options
+### Opciones
-| Variable | Default | Description |
+| Variable | Por defecto | Descripción |
| -------------------- | -------------- | ----------------------------------------------------- |
| `commit_hash_length` | `7` | The length of the displayed git commit hash. |
| `prefix` | `"("` | Prefix to display immediately before git commit. |
| `suffix` | `")"` | Suffix to display immediately after git commit. |
-| `style` | `"bold green"` | The style for the module. |
+| `style` | `"bold green"` | El estilo del módulo. |
| `only_detached` | `true` | Only show git commit hash when in detached HEAD state |
| `disabled` | `false` | Disables the `git_commit` module. |
-### Example
+### Ejemplo
```toml
# ~/.config/starship.toml
@@ -560,13 +584,13 @@ The `git_commit` module shows the current commit hash of the repo in your curren
commit_hash_length = 4
```
-## Git State
+## 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.
-### Options
+### Opciones
-| Variable | Default | Description |
+| Variable | Por defecto | Descripción |
| ------------------ | ------------------ | ---------------------------------------------------------------------------------------------------------------- |
| `rebase` | `"REBASING"` | The text displayed when a `rebase` is in progress. |
| `merge` | `"MERGING"` | The text displayed when a `merge` is in progress. |
@@ -576,10 +600,10 @@ The `git_state` module will show in directories which are part of a git reposito
| `am` | `"AM"` | The text displayed when an `apply-mailbox` (`git am`) is in progress. |
| `am_or_rebase` | `"AM/REBASE"` | The text displayed when an ambiguous `apply-mailbox` or `rebase` is in progress. |
| `progress_divider` | `"/"` | The symbol or text which will separate the current and total progress amounts. (e.g., `" of "`, for `"3 of 10"`) |
-| `style` | `"bold yellow"` | The style for the module. |
+| `style` | `"bold yellow"` | El estilo del módulo. |
| `disabled` | `false` | Disables the `git_state` module. |
-### Example
+### Ejemplo
```toml
# ~/.config/starship.toml
@@ -589,13 +613,13 @@ progress_divider = " of "
cherry_pick = "🍒 PICKING"
```
-## Git Status
+## Git status
The `git_status` module shows symbols representing the state of the repo in your current directory.
-### Options
+### Opciones
-| Variable | Default | Description |
+| Variable | Por defecto | Descripción |
| ------------------ | -------------------------- | ------------------------------------------------------- |
| `conflicted` | `"="` | This branch has merge conflicts. |
| `conflicted_count` | [link](#git-status-counts) | Show and style the number of conflicts. |
@@ -617,17 +641,17 @@ The `git_status` module shows symbols representing the state of the repo in your
| `show_sync_count` | `false` | Show ahead/behind count of the branch being tracked. |
| `prefix` | `[` | Prefix to display immediately before git status. |
| `suffix` | `]` | Suffix to display immediately after git status. |
-| `style` | `"bold red"` | The style for the module. |
+| `style` | `"bold red"` | El estilo del módulo. |
| `disabled` | `false` | Disables the `git_status` module. |
-#### Git Status Counts
+#### Contadores de git status
-| Variable | Default | Description |
-| --------- | ------- | ------------------------------------------------------ |
-| `enabled` | `false` | Show the number of files |
-| `style` | | Optionally style the count differently than the module |
+| Variable | Por defecto | Descripción |
+| --------- | ----------- | ------------------------------------------------------ |
+| `enabled` | `false` | Show the number of files |
+| `style` | | Optionally style the count differently than the module |
-### Example
+### Ejemplo
```toml
# ~/.config/starship.toml
@@ -650,26 +674,26 @@ deleted = "🗑"
## Golang
-The `golang` module shows the currently installed version of Golang. The module will be shown if any of the following conditions are met:
+The `golang` module shows the currently installed version of Golang. El módulo se muestra si algunas de las siguientes condiciones se cumplen:
-- The current directory contains a `go.mod` file
-- The current directory contains a `go.sum` file
-- The current directory contains a `glide.yaml` file
+- El directorio actual contiene un fichero `go.mod`
+- El directorio actual contiene un fichero `go.sum`
+- El directorio actual contiene un fichero `glide.yaml`
- 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
-### Options
+### Opciones
-| Variable | Default | Description |
+| Variable | Por defecto | Descripción |
| ---------- | ------------- | -------------------------------------------------------- |
| `symbol` | `"🐹 "` | The symbol used before displaying the version of Golang. |
-| `style` | `"bold cyan"` | The style for the module. |
+| `style` | `"bold cyan"` | El estilo del módulo. |
| `disabled` | `false` | Disables the `golang` module. |
-### Example
+### Ejemplo
```toml
# ~/.config/starship.toml
@@ -679,20 +703,20 @@ symbol = "🏎💨 "
```
## Haskell
-The `haskell` module shows the currently installed version of Haskell Stack version. The module will be shown if any of the following conditions are met:
+The `haskell` module shows the currently installed version of Haskell Stack version. El módulo se muestra si algunas de las siguientes condiciones se cumplen:
-- The current directory contains a `stack.yaml` file
+- El directorio actual contiene un fichero `stack.yaml`
-### Options
+### Opciones
-| Variable | Default | Description |
+| Variable | Por defecto | Descripción |
| ---------- | ------------ | --------------------------------------------------------- |
| `symbol` | `"λ "` | The symbol used before displaying the version of Haskell. |
-| `style` | `"bold red"` | The style for the module. |
+| `style` | `"bold red"` | El estilo del módulo. |
| `disabled` | `false` | Disables the `haskell` module. |
-### Example
+### Ejemplo
```toml
# ~/.config/starship.toml
@@ -705,18 +729,18 @@ symbol = " "
The `hostname` module shows the system hostname.
-### Options
+### Opciones
-| Variable | Default | Description |
+| Variable | Por defecto | Descripción |
| ---------- | --------------------- | ------------------------------------------------------------------------------------------------------------------------------------ |
| `ssh_only` | `true` | Only show hostname when connected to an SSH session. |
| `prefix` | `""` | Prefix to display immediately before the hostname. |
| `suffix` | `""` | Suffix to display immediately after the hostname. |
| `trim_at` | `"."` | String that the hostname is cut off at, after the first match. `"."` will stop after the first dot. `""` will disable any truncation |
-| `style` | `"bold dimmed green"` | The style for the module. |
+| `style` | `"bold dimmed green"` | El estilo del módulo. |
| `disabled` | `false` | Disables the `hostname` module. |
-### Example
+### Ejemplo
```toml
# ~/.config/starship.toml
@@ -731,20 +755,20 @@ disabled = false
## Java
-The `java` module shows the currently installed version of Java. The module will be shown if any of the following conditions are met:
+The `java` module shows the currently installed version of Java. El módulo se muestra si algunas de las siguientes condiciones se cumplen:
- The current directory contains a `pom.xml`, `build.gradle.kts`, `build.sbt` or `.java-version` file
- The current directory contains a file with the `.java`, `.class`, `.gradle` or `.jar` extension
-### Options
+### Opciones
-| Variable | Default | Description |
+| Variable | Por defecto | Descripción |
| ---------- | -------------- | ------------------------------------------------------ |
| `symbol` | `"☕ "` | The symbol used before displaying the version of Java. |
-| `style` | `"dimmed red"` | The style for the module. |
+| `style` | `"dimmed red"` | El estilo del módulo. |
| `disabled` | `false` | Disables the `java` module. |
-### Example
+### Ejemplo
```toml
# ~/.config/starship.toml
@@ -757,16 +781,16 @@ 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.
-### Options
+### Opciones
-| Variable | Default | Description |
+| Variable | Por defecto | Descripción |
| ----------- | ------------- | ----------------------------------------------------- |
| `symbol` | `"✦"` | The symbol used before displaying the number of jobs. |
| `threshold` | `1` | Show number of jobs if exceeded. |
-| `style` | `"bold blue"` | The style for the module. |
+| `style` | `"bold blue"` | El estilo del módulo. |
| `disabled` | `false` | Disables the `jobs` module. |
-### Example
+### Ejemplo
```toml
# ~/.config/starship.toml
@@ -778,27 +802,27 @@ threshold = 4
## Julia
-The `julia` module shows the currently installed version of Julia. The module will be shown if any of the following conditions are met:
+The `julia` module shows the currently installed version of Julia. El módulo se muestra si algunas de las siguientes condiciones se cumplen:
- 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
+### Opciones
-| Variable | Default | Description |
+| Variable | Por defecto | Descripción |
| ---------- | --------------- | ------------------------------------------------------- |
-| `symbol` | `"∴ "` | The symbol used before displaying the version of Julia. |
-| `style` | `"bold purple"` | The style for the module. |
+| `symbol` | `"ஃ "` | The symbol used before displaying the version of Julia. |
+| `style` | `"bold purple"` | El estilo del módulo. |
| `disabled` | `false` | Disables the `julia` module. |
-### Example
+### Ejemplo
```toml
# ~/.config/starship.toml
[julia]
-symbol = "👸 "
+symbol = "∴ "
```
## Kubernetes
@@ -810,16 +834,16 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y
:::
-### Options
+### Opciones
-| Variable | Default | Description |
+| Variable | Por defecto | Descripción |
| ----------------- | ------------- | --------------------------------------------------- |
| `symbol` | `"☸ "` | The symbol used before displaying the Cluster info. |
| `context_aliases` | | Table of context aliases to display |
-| `style` | `"bold blue"` | The style for the module. |
+| `style` | `"bold blue"` | El estilo del módulo. |
| `disabled` | `true` | Disables the `kubernetes` module |
-### Example
+### Ejemplo
```toml
# ~/.config/starship.toml
@@ -832,17 +856,17 @@ disabled = false
"dev.local.cluster.k8s" = "dev"
```
-## Line Break
+## Salto de línea
The `line_break` module separates the prompt into two lines.
-### Options
+### Opciones
-| Variable | Default | Description |
-| ---------- | ------- | ------------------------------------------------------------------ |
-| `disabled` | `false` | Disables the `line_break` module, making the prompt a single line. |
+| Variable | Por defecto | Descripción |
+| ---------- | ----------- | ------------------------------------------------------------------ |
+| `disabled` | `false` | Disables the `line_break` module, making the prompt a single line. |
-### Example
+### Ejemplo
```toml
# ~/.config/starship.toml
@@ -851,7 +875,7 @@ The `line_break` module separates the prompt into two lines.
disabled = true
```
-## Memory Usage
+## Memoria utilizada
The `memory_usage` module shows current system memory and swap usage.
@@ -863,19 +887,19 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y
:::
-### Options
+### Opciones
-| Variable | Default | Description |
+| Variable | Por defecto | Descripción |
| ----------------- | --------------------- | ------------------------------------------------------------- |
| `show_percentage` | `false` | Display memory usage as a percentage of the available memory. |
| `show_swap` | `true` | Display swap usage if total swap is non-zero. |
| `threshold` | `75` | Hide the memory usage unless it exceeds this percentage. |
| `symbol` | `"🐏 "` | The symbol used before displaying the memory usage. |
| `separator` | `" | "` | The symbol or text that will seperate the ram and swap usage. |
-| `style` | `"bold dimmed white"` | The style for the module. |
+| `style` | `"bold dimmed white"` | El estilo del módulo. |
| `disabled` | `true` | Disables the `memory_usage` module. |
-### Example
+### Ejemplo
```toml
# ~/.config/starship.toml
@@ -894,17 +918,17 @@ style = "bold dimmed green"
The `hg_branch` module shows the active branch of the repo in your current directory.
-### Options
+### Opciones
-| Variable | Default | Description |
+| Variable | Por defecto | Descripción |
| ------------------- | --------------- | -------------------------------------------------------------------------------------------- |
| `symbol` | `" "` | The symbol used before the hg bookmark or branch name of the repo in your current directory. |
| `truncation_length` | `2^63 - 1` | Truncates the hg branch name to X graphemes |
| `truncation_symbol` | `"…"` | The symbol used to indicate a branch name was truncated. |
-| `style` | `"bold purple"` | The style for the module. |
+| `style` | `"bold purple"` | El estilo del módulo. |
| `disabled` | `true` | Disables the `hg_branch` module. |
-### Example
+### Ejemplo
```toml
# ~/.config/starship.toml
@@ -919,17 +943,18 @@ truncation_symbol = ""
The `nix_shell` module shows the nix-shell environment. The module will be shown when inside a nix-shell environment.
-### Options
+### Opciones
-| Variable | Default | Description |
-| ------------ | ------------ | ---------------------------------- |
-| `use_name` | `false` | Display the name of the nix-shell. |
-| `impure_msg` | `"impure"` | Customize the "impure" msg. |
-| `pure_msg` | `"pure"` | Customize the "pure" msg. |
-| `style` | `"bold red"` | The style for the module. |
-| `disabled` | `false` | Disables the `nix_shell` module. |
+| Variable | Por defecto | Descripción |
+| ------------ | ------------- | ------------------------------------------------- |
+| `use_name` | `false` | Display the name of the nix-shell. |
+| `impure_msg` | `"impure"` | Customize the "impure" msg. |
+| `pure_msg` | `"pure"` | Customize the "pure" msg. |
+| `symbol` | `"❄️ "` | The symbol used before displaying the shell name. |
+| `style` | `"bold blue"` | El estilo del módulo. |
+| `disabled` | `false` | Disables the `nix_shell` module. |
-### Example
+### Ejemplo
```toml
# ~/.config/starship.toml
@@ -939,26 +964,27 @@ disabled = true
use_name = true
impure_msg = "impure shell"
pure_msg = "pure shell"
+symbol = "☃️ "
```
## NodeJS
-The `nodejs` module shows the currently installed version of NodeJS. The module will be shown if any of the following conditions are met:
+The `nodejs` module shows the currently installed version of NodeJS. El módulo se muestra si algunas de las siguientes condiciones se cumplen:
-- The current directory contains a `package.json` file
+- El directorio actual contiene un fichero `package.json`
- The current directory contains a `.node-version` file
- The current directory contains a `node_modules` directory
- The current directory contains a file with the `.js` extension
-### Options
+### Opciones
-| Variable | Default | Description |
+| Variable | Por defecto | Descripción |
| ---------- | -------------- | -------------------------------------------------------- |
| `symbol` | `"⬢ "` | The symbol used before displaying the version of NodeJS. |
-| `style` | `"bold green"` | The style for the module. |
+| `style` | `"bold green"` | El estilo del módulo. |
| `disabled` | `false` | Disables the `nodejs` module. |
-### Example
+### Ejemplo
```toml
# ~/.config/starship.toml
@@ -967,9 +993,9 @@ The `nodejs` module shows the currently installed version of NodeJS. The module
symbol = "🤖 "
```
-## Package Version
+## Versión del paquete
-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`, `cargo`, `poetry`, `composer`, and `gradle` packages.
+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`, `cargo`, `poetry`, `composer`, `gradle`, `julia` and `mix` packages.
- **npm** – The `npm` package version is extracted from the `package.json` present in the current directory
- **cargo** – The `cargo` package version is extracted from the `Cargo.toml` present in the current directory
@@ -977,18 +1003,20 @@ The `package` module is shown when the current directory is the repository for a
- **composer** – The `composer` package version is extracted from the `composer.json` present in the current directory
- **gradle** – The `gradle` package version is extracted from the `build.gradle` present
- **julia** - The package version is extracted from the `Project.toml` present
+- **mix** - The `mix` package version is extracted from the `mix.exs` present
> ⚠️ The version being shown is that of the package whose source code is in your current directory, not your package manager.
-### Options
+### Opciones
-| Variable | Default | Description |
-| ---------- | ------------ | ---------------------------------------------------------- |
-| `symbol` | `"📦 "` | The symbol used before displaying the version the package. |
-| `style` | `"bold red"` | The style for the module. |
-| `disabled` | `false` | Disables the `package` module. |
+| Variable | Por defecto | Descripción |
+| ----------------- | ------------ | ---------------------------------------------------------- |
+| `symbol` | `"📦 "` | The symbol used before displaying the version the package. |
+| `style` | `"bold red"` | El estilo del módulo. |
+| `display_private` | `false` | Enable displaying version for packages marked as private. |
+| `disabled` | `false` | Disables the `package` module. |
-### Example
+### Ejemplo
```toml
# ~/.config/starship.toml
@@ -999,21 +1027,21 @@ symbol = "🎁 "
## PHP
-The `php` module shows the currently installed version of PHP. The module will be shown if any of the following conditions are met:
+The `php` module shows the currently installed version of PHP. El módulo se muestra si algunas de las siguientes condiciones se cumplen:
-- The current directory contains a `composer.json` file
+- El directorio actual contiene un fichero `composer.json`
- The current directory contains a `.php-version` file
- The current directory contains a `.php` file
-### Options
+### Opciones
-| Variable | Default | Description |
+| Variable | Por defecto | Descripción |
| ---------- | ------------ | ----------------------------------------------------- |
| `symbol` | `"🐘 "` | The symbol used before displaying the version of PHP. |
-| `style` | `"bold red"` | The style for the module. |
+| `style` | `"bold red"` | El estilo del módulo. |
| `disabled` | `false` | Disables the `php` module. |
-### Example
+### Ejemplo
```toml
# ~/.config/starship.toml
@@ -1030,27 +1058,30 @@ 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` and show the current Python virtual environment if one is activated.
-The module will be shown if any of the following conditions are met:
+El módulo se muestra si algunas de las siguientes condiciones se cumplen:
- The current directory contains a `.python-version` file
-- The current directory contains a `requirements.txt` file
-- The current directory contains a `pyproject.toml` file
-- The current directory contains a file with the `.py` extension
+- El directorio actual contiene un fichero `requirements.txt`
+- El directorio actual contiene un fichero `pyproject.toml`
+- The current directory contains a file with the `.py` extension (and `scan_for_pyfiles` is true)
- The current directory contains a `Pipfile` file
-- The current directory contains a `tox.ini` file
+- El directorio actual contiene un fichero `tox.ini`
+- El directorio actual contiene un fichero `setup.py`
+- The current directory contains a `__init__.py` file
- A virtual environment is currently activated
-### Options
+### Opciones
-| Variable | Default | Description |
+| Variable | Por defecto | Descripción |
| -------------------- | --------------- | --------------------------------------------------------------------------- |
| `symbol` | `"🐍 "` | The symbol used before displaying the version of Python. |
| `pyenv_version_name` | `false` | Use pyenv to get Python version |
| `pyenv_prefix` | `"pyenv "` | Prefix before pyenv version display (default display is `pyenv MY_VERSION`) |
-| `style` | `"bold yellow"` | The style for the module. |
+| `scan_for_pyfiles` | `true` | If false, Python files in the current directory will not show this module. |
+| `style` | `"bold yellow"` | El estilo del módulo. |
| `disabled` | `false` | Disables the `python` module. |
-### Example
+### Ejemplo
```toml
# ~/.config/starship.toml
@@ -1063,21 +1094,21 @@ pyenv_prefix = "foo "
## Ruby
-The `ruby` module shows the currently installed version of Ruby. The module will be shown if any of the following conditions are met:
+The `ruby` module shows the currently installed version of Ruby. El módulo se muestra si algunas de las siguientes condiciones se cumplen:
- The current directory contains a `Gemfile` file
- The current directory contains a `.ruby-version` file
- The current directory contains a `.rb` file
-### Options
+### Opciones
-| Variable | Default | Description |
+| Variable | Por defecto | Descripción |
| ---------- | ------------ | ------------------------------------------------------ |
| `symbol` | `"💎 "` | The symbol used before displaying the version of Ruby. |
-| `style` | `"bold red"` | The style for the module. |
+| `style` | `"bold red"` | El estilo del módulo. |
| `disabled` | `false` | Disables the `ruby` module. |
-### Example
+### Ejemplo
```toml
# ~/.config/starship.toml
@@ -1088,20 +1119,20 @@ symbol = "🔺 "
## Rust
-The `rust` module shows the currently installed version of Rust. The module will be shown if any of the following conditions are met:
+The `rust` module shows the currently installed version of Rust. El módulo se muestra si algunas de las siguientes condiciones se cumplen:
- The current directory contains a `Cargo.toml` file
- The current directory contains a file with the `.rs` extension
-### Options
+### Opciones
-| Variable | Default | Description |
+| Variable | Por defecto | Descripción |
| ---------- | ------------ | ------------------------------------------------------ |
| `symbol` | `"🦀 "` | The symbol used before displaying the version of Rust. |
-| `style` | `"bold red"` | The style for the module. |
+| `style` | `"bold red"` | El estilo del módulo. |
| `disabled` | `false` | Disables the `rust` module. |
-### Example
+### Ejemplo
```toml
# ~/.config/starship.toml
@@ -1114,20 +1145,18 @@ symbol = "⚙️ "
The `singularity` module shows the current singularity image, if inside a container and `$SINGULARITY_NAME` is set.
-:::
+### Opciones
-### Options
-
-| Variable | Default | Description |
+| Variable | Por defecto | Descripción |
| ---------- | -------------------- | ------------------------------------------------ |
| `label` | `""` | Prefix before the image name display. |
| `prefix` | `"["` | Prefix to display immediately before image name. |
| `suffix` | `"]"` | Suffix to display immediately after image name. |
| `symbol` | `""` | The symbol used before the image name. |
-| `style` | `"bold dimmed blue"` | The style for the module. |
+| `style` | `"bold dimmed blue"` | El estilo del módulo. |
| `disabled` | `false` | Disables the `singularity` module. |
-### Example
+### Ejemplo
```toml
# ~/.config/starship.toml
@@ -1138,21 +1167,21 @@ symbol = "📦 "
## Terraform
-The `terraform` module shows the currently selected terraform workspace and version. By default the terraform version is not shown, since this is slow on current versions of terraform when a lot of plugins are in use. The module will be shown if any of the following conditions are met:
+The `terraform` module shows the currently selected terraform workspace and version. By default the terraform version is not shown, since this is slow on current versions of terraform when a lot of plugins are in use. El módulo se muestra si algunas de las siguientes condiciones se cumplen:
- The current directory contains a `.terraform` folder
- Current directory contains a file with the `.tf` extension
-### Options
+### Opciones
-| Variable | Default | Description |
+| Variable | Por defecto | Descripción |
| -------------- | ------------ | ----------------------------------------------------------- |
| `symbol` | `"💠 "` | The symbol used before displaying the terraform workspace. |
| `show_version` | `false` | Shows the terraform version. Very slow on large workspaces. |
-| `style` | `"bold 105"` | The style for the module. |
+| `style` | `"bold 105"` | El estilo del módulo. |
| `disabled` | `false` | Disables the `terraform` module. |
-### Example
+### Ejemplo
```toml
# ~/.config/starship.toml
@@ -1161,7 +1190,7 @@ The `terraform` module shows the currently selected terraform workspace and vers
symbol = "🏎💨 "
```
-## Time
+## Hora
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.
@@ -1171,9 +1200,9 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y
:::
-### Options
+### Opciones
-| Variable | Default | Description |
+| Variable | Por defecto | Descripción |
| ----------------- | --------------- | ------------------------------------------------------------------------------------------------------------------- |
| `use_12hr` | `false` | Enables 12 hour formatting |
| `format` | see below | The [chrono format string](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) used to format the time. |
@@ -1183,7 +1212,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y
If `use_12hr` is `true`, then `format` defaults to `"%r"`. Otherwise, it defaults to `"%T"`. Manually setting `format` will override the `use_12hr` setting.
-### Example
+### Ejemplo
```toml
# ~/.config/starship.toml
@@ -1194,25 +1223,25 @@ format = "🕙[ %T ]"
utc_time_offset = "-5"
```
-## Username
+## Nombre de usuario
-The `username` module shows active user's username. The module will be shown if any of the following conditions are met:
+The `username` module shows active user's username. El módulo se muestra si algunas de las siguientes condiciones se cumplen:
- 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
-### Options
+### Opciones
-| Variable | Default | Description |
+| Variable | Por defecto | Descripción |
| ------------- | --------------- | ------------------------------------- |
| `style_root` | `"bold red"` | The style used when the user is root. |
| `style_user` | `"bold yellow"` | The style used for non-root users. |
| `show_always` | `false` | Always shows the `username` module. |
| `disabled` | `false` | Disables the `username` module. |
-### Example
+### Ejemplo
```toml
# ~/.config/starship.toml
@@ -1220,3 +1249,54 @@ The `username` module shows active user's username. The module will be shown if
[username]
disabled = true
```
+
+## Comandos personalizados
+
+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
+
+::: tip
+
+Multiple custom modules can be defined by using a `.`.
+
+:::
+
+::: tip
+
+The order in which custom modules are shown can be individually set by setting `custom.foo` in `prompt_order`. By default, the `custom` module will simply show all custom modules in the order they were defined.
+
+:::
+
+### Opciones
+
+| Variable | Por defecto | Descripción |
+| ------------- | ------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
+| `command` | | The command whose output should be printed. |
+| `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` | | The path to the shell to use to execute the command. If unset, it will fallback to STARSHIP_SHELL and then to "sh". |
+| `descripción` | `""` | 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"` | El estilo del módulo. |
+| `prefix` | `""` | Prefix to display immediately before the command output. |
+| `suffix` | `""` | Suffix to display immediately after the command output. |
+| `disabled` | `false` | Disables this `custom` module. |
+
+### Ejemplo
+
+```toml
+# ~/.config/starship.toml
+
+[custom.foo]
+command = "echo foo" # shows output of command
+files = ["foo"] # can specify filters
+when = """ test "$HOME" == "$PWD" """
+prefix = " transcending "
+```
diff --git a/docs/es-ES/faq/README.md b/docs/es-ES/faq/README.md
index 478f25c6..50363f67 100644
--- a/docs/es-ES/faq/README.md
+++ b/docs/es-ES/faq/README.md
@@ -10,36 +10,44 @@
- **Configuración**: [archivos de configuración de matchai](https://github.com/matchai/dotfiles/blob/master/.config/fish/config.fish)
- **Prompt**: [Starship](https://starship.rs/)
-## Do `prompt_order` and `.disabled` do the same thing?
+## ¿`prompt_order` y `.disabled` hacen lo mismo?
-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:
+Sí, se pueden usar ambos para desactivar los módulos en el símbolo del sistema. Si todo lo que planeas es desactivar módulos, `.disabled` es el método preferido por las siguientes razones:
-- Disabling modules is more explicit than omitting them from the prompt_order
-- Newly created modules will be added to the prompt as Starship is updated
+- Es más evidente desactivar módulos que omitirlos usando prompt_order
+- Los nuevos módulos se añadirán al símbolo del sistema en cuanto Starship se actualice
-## The docs say Starship is cross-shell, but it doesn't support X shell. Why?
+## La documentación dice que Starship es compatible con cualquier intérprete de comandos pero no soporta X Shell. ¿Por qué?
-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.
+Por la forma en que Starshp está construído, debería ser posible añadir soporte para prácticamente cualquier intérprete de comandos. El binario de Starship es sin estado y agnóstico, por lo que mientras que tu intérprete de comandos se pueda ampliar y soporte la personalización del símbolo del sistema, puede utilizar Starship.
-Here's a small example getting Starship working with bash:
+Aquí tienes un pequeño ejemplo haciendo que Starship funcione con bash:
```sh
-# Get the status code from the last command executed
+# Obtener el código de estado del último comando ejecutado
STATUS=$?
-# Get the number of jobs running.
+# Calcula el número de tareas ejecutándose.
NUM_JOBS=$(jobs -p | wc -l)
-# Set the prompt to the output of `starship prompt`
+# Actualiza el símbolo del sistema para mostrar la salida de `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.
+La [implementación de Bash](https://github.com/starship/starship/blob/master/src/init/starship.bash) en Starship es sensíblemente is ligeramente más compleja para permitir características avanzadas como [el módulo de duración de comando](https://starship.rs/config/#Command-Duration) y para asegurar que Starship es compatible con las configuraciones preinstaladas de Bash.
-For a list of all flags accepted by `starship prompt`, use the following command:
+Para obtener una lista de todos los parámetros aceptados por `el símbolo del sistema starship`, usa el siguiente comando:
```sh
starship prompt --help
```
-The prompt will use as much context as is provided, but no flags are "required".
+El símbolo de sistema usará tanto contexto como le proveas, pero no hay parámetros "obligatorios".
+
+## ¿Cómo lanzo Starship en distribuciones Linux con versiones antiguas de glibc?
+
+Si obtienes un error como "*version 'GLIBC_2.18' not found (required by starship)*" al usar el binario precompilado (por ejemplo, en CentOS 6 o 7), puedes usar el binario compilado con `musl` en vez de `glibc`:
+
+```sh
+curl -fsSL https://starship.rs/install.sh | bash -s -- --platform unknown-linux-musl
+```
diff --git a/docs/es-ES/guide/README.md b/docs/es-ES/guide/README.md
index 839164f1..c0c5b979 100644
--- a/docs/es-ES/guide/README.md
+++ b/docs/es-ES/guide/README.md
@@ -26,13 +26,13 @@
+ alt="Sigue a @StarshipPrompt en Twitter" />
@@ -101,20 +101,22 @@
align="right" />
-**The minimal, blazing-fast, and infinitely customizable prompt for any shell!**
+**El símbolo del sistema minimalista, ultrarápido e infinitamente customizable para cualquier intérprete de comandos!**
-- **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.
+- **Rápido:** es rápido – _muy muy_ rápido! 🚀
+- **Customizable:** configura cada parte de tu intérprete de comandos.
+- **Universal:** funciona en cualquier símbolo del sistema, en cualquier sistema operativo.
+- **Inteligente:** muestra información relevante de un vistazo.
+- **Repleto de funciones**: con soporte para tus herramientas favoritas.
+- **Fácil de instalar**: empieza a usarlo en pocos minutos.
+
+
## 🚀 Instalacíon
### Prerequisitos
@@ -129,14 +131,14 @@
#### Instalar la última versión
- ##### From prebuilt binary, with Shell:
+ ##### Desde un binario, con Shell:
```sh
curl -fsSL https://starship.rs/install.sh | bash
```
- ##### From source on [crates.io](https://crates.io/):
+ ##### Con [crates.io](https://crates.io/):
```sh
cargo install starship
@@ -220,22 +222,22 @@
Si quiere ayudar a colaborar a starship, por favor mira a nuestra [Guía de Colaboradores](https://github.com/starship/starship/blob/master/CONTRIBUTING.md) (Contributing Guide). Además, juntarse con nosotros en nuestro [servidor de Discord](https://discord.gg/8Jzqu3T) y di "¡hola!". 👋
-### Code Contributors
+### Desarrolladores
-This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)].
+Este proyecto existe gracias a todas las personas que han ayudado. [[Contribuir](CONTRIBUTING.md)].
-### Financial Contributors
+### Financiadores
-Become a financial contributor and help us sustain our community. [[Contribute](https://opencollective.com/starship/contribute)]
+Invierte y ayúdanos a mantener nuestra comunidad. [[Contribuir](https://opencollective.com/starship/contribute)]
-#### Individuals
+#### Personas
-#### Organizations
+#### Organizaciones
-Support this project with your organization. Your logo will show up here with a link to your website. [[Contribute](https://opencollective.com/starship/contribute)]
+Apoya este proyecto con tu organización. Vuestro logo se mostrará aquí con un enlace a vuestra web. [[Contribuir](https://opencollective.com/starship/contribute)]
@@ -248,9 +250,9 @@ Support this project with your organization. Your logo will show up here with a
-## 💭 Inspiracíon
+## 💭 Inspiración
-Please check out these previous works that helped inspire the creation of starship. 🙏
+Aquí tienes algunos de los trabajos previos que ayudaron a crear starship. 🙏
- **[denysdovhan/spaceship-prompt](https://github.com/denysdovhan/spaceship-prompt)** - Una prompt Zsh para astronautas.
@@ -260,9 +262,9 @@ Please check out these previous works that helped inspire the creation of starsh
@@ -115,6 +115,8 @@
Consulter la documentation de Starship ▶
+
+
## 🚀 Installation
### Pré-requis
@@ -250,7 +252,7 @@ Support this project with your organization. Your logo will show up here with a
## 💭Inspiré par
-Please check out these previous works that helped inspire the creation of starship. 🙏
+Voyez ces travaux précédents qui ont contribué à inspirer la création de vaisseau. 🙏
- **[denysdovhan/spaceship-prompt](https://github.com/denysdovhan/spaceship-prompt)** - Un ZSH prompt pour les astronautes.
@@ -260,9 +262,9 @@ Please check out these previous works that helped inspire the creation of starsh
+
+### Quick Install
+
+1. Install the **starship** binary:
+
+
+ #### Install Latest Version
+
+ With Shell:
+
+ ```sh
+ curl -fsSL https://starship.rs/install.sh | bash
+ ```
+
+
+ #### Install via Package Manager
+
+ With [Homebrew](https://brew.sh/):
+
+ ```sh
+ brew install starship
+ ```
+
+ With [Scoop](https://scoop.sh):
+
+ ```powershell
+ scoop install starship
+ ```
+
+1. 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
+
+ Add the following to the end of `~\Documents\PowerShell\Microsoft.PowerShell_profile.ps1` (or `~/.config/powershell/Microsoft.PowerShell_profile.ps1` on -Nix):
+
+ ```sh
+ # ~\Documents\PowerShell\Profile.ps1
+
+ Invoke-Expression (&starship init powershell)
+ ```
+
+
+ #### Ion
+
+ Add the following to the end of `~/.config/ion/initrc`:
+
+ ```sh
+ # ~/.config/ion/initrc
+
+ eval $(starship init ion)
+ ```
diff --git a/docs/pt-BR/advanced-config/README.md b/docs/pt-BR/advanced-config/README.md
new file mode 100644
index 00000000..d5d27031
--- /dev/null
+++ b/docs/pt-BR/advanced-config/README.md
@@ -0,0 +1,84 @@
+# Advanced Configuration
+
+While Starship is a versatile shell, sometimes you need to do more than edit `starship.toml` to get it to do certain things. This page details some of the more advanced configuration techniques used in starship.
+
+::: warning
+
+The configurations in this section are subject to change in future releases of Starship.
+
+:::
+
+## Custom pre-prompt and pre-execution Commands in Bash
+
+Bash does not have a formal preexec/precmd framework like most other shells. Because of this, it is difficult to provide fully customizable hooks in `bash`. However, Starship does give you limited ability to insert your own functions into the prompt-rendering procedure:
+
+- To run a custom function right before the prompt is drawn, define a new function and then assign its name to `starship_precmd_user_func`. For example, to draw a rocket before the prompt, you would do
+
+```bash
+function blastoff(){
+ echo "🚀"
+}
+starship_precmd_user_func="blastoff"
+```
+
+- To run a custom function right before a command runs, you can use the [`DEBUG` trap mechanism](https://jichu4n.com/posts/debug-trap-and-prompt_command-in-bash/). However, you **must** trap the DEBUG signal *before* initializing Starship! Starship can preserve the value of the DEBUG trap, but if the trap is overwritten after starship starts up, some functionality will break.
+
+```bash
+function blastoff(){
+ echo "🚀"
+}
+trap blastoff DEBUG # Trap DEBUG *before* running starship
+eval $(starship init bash)
+```
+
+## Change Window Title
+
+Some shell prompts will automatically change the window title for you (e.g. to reflect your working directory). Fish even does it by default. Starship does not do this, but it's fairly straightforward to add this functionality to `bash` or `zsh`.
+
+First, define a window title change function (identical in bash and zsh):
+
+```bash
+function set_win_title(){
+ echo -ne "\033]0; YOUR_WINDOW_TITLE_HERE \007"
+}
+```
+
+You can use variables to customize this title (`$USER`, `$HOSTNAME`, and `$PWD` are popular choices).
+
+In `bash`, set this function to be the precmd starship function:
+
+```bash
+starship_precmd_user_func="set_win_title"
+```
+
+In `zsh`, add this to the `precmd_functions` array:
+
+```bash
+precmd_functions+=(set_win_title)
+```
+
+If you like the result, add these lines to your shell configuration file (`~/.bashrc` or `~/.zsrhc`) to make it permanent.
+
+## Style Strings
+
+Style strings are a list of words, separated by whitespace. The words are not case sensitive (i.e. `bold` and `BoLd` are considered the same string). Each word can be one of the following:
+
+ - `bold`
+ - `underline`
+ - `dimmed`
+ - `bg:`
+ - `fg:`
+ - ``
+ - `none`
+
+where `` is a color specifier (discussed below). `fg:` and `` currently do the same thing , though this may change in the future. The order of words in the string does not matter.
+
+The `none` token overrides all other tokens in a string, so that e.g. `fg:red none fg:blue` will still create a string with no styling. It may become an error to use `none` in conjunction with other tokens in the future.
+
+A color specifier can be one of the following:
+
+ - One of the standard terminal colors: `black`, `red`, `green`, `blue`, `yellow`, `purple`, `cyan`, `white`. You can optionally prefix these with `bright-` to get the bright version (e.g. `bright-white`).
+ - A `#` followed by a six-digit hexadecimal number. This specifies an [RGB color hex code](https://www.w3schools.com/colors/colors_hexadecimal.asp).
+ - A number between 0-255. This specifies an [8-bit ANSI Color Code](https://i.stack.imgur.com/KTSQa.png).
+
+If multiple colors are specified for foreground/background, the last one in the string will take priority.
diff --git a/docs/pt-BR/config/README.md b/docs/pt-BR/config/README.md
new file mode 100644
index 00000000..c4bef59c
--- /dev/null
+++ b/docs/pt-BR/config/README.md
@@ -0,0 +1,1302 @@
+# Configuration
+
+::: tip
+
+🔥 Configuration is currently being worked on. Many new configuration options will be available in coming releases.
+
+:::
+
+To get started configuring starship, create the following file: `~/.config/starship.toml`.
+
+```sh
+$ mkdir -p ~/.config && touch ~/.config/starship.toml
+```
+
+All configuration for starship is done in this [TOML](https://github.com/toml-lang/toml) file:
+
+```toml
+# Don't print a new line at the start of the prompt
+add_newline = false
+
+# Replace the "❯" symbol in the prompt with "➜"
+[character] # The name of the module we are configuring is "character"
+symbol = "➜" # The "symbol" segment is being set to "➜"
+
+# Disable the package module, hiding it from the prompt completely
+[package]
+disabled = true
+```
+
+You can change default `starship.toml` file location with `STARSHIP_CONFIG` environment variable:
+```sh
+export STARSHIP_CONFIG=~/.starship
+```
+
+### Terminology
+
+**Module**: A component in the prompt giving information based on contextual information from your OS. For example, the "nodejs" module shows the version of NodeJS that is currently installed on your computer, if your current directory is a NodeJS project.
+
+**Segment**: Smaller sub-components that compose a module. For example, the "symbol" segment in the "nodejs" module contains the character that is shown before the version number (⬢ by default).
+
+Here is the representation of the node module. In the following example, "symbol" and "version" are segments within it. Every module also has a prefix and suffix that are the default terminal color.
+
+```
+[prefix] [symbol] [version] [suffix]
+ "via " "⬢" "v10.4.1" ""
+```
+
+### Style Strings
+
+Most modules in starship allow you to configure their display styles. This is done with an entry (usually called `style`) which is a string specifying the configuration. Here are some examples of style strings along with what they do. For details on the full syntax, consult the [advanced config guide](/advanced-config/).
+
+- `"fg:green bg:blue"` sets green text on a blue background
+- `"bg:blue fg:bright-green"` sets bright green text on a blue background
+- `"bold fg:27"` sets bold text with [ANSI color](https://i.stack.imgur.com/KTSQa.png) 27
+- `"underline bg:#bf5700"` sets underlined text on a burnt orange background
+- `"bold italic fg:purple"` sets bold italic purple text
+- `""` explicitly disables all styling
+
+Note that what styling looks like will be controlled by your terminal emulator. For example, some terminal emulators will brighten the colors instead of bolding text, and some color themes use the same values for the normal and bright colors. Also, to get italic text, your terminal must support italics.
+
+## Prompt
+
+This is the list of prompt-wide configuration options.
+
+### Options
+
+| Variable | Default | Description |
+| -------------- | ----------------------------- | ------------------------------------------------------ |
+| `add_newline` | `true` | Add a new line before the start of the prompt. |
+| `prompt_order` | [link](#default-prompt-order) | Configure the order in which the prompt module occurs. |
+| `scan_timeout` | `30` | Timeout for starship to scan files (in milliseconds). |
+
+### Example
+
+```toml
+# ~/.config/starship.toml
+
+# Disable the newline at the start of the prompt
+add_newline = false
+# Overwrite a default_prompt_order and use custom prompt_order
+prompt_order=["rust","line_break","package","line_break","character"]
+# Wait 10 milliseconds for starship to check files under the current directory.
+scan_timeout = 10
+```
+
+### Default Prompt Order
+
+The default `prompt_order` is used to define the order in which modules are shown in the prompt, if empty or no `prompt_order` is provided. The default is as shown:
+
+```toml
+prompt_order = [
+ "username",
+ "hostname",
+ "kubernetes",
+ "directory",
+ "git_branch",
+ "git_commit",
+ "git_state",
+ "git_status",
+ "hg_branch",
+ "docker_context",
+ "package",
+ "dotnet",
+ "elixir",
+ "elm",
+ "erlang",
+ "golang",
+ "haskell",
+ "java",
+ "julia",
+ "nodejs",
+ "php",
+ "python",
+ "ruby",
+ "rust",
+ "terraform",
+ "nix_shell",
+ "conda",
+ "memory_usage",
+ "aws",
+ "env_var",
+ "crystal",
+ "cmd_duration",
+ "custom",
+ "line_break",
+ "jobs",
+ "battery",
+ "time",
+ "character",
+]
+```
+
+## AWS
+
+The `aws` module shows the current AWS region and profile. This is based on `AWS_REGION`, `AWS_DEFAULT_REGION`, and `AWS_PROFILE` env var with `~/.aws/config` file.
+
+When using [aws-vault](https://github.com/99designs/aws-vault) the profile is read from the `AWS_VAULT` env var.
+
+### Options
+
+| Variable | Default | Description |
+| ----------------- | --------------- | --------------------------------------------------------------------------- |
+| `symbol` | `"☁️ "` | The symbol used before displaying the current AWS profile. |
+| `displayed_items` | `all` | Choose which item to display. Possible values: [`all`, `profile`, `region`] |
+| `region_aliases` | | Table of region aliases to display in addition to the AWS name. |
+| `style` | `"bold yellow"` | The style for the module. |
+| `disabled` | `false` | Disables the `AWS` module. |
+
+### Example
+
+```toml
+# ~/.config/starship.toml
+
+[aws]
+style = "bold blue"
+symbol = "🅰 "
+displayed_items = "region"
+[aws.region_aliases]
+ap-southeast-2 = "au"
+us-east-1 = "va"
+```
+
+## Battery
+
+The `battery` module shows how charged the device's battery is and its current charging status. The module is only visible when the device's battery is below 10%.
+
+### Options
+
+| Variable | Default | Description |
+| -------------------- | ------------------------ | ------------------------------------------------- |
+| `full_symbol` | `"•"` | The symbol shown when the battery is full. |
+| `charging_symbol` | `"⇡"` | The symbol shown when the battery is charging. |
+| `discharging_symbol` | `"⇣"` | The symbol shown when the battery is discharging. |
+| `display` | [link](#battery-display) | Display threshold and style for the module. |
+| `disabled` | `false` | Disables the `battery` module. |
+
+
+There are also options for some uncommon battery states.
+
+| Variable | Description |
+| ---------------- | --------------------------------------------------- |
+| `unknown_symbol` | The symbol shown when the battery state is unknown. |
+| `empty_symbol` | The symbol shown when the battery state is empty. |
+
+Note: Battery indicator will be hidden if the status is `unknown` or `empty` unless you specify the option in the config.
+
+
+
+### Example
+
+```toml
+# ~/.config/starship.toml
+
+[battery]
+full_symbol = "🔋"
+charging_symbol = "⚡️"
+discharging_symbol = "💀"
+```
+
+### Battery Display
+
+The `display` configuration option is used to define when the battery indicator should be shown (threshold) and what it looks like (style). If no `display` is provided. The default is as shown:
+
+```toml
+[[battery.display]]
+threshold = 10
+style = "bold red"
+```
+
+#### Options
+
+The `display` option is an array of the following table.
+
+| Variable | Description |
+| ----------- | ----------------------------------------------- |
+| `threshold` | The upper bound for the display option. |
+| `style` | The style used if the display option is in use. |
+
+#### Example
+
+```toml
+[[battery.display]] # "bold red" style when capacity is between 0% and 10%
+threshold = 10
+style = "bold red"
+
+[[battery.display]] # "bold yellow" style when capacity is between 10% and 30%
+threshold = 30
+style = "bold yellow"
+
+# when capacity is over 30%, the battery indicator will not be displayed
+
+```
+
+## Character
+
+The `character` module shows a character (usually an arrow) beside where the text is entered in your terminal.
+
+The character will tell you whether the last command was successful or not. It can do this in two ways: by changing color (red/green) or by changing its shape (❯/✖). The latter will only be done if `use_symbol_for_status` is set to `true`.
+
+### Options
+
+| Variable | Default | Description |
+| ----------------------- | -------------- | ----------------------------------------------------------------------------------- |
+| `symbol` | `"❯"` | The symbol used before the text input in the prompt. |
+| `error_symbol` | `"✖"` | The symbol used before text input if the previous command failed. |
+| `use_symbol_for_status` | `false` | Indicate error status by changing the symbol. |
+| `vicmd_symbol` | `"❮"` | The symbol used before the text input in the prompt if shell is in vim normal mode. |
+| `style_success` | `"bold green"` | The style used if the last command was successful. |
+| `style_failure` | `"bold red"` | The style used if the last command failed. |
+| `disabled` | `false` | Disables the `character` module. |
+
+### Example
+
+```toml
+# ~/.config/starship.toml
+
+[character]
+symbol = "➜"
+error_symbol = "✗"
+use_symbol_for_status = true
+```
+
+## Command Duration
+
+The `cmd_duration` module shows how long the last command took to execute. The module will be shown only if the command took longer than two seconds, or the `min_time` config value, if it exists.
+
+::: warning Do not hook the DEBUG trap in Bash
+
+If you are running Starship in `bash`, do not hook the `DEBUG` trap after running `eval $(starship init $0)`, or this module **will** break.
+
+:::
+
+Bash users who need preexec-like functionality can use [rcaloras's bash_preexec framework](https://github.com/rcaloras/bash-preexec). Simply define the arrays `preexec_functions` and `precmd_functions` before running `eval $(starship init $0)`, and then proceed as normal.
+
+### Options
+
+| Variable | Default | Description |
+| ------------------- | --------------- | ---------------------------------------------------------- |
+| `min_time` | `2_000` | Shortest duration to show time for (in milliseconds). |
+| `show_milliseconds` | `false` | Show milliseconds in addition to seconds for the duration. |
+| `prefix` | `took` | Prefix to display immediately before the command duration. |
+| `style` | `"bold yellow"` | The style for the module. |
+| `disabled` | `false` | Disables the `cmd_duration` module. |
+
+### Example
+
+```toml
+# ~/.config/starship.toml
+
+[cmd_duration]
+min_time = 500
+prefix = "underwent "
+```
+
+## Conda
+
+The `conda` module shows the current conda environment, if `$CONDA_DEFAULT_ENV` is set.
+
+::: tip
+
+This does not suppress conda's own prompt modifier, you may want to run `conda config --set changeps1 False`.
+
+:::
+
+### Options
+
+| Variable | Default | Description |
+| ------------------- | -------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `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` | `"C "` | The symbol used before the environment name. |
+| `style` | `"bold green"` | The style for the module. |
+| `disabled` | `false` | Disables the `conda` module. |
+
+### Example
+
+```toml
+# ~/.config/starship.toml
+
+[conda]
+style = "dimmed green"
+```
+
+## Crystal
+
+The `crystal` module shows the currently installed version of Crystal. 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
+
+### Options
+
+| Variable | Default | Description |
+| ---------- | ------------ | --------------------------------------------------------- |
+| `symbol` | `"🔮 "` | The symbol used before displaying the version of crystal. |
+| `style` | `"bold red"` | The style for the module. |
+| `disabled` | `false` | Disables the `crystal` module. |
+
+### Example
+
+```toml
+# ~/.config/starship.toml
+
+[crystal]
+symbol = "✨ "
+style = "bold blue"
+```
+
+## 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`.
+
+### Options
+
+| Variable | Default | Description |
+| ------------------- | ------------- | -------------------------------------------------------------------------------- |
+| `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. |
+| `prefix` | `"in "` | Prefix to display immediately before the directory. |
+| `style` | `"bold cyan"` | The style for the module. |
+| `disabled` | `false` | Disables the `directory` module. |
+
+
+This module has a few advanced configuration options that control how the directory is displayed.
+
+| Variable | Default | Description |
+| --------------------------- | ------- | ---------------------------------------------------------------------------------------- |
+| `fish_style_pwd_dir_length` | `0` | The number of characters to use when applying fish shell pwd path logic. |
+| `use_logical_path` | `true` | Displays the logical path provided by the shell (`PWD`) instead of the path from the OS. |
+
+`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`.
+
+
+
+### Example
+
+```toml
+# ~/.config/starship.toml
+
+[directory]
+truncation_length = 8
+```
+
+## 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`.
+
+### Options
+
+| Variable | Default | Description |
+| ----------------- | ------------- | --------------------------------------------------------------------------------------- |
+| `symbol` | `"🐳 "` | The symbol used before displaying the Docker context . |
+| `only_with_files` | `false` | Only show when there's a `docker-compose.yml` or `Dockerfile` in the current directory. |
+| `style` | `"bold blue"` | The style for the module. |
+| `disabled` | `true` | Disables the `docker_context` module. |
+
+### Example
+
+```toml
+# ~/.config/starship.toml
+
+[docker_context]
+symbol = "🐋 "
+```
+
+## Dotnet
+
+The `dotnet` module shows the relevant version of the .NET Core SDK for the current directory. If the SDK has been pinned in the current directory, the pinned version is shown. Otherwise the module shows the latest installed version of the SDK.
+
+This module will only be shown in your prompt when one of the following files are present in the current directory: `global.json`, `project.json`, `*.sln`, `*.csproj`, `*.fsproj`, `*.xproj`. You'll also need the .NET Core command-line tools 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.
+
+### Options
+
+| Variable | Default | Description |
+| ----------- | ------------- | -------------------------------------------------------- |
+| `symbol` | `"•NET "` | The symbol used before displaying the version of dotnet. |
+| `heuristic` | `true` | Use faster version detection to keep starship snappy. |
+| `style` | `"bold blue"` | The style for the module. |
+| `disabled` | `false` | Disables the `dotnet` module. |
+
+### Example
+
+```toml
+# ~/.config/starship.toml
+
+[dotnet]
+symbol = "🥅 "
+style = "green"
+heuristic = false
+```
+
+## Elixir
+
+The `elixir` module shows the currently installed version of Elixir and Erlang/OTP. The module will be shown if any of the following conditions are met:
+
+- The current directory contains a `mix.exs` file.
+
+### Options
+
+| Variable | Default | Description |
+| ---------- | ------- | --------------------------------------------------------------- |
+| `symbol` | `"💧 "` | The symbol used before displaying the version of Elixir/Erlang. |
+| `disabled` | `false` | Disables the `elixir` module. |
+
+### Example
+
+```toml
+# ~/.config/starship.toml
+
+[elixir]
+symbol = "🔮 "
+```
+
+## Elm
+
+The `elm` module shows the currently installed version of Elm. 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
+
+### Options
+
+| Variable | Default | Description |
+| ---------- | ------------- | ----------------------------------------------------- |
+| `symbol` | `"🌳 "` | The symbol used before displaying the version of Elm. |
+| `style` | `"bold cyan"` | The style for the module. |
+| `disabled` | `false` | Disables the `elm` module. |
+
+
+### Example
+
+```toml
+# ~/.config/starship.toml
+
+[elm]
+symbol = " "
+```
+
+## Erlang
+
+The `erlang` module shows the currently installed version of Erlang/OTP. 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.
+
+### Options
+
+| Variable | Default | Description |
+| ---------- | ------- | -------------------------------------------------------- |
+| `symbol` | `"🖧 "` | The symbol used before displaying the version of Erlang. |
+| `disabled` | `false` | Disables the `erlang` module. |
+
+### Example
+
+```toml
+# ~/.config/starship.toml
+
+[erlang]
+symbol = "e "
+```
+## Environment Variable
+
+The `env_var` module displays the current value of a selected environment variable. 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
+
+### Options
+
+| Variable | Default | Description |
+| ---------- | ---------------- | ---------------------------------------------------------------------------- |
+| `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. |
+| `prefix` | `""` | Prefix to display immediately before the variable value. |
+| `suffix` | `""` | Suffix to display immediately after the variable value. |
+| `style` | `"dimmed black"` | The style for the module. |
+| `disabled` | `false` | Disables the `env_var` module. |
+
+### Example
+
+```toml
+# ~/.config/starship.toml
+
+[env_var]
+variable = "SHELL"
+default = "unknown shell"
+```
+
+## Git Branch
+
+The `git_branch` module shows the active branch of the repo in your current directory.
+
+### Options
+
+| Variable | Default | Description |
+| ------------------- | --------------- | ------------------------------------------------------------------------------------- |
+| `symbol` | `" "` | The symbol used before the branch name of the repo in your current directory. |
+| `truncation_length` | `2^63 - 1` | Truncates a git branch to X graphemes |
+| `truncation_symbol` | `"…"` | The symbol used to indicate a branch name was truncated. You can use "" for no symbol |
+| `style` | `"bold purple"` | The style for the module. |
+| `disabled` | `false` | Disables the `git_branch` module. |
+
+### Example
+
+```toml
+# ~/.config/starship.toml
+
+[git_branch]
+symbol = "🌱 "
+truncation_length = 4
+truncation_symbol = ""
+```
+
+## Git Commit
+
+The `git_commit` module shows the current commit hash of the repo in your current directory.
+
+### Options
+
+| Variable | Default | Description |
+| -------------------- | -------------- | ----------------------------------------------------- |
+| `commit_hash_length` | `7` | The length of the displayed git commit hash. |
+| `prefix` | `"("` | Prefix to display immediately before git commit. |
+| `suffix` | `")"` | Suffix to display immediately after git commit. |
+| `style` | `"bold green"` | The style for the module. |
+| `only_detached` | `true` | Only show git commit hash when in detached HEAD state |
+| `disabled` | `false` | Disables the `git_commit` module. |
+
+### Example
+
+```toml
+# ~/.config/starship.toml
+
+[git_commit]
+commit_hash_length = 4
+```
+
+## 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.
+
+### Options
+
+| Variable | Default | Description |
+| ------------------ | ------------------ | ---------------------------------------------------------------------------------------------------------------- |
+| `rebase` | `"REBASING"` | The text displayed when a `rebase` is in progress. |
+| `merge` | `"MERGING"` | The text displayed when a `merge` is in progress. |
+| `revert` | `"REVERTING"` | The text displayed when a `revert` is in progress. |
+| `cherry_pick` | `"CHERRY-PICKING"` | The text displayed when a `cherry-pick` is in progress. |
+| `bisect` | `"BISECTING"` | The text displayed when a `bisect` is in progress. |
+| `am` | `"AM"` | The text displayed when an `apply-mailbox` (`git am`) is in progress. |
+| `am_or_rebase` | `"AM/REBASE"` | The text displayed when an ambiguous `apply-mailbox` or `rebase` is in progress. |
+| `progress_divider` | `"/"` | The symbol or text which will separate the current and total progress amounts. (e.g., `" of "`, for `"3 of 10"`) |
+| `style` | `"bold yellow"` | The style for the module. |
+| `disabled` | `false` | Disables the `git_state` module. |
+
+### Example
+
+```toml
+# ~/.config/starship.toml
+
+[git_state]
+progress_divider = " of "
+cherry_pick = "🍒 PICKING"
+```
+
+## Git Status
+
+The `git_status` module shows symbols representing the state of the repo in your current directory.
+
+### Options
+
+| Variable | Default | Description |
+| ------------------ | -------------------------- | ------------------------------------------------------- |
+| `conflicted` | `"="` | This branch has merge conflicts. |
+| `conflicted_count` | [link](#git-status-counts) | Show and style the number of conflicts. |
+| `ahead` | `"⇡"` | This branch is ahead of the branch being tracked. |
+| `behind` | `"⇣"` | This branch is behind of the branch being tracked. |
+| `diverged` | `"⇕"` | This branch has diverged from the branch being tracked. |
+| `untracked` | `"?"` | There are untracked files in the working directory. |
+| `untracked_count` | [link](#git-status-counts) | Show and style the number of untracked files. |
+| `stashed` | `"$"` | A stash exists for the local repository. |
+| `stashed_count` | [link](#git-status-counts) | Show and style the number of stashes. |
+| `modified` | `"!"` | There are file modifications in the working directory. |
+| `modified_count` | [link](#git-status-counts) | Show and style the number of modified files. |
+| `staged` | `"+"` | A new file has been added to the staging area. |
+| `staged_count` | [link](#git-status-counts) | Show and style the number of files staged files. |
+| `renamed` | `"»"` | A renamed file has been added to the staging area. |
+| `renamed_count` | [link](#git-status-counts) | Show and style the number of renamed files. |
+| `deleted` | `"✘"` | A file's deletion has been added to the staging area. |
+| `deleted_count` | [link](#git-status-counts) | Show and style the number of deleted files. |
+| `show_sync_count` | `false` | Show ahead/behind count of the branch being tracked. |
+| `prefix` | `[` | Prefix to display immediately before git status. |
+| `suffix` | `]` | Suffix to display immediately after git status. |
+| `style` | `"bold red"` | The style for the module. |
+| `disabled` | `false` | Disables the `git_status` module. |
+
+#### Git Status Counts
+
+| Variable | Default | Description |
+| --------- | ------- | ------------------------------------------------------ |
+| `enabled` | `false` | Show the number of files |
+| `style` | | Optionally style the count differently than the module |
+
+### Example
+
+```toml
+# ~/.config/starship.toml
+
+[git_status]
+conflicted = "🏳"
+ahead = "🏎💨"
+behind = "😰"
+diverged = "😵"
+untracked = "🤷"
+stashed = "📦"
+modified = "📝"
+staged.value = "++"
+staged.style = "green"
+staged_count.enabled = true
+staged_count.style = "green"
+renamed = "👅"
+deleted = "🗑"
+```
+
+## Golang
+
+The `golang` module shows the currently installed version of Golang. 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
+
+### Options
+
+| Variable | Default | Description |
+| ---------- | ------------- | -------------------------------------------------------- |
+| `symbol` | `"🐹 "` | The symbol used before displaying the version of Golang. |
+| `style` | `"bold cyan"` | The style for the module. |
+| `disabled` | `false` | Disables the `golang` module. |
+
+### Example
+
+```toml
+# ~/.config/starship.toml
+
+[golang]
+symbol = "🏎💨 "
+```
+## Haskell
+
+The `haskell` module shows the currently installed version of Haskell Stack version. The module will be shown if any of the following conditions are met:
+
+- The current directory contains a `stack.yaml` file
+
+### Options
+
+| Variable | Default | Description |
+| ---------- | ------------ | --------------------------------------------------------- |
+| `symbol` | `"λ "` | The symbol used before displaying the version of Haskell. |
+| `style` | `"bold red"` | The style for the module. |
+| `disabled` | `false` | Disables the `haskell` module. |
+
+
+### Example
+
+```toml
+# ~/.config/starship.toml
+
+[haskell]
+symbol = " "
+```
+
+## Hostname
+
+The `hostname` module shows the system hostname.
+
+### Options
+
+| Variable | Default | Description |
+| ---------- | --------------------- | ------------------------------------------------------------------------------------------------------------------------------------ |
+| `ssh_only` | `true` | Only show hostname when connected to an SSH session. |
+| `prefix` | `""` | Prefix to display immediately before the hostname. |
+| `suffix` | `""` | Suffix to display immediately after the hostname. |
+| `trim_at` | `"."` | String that the hostname is cut off at, after the first match. `"."` will stop after the first dot. `""` will disable any truncation |
+| `style` | `"bold dimmed green"` | The style for the module. |
+| `disabled` | `false` | Disables the `hostname` module. |
+
+### Example
+
+```toml
+# ~/.config/starship.toml
+
+[hostname]
+ssh_only = false
+prefix = "⟪"
+suffix = "⟫"
+trim_at = ".companyname.com"
+disabled = false
+```
+
+## Java
+
+The `java` module shows the currently installed version of Java. 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` or `.java-version` file
+- The current directory contains a file with the `.java`, `.class`, `.gradle` or `.jar` extension
+
+### Options
+
+| Variable | Default | Description |
+| ---------- | -------------- | ------------------------------------------------------ |
+| `symbol` | `"☕ "` | The symbol used before displaying the version of Java. |
+| `style` | `"dimmed red"` | The style for the module. |
+| `disabled` | `false` | Disables the `java` module. |
+
+### Example
+
+```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 is more than 1 job, or more than the `threshold` config value, if it exists.
+
+### Options
+
+| Variable | Default | Description |
+| ----------- | ------------- | ----------------------------------------------------- |
+| `symbol` | `"✦"` | The symbol used before displaying the number of jobs. |
+| `threshold` | `1` | Show number of jobs if exceeded. |
+| `style` | `"bold blue"` | The style for the module. |
+| `disabled` | `false` | Disables the `jobs` module. |
+
+### Example
+
+```toml
+# ~/.config/starship.toml
+
+[jobs]
+symbol = "+ "
+threshold = 4
+```
+
+## Julia
+
+The `julia` module shows the currently installed version of Julia. 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
+
+### Options
+
+| Variable | Default | Description |
+| ---------- | --------------- | ------------------------------------------------------- |
+| `symbol` | `"ஃ "` | The symbol used before displaying the version of Julia. |
+| `style` | `"bold purple"` | The style for the module. |
+| `disabled` | `false` | Disables the `julia` module. |
+
+### Example
+
+```toml
+# ~/.config/starship.toml
+
+[julia]
+symbol = "∴ "
+```
+## Kubernetes
+
+Displays the current Kubernetes 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`.
+
+::: tip
+
+This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
+
+:::
+
+### Options
+
+| Variable | Default | Description |
+| ----------------- | ------------- | --------------------------------------------------- |
+| `symbol` | `"☸ "` | The symbol used before displaying the Cluster info. |
+| `context_aliases` | | Table of context aliases to display |
+| `style` | `"bold blue"` | The style for the module. |
+| `disabled` | `true` | Disables the `kubernetes` module |
+
+### Example
+
+```toml
+# ~/.config/starship.toml
+
+[kubernetes]
+symbol = "⛵ "
+style = "dimmed green"
+disabled = false
+[kubernetes.context_aliases]
+"dev.local.cluster.k8s" = "dev"
+```
+
+## Line Break
+
+The `line_break` module separates the prompt into two lines.
+
+### Options
+
+| Variable | Default | Description |
+| ---------- | ------- | ------------------------------------------------------------------ |
+| `disabled` | `false` | Disables the `line_break` module, making the prompt a single line. |
+
+### Example
+
+```toml
+# ~/.config/starship.toml
+
+[line_break]
+disabled = true
+```
+
+## Memory Usage
+
+The `memory_usage` module shows current system memory and swap usage.
+
+By default the swap usage is displayed if the total system swap is non-zero.
+
+::: tip
+
+This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
+
+:::
+
+### Options
+
+| Variable | Default | Description |
+| ----------------- | --------------------- | ------------------------------------------------------------- |
+| `show_percentage` | `false` | Display memory usage as a percentage of the available memory. |
+| `show_swap` | `true` | Display swap usage if total swap is non-zero. |
+| `threshold` | `75` | Hide the memory usage unless it exceeds this percentage. |
+| `symbol` | `"🐏 "` | The symbol used before displaying the memory usage. |
+| `separator` | `" | "` | The symbol or text that will seperate the ram and swap usage. |
+| `style` | `"bold dimmed white"` | The style for the module. |
+| `disabled` | `true` | Disables the `memory_usage` module. |
+
+### Example
+
+```toml
+# ~/.config/starship.toml
+
+[memory_usage]
+disabled = false
+show_percentage = true
+show_swap = true
+threshold = -1
+symbol = " "
+separator = "/"
+style = "bold dimmed green"
+```
+
+## Mercurial Branch
+
+The `hg_branch` module shows the active branch of the repo in your current directory.
+
+### Options
+
+| Variable | Default | Description |
+| ------------------- | --------------- | -------------------------------------------------------------------------------------------- |
+| `symbol` | `" "` | The symbol used before the hg bookmark or branch name of the repo in your current directory. |
+| `truncation_length` | `2^63 - 1` | Truncates the hg branch name to X graphemes |
+| `truncation_symbol` | `"…"` | The symbol used to indicate a branch name was truncated. |
+| `style` | `"bold purple"` | The style for the module. |
+| `disabled` | `true` | Disables the `hg_branch` module. |
+
+### Example
+
+```toml
+# ~/.config/starship.toml
+
+[hg_branch]
+symbol = "🌱 "
+truncation_length = 4
+truncation_symbol = ""
+```
+
+## Nix-shell
+
+The `nix_shell` module shows the nix-shell environment. The module will be shown when inside a nix-shell environment.
+
+### Options
+
+| Variable | Default | Description |
+| ------------ | ------------- | ------------------------------------------------- |
+| `use_name` | `false` | Display the name of the nix-shell. |
+| `impure_msg` | `"impure"` | Customize the "impure" msg. |
+| `pure_msg` | `"pure"` | Customize the "pure" msg. |
+| `symbol` | `"❄️ "` | The symbol used before displaying the shell name. |
+| `style` | `"bold blue"` | The style for the module. |
+| `disabled` | `false` | Disables the `nix_shell` module. |
+
+### Example
+
+```toml
+# ~/.config/starship.toml
+
+[nix_shell]
+disabled = true
+use_name = true
+impure_msg = "impure shell"
+pure_msg = "pure shell"
+symbol = "☃️ "
+```
+
+## NodeJS
+
+The `nodejs` module shows the currently installed version of NodeJS. 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 `node_modules` directory
+- The current directory contains a file with the `.js` extension
+
+### Options
+
+| Variable | Default | Description |
+| ---------- | -------------- | -------------------------------------------------------- |
+| `symbol` | `"⬢ "` | The symbol used before displaying the version of NodeJS. |
+| `style` | `"bold green"` | The style for the module. |
+| `disabled` | `false` | Disables the `nodejs` module. |
+
+### Example
+
+```toml
+# ~/.config/starship.toml
+
+[nodejs]
+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`, `cargo`, `poetry`, `composer`, `gradle`, `julia` and `mix` packages.
+
+- **npm** – The `npm` package version is extracted from the `package.json` present in the current directory
+- **cargo** – The `cargo` package version is extracted from the `Cargo.toml` present in the current directory
+- **poetry** – The `poetry` package version is extracted from the `pyproject.toml` present in the current directory
+- **composer** – The `composer` package version is extracted from the `composer.json` present in the current directory
+- **gradle** – The `gradle` package version is extracted from the `build.gradle` present
+- **julia** - The package version is extracted from the `Project.toml` present
+- **mix** - The `mix` package version is extracted from the `mix.exs` present
+
+> ⚠️ The version being shown is that of the package whose source code is in your current directory, not your package manager.
+
+### Options
+
+| Variable | Default | Description |
+| ----------------- | ------------ | ---------------------------------------------------------- |
+| `symbol` | `"📦 "` | The symbol used before displaying the version the package. |
+| `style` | `"bold red"` | The style for the module. |
+| `display_private` | `false` | Enable displaying version for packages marked as private. |
+| `disabled` | `false` | Disables the `package` module. |
+
+### Example
+
+```toml
+# ~/.config/starship.toml
+
+[package]
+symbol = "🎁 "
+```
+
+## PHP
+
+The `php` module shows the currently installed version of PHP. 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` file
+
+### Options
+
+| Variable | Default | Description |
+| ---------- | ------------ | ----------------------------------------------------- |
+| `symbol` | `"🐘 "` | The symbol used before displaying the version of PHP. |
+| `style` | `"bold red"` | The style for the module. |
+| `disabled` | `false` | Disables the `php` module. |
+
+### Example
+
+```toml
+# ~/.config/starship.toml
+
+[php]
+symbol = "🔹 "
+```
+
+## Python
+
+The `python` module shows the currently installed version of Python.
+
+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` and show the current Python virtual environment if one is activated.
+
+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 `requirements.txt` file
+- The current directory contains a `pyproject.toml` file
+- The current directory contains a file with the `.py` extension (and `scan_for_pyfiles` is true)
+- The current directory contains a `Pipfile` file
+- The current directory contains a `tox.ini` file
+- The current directory contains a `setup.py` file
+- The current directory contains a `__init__.py` file
+- A virtual environment is currently activated
+
+### Options
+
+| Variable | Default | Description |
+| -------------------- | --------------- | --------------------------------------------------------------------------- |
+| `symbol` | `"🐍 "` | The symbol used before displaying the version of Python. |
+| `pyenv_version_name` | `false` | Use pyenv to get Python version |
+| `pyenv_prefix` | `"pyenv "` | Prefix before pyenv version display (default display is `pyenv MY_VERSION`) |
+| `scan_for_pyfiles` | `true` | If false, Python files in the current directory will not show this module. |
+| `style` | `"bold yellow"` | The style for the module. |
+| `disabled` | `false` | Disables the `python` module. |
+
+### Example
+
+```toml
+# ~/.config/starship.toml
+
+[python]
+symbol = "👾 "
+pyenv_version_name = true
+pyenv_prefix = "foo "
+```
+
+## Ruby
+
+The `ruby` module shows the currently installed version of Ruby. 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
+
+### Options
+
+| Variable | Default | Description |
+| ---------- | ------------ | ------------------------------------------------------ |
+| `symbol` | `"💎 "` | The symbol used before displaying the version of Ruby. |
+| `style` | `"bold red"` | The style for the module. |
+| `disabled` | `false` | Disables the `ruby` module. |
+
+### Example
+
+```toml
+# ~/.config/starship.toml
+
+[ruby]
+symbol = "🔺 "
+```
+
+## Rust
+
+The `rust` module shows the currently installed version of Rust. 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
+
+### Options
+
+| Variable | Default | Description |
+| ---------- | ------------ | ------------------------------------------------------ |
+| `symbol` | `"🦀 "` | The symbol used before displaying the version of Rust. |
+| `style` | `"bold red"` | The style for the module. |
+| `disabled` | `false` | Disables the `rust` module. |
+
+### Example
+
+```toml
+# ~/.config/starship.toml
+
+[rust]
+symbol = "⚙️ "
+```
+
+## Singularity
+
+The `singularity` module shows the current singularity image, if inside a container and `$SINGULARITY_NAME` is set.
+
+### Options
+
+| Variable | Default | Description |
+| ---------- | -------------------- | ------------------------------------------------ |
+| `label` | `""` | Prefix before the image name display. |
+| `prefix` | `"["` | Prefix to display immediately before image name. |
+| `suffix` | `"]"` | Suffix to display immediately after image name. |
+| `symbol` | `""` | The symbol used before the image name. |
+| `style` | `"bold dimmed blue"` | The style for the module. |
+| `disabled` | `false` | Disables the `singularity` module. |
+
+### Example
+
+```toml
+# ~/.config/starship.toml
+
+[singularity]
+symbol = "📦 "
+```
+
+## Terraform
+
+The `terraform` module shows the currently selected terraform workspace and version. By default the terraform version is not shown, since this is slow on current versions of terraform when a lot of plugins are in use. 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` extension
+
+### Options
+
+| Variable | Default | Description |
+| -------------- | ------------ | ----------------------------------------------------------- |
+| `symbol` | `"💠 "` | The symbol used before displaying the terraform workspace. |
+| `show_version` | `false` | Shows the terraform version. Very slow on large workspaces. |
+| `style` | `"bold 105"` | The style for the module. |
+| `disabled` | `false` | Disables the `terraform` module. |
+
+### Example
+
+```toml
+# ~/.config/starship.toml
+
+[terraform]
+symbol = "🏎💨 "
+```
+
+## 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.
+
+::: tip
+
+This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
+
+:::
+
+### Options
+
+| Variable | Default | Description |
+| ----------------- | --------------- | ------------------------------------------------------------------------------------------------------------------- |
+| `use_12hr` | `false` | Enables 12 hour formatting |
+| `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. |
+
+If `use_12hr` is `true`, then `format` defaults to `"%r"`. Otherwise, it defaults to `"%T"`. Manually setting `format` will override the `use_12hr` setting.
+
+### Example
+
+```toml
+# ~/.config/starship.toml
+
+[time]
+disabled = false
+format = "🕙[ %T ]"
+utc_time_offset = "-5"
+```
+
+## 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
+
+### Options
+
+| Variable | Default | Description |
+| ------------- | --------------- | ------------------------------------- |
+| `style_root` | `"bold red"` | The style used when the user is root. |
+| `style_user` | `"bold yellow"` | The style used for non-root users. |
+| `show_always` | `false` | Always shows the `username` module. |
+| `disabled` | `false` | Disables the `username` module. |
+
+### Example
+
+```toml
+# ~/.config/starship.toml
+
+[username]
+disabled = true
+```
+
+## 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
+
+::: tip
+
+Multiple custom modules can be defined by using a `.`.
+
+:::
+
+::: tip
+
+The order in which custom modules are shown can be individually set by setting `custom.foo` in `prompt_order`. By default, the `custom` module will simply show all custom modules in the order they were defined.
+
+:::
+
+### Options
+
+| Variable | Default | Description |
+| ------------- | ------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
+| `command` | | The command whose output should be printed. |
+| `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` | | The path to the shell to use to execute the command. If unset, it will fallback to STARSHIP_SHELL and then to "sh". |
+| `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"` | The style for the module. |
+| `prefix` | `""` | Prefix to display immediately before the command output. |
+| `suffix` | `""` | Suffix to display immediately after the command output. |
+| `disabled` | `false` | Disables this `custom` module. |
+
+### Example
+
+```toml
+# ~/.config/starship.toml
+
+[custom.foo]
+command = "echo foo" # shows output of command
+files = ["foo"] # can specify filters
+when = """ test "$HOME" == "$PWD" """
+prefix = " transcending "
+```
diff --git a/docs/pt-BR/faq/README.md b/docs/pt-BR/faq/README.md
new file mode 100644
index 00000000..bc758c89
--- /dev/null
+++ b/docs/pt-BR/faq/README.md
@@ -0,0 +1,53 @@
+# 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**: [Fira Code](https://github.com/tonsky/FiraCode)
+- **Shell**: [Fish Shell](https://fishshell.com/)
+ - **Configuration**: [matchai's Dotfiles](https://github.com/matchai/dotfiles/blob/master/.config/fish/config.fish)
+ - **Prompt**: [Starship](https://starship.rs/)
+
+## Do `prompt_order` 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 prompt_order
+- Newly created modules will be added to the prompt as Starship is updated
+
+## The docs say Starship is cross-shell, but it doesn't support X shell. Why?
+
+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
+curl -fsSL https://starship.rs/install.sh | bash -s -- --platform unknown-linux-musl
+```
diff --git a/docs/pt-BR/guide/README.md b/docs/pt-BR/guide/README.md
new file mode 100644
index 00000000..88e7a57b
--- /dev/null
+++ b/docs/pt-BR/guide/README.md
@@ -0,0 +1,270 @@
+
+
+
+
+
+
+
+**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.
+
+
+
+
+
+## 🚀 Installation
+
+### Prerequisites
+
+- A [Powerline font](https://github.com/powerline/fonts) installed and enabled in your terminal (for example, try [Fira Code](https://github.com/tonsky/FiraCode)).
+
+### Getting Started
+
+1. Install the **starship** binary:
+
+
+ #### Install Latest Version
+
+
+ ##### From prebuilt binary, with Shell:
+
+ ```sh
+ curl -fsSL https://starship.rs/install.sh | bash
+ ```
+
+
+ ##### From source on [crates.io](https://crates.io/):
+
+ ```sh
+ cargo install starship
+ ```
+
+
+ #### Install via Package Manager
+
+
+ ##### With [Homebrew](https://brew.sh/):
+
+ ```sh
+ brew install starship
+ ```
+
+
+ ##### With [Scoop](https://scoop.sh):
+
+ ```powershell
+ scoop install starship
+ ```
+
+1. 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
+
+ Add the following to the end of `~\Documents\PowerShell\Microsoft.PowerShell_profile.ps1` (or `~/.config/powershell/Microsoft.PowerShell_profile.ps1` on -Nix):
+
+ ```sh
+ Invoke-Expression (&starship init powershell)
+ ```
+
+
+ #### Ion
+
+ Add the following to the end of `~/.config/ion/initrc`:
+
+ ```sh
+ # ~/.config/ion/initrc
+
+ eval $(starship init ion)
+ ```
+
+## 🤝 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 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](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.
+
+
+
+### Quick Install
+
+1. Install the **starship** binary:
+
+
+ #### Install Latest Version
+
+ With Shell:
+
+ ```sh
+ curl -fsSL https://starship.rs/install.sh | bash
+ ```
+
+
+ #### Install via Package Manager
+
+ With [Homebrew](https://brew.sh/):
+
+ ```sh
+ brew install starship
+ ```
+
+ With [Scoop](https://scoop.sh):
+
+ ```powershell
+ scoop install starship
+ ```
+
+1. 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
+
+ Add the following to the end of `~\Documents\PowerShell\Microsoft.PowerShell_profile.ps1` (or `~/.config/powershell/Microsoft.PowerShell_profile.ps1` on -Nix):
+
+ ```sh
+ # ~\Documents\PowerShell\Profile.ps1
+
+ Invoke-Expression (&starship init powershell)
+ ```
+
+
+ #### Ion
+
+ Add the following to the end of `~/.config/ion/initrc`:
+
+ ```sh
+ # ~/.config/ion/initrc
+
+ eval $(starship init ion)
+ ```
diff --git a/docs/pt-PT/advanced-config/README.md b/docs/pt-PT/advanced-config/README.md
new file mode 100644
index 00000000..d5d27031
--- /dev/null
+++ b/docs/pt-PT/advanced-config/README.md
@@ -0,0 +1,84 @@
+# Advanced Configuration
+
+While Starship is a versatile shell, sometimes you need to do more than edit `starship.toml` to get it to do certain things. This page details some of the more advanced configuration techniques used in starship.
+
+::: warning
+
+The configurations in this section are subject to change in future releases of Starship.
+
+:::
+
+## Custom pre-prompt and pre-execution Commands in Bash
+
+Bash does not have a formal preexec/precmd framework like most other shells. Because of this, it is difficult to provide fully customizable hooks in `bash`. However, Starship does give you limited ability to insert your own functions into the prompt-rendering procedure:
+
+- To run a custom function right before the prompt is drawn, define a new function and then assign its name to `starship_precmd_user_func`. For example, to draw a rocket before the prompt, you would do
+
+```bash
+function blastoff(){
+ echo "🚀"
+}
+starship_precmd_user_func="blastoff"
+```
+
+- To run a custom function right before a command runs, you can use the [`DEBUG` trap mechanism](https://jichu4n.com/posts/debug-trap-and-prompt_command-in-bash/). However, you **must** trap the DEBUG signal *before* initializing Starship! Starship can preserve the value of the DEBUG trap, but if the trap is overwritten after starship starts up, some functionality will break.
+
+```bash
+function blastoff(){
+ echo "🚀"
+}
+trap blastoff DEBUG # Trap DEBUG *before* running starship
+eval $(starship init bash)
+```
+
+## Change Window Title
+
+Some shell prompts will automatically change the window title for you (e.g. to reflect your working directory). Fish even does it by default. Starship does not do this, but it's fairly straightforward to add this functionality to `bash` or `zsh`.
+
+First, define a window title change function (identical in bash and zsh):
+
+```bash
+function set_win_title(){
+ echo -ne "\033]0; YOUR_WINDOW_TITLE_HERE \007"
+}
+```
+
+You can use variables to customize this title (`$USER`, `$HOSTNAME`, and `$PWD` are popular choices).
+
+In `bash`, set this function to be the precmd starship function:
+
+```bash
+starship_precmd_user_func="set_win_title"
+```
+
+In `zsh`, add this to the `precmd_functions` array:
+
+```bash
+precmd_functions+=(set_win_title)
+```
+
+If you like the result, add these lines to your shell configuration file (`~/.bashrc` or `~/.zsrhc`) to make it permanent.
+
+## Style Strings
+
+Style strings are a list of words, separated by whitespace. The words are not case sensitive (i.e. `bold` and `BoLd` are considered the same string). Each word can be one of the following:
+
+ - `bold`
+ - `underline`
+ - `dimmed`
+ - `bg:`
+ - `fg:`
+ - ``
+ - `none`
+
+where `` is a color specifier (discussed below). `fg:` and `` currently do the same thing , though this may change in the future. The order of words in the string does not matter.
+
+The `none` token overrides all other tokens in a string, so that e.g. `fg:red none fg:blue` will still create a string with no styling. It may become an error to use `none` in conjunction with other tokens in the future.
+
+A color specifier can be one of the following:
+
+ - One of the standard terminal colors: `black`, `red`, `green`, `blue`, `yellow`, `purple`, `cyan`, `white`. You can optionally prefix these with `bright-` to get the bright version (e.g. `bright-white`).
+ - A `#` followed by a six-digit hexadecimal number. This specifies an [RGB color hex code](https://www.w3schools.com/colors/colors_hexadecimal.asp).
+ - A number between 0-255. This specifies an [8-bit ANSI Color Code](https://i.stack.imgur.com/KTSQa.png).
+
+If multiple colors are specified for foreground/background, the last one in the string will take priority.
diff --git a/docs/pt-PT/config/README.md b/docs/pt-PT/config/README.md
new file mode 100644
index 00000000..c4bef59c
--- /dev/null
+++ b/docs/pt-PT/config/README.md
@@ -0,0 +1,1302 @@
+# Configuration
+
+::: tip
+
+🔥 Configuration is currently being worked on. Many new configuration options will be available in coming releases.
+
+:::
+
+To get started configuring starship, create the following file: `~/.config/starship.toml`.
+
+```sh
+$ mkdir -p ~/.config && touch ~/.config/starship.toml
+```
+
+All configuration for starship is done in this [TOML](https://github.com/toml-lang/toml) file:
+
+```toml
+# Don't print a new line at the start of the prompt
+add_newline = false
+
+# Replace the "❯" symbol in the prompt with "➜"
+[character] # The name of the module we are configuring is "character"
+symbol = "➜" # The "symbol" segment is being set to "➜"
+
+# Disable the package module, hiding it from the prompt completely
+[package]
+disabled = true
+```
+
+You can change default `starship.toml` file location with `STARSHIP_CONFIG` environment variable:
+```sh
+export STARSHIP_CONFIG=~/.starship
+```
+
+### Terminology
+
+**Module**: A component in the prompt giving information based on contextual information from your OS. For example, the "nodejs" module shows the version of NodeJS that is currently installed on your computer, if your current directory is a NodeJS project.
+
+**Segment**: Smaller sub-components that compose a module. For example, the "symbol" segment in the "nodejs" module contains the character that is shown before the version number (⬢ by default).
+
+Here is the representation of the node module. In the following example, "symbol" and "version" are segments within it. Every module also has a prefix and suffix that are the default terminal color.
+
+```
+[prefix] [symbol] [version] [suffix]
+ "via " "⬢" "v10.4.1" ""
+```
+
+### Style Strings
+
+Most modules in starship allow you to configure their display styles. This is done with an entry (usually called `style`) which is a string specifying the configuration. Here are some examples of style strings along with what they do. For details on the full syntax, consult the [advanced config guide](/advanced-config/).
+
+- `"fg:green bg:blue"` sets green text on a blue background
+- `"bg:blue fg:bright-green"` sets bright green text on a blue background
+- `"bold fg:27"` sets bold text with [ANSI color](https://i.stack.imgur.com/KTSQa.png) 27
+- `"underline bg:#bf5700"` sets underlined text on a burnt orange background
+- `"bold italic fg:purple"` sets bold italic purple text
+- `""` explicitly disables all styling
+
+Note that what styling looks like will be controlled by your terminal emulator. For example, some terminal emulators will brighten the colors instead of bolding text, and some color themes use the same values for the normal and bright colors. Also, to get italic text, your terminal must support italics.
+
+## Prompt
+
+This is the list of prompt-wide configuration options.
+
+### Options
+
+| Variable | Default | Description |
+| -------------- | ----------------------------- | ------------------------------------------------------ |
+| `add_newline` | `true` | Add a new line before the start of the prompt. |
+| `prompt_order` | [link](#default-prompt-order) | Configure the order in which the prompt module occurs. |
+| `scan_timeout` | `30` | Timeout for starship to scan files (in milliseconds). |
+
+### Example
+
+```toml
+# ~/.config/starship.toml
+
+# Disable the newline at the start of the prompt
+add_newline = false
+# Overwrite a default_prompt_order and use custom prompt_order
+prompt_order=["rust","line_break","package","line_break","character"]
+# Wait 10 milliseconds for starship to check files under the current directory.
+scan_timeout = 10
+```
+
+### Default Prompt Order
+
+The default `prompt_order` is used to define the order in which modules are shown in the prompt, if empty or no `prompt_order` is provided. The default is as shown:
+
+```toml
+prompt_order = [
+ "username",
+ "hostname",
+ "kubernetes",
+ "directory",
+ "git_branch",
+ "git_commit",
+ "git_state",
+ "git_status",
+ "hg_branch",
+ "docker_context",
+ "package",
+ "dotnet",
+ "elixir",
+ "elm",
+ "erlang",
+ "golang",
+ "haskell",
+ "java",
+ "julia",
+ "nodejs",
+ "php",
+ "python",
+ "ruby",
+ "rust",
+ "terraform",
+ "nix_shell",
+ "conda",
+ "memory_usage",
+ "aws",
+ "env_var",
+ "crystal",
+ "cmd_duration",
+ "custom",
+ "line_break",
+ "jobs",
+ "battery",
+ "time",
+ "character",
+]
+```
+
+## AWS
+
+The `aws` module shows the current AWS region and profile. This is based on `AWS_REGION`, `AWS_DEFAULT_REGION`, and `AWS_PROFILE` env var with `~/.aws/config` file.
+
+When using [aws-vault](https://github.com/99designs/aws-vault) the profile is read from the `AWS_VAULT` env var.
+
+### Options
+
+| Variable | Default | Description |
+| ----------------- | --------------- | --------------------------------------------------------------------------- |
+| `symbol` | `"☁️ "` | The symbol used before displaying the current AWS profile. |
+| `displayed_items` | `all` | Choose which item to display. Possible values: [`all`, `profile`, `region`] |
+| `region_aliases` | | Table of region aliases to display in addition to the AWS name. |
+| `style` | `"bold yellow"` | The style for the module. |
+| `disabled` | `false` | Disables the `AWS` module. |
+
+### Example
+
+```toml
+# ~/.config/starship.toml
+
+[aws]
+style = "bold blue"
+symbol = "🅰 "
+displayed_items = "region"
+[aws.region_aliases]
+ap-southeast-2 = "au"
+us-east-1 = "va"
+```
+
+## Battery
+
+The `battery` module shows how charged the device's battery is and its current charging status. The module is only visible when the device's battery is below 10%.
+
+### Options
+
+| Variable | Default | Description |
+| -------------------- | ------------------------ | ------------------------------------------------- |
+| `full_symbol` | `"•"` | The symbol shown when the battery is full. |
+| `charging_symbol` | `"⇡"` | The symbol shown when the battery is charging. |
+| `discharging_symbol` | `"⇣"` | The symbol shown when the battery is discharging. |
+| `display` | [link](#battery-display) | Display threshold and style for the module. |
+| `disabled` | `false` | Disables the `battery` module. |
+
+
+There are also options for some uncommon battery states.
+
+| Variable | Description |
+| ---------------- | --------------------------------------------------- |
+| `unknown_symbol` | The symbol shown when the battery state is unknown. |
+| `empty_symbol` | The symbol shown when the battery state is empty. |
+
+Note: Battery indicator will be hidden if the status is `unknown` or `empty` unless you specify the option in the config.
+
+
+
+### Example
+
+```toml
+# ~/.config/starship.toml
+
+[battery]
+full_symbol = "🔋"
+charging_symbol = "⚡️"
+discharging_symbol = "💀"
+```
+
+### Battery Display
+
+The `display` configuration option is used to define when the battery indicator should be shown (threshold) and what it looks like (style). If no `display` is provided. The default is as shown:
+
+```toml
+[[battery.display]]
+threshold = 10
+style = "bold red"
+```
+
+#### Options
+
+The `display` option is an array of the following table.
+
+| Variable | Description |
+| ----------- | ----------------------------------------------- |
+| `threshold` | The upper bound for the display option. |
+| `style` | The style used if the display option is in use. |
+
+#### Example
+
+```toml
+[[battery.display]] # "bold red" style when capacity is between 0% and 10%
+threshold = 10
+style = "bold red"
+
+[[battery.display]] # "bold yellow" style when capacity is between 10% and 30%
+threshold = 30
+style = "bold yellow"
+
+# when capacity is over 30%, the battery indicator will not be displayed
+
+```
+
+## Character
+
+The `character` module shows a character (usually an arrow) beside where the text is entered in your terminal.
+
+The character will tell you whether the last command was successful or not. It can do this in two ways: by changing color (red/green) or by changing its shape (❯/✖). The latter will only be done if `use_symbol_for_status` is set to `true`.
+
+### Options
+
+| Variable | Default | Description |
+| ----------------------- | -------------- | ----------------------------------------------------------------------------------- |
+| `symbol` | `"❯"` | The symbol used before the text input in the prompt. |
+| `error_symbol` | `"✖"` | The symbol used before text input if the previous command failed. |
+| `use_symbol_for_status` | `false` | Indicate error status by changing the symbol. |
+| `vicmd_symbol` | `"❮"` | The symbol used before the text input in the prompt if shell is in vim normal mode. |
+| `style_success` | `"bold green"` | The style used if the last command was successful. |
+| `style_failure` | `"bold red"` | The style used if the last command failed. |
+| `disabled` | `false` | Disables the `character` module. |
+
+### Example
+
+```toml
+# ~/.config/starship.toml
+
+[character]
+symbol = "➜"
+error_symbol = "✗"
+use_symbol_for_status = true
+```
+
+## Command Duration
+
+The `cmd_duration` module shows how long the last command took to execute. The module will be shown only if the command took longer than two seconds, or the `min_time` config value, if it exists.
+
+::: warning Do not hook the DEBUG trap in Bash
+
+If you are running Starship in `bash`, do not hook the `DEBUG` trap after running `eval $(starship init $0)`, or this module **will** break.
+
+:::
+
+Bash users who need preexec-like functionality can use [rcaloras's bash_preexec framework](https://github.com/rcaloras/bash-preexec). Simply define the arrays `preexec_functions` and `precmd_functions` before running `eval $(starship init $0)`, and then proceed as normal.
+
+### Options
+
+| Variable | Default | Description |
+| ------------------- | --------------- | ---------------------------------------------------------- |
+| `min_time` | `2_000` | Shortest duration to show time for (in milliseconds). |
+| `show_milliseconds` | `false` | Show milliseconds in addition to seconds for the duration. |
+| `prefix` | `took` | Prefix to display immediately before the command duration. |
+| `style` | `"bold yellow"` | The style for the module. |
+| `disabled` | `false` | Disables the `cmd_duration` module. |
+
+### Example
+
+```toml
+# ~/.config/starship.toml
+
+[cmd_duration]
+min_time = 500
+prefix = "underwent "
+```
+
+## Conda
+
+The `conda` module shows the current conda environment, if `$CONDA_DEFAULT_ENV` is set.
+
+::: tip
+
+This does not suppress conda's own prompt modifier, you may want to run `conda config --set changeps1 False`.
+
+:::
+
+### Options
+
+| Variable | Default | Description |
+| ------------------- | -------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `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` | `"C "` | The symbol used before the environment name. |
+| `style` | `"bold green"` | The style for the module. |
+| `disabled` | `false` | Disables the `conda` module. |
+
+### Example
+
+```toml
+# ~/.config/starship.toml
+
+[conda]
+style = "dimmed green"
+```
+
+## Crystal
+
+The `crystal` module shows the currently installed version of Crystal. 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
+
+### Options
+
+| Variable | Default | Description |
+| ---------- | ------------ | --------------------------------------------------------- |
+| `symbol` | `"🔮 "` | The symbol used before displaying the version of crystal. |
+| `style` | `"bold red"` | The style for the module. |
+| `disabled` | `false` | Disables the `crystal` module. |
+
+### Example
+
+```toml
+# ~/.config/starship.toml
+
+[crystal]
+symbol = "✨ "
+style = "bold blue"
+```
+
+## 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`.
+
+### Options
+
+| Variable | Default | Description |
+| ------------------- | ------------- | -------------------------------------------------------------------------------- |
+| `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. |
+| `prefix` | `"in "` | Prefix to display immediately before the directory. |
+| `style` | `"bold cyan"` | The style for the module. |
+| `disabled` | `false` | Disables the `directory` module. |
+
+
+This module has a few advanced configuration options that control how the directory is displayed.
+
+| Variable | Default | Description |
+| --------------------------- | ------- | ---------------------------------------------------------------------------------------- |
+| `fish_style_pwd_dir_length` | `0` | The number of characters to use when applying fish shell pwd path logic. |
+| `use_logical_path` | `true` | Displays the logical path provided by the shell (`PWD`) instead of the path from the OS. |
+
+`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`.
+
+
+
+### Example
+
+```toml
+# ~/.config/starship.toml
+
+[directory]
+truncation_length = 8
+```
+
+## 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`.
+
+### Options
+
+| Variable | Default | Description |
+| ----------------- | ------------- | --------------------------------------------------------------------------------------- |
+| `symbol` | `"🐳 "` | The symbol used before displaying the Docker context . |
+| `only_with_files` | `false` | Only show when there's a `docker-compose.yml` or `Dockerfile` in the current directory. |
+| `style` | `"bold blue"` | The style for the module. |
+| `disabled` | `true` | Disables the `docker_context` module. |
+
+### Example
+
+```toml
+# ~/.config/starship.toml
+
+[docker_context]
+symbol = "🐋 "
+```
+
+## Dotnet
+
+The `dotnet` module shows the relevant version of the .NET Core SDK for the current directory. If the SDK has been pinned in the current directory, the pinned version is shown. Otherwise the module shows the latest installed version of the SDK.
+
+This module will only be shown in your prompt when one of the following files are present in the current directory: `global.json`, `project.json`, `*.sln`, `*.csproj`, `*.fsproj`, `*.xproj`. You'll also need the .NET Core command-line tools 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.
+
+### Options
+
+| Variable | Default | Description |
+| ----------- | ------------- | -------------------------------------------------------- |
+| `symbol` | `"•NET "` | The symbol used before displaying the version of dotnet. |
+| `heuristic` | `true` | Use faster version detection to keep starship snappy. |
+| `style` | `"bold blue"` | The style for the module. |
+| `disabled` | `false` | Disables the `dotnet` module. |
+
+### Example
+
+```toml
+# ~/.config/starship.toml
+
+[dotnet]
+symbol = "🥅 "
+style = "green"
+heuristic = false
+```
+
+## Elixir
+
+The `elixir` module shows the currently installed version of Elixir and Erlang/OTP. The module will be shown if any of the following conditions are met:
+
+- The current directory contains a `mix.exs` file.
+
+### Options
+
+| Variable | Default | Description |
+| ---------- | ------- | --------------------------------------------------------------- |
+| `symbol` | `"💧 "` | The symbol used before displaying the version of Elixir/Erlang. |
+| `disabled` | `false` | Disables the `elixir` module. |
+
+### Example
+
+```toml
+# ~/.config/starship.toml
+
+[elixir]
+symbol = "🔮 "
+```
+
+## Elm
+
+The `elm` module shows the currently installed version of Elm. 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
+
+### Options
+
+| Variable | Default | Description |
+| ---------- | ------------- | ----------------------------------------------------- |
+| `symbol` | `"🌳 "` | The symbol used before displaying the version of Elm. |
+| `style` | `"bold cyan"` | The style for the module. |
+| `disabled` | `false` | Disables the `elm` module. |
+
+
+### Example
+
+```toml
+# ~/.config/starship.toml
+
+[elm]
+symbol = " "
+```
+
+## Erlang
+
+The `erlang` module shows the currently installed version of Erlang/OTP. 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.
+
+### Options
+
+| Variable | Default | Description |
+| ---------- | ------- | -------------------------------------------------------- |
+| `symbol` | `"🖧 "` | The symbol used before displaying the version of Erlang. |
+| `disabled` | `false` | Disables the `erlang` module. |
+
+### Example
+
+```toml
+# ~/.config/starship.toml
+
+[erlang]
+symbol = "e "
+```
+## Environment Variable
+
+The `env_var` module displays the current value of a selected environment variable. 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
+
+### Options
+
+| Variable | Default | Description |
+| ---------- | ---------------- | ---------------------------------------------------------------------------- |
+| `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. |
+| `prefix` | `""` | Prefix to display immediately before the variable value. |
+| `suffix` | `""` | Suffix to display immediately after the variable value. |
+| `style` | `"dimmed black"` | The style for the module. |
+| `disabled` | `false` | Disables the `env_var` module. |
+
+### Example
+
+```toml
+# ~/.config/starship.toml
+
+[env_var]
+variable = "SHELL"
+default = "unknown shell"
+```
+
+## Git Branch
+
+The `git_branch` module shows the active branch of the repo in your current directory.
+
+### Options
+
+| Variable | Default | Description |
+| ------------------- | --------------- | ------------------------------------------------------------------------------------- |
+| `symbol` | `" "` | The symbol used before the branch name of the repo in your current directory. |
+| `truncation_length` | `2^63 - 1` | Truncates a git branch to X graphemes |
+| `truncation_symbol` | `"…"` | The symbol used to indicate a branch name was truncated. You can use "" for no symbol |
+| `style` | `"bold purple"` | The style for the module. |
+| `disabled` | `false` | Disables the `git_branch` module. |
+
+### Example
+
+```toml
+# ~/.config/starship.toml
+
+[git_branch]
+symbol = "🌱 "
+truncation_length = 4
+truncation_symbol = ""
+```
+
+## Git Commit
+
+The `git_commit` module shows the current commit hash of the repo in your current directory.
+
+### Options
+
+| Variable | Default | Description |
+| -------------------- | -------------- | ----------------------------------------------------- |
+| `commit_hash_length` | `7` | The length of the displayed git commit hash. |
+| `prefix` | `"("` | Prefix to display immediately before git commit. |
+| `suffix` | `")"` | Suffix to display immediately after git commit. |
+| `style` | `"bold green"` | The style for the module. |
+| `only_detached` | `true` | Only show git commit hash when in detached HEAD state |
+| `disabled` | `false` | Disables the `git_commit` module. |
+
+### Example
+
+```toml
+# ~/.config/starship.toml
+
+[git_commit]
+commit_hash_length = 4
+```
+
+## 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.
+
+### Options
+
+| Variable | Default | Description |
+| ------------------ | ------------------ | ---------------------------------------------------------------------------------------------------------------- |
+| `rebase` | `"REBASING"` | The text displayed when a `rebase` is in progress. |
+| `merge` | `"MERGING"` | The text displayed when a `merge` is in progress. |
+| `revert` | `"REVERTING"` | The text displayed when a `revert` is in progress. |
+| `cherry_pick` | `"CHERRY-PICKING"` | The text displayed when a `cherry-pick` is in progress. |
+| `bisect` | `"BISECTING"` | The text displayed when a `bisect` is in progress. |
+| `am` | `"AM"` | The text displayed when an `apply-mailbox` (`git am`) is in progress. |
+| `am_or_rebase` | `"AM/REBASE"` | The text displayed when an ambiguous `apply-mailbox` or `rebase` is in progress. |
+| `progress_divider` | `"/"` | The symbol or text which will separate the current and total progress amounts. (e.g., `" of "`, for `"3 of 10"`) |
+| `style` | `"bold yellow"` | The style for the module. |
+| `disabled` | `false` | Disables the `git_state` module. |
+
+### Example
+
+```toml
+# ~/.config/starship.toml
+
+[git_state]
+progress_divider = " of "
+cherry_pick = "🍒 PICKING"
+```
+
+## Git Status
+
+The `git_status` module shows symbols representing the state of the repo in your current directory.
+
+### Options
+
+| Variable | Default | Description |
+| ------------------ | -------------------------- | ------------------------------------------------------- |
+| `conflicted` | `"="` | This branch has merge conflicts. |
+| `conflicted_count` | [link](#git-status-counts) | Show and style the number of conflicts. |
+| `ahead` | `"⇡"` | This branch is ahead of the branch being tracked. |
+| `behind` | `"⇣"` | This branch is behind of the branch being tracked. |
+| `diverged` | `"⇕"` | This branch has diverged from the branch being tracked. |
+| `untracked` | `"?"` | There are untracked files in the working directory. |
+| `untracked_count` | [link](#git-status-counts) | Show and style the number of untracked files. |
+| `stashed` | `"$"` | A stash exists for the local repository. |
+| `stashed_count` | [link](#git-status-counts) | Show and style the number of stashes. |
+| `modified` | `"!"` | There are file modifications in the working directory. |
+| `modified_count` | [link](#git-status-counts) | Show and style the number of modified files. |
+| `staged` | `"+"` | A new file has been added to the staging area. |
+| `staged_count` | [link](#git-status-counts) | Show and style the number of files staged files. |
+| `renamed` | `"»"` | A renamed file has been added to the staging area. |
+| `renamed_count` | [link](#git-status-counts) | Show and style the number of renamed files. |
+| `deleted` | `"✘"` | A file's deletion has been added to the staging area. |
+| `deleted_count` | [link](#git-status-counts) | Show and style the number of deleted files. |
+| `show_sync_count` | `false` | Show ahead/behind count of the branch being tracked. |
+| `prefix` | `[` | Prefix to display immediately before git status. |
+| `suffix` | `]` | Suffix to display immediately after git status. |
+| `style` | `"bold red"` | The style for the module. |
+| `disabled` | `false` | Disables the `git_status` module. |
+
+#### Git Status Counts
+
+| Variable | Default | Description |
+| --------- | ------- | ------------------------------------------------------ |
+| `enabled` | `false` | Show the number of files |
+| `style` | | Optionally style the count differently than the module |
+
+### Example
+
+```toml
+# ~/.config/starship.toml
+
+[git_status]
+conflicted = "🏳"
+ahead = "🏎💨"
+behind = "😰"
+diverged = "😵"
+untracked = "🤷"
+stashed = "📦"
+modified = "📝"
+staged.value = "++"
+staged.style = "green"
+staged_count.enabled = true
+staged_count.style = "green"
+renamed = "👅"
+deleted = "🗑"
+```
+
+## Golang
+
+The `golang` module shows the currently installed version of Golang. 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
+
+### Options
+
+| Variable | Default | Description |
+| ---------- | ------------- | -------------------------------------------------------- |
+| `symbol` | `"🐹 "` | The symbol used before displaying the version of Golang. |
+| `style` | `"bold cyan"` | The style for the module. |
+| `disabled` | `false` | Disables the `golang` module. |
+
+### Example
+
+```toml
+# ~/.config/starship.toml
+
+[golang]
+symbol = "🏎💨 "
+```
+## Haskell
+
+The `haskell` module shows the currently installed version of Haskell Stack version. The module will be shown if any of the following conditions are met:
+
+- The current directory contains a `stack.yaml` file
+
+### Options
+
+| Variable | Default | Description |
+| ---------- | ------------ | --------------------------------------------------------- |
+| `symbol` | `"λ "` | The symbol used before displaying the version of Haskell. |
+| `style` | `"bold red"` | The style for the module. |
+| `disabled` | `false` | Disables the `haskell` module. |
+
+
+### Example
+
+```toml
+# ~/.config/starship.toml
+
+[haskell]
+symbol = " "
+```
+
+## Hostname
+
+The `hostname` module shows the system hostname.
+
+### Options
+
+| Variable | Default | Description |
+| ---------- | --------------------- | ------------------------------------------------------------------------------------------------------------------------------------ |
+| `ssh_only` | `true` | Only show hostname when connected to an SSH session. |
+| `prefix` | `""` | Prefix to display immediately before the hostname. |
+| `suffix` | `""` | Suffix to display immediately after the hostname. |
+| `trim_at` | `"."` | String that the hostname is cut off at, after the first match. `"."` will stop after the first dot. `""` will disable any truncation |
+| `style` | `"bold dimmed green"` | The style for the module. |
+| `disabled` | `false` | Disables the `hostname` module. |
+
+### Example
+
+```toml
+# ~/.config/starship.toml
+
+[hostname]
+ssh_only = false
+prefix = "⟪"
+suffix = "⟫"
+trim_at = ".companyname.com"
+disabled = false
+```
+
+## Java
+
+The `java` module shows the currently installed version of Java. 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` or `.java-version` file
+- The current directory contains a file with the `.java`, `.class`, `.gradle` or `.jar` extension
+
+### Options
+
+| Variable | Default | Description |
+| ---------- | -------------- | ------------------------------------------------------ |
+| `symbol` | `"☕ "` | The symbol used before displaying the version of Java. |
+| `style` | `"dimmed red"` | The style for the module. |
+| `disabled` | `false` | Disables the `java` module. |
+
+### Example
+
+```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 is more than 1 job, or more than the `threshold` config value, if it exists.
+
+### Options
+
+| Variable | Default | Description |
+| ----------- | ------------- | ----------------------------------------------------- |
+| `symbol` | `"✦"` | The symbol used before displaying the number of jobs. |
+| `threshold` | `1` | Show number of jobs if exceeded. |
+| `style` | `"bold blue"` | The style for the module. |
+| `disabled` | `false` | Disables the `jobs` module. |
+
+### Example
+
+```toml
+# ~/.config/starship.toml
+
+[jobs]
+symbol = "+ "
+threshold = 4
+```
+
+## Julia
+
+The `julia` module shows the currently installed version of Julia. 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
+
+### Options
+
+| Variable | Default | Description |
+| ---------- | --------------- | ------------------------------------------------------- |
+| `symbol` | `"ஃ "` | The symbol used before displaying the version of Julia. |
+| `style` | `"bold purple"` | The style for the module. |
+| `disabled` | `false` | Disables the `julia` module. |
+
+### Example
+
+```toml
+# ~/.config/starship.toml
+
+[julia]
+symbol = "∴ "
+```
+## Kubernetes
+
+Displays the current Kubernetes 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`.
+
+::: tip
+
+This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
+
+:::
+
+### Options
+
+| Variable | Default | Description |
+| ----------------- | ------------- | --------------------------------------------------- |
+| `symbol` | `"☸ "` | The symbol used before displaying the Cluster info. |
+| `context_aliases` | | Table of context aliases to display |
+| `style` | `"bold blue"` | The style for the module. |
+| `disabled` | `true` | Disables the `kubernetes` module |
+
+### Example
+
+```toml
+# ~/.config/starship.toml
+
+[kubernetes]
+symbol = "⛵ "
+style = "dimmed green"
+disabled = false
+[kubernetes.context_aliases]
+"dev.local.cluster.k8s" = "dev"
+```
+
+## Line Break
+
+The `line_break` module separates the prompt into two lines.
+
+### Options
+
+| Variable | Default | Description |
+| ---------- | ------- | ------------------------------------------------------------------ |
+| `disabled` | `false` | Disables the `line_break` module, making the prompt a single line. |
+
+### Example
+
+```toml
+# ~/.config/starship.toml
+
+[line_break]
+disabled = true
+```
+
+## Memory Usage
+
+The `memory_usage` module shows current system memory and swap usage.
+
+By default the swap usage is displayed if the total system swap is non-zero.
+
+::: tip
+
+This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
+
+:::
+
+### Options
+
+| Variable | Default | Description |
+| ----------------- | --------------------- | ------------------------------------------------------------- |
+| `show_percentage` | `false` | Display memory usage as a percentage of the available memory. |
+| `show_swap` | `true` | Display swap usage if total swap is non-zero. |
+| `threshold` | `75` | Hide the memory usage unless it exceeds this percentage. |
+| `symbol` | `"🐏 "` | The symbol used before displaying the memory usage. |
+| `separator` | `" | "` | The symbol or text that will seperate the ram and swap usage. |
+| `style` | `"bold dimmed white"` | The style for the module. |
+| `disabled` | `true` | Disables the `memory_usage` module. |
+
+### Example
+
+```toml
+# ~/.config/starship.toml
+
+[memory_usage]
+disabled = false
+show_percentage = true
+show_swap = true
+threshold = -1
+symbol = " "
+separator = "/"
+style = "bold dimmed green"
+```
+
+## Mercurial Branch
+
+The `hg_branch` module shows the active branch of the repo in your current directory.
+
+### Options
+
+| Variable | Default | Description |
+| ------------------- | --------------- | -------------------------------------------------------------------------------------------- |
+| `symbol` | `" "` | The symbol used before the hg bookmark or branch name of the repo in your current directory. |
+| `truncation_length` | `2^63 - 1` | Truncates the hg branch name to X graphemes |
+| `truncation_symbol` | `"…"` | The symbol used to indicate a branch name was truncated. |
+| `style` | `"bold purple"` | The style for the module. |
+| `disabled` | `true` | Disables the `hg_branch` module. |
+
+### Example
+
+```toml
+# ~/.config/starship.toml
+
+[hg_branch]
+symbol = "🌱 "
+truncation_length = 4
+truncation_symbol = ""
+```
+
+## Nix-shell
+
+The `nix_shell` module shows the nix-shell environment. The module will be shown when inside a nix-shell environment.
+
+### Options
+
+| Variable | Default | Description |
+| ------------ | ------------- | ------------------------------------------------- |
+| `use_name` | `false` | Display the name of the nix-shell. |
+| `impure_msg` | `"impure"` | Customize the "impure" msg. |
+| `pure_msg` | `"pure"` | Customize the "pure" msg. |
+| `symbol` | `"❄️ "` | The symbol used before displaying the shell name. |
+| `style` | `"bold blue"` | The style for the module. |
+| `disabled` | `false` | Disables the `nix_shell` module. |
+
+### Example
+
+```toml
+# ~/.config/starship.toml
+
+[nix_shell]
+disabled = true
+use_name = true
+impure_msg = "impure shell"
+pure_msg = "pure shell"
+symbol = "☃️ "
+```
+
+## NodeJS
+
+The `nodejs` module shows the currently installed version of NodeJS. 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 `node_modules` directory
+- The current directory contains a file with the `.js` extension
+
+### Options
+
+| Variable | Default | Description |
+| ---------- | -------------- | -------------------------------------------------------- |
+| `symbol` | `"⬢ "` | The symbol used before displaying the version of NodeJS. |
+| `style` | `"bold green"` | The style for the module. |
+| `disabled` | `false` | Disables the `nodejs` module. |
+
+### Example
+
+```toml
+# ~/.config/starship.toml
+
+[nodejs]
+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`, `cargo`, `poetry`, `composer`, `gradle`, `julia` and `mix` packages.
+
+- **npm** – The `npm` package version is extracted from the `package.json` present in the current directory
+- **cargo** – The `cargo` package version is extracted from the `Cargo.toml` present in the current directory
+- **poetry** – The `poetry` package version is extracted from the `pyproject.toml` present in the current directory
+- **composer** – The `composer` package version is extracted from the `composer.json` present in the current directory
+- **gradle** – The `gradle` package version is extracted from the `build.gradle` present
+- **julia** - The package version is extracted from the `Project.toml` present
+- **mix** - The `mix` package version is extracted from the `mix.exs` present
+
+> ⚠️ The version being shown is that of the package whose source code is in your current directory, not your package manager.
+
+### Options
+
+| Variable | Default | Description |
+| ----------------- | ------------ | ---------------------------------------------------------- |
+| `symbol` | `"📦 "` | The symbol used before displaying the version the package. |
+| `style` | `"bold red"` | The style for the module. |
+| `display_private` | `false` | Enable displaying version for packages marked as private. |
+| `disabled` | `false` | Disables the `package` module. |
+
+### Example
+
+```toml
+# ~/.config/starship.toml
+
+[package]
+symbol = "🎁 "
+```
+
+## PHP
+
+The `php` module shows the currently installed version of PHP. 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` file
+
+### Options
+
+| Variable | Default | Description |
+| ---------- | ------------ | ----------------------------------------------------- |
+| `symbol` | `"🐘 "` | The symbol used before displaying the version of PHP. |
+| `style` | `"bold red"` | The style for the module. |
+| `disabled` | `false` | Disables the `php` module. |
+
+### Example
+
+```toml
+# ~/.config/starship.toml
+
+[php]
+symbol = "🔹 "
+```
+
+## Python
+
+The `python` module shows the currently installed version of Python.
+
+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` and show the current Python virtual environment if one is activated.
+
+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 `requirements.txt` file
+- The current directory contains a `pyproject.toml` file
+- The current directory contains a file with the `.py` extension (and `scan_for_pyfiles` is true)
+- The current directory contains a `Pipfile` file
+- The current directory contains a `tox.ini` file
+- The current directory contains a `setup.py` file
+- The current directory contains a `__init__.py` file
+- A virtual environment is currently activated
+
+### Options
+
+| Variable | Default | Description |
+| -------------------- | --------------- | --------------------------------------------------------------------------- |
+| `symbol` | `"🐍 "` | The symbol used before displaying the version of Python. |
+| `pyenv_version_name` | `false` | Use pyenv to get Python version |
+| `pyenv_prefix` | `"pyenv "` | Prefix before pyenv version display (default display is `pyenv MY_VERSION`) |
+| `scan_for_pyfiles` | `true` | If false, Python files in the current directory will not show this module. |
+| `style` | `"bold yellow"` | The style for the module. |
+| `disabled` | `false` | Disables the `python` module. |
+
+### Example
+
+```toml
+# ~/.config/starship.toml
+
+[python]
+symbol = "👾 "
+pyenv_version_name = true
+pyenv_prefix = "foo "
+```
+
+## Ruby
+
+The `ruby` module shows the currently installed version of Ruby. 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
+
+### Options
+
+| Variable | Default | Description |
+| ---------- | ------------ | ------------------------------------------------------ |
+| `symbol` | `"💎 "` | The symbol used before displaying the version of Ruby. |
+| `style` | `"bold red"` | The style for the module. |
+| `disabled` | `false` | Disables the `ruby` module. |
+
+### Example
+
+```toml
+# ~/.config/starship.toml
+
+[ruby]
+symbol = "🔺 "
+```
+
+## Rust
+
+The `rust` module shows the currently installed version of Rust. 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
+
+### Options
+
+| Variable | Default | Description |
+| ---------- | ------------ | ------------------------------------------------------ |
+| `symbol` | `"🦀 "` | The symbol used before displaying the version of Rust. |
+| `style` | `"bold red"` | The style for the module. |
+| `disabled` | `false` | Disables the `rust` module. |
+
+### Example
+
+```toml
+# ~/.config/starship.toml
+
+[rust]
+symbol = "⚙️ "
+```
+
+## Singularity
+
+The `singularity` module shows the current singularity image, if inside a container and `$SINGULARITY_NAME` is set.
+
+### Options
+
+| Variable | Default | Description |
+| ---------- | -------------------- | ------------------------------------------------ |
+| `label` | `""` | Prefix before the image name display. |
+| `prefix` | `"["` | Prefix to display immediately before image name. |
+| `suffix` | `"]"` | Suffix to display immediately after image name. |
+| `symbol` | `""` | The symbol used before the image name. |
+| `style` | `"bold dimmed blue"` | The style for the module. |
+| `disabled` | `false` | Disables the `singularity` module. |
+
+### Example
+
+```toml
+# ~/.config/starship.toml
+
+[singularity]
+symbol = "📦 "
+```
+
+## Terraform
+
+The `terraform` module shows the currently selected terraform workspace and version. By default the terraform version is not shown, since this is slow on current versions of terraform when a lot of plugins are in use. 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` extension
+
+### Options
+
+| Variable | Default | Description |
+| -------------- | ------------ | ----------------------------------------------------------- |
+| `symbol` | `"💠 "` | The symbol used before displaying the terraform workspace. |
+| `show_version` | `false` | Shows the terraform version. Very slow on large workspaces. |
+| `style` | `"bold 105"` | The style for the module. |
+| `disabled` | `false` | Disables the `terraform` module. |
+
+### Example
+
+```toml
+# ~/.config/starship.toml
+
+[terraform]
+symbol = "🏎💨 "
+```
+
+## 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.
+
+::: tip
+
+This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
+
+:::
+
+### Options
+
+| Variable | Default | Description |
+| ----------------- | --------------- | ------------------------------------------------------------------------------------------------------------------- |
+| `use_12hr` | `false` | Enables 12 hour formatting |
+| `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. |
+
+If `use_12hr` is `true`, then `format` defaults to `"%r"`. Otherwise, it defaults to `"%T"`. Manually setting `format` will override the `use_12hr` setting.
+
+### Example
+
+```toml
+# ~/.config/starship.toml
+
+[time]
+disabled = false
+format = "🕙[ %T ]"
+utc_time_offset = "-5"
+```
+
+## 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
+
+### Options
+
+| Variable | Default | Description |
+| ------------- | --------------- | ------------------------------------- |
+| `style_root` | `"bold red"` | The style used when the user is root. |
+| `style_user` | `"bold yellow"` | The style used for non-root users. |
+| `show_always` | `false` | Always shows the `username` module. |
+| `disabled` | `false` | Disables the `username` module. |
+
+### Example
+
+```toml
+# ~/.config/starship.toml
+
+[username]
+disabled = true
+```
+
+## 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
+
+::: tip
+
+Multiple custom modules can be defined by using a `.`.
+
+:::
+
+::: tip
+
+The order in which custom modules are shown can be individually set by setting `custom.foo` in `prompt_order`. By default, the `custom` module will simply show all custom modules in the order they were defined.
+
+:::
+
+### Options
+
+| Variable | Default | Description |
+| ------------- | ------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
+| `command` | | The command whose output should be printed. |
+| `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` | | The path to the shell to use to execute the command. If unset, it will fallback to STARSHIP_SHELL and then to "sh". |
+| `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"` | The style for the module. |
+| `prefix` | `""` | Prefix to display immediately before the command output. |
+| `suffix` | `""` | Suffix to display immediately after the command output. |
+| `disabled` | `false` | Disables this `custom` module. |
+
+### Example
+
+```toml
+# ~/.config/starship.toml
+
+[custom.foo]
+command = "echo foo" # shows output of command
+files = ["foo"] # can specify filters
+when = """ test "$HOME" == "$PWD" """
+prefix = " transcending "
+```
diff --git a/docs/pt-PT/faq/README.md b/docs/pt-PT/faq/README.md
new file mode 100644
index 00000000..bc758c89
--- /dev/null
+++ b/docs/pt-PT/faq/README.md
@@ -0,0 +1,53 @@
+# 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**: [Fira Code](https://github.com/tonsky/FiraCode)
+- **Shell**: [Fish Shell](https://fishshell.com/)
+ - **Configuration**: [matchai's Dotfiles](https://github.com/matchai/dotfiles/blob/master/.config/fish/config.fish)
+ - **Prompt**: [Starship](https://starship.rs/)
+
+## Do `prompt_order` 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 prompt_order
+- Newly created modules will be added to the prompt as Starship is updated
+
+## The docs say Starship is cross-shell, but it doesn't support X shell. Why?
+
+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
+curl -fsSL https://starship.rs/install.sh | bash -s -- --platform unknown-linux-musl
+```
diff --git a/docs/pt-PT/guide/README.md b/docs/pt-PT/guide/README.md
new file mode 100644
index 00000000..88e7a57b
--- /dev/null
+++ b/docs/pt-PT/guide/README.md
@@ -0,0 +1,270 @@
+
+
+
+
+
+
+
+**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.
+
+
+
+
+
+## 🚀 Installation
+
+### Prerequisites
+
+- A [Powerline font](https://github.com/powerline/fonts) installed and enabled in your terminal (for example, try [Fira Code](https://github.com/tonsky/FiraCode)).
+
+### Getting Started
+
+1. Install the **starship** binary:
+
+
+ #### Install Latest Version
+
+
+ ##### From prebuilt binary, with Shell:
+
+ ```sh
+ curl -fsSL https://starship.rs/install.sh | bash
+ ```
+
+
+ ##### From source on [crates.io](https://crates.io/):
+
+ ```sh
+ cargo install starship
+ ```
+
+
+ #### Install via Package Manager
+
+
+ ##### With [Homebrew](https://brew.sh/):
+
+ ```sh
+ brew install starship
+ ```
+
+
+ ##### With [Scoop](https://scoop.sh):
+
+ ```powershell
+ scoop install starship
+ ```
+
+1. 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
+
+ Add the following to the end of `~\Documents\PowerShell\Microsoft.PowerShell_profile.ps1` (or `~/.config/powershell/Microsoft.PowerShell_profile.ps1` on -Nix):
+
+ ```sh
+ Invoke-Expression (&starship init powershell)
+ ```
+
+
+ #### Ion
+
+ Add the following to the end of `~/.config/ion/initrc`:
+
+ ```sh
+ # ~/.config/ion/initrc
+
+ eval $(starship init ion)
+ ```
+
+## 🤝 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 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](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.
+
+
@@ -115,6 +115,8 @@
Изучите документацию Starship ▶
+
+
## 🚀 Установка
### Требования
@@ -220,22 +222,22 @@
Если вы хотите помочь в создании Starship, пожалуйста, ознакомьтесь с нашим [Руководством по содействию](https://github.com/starship/starship/blob/master/CONTRIBUTING.md). Кроме того, заходите на наш [Discord сервер](https://discord.gg/8Jzqu3T) и поздоровайтесь. 👋
-### Code Contributors
+### Соавторы кода
-This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)].
+Этот проект существует благодаря всем тем, кто внес свой вклад. [[Внести вклад](CONTRIBUTING.md)].
-### Financial Contributors
+### Финансовые спонсоры
-Become a financial contributor and help us sustain our community. [[Contribute](https://opencollective.com/starship/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)]
+Поддержите этот проект вашей организацией. Ваш логотип будет отображаться здесь со ссылкой на ваш сайт. [[Внести вклад](https://opencollective.com/starship/contribute)]
@@ -250,7 +252,7 @@ Support this project with your organization. Your logo will show up here with a
## 💭 Вдохновления
-Please check out these previous works that helped inspire the creation of starship. 🙏
+Пожалуйста, ознакомьтесь с этими предыдущими работами, которые помогли вдохновить создание Starship. 🙏
- **[denysdovhan/spaceship-prompt](https://github.com/denysdovhan/spaceship-prompt)** - командная строка ZSH для астронавтов.
@@ -260,9 +262,9 @@ Please check out these previous works that helped inspire the creation of starsh
@@ -115,6 +115,8 @@
Explore the Starship docs ▶
+
+
## 🚀 安装
### 前置要求
@@ -250,7 +252,7 @@ Support this project with your organization. Your logo will show up here with a
## 💭该项目受以下项目启发
-Please check out these previous works that helped inspire the creation of starship. 🙏
+请参考这些曾经为 Starship 提供启发的工程。 🙏
- **[denysdovhan/spaceship-prompt](https://github.com/denysdovhan/spaceship-prompt)** - A ZSH prompt for astronauts.
diff --git a/docs/zh-CN/presets/README.md b/docs/zh-CN/presets/README.md
index 939cb319..e81167ed 100644
--- a/docs/zh-CN/presets/README.md
+++ b/docs/zh-CN/presets/README.md
@@ -26,21 +26,39 @@ discharging_symbol = ""
[conda]
symbol = " "
+[docker]
+symbol = " "
+
+[elixir]
+symbol = " "
+
+[elm]
+symbol = " "
+
[git_branch]
symbol = " "
[golang]
symbol = " "
+[haskell]
+symbol = " "
+
[hg_branch]
symbol = " "
[java]
symbol = " "
+[julia]
+symbol = " "
+
[memory_usage]
symbol = " "
+[nix_shell]
+symbol = " "
+
[nodejs]
symbol = " "
diff --git a/docs/zh-TW/config/README.md b/docs/zh-TW/config/README.md
index bf550873..6d1c60f5 100644
--- a/docs/zh-TW/config/README.md
+++ b/docs/zh-TW/config/README.md
@@ -103,6 +103,7 @@ prompt_order = [
"dotnet",
"elixir",
"elm",
+ "erlang",
"golang",
"haskell",
"java",
@@ -120,6 +121,7 @@ prompt_order = [
"env_var",
"crystal",
"cmd_duration",
+ "custom",
"line_break",
"jobs",
"battery",
@@ -482,6 +484,28 @@ The `elm` module shows the currently installed version of Elm. 這個模組在
symbol = " "
```
+## Erlang
+
+The `erlang` module shows the currently installed version of Erlang/OTP. 這個模組在下列其中一個條件達成時顯示:
+
+- The current directory contains a `rebar.config` file.
+- The current directory contains a `erlang.mk` file.
+
+### 選項
+
+| 變數 | 預設 | 說明 |
+| ---------- | ------- | -------------------------------------------------------- |
+| `symbol` | `"🖧 "` | The symbol used before displaying the version of Erlang. |
+| `disabled` | `false` | Disables the `erlang` module. |
+
+### 範例
+
+```toml
+# ~/.config/starship.toml
+
+[erlang]
+symbol = "e "
+```
## 環境變數
`env_var`模組顯示一個選擇的環境變數的現在數值。 這個模組只在下列條件其中之一達到時顯示:
@@ -681,7 +705,7 @@ symbol = "🏎💨 "
The `haskell` module shows the currently installed version of Haskell Stack version. 這個模組在下列其中一個條件達成時顯示:
-- 現在資料夾中包含一個 `stack.yaml` 檔案
+- 現在資料夾中含有一個 `stack.yaml` 檔案
### 選項
@@ -788,7 +812,7 @@ The `julia` module shows the currently installed version of Julia. 這個模組
| 變數 | 預設 | 說明 |
| ---------- | --------------- | ------------------------------------------------------- |
-| `symbol` | `"∴ "` | The symbol used before displaying the version of Julia. |
+| `symbol` | `"ஃ "` | The symbol used before displaying the version of Julia. |
| `style` | `"bold purple"` | 這個模組的風格。 |
| `disabled` | `false` | Disables the `julia` module. |
@@ -798,7 +822,7 @@ The `julia` module shows the currently installed version of Julia. 這個模組
# ~/.config/starship.toml
[julia]
-symbol = "👸 "
+symbol = "∴ "
```
## Kubernetes
@@ -921,13 +945,14 @@ truncation_symbol = ""
### 選項
-| 變數 | 預設 | 說明 |
-| ------------ | ------------ | ------------------ |
-| `use_name` | `false` | 顯示 nix-shell 的名稱。 |
-| `impure_msg` | `"impure"` | 自定義「impure」訊息。 |
-| `pure_msg` | `"pure"` | 自定義「pure」訊息。 |
-| `style` | `"bold red"` | 這個模組的風格。 |
-| `disabled` | `false` | 停用 `nix_shell` 模組。 |
+| 變數 | 預設 | 說明 |
+| ------------ | ------------- | ------------------------------------------------- |
+| `use_name` | `false` | 顯示 nix-shell 的名稱。 |
+| `impure_msg` | `"impure"` | 自定義「impure」訊息。 |
+| `pure_msg` | `"pure"` | 自定義「pure」訊息。 |
+| `symbol` | `"❄️ "` | The symbol used before displaying the shell name. |
+| `style` | `"bold blue"` | 這個模組的風格。 |
+| `disabled` | `false` | 停用 `nix_shell` 模組。 |
### 範例
@@ -939,6 +964,7 @@ disabled = true
use_name = true
impure_msg = "impure shell"
pure_msg = "pure shell"
+symbol = "☃️ "
```
## NodeJS
@@ -969,7 +995,7 @@ symbol = "🤖 "
## 套件版本
-The `package` 模組在現在資料夾是一個套件的儲藏庫時出現,並顯示他的現在版本。 The module currently supports `npm`, `cargo`, `poetry`, `composer`, and `gradle` packages.
+The `package` 模組在現在資料夾是一個套件的儲藏庫時出現,並顯示他的現在版本。 The module currently supports `npm`, `cargo`, `poetry`, `composer`, `gradle`, `julia` and `mix` packages.
- **npm** – `npm` 套件的版本是從現在資料夾中的 `package.json` 之中擷取出來的
- **cargo** – `cargo` 套件的版本是從現在資料夾中的 `Cargo.toml` 之中擷取出來的
@@ -977,16 +1003,18 @@ The `package` 模組在現在資料夾是一個套件的儲藏庫時出現,並
- **composer** – The `composer` package version is extracted from the `composer.json` present in the current directory
- **gradle** – The `gradle` package version is extracted from the `build.gradle` present
- **julia** - The package version is extracted from the `Project.toml` present
+- **mix** - The `mix` package version is extracted from the `mix.exs` present
> ⚠️ 顯示出來的版本是從你的現在資料夾之中擷取出來的,並非從套件管理員取得。
### 選項
-| 變數 | 預設 | 說明 |
-| ---------- | ------------ | ---------------- |
-| `symbol` | `"📦 "` | 顯示在套件的版本之前的符號。 |
-| `style` | `"bold red"` | 這個模組的風格。 |
-| `disabled` | `false` | 停用 `package` 模組。 |
+| 變數 | 預設 | 說明 |
+| ----------------- | ------------ | --------------------------------------------------------- |
+| `symbol` | `"📦 "` | 顯示在套件的版本之前的符號。 |
+| `style` | `"bold red"` | 這個模組的風格。 |
+| `display_private` | `false` | Enable displaying version for packages marked as private. |
+| `disabled` | `false` | 停用 `package` 模組。 |
### 範例
@@ -1001,7 +1029,7 @@ symbol = "🎁 "
The `php` module shows the currently installed version of PHP. 這個模組在下列其中一個條件達成時顯示:
-- 現在資料夾中含有一個 `composer.json` 檔案
+- 現在資料夾中包含一個 `composer.json` 檔案
- The current directory contains a `.php-version` file
- The current directory contains a `.php` file
@@ -1035,20 +1063,23 @@ symbol = "🔹 "
- 目前資料夾中有一個 `.python-version` 檔案
- 目前資料夾中有一個 `requirements.txt` 檔案
- 目前資料夾中有一個 `pyproject.toml` 檔案
-- 目前資料夾中有一個 `.py` 副檔名的檔案
+- The current directory contains a file with the `.py` extension (and `scan_for_pyfiles` is true)
- 目前資料夾中有一個 `Pipfile` 檔案
- 目前資料夾中有一個 `tox.ini` 檔案
+- 現在資料夾中包含一個 `setup.py` 檔案
+- The current directory contains a `__init__.py` file
- A virtual environment is currently activated
### 選項
-| 變數 | 預設 | 說明 |
-| -------------------- | --------------- | --------------------------------------------- |
-| `symbol` | `"🐍 "` | 顯示在 Python 版本之前的符號。 |
-| `pyenv_version_name` | `false` | 使用 pyenv 取得 Python 的版本。 |
-| `pyenv_prefix` | `"pyenv "` | 顯示在 pyenv 版本之前的前綴 (預設顯示是 `pyenv MY_VERSION`)。 |
-| `style` | `"bold yellow"` | 這個模組的風格。 |
-| `disabled` | `false` | 停用 `python` 模組。 |
+| 變數 | 預設 | 說明 |
+| -------------------- | --------------- | -------------------------------------------------------------------------- |
+| `symbol` | `"🐍 "` | 顯示在 Python 版本之前的符號。 |
+| `pyenv_version_name` | `false` | 使用 pyenv 取得 Python 的版本。 |
+| `pyenv_prefix` | `"pyenv "` | 顯示在 pyenv 版本之前的前綴 (預設顯示是 `pyenv MY_VERSION`)。 |
+| `scan_for_pyfiles` | `true` | If false, Python files in the current directory will not show this module. |
+| `style` | `"bold yellow"` | 這個模組的風格。 |
+| `disabled` | `false` | 停用 `python` 模組。 |
### 範例
@@ -1114,8 +1145,6 @@ symbol = "⚙️ "
The `singularity` module shows the current singularity image, if inside a container and `$SINGULARITY_NAME` is set.
-:::
-
### 選項
| 變數 | 預設 | 說明 |
@@ -1220,3 +1249,54 @@ utc_time_offset = "-5"
[username]
disabled = true
```
+
+## 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
+
+::: tip
+
+Multiple custom modules can be defined by using a `.`.
+
+:::
+
+::: tip
+
+The order in which custom modules are shown can be individually set by setting `custom.foo` in `prompt_order`. By default, the `custom` module will simply show all custom modules in the order they were defined.
+
+:::
+
+### 選項
+
+| 變數 | 預設 | 說明 |
+| ------------- | ------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
+| `command` | | The command whose output should be printed. |
+| `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` | | The path to the shell to use to execute the command. If unset, it will fallback to STARSHIP_SHELL and then to "sh". |
+| `說明` | `""` | 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"` | 這個模組的風格。 |
+| `prefix` | `""` | Prefix to display immediately before the command output. |
+| `suffix` | `""` | Suffix to display immediately after the command output. |
+| `disabled` | `false` | Disables this `custom` module. |
+
+### 範例
+
+```toml
+# ~/.config/starship.toml
+
+[custom.foo]
+command = "echo foo" # shows output of command
+files = ["foo"] # can specify filters
+when = """ test "$HOME" == "$PWD" """
+prefix = " transcending "
+```
diff --git a/docs/zh-TW/faq/README.md b/docs/zh-TW/faq/README.md
index 6d5674be..bc758c89 100644
--- a/docs/zh-TW/faq/README.md
+++ b/docs/zh-TW/faq/README.md
@@ -43,3 +43,11 @@ 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
+curl -fsSL https://starship.rs/install.sh | bash -s -- --platform unknown-linux-musl
+```
diff --git a/docs/zh-TW/guide/README.md b/docs/zh-TW/guide/README.md
index 1d5c4689..da6b08ed 100644
--- a/docs/zh-TW/guide/README.md
+++ b/docs/zh-TW/guide/README.md
@@ -30,11 +30,11 @@