| nombre del host |
computadora` | El nombre de host de la computadora |
| style\* | | Refleja el valor de la opción `style` |
| ssh_symbol | `'🌏 '` | El símbolo a representar cuando está conectado a la sesión SSH |
*: Esta variable solamente puede ser usada como parte de una cadena de caracteres de estilo
### Ejemplos
#### Mostrar siempre el nombre del host
```toml
# ~/.config/starship.toml
[hostname]
ssh_only = false
format = '[$ssh_symbol](bold blue) on [$hostname](bold red) '
trim_at = '.companyname.com'
disabled = false
```
#### Ocultar el nombre de host en sesiones remotas de tmux
```toml
# ~/.config/starship.toml
[hostname]
ssh_only = false
detect_env_vars = ['!TMUX', 'SSH_CONNECTION']
disabled = false
```
## Java
El módulo `java` muestra la versión instalada de [Java](https://www.oracle.com/java/). Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones:
- The current directory contains a `pom.xml`, `build.gradle.kts`, `build.sbt`, `.java-version`, `deps.edn`, `project.clj`, `build.boot`, or `.sdkmanrc` file
- El directorio actual contiene un archivo con la extensión `.java`, `.class`, `.gradle` o `.jar`, `.clj` o `.cljc`
### Opciones
| Opción | Predeterminado | Descripción |
| ------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
| `format` | `'via [${symbol}(${version} )]($style)'` | El formato del módulo. |
| `version_format` | `'v${raw}'` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
| `detect_extensions` | `['java', 'class', 'gradle', 'jar', 'cljs', 'cljc']` | Qué extensiones deberían activar este módulo. |
| `detect_files` | `['pom.xml', 'build.gradle.kts', 'build.sbt', '.java-version', 'deps.edn', 'project.clj', 'build.boot', '.sdkmanrc']` | Qué nombres de archivo deberían activar este módulo. |
| `detect_folders` | `[]` | Qué carpetas deberían activar estos módulos. |
| `symbol` | `'☕ '` | Una cadena de formato que representa el símbolo de Java |
| `style` | `'red dimmed'` | El estilo del módulo. |
| `disabled` | `false` | Deshabilita el módulo `java`. |
### Variables
| Variable | Ejemplo | Descripción |
| --------- | ------- | -------------------------------------- |
| version | `v14` | La versión de `java` |
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
*: Esta variable solamente puede ser usada como parte de una cadena de caracteres de estilo
### Ejemplo
```toml
# ~/.config/starship.toml
[java]
symbol = '🌟 '
```
## Trabajos
El módulo `jobs` muestra el número actual de tareas en ejecución. El módulo se mostrará sólo si hay tareas en segundo plano ejecutándose. El módulo mostrará el número de tareas ejecutados si hay al menos 2 tareas, o más del valor de configuración de `number_threshold`, si existe. El módulo mostrará un símbolo si hay al menos 1 tarea, o más del valor de configuración de `symbol_threshold`, si existe. Puedes establecer ambos valores a 0 para _siempre_ mostrar el símbolo y el número de tareas, incluso si hay 0 tareas en ejecución.
La funcionalidad por defecto es:
- 0 tareas -> No se muestra nada.
- 1 tarea -> `symbol` se muestra.
- 2 tareas o más -> `symbol` + `number` son mostrados.
::: warning
Este módulo no está soportado por tcsh y nu.
:::
::: warning
La opción `threshold` está obsoleta, pero si deseas usarla, el módulo mostrará el número de tareas en ejecución si hay más de 1 tarea, o más que el valor de configuración `threshold`, si existe. Si `threshold` se establece en 0, entonces el módulo también se mostrará cuando haya 0 tareas en ejecución.
:::
### Opciones
| Opción | Predeterminado | Descripción |
| ------------------ | ----------------------------- | ---------------------------------------------------------------------------------- |
| `threshold`* | `1` | Muestra el número de tareas si se exceden. |
| `symbol_threshold` | `1` | Muestra `symbol` si el conteo de tareas es al menos `symbol_threshold`. |
| `number_threshold` | `2` | Muestra el número de tareas si el conteo de tareas es al menos `symbol_threshold`. |
| `format` | `'[$symbol$number]($style) '` | El formato del módulo. |
| `symbol` | `'✦'` | La cadena utilizada para representar la variable `symbol`. |
| `style` | `'bold blue'` | El estilo del módulo. |
| `disabled` | `false` | Desactiva el módulo `jobs`. |
*: Esta opción está desaprobada, por favor utiliza las opciones `number_threshold` y `symbol_threshold` en su lugar.
### Variables
| Variable | Ejemplo | Descripción |
| --------- | ------- | -------------------------------------- |
| número | `1` | El número de tareas |
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
*: Esta variable solamente puede ser usada como parte de una cadena de caracteres de estilo
### Ejemplo
```toml
# ~/.config/starship.toml
[jobs]
symbol = '+ '
number_threshold = 4
symbol_threshold = 0
```
## Julia
El módulo `julia` muestra la versión instalada de [Julia](https://julialang.org/). Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones:
- El directorio actual contiene un archivo `Project.toml`
- El directorio actual contiene un archivo `Manifest.toml`
- El directorio actual contiene un archivo con la extensión `.jl`
### Opciones
| Opción | Predeterminado | Descripción |
| ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | El formato del módulo. |
| `version_format` | `'v${raw}'` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
| `detect_extensions` | `['jl']` | Qué extensiones deberían activar este módulo. |
| `detect_files` | `['Project.toml', 'Manifest.toml']` | Qué nombres de archivo deberían activar este módulo. |
| `detect_folders` | `[]` | Qué carpetas deberían activar estos módulos. |
| `symbol` | `'ஃ '` | Una cadena de formato que representa el símbolo de Julia. |
| `style` | `'bold purple'` | El estilo del módulo. |
| `disabled` | `false` | Deshabilita el módulo `julia`. |
### Variables
| Variable | Ejemplo | Descripción |
| --------- | -------- | -------------------------------------- |
| version | `v1.4.0` | La versión de `julia` |
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
*: Esta variable solamente puede ser usada como parte de una cadena de caracteres de estilo
### Ejemplo
```toml
# ~/.config/starship.toml
[julia]
symbol = '∴ '
```
## Kotlin
El módulo `kotlin` muestra la versión instalada de [Kotlin](https://kotlinlang.org/). Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones:
- El directorio actual contiene un archivo `.kt` o un `.kts`
### Opciones
| Opción | Predeterminado | Descripción |
| ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | El formato del módulo. |
| `version_format` | `'v${raw}'` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
| `detect_extensions` | `['kt', 'kts']` | Qué extensiones deberían activar este módulo. |
| `detect_files` | `[]` | Qué nombres de archivo deberían activar este módulo. |
| `detect_folders` | `[]` | Qué carpetas deberían activar estos módulos. |
| `symbol` | `'🅺 '` | Una cadena de formato que representa el símbolo de Kotlin. |
| `style` | `'bold blue'` | El estilo del módulo. |
| `kotlin_binary` | `'kotlin'` | Configura el binario kotlin que Starship ejecuta al obtener la versión. |
| `disabled` | `false` | Deshabilita el módulo `kotlin`. |
### Variables
| Variable | Ejemplo | Descripción |
| --------- | --------- | -------------------------------------- |
| version | `v1.4.21` | La versión de `kotlin` |
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
*: Esta variable solamente puede ser usada como parte de una cadena de caracteres de estilo
### Ejemplo
```toml
# ~/.config/starship.toml
[kotlin]
symbol = '🅺 '
```
```toml
# ~/.config/starship.toml
[kotlin]
# Utiliza el compilador binario Kotlink para obtener la versión instalada
kotlin_binary = 'kotlinc'
```
## Kubernetes
Muestra el nombre actual del [contexto de Kubernetes](https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/#context) y, si se establece, el espacio de nombres, el usuario y el clúster del archivo kubeconfig. El espacio de nombres necesita establecerse en el archivo kubeconfig, esto puede hacerse mediante `kubectl config set-context starship-context --namespace astronaut`. Similarly, the user and cluster can be set with `kubectl config set-context starship-context --user starship-user` and `kubectl config set-context starship-context --cluster starship-cluster`. Si se establece la variable de entorno `$KUBECONFIG`, el módulo usará eso si no usará el `~/.kube/config`.
::: tip
Este módulo está deshabilitado por defecto. Para activarlo, establece `disabled` como `false` en tu archivo de configuración.
When the module is enabled it will always be active, unless any of `detect_extensions`, `detect_files` or `detect_folders` have been set in which case the module will only be active in directories that match those conditions.
:::
### Opciones
::: warning
The `context_aliases` and `user_aliases` options are deprecated. Use `contexts` and the corresponding `context_alias` and `user_alias` options instead.
:::
| Opción | Predeterminado | Descripción |
| ------------------- | ---------------------------------------------------- | --------------------------------------------------------------------------- |
| `symbol` | `'☸ '` | Una cadena de formato que representa el símbolo mostrado antes del Cluster. |
| `format` | `'[$symbol$context( \($namespace\))]($style) in '` | El formato del módulo. |
| `style` | `'cyan bold'` | El estilo del módulo. |
| `context_aliases`* | `{}` | Tabla de alias de contexto a mostrar. |
| `user_aliases`* | `{}` | Table of user aliases to display. |
| `detect_extensions` | `[]` | Qué extensiones deberían activar este módulo. |
| `detect_files` | `[]` | Qué nombres de archivo deberían activar este módulo. |
| `detect_folders` | `[]` | Qué carpetas deberían activar estos módulos. |
| `contextos` | `[]` | Customized styles and symbols for specific contexts. |
| `disabled` | `true` | Desactiva el módulo `kubernetes`. |
*: This option is deprecated, please add `contexts` with the corresponding `context_alias` and `user_alias` options instead.
To customize the style of the module for specific environments, use the following configuration as part of the `contexts` list:
| Variable | Descripción |
| ----------------- | ---------------------------------------------------------------------------------------- |
| `context_pattern` | **Required** Regular expression to match current Kubernetes context name. |
| `user_pattern` | Regular expression to match current Kubernetes user name. |
| `context_alias` | Context alias to display instead of the full context name. |
| `user_alias` | User alias to display instead of the full user name. |
| `style` | The style for the module when using this context. If not set, will use module's style. |
| `symbol` | The symbol for the module when using this context. If not set, will use module's symbol. |
Note that all regular expression are anchored with `^$` and so must match the whole string. The `*_pattern` regular expressions may contain capture groups, which can be referenced in the corresponding alias via `$name` and `$N` (see example below and the [rust Regex::replace() documentation](https://docs.rs/regex/latest/regex/struct.Regex.html#method.replace)).
### Variables
| Variable | Ejemplo | Descripción |
| --------- | -------------------- | ----------------------------------------------------------- |
| contexto | `starship-context` | El nombre del contexto actual de kubernetes |
| namespace | `starship-namespace` | Si se establece, el espacio de nombres actual de kubernetes |
| usuario | `starship-user` | Si se establece, el espacio de nombres actual de kubernetes |
| cluster | `starship-cluster` | Si se establece, el clúster actual de kubernetes |
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
*: Esta variable solamente puede ser usada como parte de una cadena de caracteres de estilo
### Ejemplo
```toml
# ~/.config/starship.toml
[kubernetes]
format = 'on [⛵ ($user on )($cluster in )$context \($namespace\)](dimmed green) '
disabled = false
contexts = [
{ context_pattern = "dev.local.cluster.k8s", style = "green", symbol = "💔 " },
]
```
Only show the module in directories that contain a `k8s` file.
```toml
# ~/.config/starship.toml
[kubernetes]
disabled = false
detect_files = ['k8s']
```
#### Configuración específica del Contexto de Kubernetes
The `contexts` configuration option is used to customise what the current Kubernetes context name looks like (style and symbol) if the name matches the defined regular expression.
```toml
# ~/.config/starship.toml
[[kubernetes.contexts]]
# "bold red" style + default symbol when Kubernetes current context name equals "production" *and* the current user
# equals "admin_user"
context_pattern = "production"
user_pattern = "admin_user"
style = "bold red"
context_alias = "prod"
user_alias = "admin"
[[kubernetes.contexts]]
# "green" style + a different symbol when Kubernetes current context name contains openshift
context_pattern = ".*openshift.*"
style = "green"
symbol = "💔 "
context_alias = "openshift"
[[kubernetes.contexts]]
# Using capture groups
# Contexts from GKE, AWS and other cloud providers usually carry additional information, like the region/zone.
# The following entry matches on the GKE format (`gke_projectname_zone_cluster-name`)
# and renames every matching kube context into a more readable format (`gke-cluster-name`):
context_pattern = "gke_.*_(?P[\\w-]+)"
context_alias = "gke-$cluster"
```
## Salto de línea
El módulo `line_break` separa el prompt en dos líneas.
### Opciones
| Opción | Predeterminado | Descripción |
| ---------- | -------------- | ------------------------------------------------------------------------------ |
| `disabled` | `false` | Deshabilita el módulo `line_break`, haciendo que el prompt sea una sola línea. |
### Ejemplo
```toml
# ~/.config/starship.toml
[line_break]
disabled = true
```
## IP local
El módulo `localip` muestra la dirección IPv4 de la interfaz de red principal.
### Opciones
| Opción | Predeterminado | Descripción |
| ---------- | ------------------------- | ----------------------------------------------------------------------- |
| `ssh_only` | `true` | Solo muestra la direccion IP cuando se está conectado a una sesión SSH. |
| `format` | `'[$localipv4]($style) '` | El formato del módulo. |
| `style` | `'bold yellow'` | El estilo del módulo. |
| `disabled` | `true` | Deshabilita el módulo `localip`. |
### Variables
| Variable | Ejemplo | Descripción |
| --------- | ------------ | ------------------------------------- |
| localipv4 | 192.168.1.13 | Contiene la dirección IPv4 primaria |
| style\* | | Refleja el valor de la opción `style` |
*: Esta variable solamente puede ser usada como parte de una cadena de caracteres de estilo
### Ejemplo
```toml
# ~/.config/starship.toml
[localip]
ssh_only = false
format = '@[$localipv4](bold red) '
disabled = false
```
## Lua
El módulo `lua` muestra la versión instalada de [Lua](http://www.lua.org/). Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones:
- El directorio actual contiene un archivo `.lua-version`
- El directorio actual contiene un directorio `lua`
- El directorio actual contiene un archivo con la extensión `.lua`
### Opciones
| Opción | Predeterminado | Descripción |
| ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | El formato del módulo. |
| `version_format` | `'v${raw}'` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'🌙 '` | Una cadena de formato que representa el símbolo de Lua. |
| `detect_extensions` | `['lua']` | Qué extensiones deberían activar este módulo. |
| `detect_files` | `['.lua-version']` | Qué nombres de archivo deberían activar este módulo. |
| `detect_folders` | `['lua']` | Qué carpetas deberían activar este módulo. |
| `style` | `'bold blue'` | El estilo del módulo. |
| `lua_binary` | `'lua'` | Configura el binario lua que Starship ejecuta al obtener la versión. |
| `disabled` | `false` | Deshabilita el módulo `lua`. |
### Variables
| Variable | Ejemplo | Descripción |
| --------- | -------- | -------------------------------------- |
| version | `v5.4.0` | La versión de `lua` |
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
*: Esta variable solamente puede ser usada como parte de una cadena de caracteres de estilo
### Ejemplo
```toml
# ~/.config/starship.toml
[lua]
format = 'via [🌕 $version](bold blue) '
```
## Uso de la memoria
El módulo `memory_usage` muestra la memoria del sistema actual y el uso de la memoria de intercambio.
Por defecto, el uso de la memoria de intercambio se muestra si no es cero.
::: tip
Este módulo está deshabilitado por defecto. Para activarlo, establece `disabled` como `false` en tu archivo de configuración.
:::
### Opciones
| Opción | Predeterminado | Descripción |
| ----------- | ----------------------------------------------- | ------------------------------------------------------------- |
| `threshold` | `75` | Ocultar el uso de memoria a menos que supere este porcentaje. |
| `format` | `'via $symbol [${ram}( \| ${swap})]($style) '` | El formato del módulo. |
| `symbol` | `'🐏'` | El símbolo usado antes de mostrar el uso de memoria. |
| `style` | `'bold dimmed white'` | El estilo del módulo. |
| `disabled` | `true` | Desactiva el módulo `memory_usage`. |
### Variables
| Variable | Ejemplo | Descripción |
| ---------------- | ------------- | ---------------------------------------------------------------------------------- |
| ram | `31GiB/65GiB` | La memoria RAM usada/total del sistema actual. |
| ram_pct | `48%` | El porcentaje de la memoria actual del sistema. |
| swap\*\* | `1GiB/4GiB` | El tamaño de la memoria de intercambio del archivo de memoria del sistema actual. |
| swap_pct\*\* | `77%` | El porcentaje de memoria de intercambio del archivo de memoria del sistema actual. |
| symbol | `🐏` | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
*: Está variable solo puede utilizarse como parte de una cadena de estilo *\*: La información del archivo SWAP solo se muestra si se detecta en el sistema actual
### Ejemplo
```toml
# ~/.config/starship.toml
[memory_usage]
disabled = false
threshold = -1
symbol = ' '
style = 'bold dimmed green'
```
## Meson
The `meson` module shows the current Meson developer environment status.
By default the Meson project name is displayed, if `$MESON_DEVENV` is set.
### Opciones
| Opción | Predeterminado | Descripción |
| ------------------- | ---------------------------------- | ----------------------------------------------------------------------------------------- |
| `truncation_length` | `2^32 - 1` | Truncates a project name to `N` graphemes. |
| `truncation_symbol` | `'…'` | The symbol used to indicate a project name was truncated. You can use `''` for no symbol. |
| `format` | `'via [$symbol$project]($style) '` | El formato del módulo. |
| `symbol` | `'⬢ '` | The symbol used before displaying the project name. |
| `style` | `'blue bold'` | El estilo del módulo. |
| `disabled` | `false` | Deshabilita el módulo `meson`. |
### Variables
| Variable | Ejemplo | Descripción |
| --------- | ---------- | -------------------------------------- |
| proyecto | `starship` | El nombre actual del proyecto Meson |
| symbol | `🐏` | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
*: Esta variable solamente puede ser usada como parte de una cadena de caracteres de estilo
### Ejemplo
```toml
# ~/.config/starship.toml
[meson]
disabled = false
truncation_symbol = '--'
symbol = ' '
style = 'bold dimmed green'
```
## Rama Mercurial
The `hg_branch` module shows the active branch and topic of the repo in your current directory.
### Opciones
| Opción | Predeterminado | Descripción |
| ------------------- | ----------------------------------------- | --------------------------------------------------------------------------------------------------- |
| `symbol` | `' '` | El símbolo usado antes del marcador hg o nombre de la rama del repositorio en su directorio actual. |
| `style` | `'bold purple'` | El estilo del módulo. |
| `format` | `'on [$symbol$branch(:$topic)]($style) '` | El formato del módulo. |
| `truncation_length` | `2^63 - 1` | Truncates the hg branch / topic name to `N` graphemes |
| `truncation_symbol` | `'…'` | El símbolo usado para indicar que un nombre de rama fue truncado. |
| `disabled` | `true` | Deshabilita el módulo `hg_branch`. |
### Variables
| Variable | Ejemplo | Descripción |
| --------- | --------- | -------------------------------------- |
| rama | `maestro` | La rama mercurial activa |
| tema | `función` | The active mercurial topic |
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
*: Esta variable solamente puede ser usada como parte de una cadena de caracteres de estilo
### Ejemplo
```toml
# ~/.config/starship.toml
[hg_branch]
format = 'on [🌱 $branch](bold purple)'
truncation_length = 4
truncation_symbol = ''
```
## Nim
El módulo `nim` muestra la versión instalada de [Nim](https://nim-lang.org/). Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones:
- El directorio actual contiene un archivo `nim.cfg`
- El directorio actual contiene un archivo con la extensión `.nim`
- El directorio actual contiene un archivo con la extensión `.nims`
- El directorio actual contiene un archivo con la extensión `.nimble`
### Opciones
| Opción | Predeterminado | Descripción |
| ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | El formato del módulo |
| `version_format` | `'v${raw}'` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'👑 '` | El símbolo usado antes de mostrar la versión de Nim. |
| `detect_extensions` | `['nim', 'nims', 'nimble']` | Qué extensiones deberían activar este módulo. |
| `detect_files` | `['nim.cfg']` | Qué nombres de archivo deberían activar este módulo. |
| `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. |
| `style` | `'bold yellow'` | El estilo del módulo. |
| `disabled` | `false` | Deshabilita el módulo `nim`. |
### Variables
| Variable | Ejemplo | Descripción |
| --------- | -------- | -------------------------------------- |
| version | `v1.2.0` | La versión de `nimc` |
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
*: Esta variable solamente puede ser usada como parte de una cadena de caracteres de estilo
### Ejemplo
```toml
# ~/.config/starship.toml
[nim]
style = 'yellow'
symbol = '🎣 '
```
## Nix-shell
El módulo `nix_shell` muestra el entorno [nix-shell](https://nixos.org/guides/nix-pills/developing-with-nix-shell.html). El módulo se mostrará dentro de un entorno nix-shell.
### Opciones
| Opción | Predeterminado | Descripción |
| ------------- | ---------------------------------------------- | -------------------------------------------------------------------------------- |
| `format` | `'via [$symbol$state( \($name\))]($style) '` | El formato del módulo. |
| `symbol` | `'❄️ '` | Una cadena de formato que representa el símbolo de nix-shell. |
| `style` | `'bold blue'` | El estilo del módulo. |
| `impure_msg` | `'impure'` | Una cadena de formato que se muestra cuando el intérprete de comandos es impuro. |
| `pure_msg` | `'pure'` | Una cadena de formato que se muestra cuando el intérprete de comandos es puro. |
| `unknown_msg` | `''` | A format string shown when it is unknown if the shell is pure/impure. |
| `disabled` | `false` | Desactiva el módulo `nix_shell`. |
| `heuristic` | `false` | Attempts to detect new `nix shell`-style shells with a heuristic. |
### Variables
| Variable | Ejemplo | Descripción |
| --------- | ------- | -------------------------------------- |
| state | `pure` | El estado de nix-shell |
| name | `lorri` | El nombre de nix-shell |
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
*: Esta variable solamente puede ser usada como parte de una cadena de caracteres de estilo
### Ejemplo
```toml
# ~/.config/starship.toml
[nix_shell]
disabled = true
impure_msg = '[impure shell](bold red)'
pure_msg = '[pure shell](bold green)'
unknown_msg = '[unknown shell](bold yellow)'
format = 'via [☃️ $state( \($name\))](bold blue) '
```
## Node.js
El módulo `nodejs` muestra la versión instalada de [Node.js](https://nodejs.org/). Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones:
- El directorio actual contiene un archivo `package.json`
- El directorio actual contiene un archivo `.node-version`
- El directorio actual contiene un archivo `.nvmrc`
- El directorio actual contiene un directorio `node_modules`
- El directorio actual contiene un archivo con la extensión `.js`, `.mjs` o `.cjs`
- El directorio actual contiene un archivo con la extensión `.ts`, `.mts` o `.cts`
### Opciones
| Opción | Predeterminado | Descripción |
| ------------------- | ------------------------------------------ | --------------------------------------------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | El formato del módulo. |
| `version_format` | `'v${raw}'` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
| `symbol` | `' '` | Una cadena de formato que representa el símbolo de Node.js. |
| `detect_extensions` | `['js', 'mjs', 'cjs', 'ts', 'mts', 'cts']` | Qué extensiones deberían activar este módulo. |
| `detect_files` | `['package.json', '.node-version']` | Qué nombres de archivo deberían activar este módulo. |
| `detect_folders` | `['node_modules']` | Qué carpetas deberían activar este módulo. |
| `style` | `'bold green'` | El estilo del módulo. |
| `disabled` | `false` | Deshabilita el módulo `nodejs`. |
| `not_capable_style` | `'bold red'` | El estilo para el módulo cuando una propiedad de motores en package.json no coincide con la versión de Node.js. |
### Variables
| Variable | Ejemplo | Descripción |
| --------------- | ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
| version | `v13.12.0` | La versión de `node` |
| engines_version | `>=12.0.0` | `node` version requirement as set in the engines property of `package.json`. Will only show if the version requirement does not match the `node` version. |
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
*: Esta variable solamente puede ser usada como parte de una cadena de caracteres de estilo
### Ejemplo
```toml
# ~/.config/starship.toml
[nodejs]
format = 'via [🤖 $version](bold green) '
```
## OCamlz
El módulo `ocaml` muestra la versión instalada de [OCaml](https://ocaml.org/). Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones:
- El directorio actual contiene un archivo con extensión `.opam` o directorio `_opam`
- El directorio actual contiene un directorio `esy.lock`
- El directorio actual contiene un archivo `dune` o `dune-project`
- El directorio actual contiene un archivo `jbuild` o `jbuild-ignore`
- El directorio actual contiene un archivo `.merlin`
- El directorio actual contiene un archivo con la extensión `.ml`, `.mli`, `.re` o `.rei`
### Opciones
| Opción | Predeterminado | Descripción |
| ------------------------- | -------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )(\($switch_indicator$switch_name\) )]($style)'` | La cadena de formato para el módulo. |
| `version_format` | `'v${raw}'` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'🐫 '` | El símbolo usado antes de mostrar la versión de OCaml. |
| `global_switch_indicator` | `''` | La cadena de formato usada para representar el interruptor global de OPAM. |
| `local_switch_indicator` | `'*'` | La cadena de formato usada para representar el interruptor local de OPAM. |
| `detect_extensions` | `['opam', 'ml', 'mli', 're', 'rei']` | Qué extensiones deberían activar este módulo. |
| `detect_files` | `['dune', 'dune-project', 'jbuild', 'jbuild-ignore', '.merlin']` | Qué nombres de archivo deberían activar este módulo. |
| `detect_folders` | `['_opam', 'esy.lock']` | Qué carpetas deberían activar este módulo. |
| `style` | `'bold yellow'` | El estilo del módulo. |
| `disabled` | `false` | Deshabilita el módulo `ocaml`. |
### Variables
| Variable | Ejemplo | Descripción |
| ---------------- | ------------ | --------------------------------------------------------------------------- |
| version | `v4.10.0` | La versión de `ocaml` |
| switch_name | `my-project` | El interruptor OPAM activo |
| switch_indicator | | Refleja el valor de `indicator` para el interruptor OPAM activo actualmente |
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
*: Esta variable solamente puede ser usada como parte de una cadena de caracteres de estilo
### Ejemplo
```toml
# ~/.config/starship.toml
[ocaml]
format = 'via [🐪 $version]($style) '
```
## Open Policy Agent
The `opa` module shows the currently installed version of the OPA tool. By default the module will be shown if the current directory contains a `.rego` file.
### Opciones
| Opción | Predeterminado | Descripción |
| ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | El formato del módulo. |
| `version_format` | `'v${raw}'` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'🪖 '` | A format string representing the symbol of OPA. |
| `detect_extensions` | `['rego']` | Qué extensiones deberían activar este módulo. |
| `detect_files` | `[]` | Qué nombres de archivo deberían activar este módulo. |
| `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. |
| `style` | `'bold blue'` | El estilo del módulo. |
| `disabled` | `false` | Deshabilita el módulo `opa`. |
### Variables
| Variable | Ejemplo | Descripción |
| --------- | --------- | -------------------------------------- |
| version | `v0.44.0` | La versión de `opa` |
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
*: Esta variable solamente puede ser usada como parte de una cadena de caracteres de estilo
### Ejemplo
```toml
# ~/.config/starship.toml
[opa]
format = 'via [⛑️ $version](bold red) '
```
## OpenStack
El módulo `openstack` muestra la nube actual y el proyecto OpenStack. El módulo solo está activo cuando la variable de entorno `OS_CLOUD` está definida, en cuyo caso leerá el archivo `clouds.yaml` desde cualquiera de las [ubicaciones por defecto](https://docs.openstack.org/python-openstackclient/latest/configuration/index.html#configuration-files). para obtener el proyecto actual en uso.
### Opciones
| Opción | Predeterminado | Descripción |
| ---------- | ----------------------------------------------- | ----------------------------------------------------------- |
| `format` | `'on [$symbol$cloud(\($project\))]($style) '` | El formato del módulo. |
| `symbol` | `'☁️ '` | El símbolo usado antes de mostrar la nube OpenStack actual. |
| `style` | `'bold yellow'` | El estilo del módulo. |
| `disabled` | `false` | Deshabilita el módulo `openstack`. |
### Variables
| Variable | Ejemplo | Descripción |
| --------- | ------- | -------------------------------------- |
| nube | `corp` | La nube OpenStack actual |
| proyecto | `dev` | El actual proyecto OpenStack |
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
*: Esta variable solamente puede ser usada como parte de una cadena de caracteres de estilo
### Ejemplo
```toml
# ~/.config/starship.toml
[openstack]
format = 'on [$symbol$cloud(\($project\))]($style) '
style = 'bold yellow'
symbol = '☁️ '
```
## SO
The `os` module shows the current operating system. OS information is detected via the [os_info](https://lib.rs/crates/os_info) crate.
::: warning
The [os_info](https://lib.rs/crates/os_info) crate used by this module is known to be inaccurate on some systems.
:::
::: tip
Este módulo está deshabilitado por defecto. Para activarlo, establece `disabled` como `false` en tu archivo de configuración.
:::
### Opciones
| Opción | Predeterminado | Descripción |
| ---------- | --------------------- | ------------------------------------------------------ |
| `format` | `'[$symbol]($style)'` | El formato del módulo. |
| `style` | `'bold white'` | El estilo del módulo. |
| `disabled` | `true` | Deshabilita el módulo `os`. |
| `símbolos` | | A table that maps each operating system to its symbol. |
`symbols` allows you to define arbitrary symbols to display for each operating system type. Operating system types not defined by your configuration use the default symbols table below. All operating systems currently supported by the module are listed below. If you would like an operating system to be added, feel free to open a [feature request](https://github.com/starship/starship/issues/new/choose).
```toml
# This is the default symbols table.
[os.symbols]
Alpaquita = "🔔 "
Alpine = "🏔️ "
Amazon = "🙂 "
Android = "🤖 "
Arch = "🎗️ "
Artix = "🎗️ "
CentOS = "💠 "
Debian = "🌀 "
DragonFly = "🐉 "
Emscripten = "🔗 "
EndeavourOS = "🚀 "
Fedora = "🎩 "
FreeBSD = "😈 "
Garuda = "🦅 "
Gentoo = "🗜️ "
HardenedBSD = "🛡️ "
Illumos = "🐦 "
Linux = "🐧 "
Mabox = "📦 "
Macos = "🍎 "
Manjaro = "🥭 "
Mariner = "🌊 "
MidnightBSD = "🌘 "
Mint = "🌿 "
NetBSD = "🚩 "
NixOS = "❄️ "
OpenBSD = "🐡 "
OpenCloudOS = "☁️ "
openEuler = "🦉 "
openSUSE = "🦎 "
OracleLinux = "🦴 "
Pop = "🍭 "
Raspbian = "🍓 "
Redhat = "🎩 "
RedHatEnterprise = "🎩 "
Redox = "🧪 "
Solus = "⛵ "
SUSE = "🦎 "
Ubuntu = "🎯 "
Unknown = "❓ "
Windows = "🪟 "
```
### Variables
| Variable | Ejemplo | Descripción |
| --------- | ------------ | ------------------------------------------------------------------ |
| symbol | `🎗️` | The current operating system symbol from advanced option `symbols` |
| name | `Arch Linux` | El nombre actual del sistema operativo |
| tipo | `Arch` | El tipo actual de sistema operativo |
| codename | | The current operating system codename, if applicable |
| edición | | The current operating system edition, if applicable |
| version | | The current operating system version, if applicable |
| style\* | | Refleja el valor de la opción `style` |
*: Esta variable solamente puede ser usada como parte de una cadena de caracteres de estilo
### Ejemplo
```toml
# ~/.config/starship.toml
[os]
format = "on [($name )]($style)"
style = "bold blue"
disabled = false
[os.symbols]
Windows = " "
Arch = "Arch es lo mejor! "
```
## Package Version
El módulo `package` se muestra cuando el directorio actual es el repositorio de un paquete, y muestra su versión actual. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards`, `daml` and `dart` packages.
- [**npm**](https://docs.npmjs.com/cli/commands/npm) – La versión del paquete `npm` se extrae del `package.json` presente en el directorio actual
- [**Cargo**](https://doc.rust-lang.org/cargo/) – La versión del paquete `cargo` se extrae del `Cargo.toml` presente en el directorio actual
- [**Nimble**](https://github.com/nim-lang/nimble) - La versión del paquete `nimble` se extrae del archivo `*.nimble` presente en el directorio actual con el comando `nimble dump`
- [**Poetry**](https://python-poetry.org/) – La versión del paquete `poetry` se extrae del `pyproject.toml` presente en el directorio actual
- [**Python**](https://www.python.org) – La versión del paquete `python` se extrae del [pyproject.toml](https://peps.python.org/pep-0621/) presente en el directorio actual
- [**Composer**](https://getcomposer.org/) – La versión del paquete `composer` se extrae del `composer.json` presente en el directorio actual
- [**Gradle**](https://gradle.org/) – La versión `gradle` del paquete se extrae de `build.gradle` presente en el directorio actual
- [**Julia**](https://docs.julialang.org/en/v1/stdlib/Pkg/) - La versión del paquete se extrae de `Project.toml` presente en el directorio actual
- [**Mix**](https://hexdocs.pm/mix/) - La versión del paquete `mix` es extraída del `mix.exs` presente en el directorio actual
- [**Helm**](https://helm.sh/docs/helm/helm_package/) - La versión del paquete `helm` se extrae de `Chart.yaml` presente en el directorio actual
- [**Maven**](https://maven.apache.org/) - La versión de paquete `maven` se extrae de `pom.xml` presente en el directorio actual
- [**Meson**](https://mesonbuild.com/) - La versión del paquete `meson` se extrae de `meson.build` presente en el directorio actual
- [**Shards**](https://crystal-lang.org/reference/the_shards_command/index.html) - La versión del paquete `shards` se extrae de `shard.yml` presente en el directorio actual
- [**V**](https://vlang.io) - La versión del paquete `vlang` se extrae de `v.mod` presente en el directorio actual
- [**SBT**](https://scala-sbt.org) - La versión del paquete `sbt` se extrae del archivo `build.sbt` presente en el directorio actual
- [**Daml**](https://www.digitalasset.com/developers) - The `daml` package version is extracted from the `daml.yaml` present in the current directory
- [**Dart**](https://pub.dev/) - La versión del paquete `dart` se extrae del archivo `pubspec.yaml` presente en el directorio actual
> ⚠️ La versión que se muestra es la del paquete cuyo código fuente está en tu directorio actual, no en tu gestor de paquetes.
### Opciones
| Opción | Predeterminado | Descripción |
| ---------------- | --------------------------------- | --------------------------------------------------------------------------------------- |
| `format` | `'is [$symbol$version]($style) '` | El formato del módulo. |
| `symbol` | `'📦 '` | El símbolo usado antes de mostrar la versión del paquete. |
| `version_format` | `'v${raw}'` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
| `style` | `'bold 208'` | El estilo del módulo. |
| `'📦 '` | `false` | Activar la visualización de la versión para los paquetes marcados como privados. |
| `disabled` | `false` | Desactiva el módulo `package`. |
### Variables
| Variable | Ejemplo | Descripción |
| --------- | -------- | -------------------------------------- |
| version | `v1.0.0` | La versión de su paquete |
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
*: Esta variable solamente puede ser usada como parte de una cadena de caracteres de estilo
### Ejemplo
```toml
# ~/.config/starship.toml
[package]
format = 'vía [🎁 $version](208 bold) '
```
## Perl
El módulo `perl` muestra la versión instalada de [Perl](https://www.perl.org/). Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones:
- El directorio actual contiene un archivo `Makefile.PL` o `Build.PL`
- El directorio actual contiene un archivo `cpanfile` o `cpanfile.snapshot`
- El directorio actual contiene un archivo `META.json` o `META.yml`
- El directorio actual contiene un archivo `.perl-version`
- El directorio actual contiene un `.pl`, `.pm` o `.pod`
### Opciones
| Opción | Predeterminado | Descripción |
| ------------------- | -------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | La cadena de formato para el módulo. |
| `version_format` | `'v${raw}'` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'🐪 '` | El símbolo usado antes de mostrar la versión de Perl |
| `detect_extensions` | `['pl', 'pm', 'pod']` | Qué extensiones deberían activar este módulo. |
| `detect_files` | `['Makefile.PL', 'Build.PL', 'cpanfile', 'cpanfile.snapshot', 'META.json', 'META.yml', '.perl-version']` | Qué nombres de archivo deberían activar este módulo. |
| `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. |
| `style` | `'bold 149'` | El estilo del módulo. |
| `disabled` | `false` | Deshabilita el módulo `perl`. |
### Variables
| Variable | Ejemplo | Descripción |
| --------- | --------- | -------------------------------------- |
| version | `v5.26.1` | La versión de `perl` |
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
### Ejemplo
```toml
# ~/.config/starship.toml
[perl]
format = 'via [🦪 $version]($style) '
```
## PHP
El módulo `php` muestra la versión instalada de [PHP](https://www.php.net/). Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones:
- El directorio actual contiene un archivo `composer.json`
- El directorio actual contiene un archivo `.php-version`
- El directorio actual contiene una extensión `.php`
### Opciones
| Opción | Predeterminado | Descripción |
| ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | El formato del módulo. |
| `version_format` | `'v${raw}'` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'🐘 '` | El símbolo usado antes de mostrar la versión de PHP. |
| `detect_extensions` | `['php']` | Qué extensiones deberían activar este módulo. |
| `detect_files` | `['composer.json', '.php-version']` | Qué nombres de archivo deberían activar este módulo. |
| `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. |
| `style` | `'147 bold'` | El estilo del módulo. |
| `disabled` | `false` | Deshabilita el módulo `php`. |
### Variables
| Variable | Ejemplo | Descripción |
| --------- | -------- | -------------------------------------- |
| version | `v7.3.8` | La versión de `php` |
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
*: Esta variable solamente puede ser usada como parte de una cadena de caracteres de estilo
### Ejemplo
```toml
# ~/.config/starship.toml
[php]
format = 'via [🔹 $version](147 bold) '
```
## Canal Pijul
The `pijul_channel` module shows the active channel of the repo in your current directory.
### Opciones
| Opción | Predeterminado | Descripción |
| ------------------- | --------------------------------- | ------------------------------------------------------------------------------------ |
| `symbol` | `' '` | The symbol used before the pijul channel name of the repo in your current directory. |
| `style` | `'bold purple'` | El estilo del módulo. |
| `format` | `'on [$symbol$channel]($style) '` | El formato del módulo. |
| `truncation_length` | `2^63 - 1` | Truncates the pijul channel name to `N` graphemes |
| `truncation_symbol` | `'…'` | El símbolo usado para indicar que un nombre de rama fue truncado. |
| `disabled` | `true` | Disables the `pijul` module. |
## Pulumi
El módulo `pulumi` muestra el nombre de usuario actual, [Pulumi Stack](https://www.pulumi.com/docs/intro/concepts/stack/)seleccionado y la versión.
::: tip
Por defecto la versión de Pulumi no se muestra, ya que toma un orden de magnitud más largo para cargar que la mayoría de los plugins (~70ms). Si aún deseas activarlo, [sigue el ejemplo que se muestra a continuación](#with-pulumi-version).
:::
Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones:
- El directorio actual contiene `Pulumi.yaml` o `Pulumi.yml`
- A parent directory contains either `Pulumi.yaml` or `Pulumi.yml` unless `search_upwards` is set to `false`
### Opciones
| Opción | Predeterminado | Descripción |
| ---------------- | -------------------------------------------- | --------------------------------------------------------------------------------------- |
| `format` | `'vía [$symbol($username@)$stack]($style) '` | La cadena de formato para el módulo. |
| `version_format` | `'v${raw}'` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
| `symbol` | `' '` | Una cadena de formato que se muestra antes de la pila de Pulumi. |
| `style` | `'bold 5'` | El estilo del módulo. |
| `search_upwards` | `true` | Enable discovery of pulumi config files in parent directories. |
| `disabled` | `false` | Deshabilita el módulo `pulumi`. |
### Variables
| Variable | Ejemplo | Descripción |
| ----------------- | ---------- | -------------------------------------- |
| version | `v0.12.24` | La versión de `pulumi` |
| stack | `dev` | La pila actual de Pulumi |
| nombre de usuario | `alice` | El usuario actual de Pulumi |
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
*: Esta variable solamente puede ser usada como parte de una cadena de caracteres de estilo
### Ejemplo
#### Con la versión de Pulumi
```toml
# ~/.config/starship.toml
[pulumi]
format = '[🛥 ($version )$stack]($style) '
```
#### Sin versión de Pulumi
```toml
# ~/.config/starship.toml
[pulumi]
symbol = '🛥 '
format = '[$symbol$stack]($style) '
```
## PureScript
El módulo `purescript` muestra la versión instalada de [PureScript](https://www.purescript.org/). Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones:
- El directorio actual contiene un archivo `spago.dhall`
- El directorio actual contiene un archivo con la extensión `.purs`
### Opciones
| Opción | Predeterminado | Descripción |
| ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | El formato del módulo. |
| `version_format` | `'v${raw}'` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'<=> '` | El símbolo usado antes de mostrar la versión de PureScript. |
| `detect_extensions` | `['purs']` | Qué extensiones deberían activar este módulo. |
| `detect_files` | `['spago.dhall']` | Qué nombres de archivo deberían activar este módulo. |
| `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. |
| `style` | `'bold white'` | El estilo del módulo. |
| `disabled` | `false` | Desactiva el módulo `purescript`. |
### Variables
| Variable | Ejemplo | Descripción |
| --------- | -------- | -------------------------------------- |
| version | `0.13.5` | La versión de `purescript` |
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
*: Esta variable solamente puede ser usada como parte de una cadena de caracteres de estilo
### Ejemplo
```toml
# ~/.config/starship.toml
[purescript]
format = 'via [$symbol$version](bold white)'
```
## Python
El módulo `python` muestra la versión instalada de [Python](https://www.python.org/) y el entorno virtual actual [Python](https://docs.python.org/tutorial/venv.html) si uno está activado.
Si `pyenv_version_name` se establece en `true`, mostrará el nombre de la versión de pyenv. De lo contrario, se mostrará el número de versión de `python --version`.
Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones:
- El directorio actual contiene un archivo `.python-version`
- El directorio actual contiene un archivo `Pipfile`
- El directorio actual contiene un archivo `__init__.py`
- El directorio actual contiene un archivo `pyproject.toml`
- El directorio actual contiene un archivo `requirements.txt`
- El directorio actual contiene un archivo `setup.py`
- El directorio actual contiene un archivo `tox.ini`
- El directorio actual contiene un archivo con la extensión `.py`.
- Un entorno virtual está activado actualmente
### Opciones
| Opción | Predeterminado | Descripción |
| -------------------- | ------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------- |
| `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\) )]($style)'` | El formato del módulo. |
| `version_format` | `'v${raw}'` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'🐍 '` | Una cadena de formato que representa el símbolo de Python |
| `style` | `'yellow bold'` | El estilo del módulo. |
| `pyenv_version_name` | `false` | Usar pyenv para obtener la versión de Python |
| `pyenv_prefix` | `'pyenv'` | Prefijo antes de mostrar la versión de pyenv sólo se utiliza si se utiliza pyenv |
| `python_binary` | `['python', 'python3', 'python2']` | Configura los binarios de python que Starship debería ejecutar al obtener la versión. |
| `detect_extensions` | `['py']` | Qué extensiones deben activar este módulo |
| `detect_files` | `['.python-version', 'Pipfile', '__init__.py', 'pyproject.toml', 'requirements.txt', 'setup.py', 'tox.ini']` | Qué nombres de archivo deben activar este módulo |
| `detect_folders` | `[]` | Qué carpetas deben activar este módulo |
| `disabled` | `false` | Deshabilita el módulo `python`. |
::: tip
La variable `python_binary` acepta una cadena o una lista de cadenas. La Starship intentará ejecutar cada binario hasta que obtenga un resultado. Ten en cuenta que sólo puedes cambiar el binario que Starship ejecuta para obtener la versión de Python no los argumentos que se utilizan.
Los valores por defecto y el orden para `python_binary` fue elegido para identificar primero la versión de Python en un entorno virtualenv/conda (que actualmente añade un `python`, no importa si apunta a `python3` o `python2`). Esto tiene el efecto secundario que si todavía tienes un sistema de Python 2 instalado, puede ser recogido antes de cualquier Python 3 (al menos en las Distros de Linux que siempre enlazan `/usr/bin/python` a Python 2). If you do not work with Python 2 anymore but cannot remove the system Python 2, changing this to `'python3'` will hide any Python version 2, see example below.
:::
### Variables
| Variable | Ejemplo | Descripción |
| ------------ | --------------- | -------------------------------------------- |
| version | `'v3.8.1'` | La versión de `python` |
| symbol | `'🐍 '` | Refleja el valor de la opción `symbol` |
| style | `'yellow bold'` | Refleja el valor de la opción `style` |
| pyenv_prefix | `'pyenv '` | Refleja el valor de la opción `pyenv_prefix` |
| virtualenv | `'venv'` | El nombre actual del `virtualenv` |
### Ejemplo
```toml
# ~/.config/starship.toml
[python]
symbol = '👾 '
pyenv_version_name = true
```
```toml
# ~/.config/starship.toml
[python]
# Solo usa el binario `python3` para obtener la versión.
python_binary = 'python3'
```
```toml
# ~/.config/starship.toml
[python]
# No se dispara con archivos con extensión py
detect_extensions = []
```
```toml
# ~/.config/starship.toml
[python]
# Muestra la versión de python dentro de un entorno virtual local.
#
# Ten en cuenta que esto solo funcionará cuando el venv esté dentro del proyecto y sólo
# funcionará en el directorio que contiene el directorio venv dir pero ¿tal vez esté bien?
python_binary = ['./venv/bin/python', 'python', 'python3', 'python2']
```
## R
El módulo `rlang` muestra la versión instalada de [R](https://www.r-project.org/). El módulo se mostrará si se cumplen cualquiera de las siguientes condiciones:
- El directorio actual contiene un archivo con la extensión `.R`.
- El directorio actual contiene un archivo con la extensión `.Rd`.
- El directorio actual contiene un archivo con la extensión `.Rmd`.
- El directorio actual contiene un archivo con la extensión `.Rproj`.
- El directorio actual contiene un archivo con la extensión `.Rsx`.
- El directorio actual contiene un archivo `.Rprofile`
- El directorio actual contiene una carpeta `.Rproj.user`
### Opciones
| Opción | Predeterminado | Descripción |
| ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | El formato del módulo. |
| `version_format` | `'v${raw}'` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'📐'` | Una cadena de formato que representa el símbolo de R. |
| `style` | `'blue bold'` | El estilo del módulo. |
| `detect_extensions` | `['R', 'Rd', 'Rmd', 'Rproj', 'Rsx']` | Qué extensiones deben activar este módulo |
| `detect_files` | `['.Rprofile']` | Qué nombres de archivo deben activar este módulo |
| `detect_folders` | `['.Rproj.user']` | Qué carpetas deben activar este módulo |
| `disabled` | `false` | Deshabilita el módulo `r`. |
### Variables
| Variable | Ejemplo | Descripción |
| -------- | ------------- | -------------------------------------- |
| version | `v4.0.5` | La versión de `R` |
| symbol | | Refleja el valor de la opción `symbol` |
| style | `'blue bold'` | Refleja el valor de la opción `style` |
### Ejemplo
```toml
# ~/.config/starship.toml
[rlang]
format = 'with [📐 $version](blue bold) '
```
## Raku
El módulo `raku` muestra la versión instalada de [Raku](https://www.raku.org/). Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones:
- El directorio actual contiene un archivo `META6.json`
- El directorio actual contiene un `.p6`, `.pm6`, `.raku`, `.rakumod` o `.pod6`
### Opciones
| Opción | Predeterminado | Descripción |
| ------------------- | ------------------------------------------------ | --------------------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version-$vm_version )]($style)'` | La cadena de formato para el módulo. |
| `version_format` | `'v${raw}'` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'🦋 '` | El símbolo usado antes de mostrar la versión de Raku |
| `detect_extensions` | `['p6', 'pm6', 'pod6', 'raku', 'rakumod']` | Qué extensiones deberían activar este módulo. |
| `detect_files` | `['META6.json']` | Qué nombres de archivo deberían activar este módulo. |
| `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. |
| `style` | `'bold 149'` | El estilo del módulo. |
| `disabled` | `false` | Deshabilita el módulo `raku`. |
### Variables
| Variable | Ejemplo | Descripción |
| ---------- | ------- | ---------------------------------------------------------- |
| version | `v6.d` | La versión de `raku` |
| vm_version | `moar` | La versión de la máquina virtual `raku` está construida en |
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
### Ejemplo
```toml
# ~/.config/starship.toml
[raku]
format = 'via [🦪 $version]($style) '
```
## Red
Por defecto, el módulo `red` muestra la versión actualmente instalada de [Red](https://www.red-lang.org/). El módulo se mostrará si se cumplen alguna de las siguientes condiciones:
- El directorio actual contiene un archivo con extensión `.red` o `.Red`
### Opciones
| Opción | Predeterminado | Descripción |
| ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | El formato del módulo. |
| `version_format` | `'v${raw}'` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'🔺 '` | Una cadena de formato que representa el símbolo de Red. |
| `detect_extensions` | `['red']` | Qué extensiones deberían activar este módulo. |
| `detect_files` | `[]` | Qué nombres de archivo deberían activar este módulo. |
| `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. |
| `style` | `'red bold'` | El estilo del módulo. |
| `disabled` | `false` | Deshabilita el módulo `red`. |
### Variables
| Variable | Ejemplo | Descripción |
| --------- | -------- | -------------------------------------- |
| version | `v2.5.1` | La versión de `red` |
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
*: Esta variable solamente puede ser usada como parte de una cadena de caracteres de estilo
### Ejemplo
```toml
# ~/.config/starship.toml
[red]
symbol = '🔴 '
```
## Ruby
Por defecto, el módulo `ruby` muestra la versión actualmente instalada de [Ruby](https://www.ruby-lang.org/). El módulo se mostrará si se cumplen alguna de las siguientes condiciones:
- El directorio actual contiene un archivo `Gemfile`
- El directorio actual contiene un archivo `.ruby-version`
- El directorio actual contiene un archivo `.rb`
- Las variables de entorno `RUBY_VERSION` o `RBENV_VERSION` están configuradas
Starship obtiene la versión actual de Ruby ejecutando `ruby -v`.
### Opciones
| Opción | Predeterminado | Descripción |
| ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | El formato del módulo. |
| `version_format` | `'v${raw}'` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'💎 '` | Una cadena de formato que representa el símbolo de Ruby. |
| `detect_extensions` | `['rb']` | Qué extensiones deberían activar este módulo. |
| `detect_files` | `['Gemfile', '.ruby-version']` | Qué nombres de archivo deberían activar este módulo. |
| `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. |
| `detect_variables` | `['RUBY_VERSION', 'RBENV_VERSION']` | Qué variables de entorno deben activar este módulo. |
| `style` | `'bold red'` | El estilo del módulo. |
| `disabled` | `false` | Deshabilita el módulo `ruby`. |
### Variables
| Variable | Ejemplo | Descripción |
| --------- | -------- | -------------------------------------- |
| version | `v2.5.1` | La versión de `ruby` |
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
*: Esta variable solamente puede ser usada como parte de una cadena de caracteres de estilo
### Ejemplo
```toml
# ~/.config/starship.toml
[ruby]
symbol = '🔺 '
```
## Rust
Por defecto, el módulo `rust` muestra la versión instalada de [Rust](https://www.rust-lang.org/). El módulo se mostrará si se cumplen alguna de las siguientes condiciones:
- El directorio actual contiene un archivo `Cargo.toml`
- El directorio actual contiene un archivo con la extensión `.rs`
### Opciones
| Opción | Predeterminado | Descripción |
| ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | El formato del módulo. |
| `version_format` | `'v${raw}'` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'🦀 '` | Una cadena de formato que representa el símbolo de Rust |
| `detect_extensions` | `['rs']` | Qué extensiones deberían activar este módulo. |
| `detect_files` | `['Cargo.toml']` | Qué nombres de archivo deberían activar este módulo. |
| `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. |
| `style` | `'bold red'` | El estilo del módulo. |
| `disabled` | `false` | Deshabilita el módulo `rust`. |
### Variables
| Variable | Ejemplo | Descripción |
| --------- | ----------------- | -------------------------------------------- |
| version | `v1.43.0-nightly` | La versión de `rustc` |
| numver | `1.51.0` | El componente numérico de la versión `rustc` |
| toolchain | `beta` | La versión de toolchain |
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
*: Esta variable solamente puede ser usada como parte de una cadena de caracteres de estilo
### Ejemplo
```toml
# ~/.config/starship.toml
[rust]
format = 'via [⚙️ $version](red bold)'
```
## Scala
El módulo `scala` muestra la versión actualmente instalada de [Scala](https://www.scala-lang.org/). Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones:
- El directorio actual contiene un archivo `build.sbt`, `.scalaenv` o `.sbtenv`
- El directorio actual contiene un archivo con la extensión `.scala` o `.sbt`
- El directorio actual contiene un directorio llamado `.metals`
### Opciones
| Opción | Predeterminado | Descripción |
| ------------------- | ---------------------------------------- | --------------------------------------------------------------------------------------- |
| `format` | `'via [${symbol}(${version} )]($style)'` | El formato del módulo. |
| `version_format` | `'v${raw}'` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
| `detect_extensions` | `['sbt', 'scala']` | Qué extensiones deberían activar este módulo. |
| `detect_files` | `['.scalaenv', '.sbtenv', 'build.sbt']` | Qué nombres de archivo deberían activar este módulo. |
| `detect_folders` | `['.metals']` | Qué carpetas deberían activar estos módulos. |
| `symbol` | `'🆂 '` | Una cadena de formato que representa el símbolo de Scala. |
| `style` | `'red dimmed'` | El estilo del módulo. |
| `disabled` | `false` | Deshabilita el módulo `scala`. |
### Variables
| Variable | Ejemplo | Descripción |
| --------- | -------- | -------------------------------------- |
| version | `2.13.5` | La versión de `scala` |
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
*: Esta variable solamente puede ser usada como parte de una cadena de caracteres de estilo
### Ejemplo
```toml
# ~/.config/starship.toml
[scala]
symbol = '🌟 '
```
## Shell
El módulo `shell` muestra un indicador para el intérprete de comandos actualmente utilizado.
::: tip
Este módulo está deshabilitado por defecto. Para activarlo, establece `disabled` como `false` en tu archivo de configuración.
:::
### Opciones
| Opción | Predeterminado | Descripción |
| ---------------------- | ------------------------- | ------------------------------------------------------------------------------------------------------ |
| `bash_indicator` | `'bsh'` | Una cadena de formato usada para representar bash. |
| `fish_indicator` | `'fsh'` | Una cadena de formato usada para representar fish. |
| `zsh_indicator` | `'zsh'` | Una cadena de formato usada para representar zsh. |
| `powershell_indicator` | `'psh'` | Una cadena de formato usada para representar powershell. |
| `pwsh_indicator` | | A format string used to represent pwsh. The default value mirrors the value of `powershell_indicator`. |
| `ion_indicator` | `'ion'` | Una cadena de formato usada para representar ion. |
| `elvish_indicator` | `'esh'` | Una cadena de formato usada para representar elvish. |
| `tcsh_indicator` | `'tsh'` | A format string used to represent tcsh. |
| `xonsh_indicator` | `'xsh'` | Una cadena de formato usada para representar xonsh. |
| `cmd_indicator` | `'cmd'` | Una cadena de formato usada para representar cmd. |
| `nu_indicator` | `'nu'` | Una cadena de formato usada para representar nu. |
| `unknown_indicator` | `''` | El valor por defecto que se mostrará cuando se desconoce el intérprete. |
| `format` | `'[$indicator]($style) '` | El formato del módulo. |
| `style` | `'white bold'` | El estilo del módulo. |
| `disabled` | `true` | Deshabilita el módulo `shell`. |
### Variables
| Variable | Predeterminado | Descripción |
| --------- | -------------- | ------------------------------------------------------------------------------------- |
| indicador | | Refleja el valor de `indicator` para el intérprete de comandos actualmente utilizado. |
| style\* | | Refleja el valor de la opción `style`. |
*: Esta variable solamente puede ser usada como parte de una cadena de caracteres de estilo
### Ejemplos
```toml
# ~/.config/starship.toml
[shell]
fish_indicator = ' '
powershell_indicator = '_'
unknown_indicator = 'mystery shell'
style = 'cyan bold'
disabled = false
```
## SHLVL
The `shlvl` module shows the current [`SHLVL`](https://tldp.org/LDP/abs/html/internalvariables.html#SHLVLREF) ('shell level') environment variable, if it is set to a number and meets or exceeds the specified threshold.
### Opciones
| Opción | Predeterminado | Descripción |
| --------------- | ---------------------------- | ------------------------------------------------------------------- |
| `threshold` | `2` | Mostrar el umbral. |
| `format` | `'[$symbol$shlvl]($style) '` | El formato del módulo. |
| `symbol` | `'↕️ '` | El símbolo utilizado para representar el `SHLVL`. |
| `repetir` | `false` | Hace que el `symbol` se repita con la cantidad actual de `SHLVL`. |
| `repeat_offset` | `0` | Decrements number of times `symbol` is repeated by the offset value |
| `style` | `'bold yellow'` | El estilo del módulo. |
| `disabled` | `true` | Deshabilita el módulo `shlvl`. |
### Variables
| Variable | Ejemplo | Descripción |
| --------- | ------- | -------------------------------------- |
| shlvl | `3` | El valor actual de `SHLVL` |
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
*: Esta variable solamente puede ser usada como parte de una cadena de caracteres de estilo
### Ejemplo
```toml
# ~/.config/starship.toml
[shlvl]
disabled = false
format = '$shlvl level(s) down'
threshold = 3
```
Using `repeat` and `repeat_offset` along with `character` module, one can get prompt like `❯❯❯` where last character is colored appropriately for return status code and preceeding characters are provided by `shlvl`.
```toml
# ~/.config/starship.toml
[shlvl]
disabled = false
format = '[$symbol$shlvl]($style)'
repeat = true
symbol = '❯'
repeat_offset = 1
threshold = 0
```
## Singularity
El módulo `singularity` muestra la imagen de [singularity](https://sylabs.io/singularity/) actual, si se encuentra dentro de un contenedor y `$SINGULARITY_NAME` está establecido.
### Opciones
| Opción | Predeterminado | Descripción |
| ---------- | -------------------------------- | ------------------------------------------------------------------- |
| `format` | `'[$symbol\[$env\]]($style) '` | El formato del módulo. |
| `symbol` | `''` | Una cadena de formato que se muestra antes del nombre de la imagen. |
| `style` | `'bold dimmed blue'` | El estilo del módulo. |
| `disabled` | `false` | Deshabilita el módulo de `singularity`. |
### Variables
| Variable | Ejemplo | Descripción |
| --------- | ------------ | -------------------------------------- |
| env | `centos.img` | La imagen de Singularity actual |
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
*: Esta variable solamente puede ser usada como parte de una cadena de caracteres de estilo
### Ejemplo
```toml
# ~/.config/starship.toml
[singularity]
format = '[📦 \[$env\]]($style) '
```
## Solidity
The `solidity` module shows the currently installed version of [Solidity](https://soliditylang.org/) The module will be shown if any of the following conditions are met:
- The current directory contains a file with the `.sol` extension
### Opciones
| Opción | Predeterminado | Descripción |
| ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | El formato del módulo. |
| `version_format` | `'v${major}.${minor}.${patch}'` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'S '` | A format string representing the symbol of Solidity |
| `compiler | ['solc'] | The default compiler for Solidity. |
| `detect_extensions` | `['sol']` | Qué extensiones deberían activar este módulo. |
| `detect_files` | `[]` | Qué nombres de archivo deberían activar este módulo. |
| `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. |
| `style` | `'bold blue'` | El estilo del módulo. |
| `disabled` | `false` | Disables this module. |
### Variables
| Variable | Ejemplo | Descripción |
| --------- | -------- | -------------------------------------- |
| version | `v0.8.1` | The version of `solidity` |
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
*: Esta variable solamente puede ser usada como parte de una cadena de caracteres de estilo
### Ejemplo
```toml
# ~/.config/starship.toml
[solidity]
format = "via [S $version](blue bold)"
```
## Spack
El módulo `spack` muestra el entorno actual [Spack](https://spack.readthedocs.io/en/latest/), si `$SPACK_ENV` está configurado.
### Opciones
| Opción | Predeterminado | Descripción |
| ------------------- | -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `truncation_length` | `1` | El número de directorios a los que se debe truncar la ruta de entorno. `0` significa sin truncamiento. Vea también el módulo [`directory`](#directory). |
| `symbol` | `'🅢 '` | El símbolo usado antes del nombre del entorno. |
| `style` | `'bold blue'` | El estilo del módulo. |
| `format` | `'via [$symbol$environment]($style) '` | El formato del módulo. |
| `disabled` | `false` | Deshabilita el módulo `spack`. |
### Variables
| Variable | Ejemplo | Descripción |
| ----------- | ------------ | -------------------------------------- |
| environment | `astronauts` | El entorno de spack actual |
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
*: Esta variable solamente puede ser usada como parte de una cadena de caracteres de estilo
### Ejemplo
```toml
# ~/.config/starship.toml
[spack]
format = '[$symbol$environment](dimmed blue) '
```
## Estado
El módulo `status` muestra el código de salida del comando anterior. Si $success_symbol está vacío (por defecto), el módulo solo se mostrará si el código de salida no es `0`. El código de estado se convertirá a un entero con signo de 32 bits.
::: tip
Este módulo está deshabilitado por defecto. Para activarlo, establece `disabled` como `false` en tu archivo de configuración.
:::
### Opciones
| Opción | Predeterminado | Descripción |
| --------------------------- | ---------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ |
| `format` | `'[$symbol$status]($style) '` | El formato del módulo |
| `symbol` | `'❌'` | El símbolo mostrado en el error del programa |
| `success_symbol` | `''` | El símbolo mostrado en el éxito del programa |
| `not_executable_symbol` | `'🚫'` | El símbolo mostrado cuando el archivo no es ejecutable |
| `not_found_symbol` | `'🔍'` | El símbolo mostrado cuando no se encuentra el comando |
| `sigint_symbol` | `'🧱'` | El símbolo mostrado en SIGINT (Ctrl + c) |
| `signal_symbol` | `'⚡'` | El símbolo mostrado en cualquier señal |
| `style` | `'bold red'` | El estilo del módulo. |
| `recognize_signal_code` | `true` | Habilita el mapeo de señales desde el código de salida |
| `map_symbol` | `false` | Habilita el mapeo de símbolos desde el código de salida |
| `pipestatus` | `false` | Habilita el reporte de pipstatus |
| `pipestatus_separator` | | | El símbolo usado para separar segmentos de pipestatus (soporta formato) |
| `pipestatus_format` | `'\[$pipestatus\] => [$symbol$common_meaning$signal_name$maybe_int]($style)'` | El formato del módulo cuando el comando es un pipeline |
| `pipestatus_segment_format` | | Cuando se especifica, reemplaza `formato` al formatear segmentos de pipestatus |
| `disabled` | `true` | Deshabilita el módulo `status`. |
### Variables
| Variable | Ejemplo | Descripción |
| -------------- | ------- | ------------------------------------------------------------------------------------------ |
| estado | `127` | El código de salida del último comando |
| hex_status | `0x7F` | El código de salida del último comando en hexadecimal |
| int | `127` | El código de salida del último comando |
| common_meaning | `ERROR` | Comprobación del código si no es una señal |
| signal_number | `9` | Número de señal correspondiente al código de salida, sólo si está señalizado |
| signal_name | `KILL` | Nombre de la señal correspondiente al código de salida, sólo si está señalizada |
| maybe_int | `7` | Contiene el número de código de salida cuando no se ha encontrado ningún significado |
| pipestatus | | Rendering of in pipeline programs' exit codes, this is only available in pipestatus_format |
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
*: Esta variable solamente puede ser usada como parte de una cadena de caracteres de estilo
### Ejemplo
```toml
# ~/.config/starship.toml
[status]
style = 'bg:blue'
symbol = '🔴 '
success_symbol = '🟢 SUCCESS'
format = '[\[$symbol$common_meaning$signal_name$maybe_int\]]($style) '
map_symbol = true
disabled = false
```
## Sudo
El módulo `sudo` muestra si las credenciales de sudo están actualmente en caché. El módulo solo se mostrará si las credenciales están guardadas en caché.
::: tip
Este módulo está deshabilitado por defecto. Para activarlo, establece `disabled` como `false` en tu archivo de configuración.
:::
### Opciones
| Opción | Predeterminado | Descripción |
| --------------- | ------------------------ | -------------------------------------------------------------------------------- |
| `format` | `'[as $symbol]($style)'` | El formato del módulo |
| `symbol` | `'🧙 '` | El símbolo mostrado cuando las credenciales se almacenan en caché |
| `style` | `'bold blue'` | El estilo del módulo. |
| `allow_windows` | `false` | Como Windows no tiene sudo por defecto, el valor por defecto está deshabilitado. |
| `disabled` | `true` | Deshabilita el módulo `sudo`. |
### Variables
| Variable | Ejemplo | Descripción |
| --------- | ------- | -------------------------------------- |
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
*: Esta variable solamente puede ser usada como parte de una cadena de caracteres de estilo
### Ejemplo
```toml
# ~/.config/starship.toml
[sudo]
style = 'bold green'
symbol = '👩💻 '
disabled = false
```
```toml
# On windows
# $HOME\.starship\config.toml
[sudo]
allow_windows = true
disabled = false
```
## Swift
Por defecto, el módulo `swift` muestra la versión instalada de [Swift](https://swift.org/). El módulo se mostrará si se cumplen alguna de las siguientes condiciones:
- El directorio actual contiene un archivo `Package.swift`
- El directorio actual contiene un archivo con la extensión `.swift`
### Opciones
| Opción | Predeterminado | Descripción |
| ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | El formato del módulo. |
| `version_format` | `'v${raw}'` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'🐦 '` | Una cadena de formato que representa el símbolo de Swift |
| `detect_extensions` | `['swift']` | Qué extensiones deberían activar este módulo. |
| `detect_files` | `['Package.swift']` | Qué nombres de archivo deberían activar este módulo. |
| `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. |
| `style` | `'bold 202'` | El estilo del módulo. |
| `disabled` | `false` | Deshabilita el módulo `swift`. |
### Variables
| Variable | Ejemplo | Descripción |
| --------- | -------- | -------------------------------------- |
| version | `v5.2.4` | La versión de `swift` |
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
*: Esta variable solamente puede ser usada como parte de una cadena de caracteres de estilo
### Ejemplo
```toml
# ~/.config/starship.toml
[swift]
format = 'vía [🏎 $version](red bold)'
```
## Terraform
El módulo `Terraform` muestra el [espacio de trabajo de Terraform](https://www.terraform.io/docs/language/state/workspaces.html) y la versión seleccionados actualmente.
::: tip
Por defecto no se muestra la versión de Terraform, ya que esto es lento para las versiones actuales de Terraform cuando hay muchos plugins en uso. Si aún deseas activarlo, [sigue el ejemplo que se muestra a continuación](#with-terraform-version).
:::
Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones:
- El directorio actual contiene una carpeta `.terraform`
- El directorio actual contiene un archivo con las extensiones `.tf`, `.tfplan` o `.tfstate`
### Opciones
| Opción | Predeterminado | Descripción |
| ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------- |
| `format` | `'via [$symbol$workspace]($style) '` | La cadena de formato para el módulo. |
| `version_format` | `'v${raw}'` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'💠'` | Una cadena de formato que se muestra antes del espacio de trabajo terraform. |
| `detect_extensions` | `['tf', 'tfplan', 'tfstate']` | Qué extensiones deberían activar este módulo. |
| `detect_files` | `[]` | Qué nombres de archivo deberían activar este módulo. |
| `detect_folders` | `['.terraform']` | Qué carpetas deberían activar este módulo. |
| `style` | `'bold 105'` | El estilo del módulo. |
| `disabled` | `false` | Deshabilita el módulo `terraform`. |
### Variables
| Variable | Ejemplo | Descripción |
| --------------- | ---------- | ----------------------------------------- |
| version | `v0.12.24` | La versión de `terraform` |
| área de trabajo | `default` | El espacio de trabajo actual de Terraform |
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
*: Esta variable solamente puede ser usada como parte de una cadena de caracteres de estilo
### Ejemplo
#### Con Terraform Version
```toml
# ~/.config/starship.toml
[terraform]
format = '[🏎💨 $version$workspace]($style) '
```
#### Sin Terraform Version
```toml
# ~/.config/starship.toml
[terraform]
format = '[🏎💨 $workspace]($style) '
```
## Time
El módulo `time` muestra la hora **local** actual. El valor de configuración de `format` es usado por el crate de [`chrono`](https://crates.io/crates/chrono) para controlar cómo se muestra la hora. Echa un vistazo a [los documentos de chrono strftime](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) para ver qué opciones están disponibles.
::: tip
Este módulo está deshabilitado por defecto. Para activarlo, establece `disabled` como `false` en tu archivo de configuración.
:::
### Opciones
| Opción | Predeterminado | Descripción |
| ----------------- | ----------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `format` | `'at [$time]($style) '` | La cadena de formato para el módulo. |
| `use_12hr` | `false` | Habilita el formato de 12 horas |
| `time_format` | see below | La [cadena de formato de chrono](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) utilizada para dar formato a la hora. |
| `style` | `'bold yellow'` | El estilo para el módulo de time |
| `utc_time_offset` | `'local'` | Establece el desplazamiento UTC a utilizar. Rango de -24 < x < 24. Permite a los flotantes acomodar los desplazamientos de zona horaria de 30/45 minutos. |
| `disabled` | `true` | Deshabilita el módulo `time`. |
| `time_range` | `'-'` | Establece el intervalo de tiempo durante el cual se mostrará el módulo. Las horas deben especificarse en formato de 24 horas |
If `use_12hr` is `true`, then `time_format` defaults to `'%r'`. De lo contrario, el valor predeterminado es `'%T'`. Configurar manualmente `time_format` sobrescribirá la configuración `use_12hr`.
### Variables
| Variable | Ejemplo | Descripción |
| --------- | ---------- | ------------------------------------- |
| tiempo | `13:08:10` | La hora actual. |
| style\* | | Refleja el valor de la opción `style` |
*: Esta variable solamente puede ser usada como parte de una cadena de caracteres de estilo
### Ejemplo
```toml
# ~/.config/starship.toml
[time]
disabled = false
format = '🕙[\[ $time \]]($style) '
time_format = '%T'
utc_time_offset = '-5'
time_range = '10:00:00-14:00:00'
```
## Typst
The `typst` module shows the current installed version of Typst used in a project.
Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones:
- El directorio actual contiene un archivo `template.typ`
- The current directory contains any `*.typ` file
### Opciones
| Opción | Predeterminado | Descripción |
| ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | El formato del módulo. |
| `version_format` | `'v${raw}'` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'t '` | A format string representing the symbol of Daml |
| `style` | `'bold #0093A7'` | El estilo del módulo. |
| `detect_extensions` | `['.typ']` | Qué extensiones deberían activar este módulo. |
| `detect_files` | `['template.typ']` | Qué nombres de archivo deberían activar este módulo. |
| `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. |
| `disabled` | `false` | Deshabilita el módulo `daml`. |
### Variables
| Variable | Ejemplo | Descripción |
| ------------- | --------- | ----------------------------------------------- |
| version | `v0.9.0` | The version of `typst`, alias for typst_version |
| typst_version | `default` | The current Typst version |
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
*: Esta variable solamente puede ser usada como parte de una cadena de caracteres de estilo
## Username
El módulo `username` muestra el nombre de usuario activo. El módulo se mostrará si se cumplen alguna de las siguientes condiciones:
- El usuario actual es root/admin
- El usuario actual no es el mismo que el que está conectado
- El usuario está actualmente conectado como una sesión SSH
- La variable `show_always` se establece en true
::: tip
La conexión SSH se detecta comprobando las variables de entorno `SSH_CONNECTION`, `SSH_CLIENT`, y `SSH_TTY`. Si tu host SSH no configura estas variables, una solución es establecer una de ellas con un valor tonto.
:::
### Opciones
| Opción | Predeterminado | Descripción |
| ------------- | ----------------------- | ------------------------------------------------ |
| `style_root` | `'bold red'` | El estilo usado cuando el usuario es root/admin. |
| `style_user` | `'bold yellow'` | El estilo usado para usuarios no root. |
| `format` | `'[$user]($style) in '` | El formato del módulo. |
| `show_always` | `false` | Siempre muestra el módulo `username`. |
| `disabled` | `false` | Deshabilita el módulo `username`. |
### Variables
| Variable | Ejemplo | Descripción |
| --------- | ------------ | --------------------------------------------------------------------------------------------------- |
| `style` | `'red bold'` | Refleja el valor de la opción `style_root` cuando root inició sesión y `style_user` por otra parte. |
| `usuario` | `'matchai'` | El ID de usuario conectado actualmente. |
### Ejemplo
```toml
# ~/.config/starship.toml
[username]
style_user = 'white bold'
style_root = 'black bold'
format = 'user: [$user]($style) '
disabled = false
show_always = true
```
## Vagrant
El módulo `vagrant` muestra la versión instalada de [Vagrant](https://www.vagrantup.com/). Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones:
- El directorio actual contiene un archivo `Vagrantfile`
### Opciones
| Opción | Predeterminado | Descripción |
| ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | El formato del módulo. |
| `version_format` | `'v${raw}'` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'⍱ '` | Una cadena de formato que representa el símbolo de Vagrant. |
| `detect_extensions` | `[]` | Qué extensiones deberían activar este módulo. |
| `detect_files` | `['Vagrantfile']` | Qué nombres de archivo deberían activar este módulo. |
| `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. |
| `style` | `'cyan bold'` | El estilo del módulo. |
| `disabled` | `false` | Deshabilita el módulo `vagrant`. |
### Variables
| Variable | Ejemplo | Descripción |
| --------- | ---------------- | -------------------------------------- |
| version | `Vagrant 2.2.10` | La versión de `Vagrant` |
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
*: Esta variable solamente puede ser usada como parte de una cadena de caracteres de estilo
### Ejemplo
```toml
# ~/.config/starship.toml
[vagrant]
format = 'via [⍱ $version](bold white) '
```
## V
El módulo `vlang` te muestra la versión instalada de [V](https://vlang.io/). Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones:
- El directorio actual contiene un archivo con la extensión `.v`
- El directorio actual contiene un archivo `v.mod`, `vpkg.json` o `.vpkg-lock.json`
### Opciones
| Opción | Predeterminado | Descripción |
| ------------------- | -------------------------------------------- | --------------------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | El formato del módulo. |
| `version_format` | `'v${raw}'` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'V '` | Una cadena de formato que representa el símbolo de V |
| `detect_extensions` | `['v']` | Qué extensiones deberían activar este módulo. |
| `detect_files` | `['v.mod', 'vpkg.json', '.vpkg-lock.json' ]` | Qué nombres de archivo deberían activar este módulo. |
| `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. |
| `style` | `'blue bold'` | El estilo del módulo. |
| `disabled` | `false` | Deshabilita el módulo `vlang`. |
### Variables
| Variable | Ejemplo | Descripción |
| --------- | ------- | -------------------------------------- |
| version | `v0.2` | La versión de `v` |
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
### Ejemplo
```toml
# ~/.config/starship.toml
[vlang]
format = 'via [V $version](blue bold) '
```
## VCSH
El módulo `vcsh` muestra el repositorio activo [VCSH](https://github.com/RichiH/vcsh) actual. El módulo sólo se mostrará si un repositorio está actualmente en uso.
### Opciones
| Opción | Predeterminado | Descripción |
| ---------- | -------------------------------- | ------------------------------------------------------------ |
| `symbol` | `''` | El símbolo usado antes de mostrar el nombre del repositorio. |
| `style` | `'bold yellow'` | El estilo del módulo. |
| `format` | `'vcsh [$symbol$repo]($style) '` | El formato del módulo. |
| `disabled` | `false` | Deshabilita el módulo `vcsh`. |
### Variables
| Variable | Ejemplo | Descripción |
| --------- | ----------------------------------------------------------- | -------------------------------------- |
| repo | `dotfiles` si está en un repositorio VCSH nombrado dotfiles | El nombre del repositorio activo |
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | `black bold dimmed` | Refleja el valor de la opción `style` |
*: Esta variable solamente puede ser usada como parte de una cadena de caracteres de estilo
### Ejemplo
```toml
# ~/.config/starship.toml
[vcsh]
format = '[🆅 $repo](bold blue) '
```
## Zig
By default the `zig` module shows the currently installed version of [Zig](https://ziglang.org/). El módulo se mostrará si se cumplen alguna de las siguientes condiciones:
- El directorio actual contiene un archivo `.zig`
### Opciones
| Opción | Predeterminado | Descripción |
| ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | El formato del módulo. |
| `version_format` | `'v${raw}'` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'↯ '` | El símbolo usado antes de mostrar la versión de Zig. |
| `style` | `'bold yellow'` | El estilo del módulo. |
| `disabled` | `false` | Deshabilita el módulo `zig`. |
| `detect_extensions` | `['zig']` | Qué extensiones deberían activar este módulo. |
| `detect_files` | `[]` | Qué nombres de archivo deberían activar este módulo. |
| `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. |
### Variables
| Variable | Ejemplo | Descripción |
| --------- | -------- | -------------------------------------- |
| version | `v0.6.0` | La versión de `zig` |
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
*: Esta variable solamente puede ser usada como parte de una cadena de caracteres de estilo
### Ejemplo
```toml
# ~/.config/starship.toml
[zig]
symbol = '⚡️ '
```
## Comandos personalizados
Los módulos `personalizados` muestran la salida de algunos comandos arbitrarios.
Estos módulos se mostrarán si se cumple alguna de las siguientes condiciones:
- El directorio actual contiene un archivo cuyo nombre está en `detect_files`
- El directorio actual contiene un directorio cuyo nombre está en `detect_folders`
- El directorio actual contiene un archivo cuya extensión está en `detect_extensions`
- El comando `when` devuelve 0
- El sistema operativo actual (std::env::consts::OS) coincide con el campo `os` si está definido.
::: tip
Múltiples módulos personalizados pueden definirse usando un `.` (un punto).
:::
::: tip
El orden en el que se muestran los módulos personalizados se puede establecer individualmente incluyendo `${custom.foo}` en el `format` de nivel superior (ya que incluye un punto, necesita usar `${...}`). Por defecto, el módulo `personalizado` simplemente mostrará todos los módulos personalizados en el orden en que fueron definidos.
:::
::: tip
[El problema #1252](https://github.com/starship/starship/discussions/1252) contiene ejemplos de módulos personalizados. ¡Si tienes un ejemplo interesante no cubierto, siéntete libre de compartirlo ahí!
:::
::: warning la salida de comandos se imprime sin escapar al prompt
Cualquiera que sea la salida que genere el comando se imprime sin modificar en el prompt. Esto significa que si la salida contiene secuencias especiales que son interpretadas por el intérprete, se expandirán cuando se muestre. Estas secuencias especiales son específicas del intérprete, por ejemplo, puedes escribir un módulo de comando que escribe secuencias de bash, por ejemplo, `\h`, pero este módulo no funcionará en el intérprete fish o zsh.
Las cadenas de formato también pueden contener secuencias específicas del intérprete, por ejemplo, [Bash](https://www.gnu.org/software/bash/manual/html_node/Controlling-the-Prompt.html), [Zsh](https://zsh.sourceforge.io/Doc/Release/Prompt-Expansion.html).
:::
### Opciones
| Opción | Predeterminado | Descripción |
| ------------------- | -------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `comando` | `''` | El comando cuya salida debe ser impresa. El comando se pasará en stdin al intérprete de comandos. |
| `cuando` | `false` | Valor booleano (`true` o `false`, sin comillas) o un comando de shell usado como una condición para mostrar el módulo. En caso de una cadena, el módulo se mostrará si el comando devuelve un código de estado `0`. |
| `require_repo` | `false` | If `true`, the module will only be shown in paths containing a (git) repository. This option alone is not sufficient display condition in absence of other options. |
| `shell` | | [Ver a continuación](#custom-command-shell) |
| `description` | `''` | La descripción del módulo que se muestra al ejecutar `starship explain`. |
| `detect_files` | `[]` | Los archivos que se buscarán en el directorio de trabajo para obtener una coincidencia. |
| `detect_folders` | `[]` | Los directorios que se buscarán en el directorio de trabajo para una coincidencia. |
| `detect_extensions` | `[]` | Las extensiones que se buscarán en el directorio de trabajo para obtener una coincidencia. |
| `symbol` | `''` | El símbolo usado antes de mostrar la salida del comando. |
| `style` | `'bold green'` | El estilo del módulo. |
| `format` | `'[$symbol($output )]($style)'` | El formato del módulo. |
| `disabled` | `false` | Deshabilita este módulo `custom`. |
| `os` | | Nombre del sistema operativo en el que se mostrará el módulo (unix, linux, macos, windows, ... ) [Ver valores posibles](https://doc.rust-lang.org/std/env/consts/constant.OS.html). |
| `use_stdin` | | Un valor booleano opcional que anula si los comandos deben ser reenviados al shell a través de la entrada estándar o como argumento. Si la entrada estándar unset es usada de manera predeterminada, a menos que el shell no lo soporte (cmd, nushell). Configurar esto desactiva el manejo de argumentos específicos del shell. |
| `ignore_timeout` | `false` | Ignorar la configuración global de `command_timeout` y seguir ejecutando comandos externos, sin importar el tiempo que tarden. |
### Variables
| Variable | Descripción |
| --------- | ----------------------------------------------------------- |
| salida | La salida del comando del intérprete de comandos en `shell` |
| symbol | Refleja el valor de la opción `symbol` |
| style\* | Refleja el valor de la opción `style` |
*: Esta variable solamente puede ser usada como parte de una cadena de caracteres de estilo
#### Comando personalizado del intérprete de comandos
`shell` acepta una lista no vacía de cadenas, donde:
- La primera cadena es la ruta al intérprete de comandos a usar para ejecutar el comando.
- Otros argumentos siguientes son pasados al intérprete de comandos.
If unset, it will fallback to STARSHIP_SHELL and then to 'sh' on Linux, and 'cmd /C' on Windows.
El `comando` será pasado en stdin.
Si no se da el `shell` o solo contiene un elemento y Starship detecta PowerShell los siguientes argumentos se añadirán automáticamente: `-NoProfile -Command -`. If `shell` is not given or only contains one element and Starship detects Cmd will be used, the following argument will automatically be added: `/C` and `stdin` will be set to `false`. If `shell` is not given or only contains one element and Starship detects Nushell will be used, the following arguments will automatically be added: `-c` and `stdin` will be set to `false`. Este comportamiento puede evitarse pasando explícitamente argumentos al intérprete de comandos, p.ej.
```toml
shell = ['pwsh', '-Command', '-']
```
::: warning Asegúrate de que tu configuración personalizada del intérprete de comandos salga con éxito
Si estableces un comando personalizado, asegúrate de que el intérprete de comandos por defecto usado por Starship ejecutará correctamente el comando con una salida elegante (a través de la opción `shell`).
Por ejemplo, PowerShell requiere el parámetro `-Command` para ejecutar una sola línea. Omitir este parámetro puede arrojar a Starship a un bucle recursivo donde el intérprete de comandos podría intentar cargar un entorno de perfil completo con Starship en sí misma y volver a ejecutar el comando personalizado, entrando en un bucle infinito.
Se recomiendan parámetros similares a `-NoProfile` en PowerShell para otros intérprete de comandos también para evitar tiempo extra de carga de un perfil personalizado en cada invocación de Starship.
La detección automática de intérpretes de comandos y la adición adecuada de parámetros están actualmente implementados, pero es posible que no todos los intérpretes de comandos estén cubiertos. Por favor, [abre un problema](https://github.com/starship/starship/issues/new/choose) con los detalles del intérprete de comandos y la configuración de Starship si te encuentras en tal escenario.
:::
### Ejemplo
```toml
# ~/.config/starship.toml
[custom.foo]
command = 'echo foo' # shows output of command
detect_files = ['foo'] # can specify filters but wildcards are not supported
when = ''' test "$HOME" = "$PWD" '''
format = ' transcending [$output]($style)'
[custom.time]
command = 'time /T'
detect_extensions = ['pst'] # filters *.pst files
shell = ['pwsh.exe', '-NoProfile', '-Command', '-']
[custom.time-as-arg]
command = 'time /T'
detect_extensions = ['pst'] # filters *.pst files
shell = ['pwsh.exe', '-NoProfile', '-Command']
use_stdin = false
```
|