2020-01-15 12:23:25 -05:00
# Configuración
2020-11-28 23:45:59 -05:00
Para comenzar a configurar Starship, crea el siguiente archivo: `~/.config/starship.toml` .
2020-01-15 12:23:25 -05:00
2020-02-07 16:47:30 -05:00
``` sh
2021-04-05 10:55:57 -04:00
mkdir -p ~/.config && starship print-config --default > ~/.config/starship.toml
2020-01-15 12:23:25 -05:00
```
2020-11-28 23:45:59 -05:00
Toda la configuración de Starship se realiza en este archivo [TOML ](https://github.com/toml-lang/toml ):
2020-01-15 12:23:25 -05:00
``` toml
2021-03-15 13:18:42 -04:00
# Inserta una línea en blanco al inicio del prompt
add_newline = true
2020-01-15 12:23:25 -05:00
2021-03-15 13:18:42 -04:00
# Reemplaza el símbolo "❯ " por "➜" en el prompt
[ character ] # El nombre del módulo que se está configurandoes "character"
success_symbol = "[➜](bold green)" # El segmento "success_symbol" es reemplzado por "➜" con el color "bold green"
2020-01-15 12:23:25 -05:00
2021-03-15 13:18:42 -04:00
# Deshabilita el módulo "package", ocultándolo por completo del prompt
2020-01-15 12:23:25 -05:00
[ package ]
disabled = true
```
2021-03-15 13:18:42 -04:00
Puedes cambiar la ubicación por defecto del archivo de configuración con la variable de entorno `STARSHIP_CONFIG` :
2020-07-23 17:07:10 -04:00
2020-02-07 16:47:30 -05:00
``` sh
2021-02-21 14:13:18 -05:00
export STARSHIP_CONFIG = ~/.starship/config.toml
2020-01-15 12:23:25 -05:00
```
2020-06-10 21:28:04 -04:00
El equivalente en PowerShell (Windows) es añadir esta línea a tu `$PROFILE` :
2020-07-23 17:07:10 -04:00
2021-01-26 17:07:13 -05:00
``` powershell
2021-02-21 14:13:18 -05:00
$ENV:STARSHIP_CONFIG = " $HOME \.starship\config.toml "
2020-05-23 19:10:58 -04:00
```
2020-11-28 23:45:59 -05:00
### Registros
2020-09-30 16:26:13 -04:00
2020-11-28 23:45:59 -05:00
Starship registra por defecto los mensajes de advertencia y error en un fichero con nombre `~/.cache/starship/session_${STARSHIP_SESSION_KEY}.log` , en el que la clave de sesión corresponde con una instancia de tu terminal. Esto, sin embargo, puede ser cambiado usando la variable de entorno `STARSHIP_CACHE` :
2020-09-30 16:26:13 -04:00
``` sh
export STARSHIP_CACHE = ~/.starship/cache
```
El equivalente en PowerShell (Windows) es añadir esta línea a tu `$PROFILE` :
2021-01-26 17:07:13 -05:00
``` powershell
2020-09-30 16:26:13 -04:00
$ENV:STARSHIP_CACHE = " $HOME \AppData\Local\Temp "
```
2020-09-30 21:23:36 -04:00
### Terminología
2020-01-15 12:23:25 -05:00
2020-11-28 23:45:59 -05:00
**Módulo ** : un componente en el promt que provee información basada en información contextual de tu sistema operativo. Por ejemplo, el módulo "nodejs" muestra la versión de NodeJS que tienes actualmente instalada en tu ordenador, si el directorio actual es un proyecto NodeJS.
2020-01-15 12:23:25 -05:00
2021-01-26 17:07:13 -05:00
**Variable ** : subcomponentes más pequeños que contienen información proporcionada por el módulo. Por ejemplo, la variable "version" en el módulo "nodejs" contiene la versión actual de NodeJS.
2020-01-15 12:23:25 -05:00
2021-03-15 13:18:42 -04:00
Por convención, la mayoría de los módulos tienen un prefijo del color por defecto de la terminal (por ejemplo, `vía` en "nodejs") y un espacio vacío como sufijo.
2020-01-15 12:23:25 -05:00
2020-11-28 23:45:59 -05:00
### Cadenas de Formato
2020-07-23 17:07:10 -04:00
2020-09-30 21:23:36 -04:00
Es el formato con el que un módulo imprime todas sus variables. La mayoría de los módulos tienen una entrada llamada `format` que configura el formato de visualización del módulo. Se puede utilizar textos, variables y grupos de texto.
2020-07-23 17:07:10 -04:00
#### Variable
2020-09-30 21:23:36 -04:00
Una variable contiene un símbolo `$` seguido por el nombre de la variable. El nombre de una variable solo contiene letras, números y `_` .
2020-07-23 17:07:10 -04:00
2020-09-30 21:23:36 -04:00
Por ejemplo:
2020-07-23 17:07:10 -04:00
2020-11-28 23:45:59 -05:00
- `$version` es una cadena de formato con una variable llamada `version` .
2020-09-30 16:26:13 -04:00
- `$git_branch$git_commit` es un formato de cadena de texto con dos variables nombradas `git_branch` y `git_commit` .
- `$git_branch $git_commit` tiene las dos variables separadas por un espacio.
2020-07-23 17:07:10 -04:00
2020-11-28 23:45:59 -05:00
#### Grupo de Texto
2020-07-23 17:07:10 -04:00
2020-09-30 21:23:36 -04:00
Un grupo de texto se compone de dos partes diferentes.
2020-07-23 17:07:10 -04:00
2020-11-28 23:45:59 -05:00
La primera parte, que está encerrada en un `[]` , es una [cadena de formato ](#format-strings ). Se puede agregar textos, variables, o incluso grupos de texto anidados.
2020-07-23 17:07:10 -04:00
2020-11-28 23:45:59 -05:00
En la segunda parte, que está encerrada entre `()` , es una [cadena de estilo ](#style-strings ). Se puede utilizar el estilo de la primera parte.
2020-07-23 17:07:10 -04:00
2020-09-30 21:23:36 -04:00
Por ejemplo:
2020-01-15 12:23:25 -05:00
2020-11-28 23:45:59 -05:00
- `[en](bold red)` imprimirá una cadena `en` con texto en negrita color rojo.
2021-03-15 13:18:42 -04:00
- `[⌘ $version](bold green)` imprimirá un símbolo `⌘` seguido por el contenido de la variable `version` , con texto en negrita color verde.
2020-11-28 23:45:59 -05:00
- `[a [b](red) c](green)` imprimirá `a b c` con `b` en rojo, `a` y `c` en verde.
2020-07-23 17:07:10 -04:00
#### Cadenas de estilo
2020-01-15 12:23:25 -05:00
2020-11-28 23:45:59 -05:00
La mayoría de los módulos de starship permiten configurar los estilos de su cadenas texto. Esto se consigue con una entrada (normalmente llamada `style` - estilo) que no es más que un texto donde se especifica la configuración. A continuación mostramos algunos ejemplos de cadenas de estilo junto con su funcionalidad. Para más detalles sobre la sintaxis completa, consulta [la guía de configuración avanzada ](/advanced-config/ ).
2020-01-15 12:23:25 -05:00
2020-05-05 13:07:34 -04:00
- `"fg:green bg:blue"` pone texto verde sobre un fondo azul
- `"bg:blue fg:bright-green"` pone texto verde claro sobre un fondo azul
- `"bold fg:27"` pone texto en negrita con [color ANSI ](https://i.stack.imgur.com/KTSQa.png ) 27
- `"underline bg:#bf5700"` subraya el texto sobre un fondo naranja oscuro
- `"bold italic fg:purple"` pone texto color morado, en negrita y cursiva
- `""` desactiva explícitamente cualquier estilo
2020-01-15 12:23:25 -05:00
2020-09-30 21:23:36 -04:00
Nótese que el estilo es similar a como se controlaría por el emulador de su terminal. Por ejemplo, algunos emuladores de terminal harán los colores más brillantes en lugar de más gruesos, y algunos temas usan los mismos valores para texto normal y colores brillantes. Además, para mostrar textos en cursiva tu terminal debe tener soporte para hacerlo.
2020-01-15 12:23:25 -05:00
2020-11-28 23:45:59 -05:00
#### Cadenas de Formato Condicional
2020-07-23 17:07:10 -04:00
2020-09-30 21:23:36 -04:00
Una cadena de formato condicional envuelto en `(` y `)` no se renderizará si todas las variables dentro están vacías.
2020-07-23 17:07:10 -04:00
2020-09-30 21:23:36 -04:00
Por ejemplo:
2020-07-23 17:07:10 -04:00
2020-09-30 16:26:13 -04:00
- `(@$region)` no mostrará nada si la variable `region` es `None` , de lo contrario `@` seguido por el valor de la región.
- `(algún texto)` siempre mostrará nada ya que no hay variables envueltas entre llaves.
2020-11-28 23:45:59 -05:00
- Cuando `$all` es un atajo para `\[$a$b\]` , `($all)` no mostrará nada solo si `$a` y `$b` ambos son `None` . Esto funciona igual que `(\[$a$b\] )` .
2020-07-23 17:07:10 -04:00
2020-11-28 23:45:59 -05:00
#### Caracteres de escape
2020-07-23 17:07:10 -04:00
2020-09-30 21:23:36 -04:00
Los siguientes símbolos tienen un uso especial en una cadena de formato. Si se quiere imprimir los siguientes símbolos, se tienen que escapar con una barra invertida (`\` ).
2020-07-23 17:07:10 -04:00
2020-09-30 16:26:13 -04:00
- \$
2020-07-23 17:07:10 -04:00
- \\
- [
- ]
- (
- )
2020-11-28 23:45:59 -05:00
Se debe tener en cuenta que `toml` tiene [su propia sintaxis de escape ](https://github.com/toml-lang/toml#user-content-string ). Se recomienda usar una cadena literal (`''` ) en la configuración. Si se desea utilizar una cadena básica (`""` ), prestar atención para escapar la barra invertida `\` .
2020-07-23 17:07:10 -04:00
2020-11-28 23:45:59 -05:00
Por ejemplo, cuando se desea imprimir un símbolo `$` en una nueva línea, las siguientes configuraciones para la variable `format` son equivalentes:
2020-07-23 17:07:10 -04:00
``` toml
2020-09-30 21:23:36 -04:00
# con cadena básica
2020-07-23 17:07:10 -04:00
format = "\n\\$"
2020-09-30 21:23:36 -04:00
# con cadena básica multilínea
2020-07-23 17:07:10 -04:00
format = "" "
\\$" ""
2020-09-30 21:23:36 -04:00
# con cadena literal
2020-07-23 17:07:10 -04:00
format = '' '
\$' ''
```
2020-09-30 16:26:13 -04:00
## Prompt
2020-01-15 12:23:25 -05:00
2021-03-15 13:18:42 -04:00
Esta es la lista de opciones de configuración del prompt.
2020-01-15 12:23:25 -05:00
2020-05-05 13:07:34 -04:00
### Opciones
2020-01-15 12:23:25 -05:00
2021-03-15 13:18:42 -04:00
| Opción | Por defecto | Descripción |
| -------------- | ---------------------------------- | ------------------------------------------------------------------------------ |
| `format` | [ver aquí ](#default-prompt-format ) | Configura el formato del prompt. |
| `scan_timeout` | `30` | Tiempo de espera tras el que Starship escanea los archivos (en milisegundos). |
| `add_newline` | `true` | Inserta un línea en blanco entre las instrucciones del intérprete de comandos. |
2020-01-15 12:23:25 -05:00
2020-05-05 13:07:34 -04:00
### Ejemplo
2020-01-15 12:23:25 -05:00
``` toml
# ~/.config/starship.toml
2020-09-30 21:23:36 -04:00
# Usar formato personalizado
2020-07-23 17:07:10 -04:00
format = "" "
[┌───────────────────>](bold green)
[│](bold green)$directory$rust$package
[└─>](bold green) " ""
2020-09-30 21:23:36 -04:00
# Espera 10 milisegundos para que starship revise los archivos del directorio actual.
2020-01-15 12:23:25 -05:00
scan_timeout = 10
2020-09-30 16:26:13 -04:00
2021-03-15 13:18:42 -04:00
# Deshabilita la línea en blanco al inicio del prompt
2020-09-30 16:26:13 -04:00
add_newline = false
2020-01-15 12:23:25 -05:00
```
2020-11-28 23:45:59 -05:00
### Formato por Defecto del Prompt
2020-01-15 12:23:25 -05:00
2020-11-28 23:45:59 -05:00
La varieble `format` por defecto se utiliza para definir el formato del prompt, si está vacía o `format` no se proporciona. El valor por defecto es el siguiente:
2020-01-15 12:23:25 -05:00
``` toml
2020-09-30 16:26:13 -04:00
format = "$all"
2020-07-23 17:07:10 -04:00
2021-04-05 10:55:57 -04:00
# el cual es el equivalente a
2020-07-23 17:07:10 -04:00
format = "" "
$username\
$hostname\
2020-09-30 16:26:13 -04:00
$shlvl\
2020-07-23 17:07:10 -04:00
$kubernetes\
$directory\
2021-04-05 10:55:57 -04:00
$vcsh\
2020-07-23 17:07:10 -04:00
$git_branch\
$git_commit\
$git_state\
$git_status\
$hg_branch\
$docker_context\
$package\
$cmake\
2020-09-30 16:26:13 -04:00
$dart\
2020-07-23 17:07:10 -04:00
$dotnet\
$elixir\
$elm\
$erlang\
$golang\
$helm\
$java\
$julia\
2021-01-03 03:56:07 -05:00
$kotlin\
2020-07-23 17:07:10 -04:00
$nim\
$nodejs\
$ocaml\
2020-09-30 16:26:13 -04:00
$perl\
2020-07-23 17:07:10 -04:00
$php\
$purescript\
$python\
$ruby\
$rust\
2021-03-15 13:18:42 -04:00
$scala\
2020-09-30 16:26:13 -04:00
$swift\
2020-07-23 17:07:10 -04:00
$terraform\
2021-02-06 12:46:15 -05:00
$vagrant\
2020-07-23 17:07:10 -04:00
$zig\
$nix_shell\
$conda\
$memory_usage\
$aws\
2020-09-30 16:26:13 -04:00
$gcloud\
2020-11-28 23:45:59 -05:00
$openstack\
2020-07-23 17:07:10 -04:00
$env_var\
$crystal\
$custom\
2021-01-03 03:56:07 -05:00
$cmd_duration\
2020-07-23 17:07:10 -04:00
$line_break\
2020-11-28 23:45:59 -05:00
$lua\
2020-07-23 17:07:10 -04:00
$jobs\
$battery\
$time\
2020-09-30 16:26:13 -04:00
$status\
2021-02-21 14:13:18 -05:00
$shell\
2020-07-23 17:07:10 -04:00
$character" ""
2020-01-15 12:23:25 -05:00
```
## AWS
2020-11-28 23:45:59 -05:00
El módulo `aws` muestra la región y el perfil actual de AWS. Éste se basa en las variables de entorno `AWS_REGION` , `AWS_DEFAULT_REGION` , y `AWS_PROFILE` del fichero `~/.aws/config` .
2020-01-15 12:23:25 -05:00
2020-09-30 21:23:36 -04:00
Cuando uses [aws-vault ](https://github.com/99designs/aws-vault ) el perfil se obtiene de la variable de entorno `AWS_VAULT` .
2020-04-06 14:48:26 -04:00
2021-04-05 10:55:57 -04:00
Cuando uses [awsu ](https://github.com/kreuzwerker/awsu ) el perfil se obtiene de la variable de entorno `AWSU_PROFILE` .
2021-03-15 13:18:42 -04:00
2020-05-05 13:07:34 -04:00
### Opciones
2020-01-15 12:23:25 -05:00
2021-03-15 13:18:42 -04:00
| Opción | Por defecto | Descripción |
| ---------------- | --------------------------------------------------- | ------------------------------------------------------------ |
| `format` | `'on [$symbol($profile )(\($region\) )]($style)'` | El formato del módulo. |
| `symbol` | `"☁️ "` | El símbolo que se muestra antes del perfil de AWS. |
| `region_aliases` | | Tabla de alias de región para mostrar además del nombre AWS. |
| `style` | `"bold yellow"` | El estilo del módulo. |
2021-04-05 10:55:57 -04:00
| `disabled` | `false` | Deshabilita el módulo `aws` . |
2020-01-15 12:23:25 -05:00
2020-07-23 17:07:10 -04:00
### Variables
2020-09-30 16:26:13 -04:00
| Variable | Ejemplo | Descripción |
| --------- | ---------------- | -------------------------------------- |
| region | `ap-northeast-1` | La región actual de AWS |
| profile | `astronauts` | El perfil actual de AWS |
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
2020-07-23 17:07:10 -04:00
2021-04-05 10:55:57 -04:00
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
2020-07-23 17:07:10 -04:00
2020-09-30 21:23:36 -04:00
### Ejemplos
2020-07-23 17:07:10 -04:00
2020-09-30 16:26:13 -04:00
#### Mostrar todo
2020-01-15 12:23:25 -05:00
``` toml
# ~/.config/starship.toml
[ aws ]
2021-03-15 13:18:42 -04:00
format = 'on [$symbol($profile )(\($region\) )]($style)'
2020-01-15 12:23:25 -05:00
style = "bold blue"
symbol = "🅰 "
[ aws . region_aliases ]
ap-southeast-2 = "au"
us-east-1 = "va"
```
2020-09-30 16:26:13 -04:00
#### Mostrar región
2020-07-23 17:07:10 -04:00
``` toml
# ~/.config/starship.toml
[ aws ]
2020-11-28 23:45:59 -05:00
format = "en [$symbol$region]($style) "
2020-07-23 17:07:10 -04:00
style = "bold blue"
symbol = "🅰 "
[ aws . region_aliases ]
ap-southeast-2 = "au"
us-east-1 = "va"
```
2020-09-30 16:26:13 -04:00
#### Mostrar perfil
2020-07-23 17:07:10 -04:00
``` toml
# ~/.config/starship.toml
[ aws ]
2020-11-28 23:45:59 -05:00
format = "en [$symbol$profile]($style) "
2020-07-23 17:07:10 -04:00
style = "bold blue"
symbol = "🅰 "
```
2020-01-15 12:23:25 -05:00
## Battery
2021-04-05 10:55:57 -04:00
El módulo `battery` muestra qué tan cargada está la batería del dispositivo y su estado de carga actual. El módulo sólo es visible cuando la batería del dispositivo está por debajo del 10%.
2020-01-15 12:23:25 -05:00
2020-05-05 13:07:34 -04:00
### Opciones
2020-01-15 12:23:25 -05:00
2021-01-07 18:08:18 -05:00
| Opción | Por defecto | Descripción |
| -------------------- | --------------------------------- | ------------------------------------------------------------------------ |
2021-04-05 10:55:57 -04:00
| `full_symbol` | `" "` | Se muestra cuando la batería está cargada. |
| `charging_symbol` | `" "` | Se muestra cuando la batería se está cargando. |
| `discharging_symbol` | `" "` | Se muestra cuando la batería se está descargando. |
| `unknown_symbol` | `" "` | El símbolo que se muestra cuando el estado de la batería es desconocido. |
| `empty_symbol` | `" "` | El símbolo que se muestra cuando el estado de la batería está vacío. |
2021-01-07 18:08:18 -05:00
| `format` | `"[$symbol$percentage]($style) "` | El formato del módulo. |
| `display` | [ver aquí ](#battery-display ) | Define cuándo mostrar el indicador y el estilo. |
| `disabled` | `false` | Desactiva el módulo `battery` . |
2020-01-15 12:23:25 -05:00
2020-05-05 13:07:34 -04:00
### Ejemplo
2020-01-15 12:23:25 -05:00
``` toml
# ~/.config/starship.toml
[ battery ]
2021-04-05 10:55:57 -04:00
full_symbol = "🔋 "
charging_symbol = "⚡️ "
discharging_symbol = "💀 "
2020-01-15 12:23:25 -05:00
```
2020-09-30 21:23:36 -04:00
### Indicador de batería
2020-01-15 12:23:25 -05:00
2021-04-05 10:55:57 -04:00
La opción de configuración de `display` se utiliza para definir cuándo se debe mostrar el indicador de batería (umbral) y cómo se ve (estilo). Si no se provee ningún valor para `display` . El valor por defecto es el siguiente:
2020-01-15 12:23:25 -05:00
``` toml
[ [ battery . display ] ]
threshold = 10
style = "bold red"
```
2020-05-05 13:07:34 -04:00
#### Opciones
2020-01-15 12:23:25 -05:00
2021-04-05 10:55:57 -04:00
La opción `display` es un arreglo de la siguiente tabla.
2020-01-15 12:23:25 -05:00
2021-01-07 18:08:18 -05:00
| Opción | Descripción |
| ----------- | --------------------------------------------------------------- |
| `threshold` | El umbral para la opción de visualización. |
| `style` | El estilo usado cuando si la opción <0>display</0> está activa. |
2020-01-15 12:23:25 -05:00
2020-05-05 13:07:34 -04:00
#### Ejemplo
2020-01-15 12:23:25 -05:00
``` toml
2020-09-30 21:23:36 -04:00
[ [ battery . display ] ] # "bold red" cuando la carga está entre 0% y 10%
2020-01-15 12:23:25 -05:00
threshold = 10
style = "bold red"
2020-09-30 21:23:36 -04:00
[ [ battery . display ] ] # "bold yellow" cuando la carga está entre 10% y 30%
2020-01-15 12:23:25 -05:00
threshold = 30
style = "bold yellow"
2020-09-30 21:23:36 -04:00
# cuando la carga está por encima del 30% el indicador no se mostrará
2020-01-15 12:23:25 -05:00
```
## Character
2021-04-05 10:55:57 -04:00
El módulo `character` muestra un caracter (normalmente una flecha) tras el texto que introduces en el terminal.
2020-01-15 12:23:25 -05:00
2021-04-05 10:55:57 -04:00
El carácter mostrará si el último comando funcionó o no. Se puede hacer de dos maneras:
2020-07-23 17:07:10 -04:00
2020-11-28 23:45:59 -05:00
- Cambiando el color (`red` /`green` )
- Cambiando la forma (`.` /`✖` )
2020-07-23 17:07:10 -04:00
2021-04-05 10:55:57 -04:00
Por defecto sólo cambia el color. Si también se quiere cambiar su forma, ver [este ejemplo ](#with-custom-error-shape ).
2020-01-15 12:23:25 -05:00
2021-04-05 10:55:57 -04:00
::: advertencia `error_symbol` no es compatible con el intérprete de comandos Elvish. :::
2021-02-06 12:46:15 -05:00
2020-05-05 13:07:34 -04:00
### Opciones
2020-01-15 12:23:25 -05:00
2021-01-07 18:08:18 -05:00
| Opción | Por defecto | Descripción |
| ---------------- | ------------------- | ------------------------------------------------------------------------------------------------------- |
| `format` | `"$symbol "` | La cadena de formato usada antes de la entrada de texto. |
| `success_symbol` | `"[❯ ](bold green)"` | La cadena de formato usada antes de la entrada de texto si el comando anterior tuvo éxito. |
| `error_symbol` | `"[❯ ](bold red)"` | La cadena de formato usada antes de la entrada de texto si el comando anterior falló. |
| `vicmd_symbol` | `"[❮ ](bold green)"` | El cadena de formato antes de la entrada de texto si el intérprete de comandos está en modo vim normal. |
| `disabled` | `false` | Desactiva el módulo `character` . |
2020-01-15 12:23:25 -05:00
2020-07-23 17:07:10 -04:00
### Variables
2021-01-07 18:08:18 -05:00
| Variable | Ejemplo | Descripción |
| -------- | ------- | -------------------------------------------------------------- |
| symbol | | Un espejo de `success_symbol` , `error_symbol` o `vicmd_symbol` |
2020-07-23 17:07:10 -04:00
2020-09-30 21:23:36 -04:00
### Ejemplos
2020-07-23 17:07:10 -04:00
2020-11-28 23:45:59 -05:00
#### Con formato de error personalizado
2020-01-15 12:23:25 -05:00
``` toml
# ~/.config/starship.toml
[ character ]
2020-07-23 17:07:10 -04:00
success_symbol = "[➜](bold green) "
error_symbol = "[✗](bold red) "
2020-01-15 12:23:25 -05:00
```
2020-11-28 23:45:59 -05:00
#### Sin formato de error personalizado
2020-07-23 17:07:10 -04:00
``` toml
# ~/.config/starship.toml
[ character ]
success_symbol = "[➜](bold green) "
error_symbol = "[➜](bold red) "
```
2020-11-28 23:45:59 -05:00
#### Con formato de vim personalizado
2020-07-23 17:07:10 -04:00
``` toml
# ~/.config/starship.toml
[ character ]
vicmd_symbol = "[V](bold green) "
```
## CMake
2021-04-05 10:55:57 -04:00
El módulo `cmake` muestra la versión instalada de CMake. Por defecto el módulo se activará si se cumplen cualquiera de las siguientes condiciones:
2020-07-23 17:07:10 -04:00
2020-09-30 16:26:13 -04:00
- El directorio actual contiene un archivo `CMakeLists.txt`
2020-11-28 23:45:59 -05:00
- El directorio actual contiene un archivo `CMakeCache.txt`
2020-07-23 17:07:10 -04:00
### Opciones
2021-02-21 14:13:18 -05:00
| Opción | Por defecto | Descripción |
| ------------------- | -------------------------------------- | ------------------------------------------------ |
| `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. |
2021-03-15 13:18:42 -04:00
| `symbol` | `"△ "` | El símbolo usado antes de la versión de cmake. |
2021-02-21 14:13:18 -05:00
| `detect_extensions` | `[]` | Qué extensiones deben activar este módulo |
| `detect_files` | `["CMakeLists.txt", "CMakeCache.txt"]` | Qué nombres de archivo deben activar este módulo |
| `detect_folders` | `[]` | Qué carpetas deben activar este módulo |
| `style` | `"bold blue"` | El estilo del módulo. |
2021-03-15 13:18:42 -04:00
| `disabled` | `false` | Deshabilita el módulo `cmake` . |
2020-07-23 17:07:10 -04:00
### Variables
2020-09-30 16:26:13 -04:00
| Variable | Ejemplo | Descripción |
| --------- | --------- | -------------------------------------- |
2021-01-07 18:08:18 -05:00
| version | `v3.17.3` | La versión de cmake |
2020-09-30 16:26:13 -04:00
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
2020-07-23 17:07:10 -04:00
2021-04-05 10:55:57 -04:00
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
2020-07-23 17:07:10 -04:00
2020-11-28 23:45:59 -05:00
## Tiempo de Ejecución
2020-01-15 12:23:25 -05:00
2021-04-05 10:55:57 -04:00
El módulo `cmd_duration` muestra cuánto tiempo tardó el último comando en ejecutarse. El módulo se mostrará solo si el comando tomó más de dos segundos, o si el valor de configuración de `min_time` existe.
2020-01-15 12:23:25 -05:00
2021-04-05 10:55:57 -04:00
::: advertencia No utilizar la trampa DEBUG en Bash
2020-01-15 12:23:25 -05:00
2021-04-05 10:55:57 -04:00
Si estás usando Starship con `bash` , no uses `DEBUG` después de ejecutar `eval $(starship init $0)` , o el módulo **se romperá ** .
2020-01-15 12:23:25 -05:00
:::
2021-04-05 10:55:57 -04:00
Los usuarios de Bash que necesiten la funcionalidad como preexec pueden usar el [framework bash_preexec de rcaloras ](https://github.com/rcaloras/bash-preexec ). Basta con definir los arreglos `preexec_functions` y `precmd_functions` antes de ejecutar `eval $(starship init $0)` , y luego proceder como siempre.
2020-01-15 12:23:25 -05:00
2020-05-05 13:07:34 -04:00
### Opciones
2020-01-15 12:23:25 -05:00
2021-01-26 17:07:13 -05:00
| Opción | Por defecto | Descripción |
| -------------------- | ----------------------------- | ---------------------------------------------------------------------- |
| `min_time` | `2_000` | Duración mínima para mostrar el tiempo de ejecución (en milisegundos) |
| `show_milliseconds` | `false` | Muestra la duración con precisión en milisegundos. |
| `format` | `"took [$duration]($style) "` | El formato del módulo. |
| `style` | `"bold yellow"` | El estilo del módulo. |
| `disabled` | `false` | Desactiva el módulo `cmd_duration` . |
| `show_notifications` | `false` | Muestra notificaciones de escritorio cuando se complete el comando. |
| `min_time_to_notify` | `45_000` | Duración mínima para mostrar el tiempo de ejecución (en milisegundos). |
2020-11-28 23:45:59 -05:00
2021-04-05 10:55:57 -04:00
::: consejo
2020-11-28 23:45:59 -05:00
2021-04-05 10:55:57 -04:00
Mostrar notificaciones de escritorio requiere que se construya Starship con soporte de `rust-notify` . Comprueba si tu Starship soporta notificaciones ejecutando `STARSHIP_LOG=debug starship module cmd_duration -d 60000` cuando `show_notifications` está establecido en `true` .
2020-11-28 23:45:59 -05:00
:::
2020-07-23 17:07:10 -04:00
### Variables
2021-01-07 18:08:18 -05:00
| Variable | Ejemplo | Descripción |
| --------- | -------- | ------------------------------------------ |
| duration | `16m40s` | El tiempo que tardó en ejecutar el comando |
| style\* | | Refleja el valor de la opción `style` |
2020-07-23 17:07:10 -04:00
2021-04-05 10:55:57 -04:00
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
2020-01-15 12:23:25 -05:00
2020-05-05 13:07:34 -04:00
### Ejemplo
2020-01-15 12:23:25 -05:00
``` toml
# ~/.config/starship.toml
[ cmd_duration ]
min_time = 500
2020-07-23 17:07:10 -04:00
format = "underwent [$duration](bold yellow)"
2020-01-15 12:23:25 -05:00
```
## Conda
2021-04-05 10:55:57 -04:00
El módulo `conda` muestra el entorno conda actual, si `$CONDA_DEFAULT_ENV` está configurado.
2020-01-15 12:23:25 -05:00
2021-04-05 10:55:57 -04:00
::: consejo
2020-01-15 12:23:25 -05:00
2021-04-05 10:55:57 -04:00
Esto no modifica el propio prompt de conda. En caso de querer suprimirlo, ejecuta `conda config --set changeps1 False` .
2020-01-15 12:23:25 -05:00
:::
2020-05-05 13:07:34 -04:00
### Opciones
2020-01-15 12:23:25 -05:00
2021-01-07 18:08:18 -05:00
| Opción | Por defecto | Descripción |
| ------------------- | -------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `truncation_length` | `1` | El número de directorios a los que se debe truncar la variable de entorno, si el entorno fue creado usando `conda create -p [path]` . `0` significa sin truncamiento. Mirar también el módulo [`directory` ](#directory ). |
| `symbol` | `"🅒 "` | El símbolo usado antes del nombre del entorno. |
| `style` | `"bold green"` | El estilo del módulo. |
| `format` | `"via [$symbol$environment]($style) "` | El formato del módulo. |
| `ignore_base` | `true` | Ignora el entorno `base` cuando se activa. |
| `disabled` | `false` | Desactiva el módulo `conda` . |
2020-07-23 17:07:10 -04:00
### Variables
2020-09-30 16:26:13 -04:00
| Variable | Ejemplo | Descripción |
| ----------- | ------------ | -------------------------------------- |
2021-01-07 18:08:18 -05:00
| environment | `astronauts` | El entorno conda actual |
2020-09-30 16:26:13 -04:00
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
2020-07-23 17:07:10 -04:00
2021-04-05 10:55:57 -04:00
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
2020-01-15 12:23:25 -05:00
2020-05-05 13:07:34 -04:00
### Ejemplo
2020-01-15 12:23:25 -05:00
``` toml
# ~/.config/starship.toml
[ conda ]
2020-07-23 17:07:10 -04:00
format = "[$symbol$environment](dimmed green) "
2020-01-15 12:23:25 -05:00
```
2020-04-03 12:35:39 -04:00
## Crystal
2021-04-05 10:55:57 -04:00
El módulo `crystal` muestra la versión actualmente instalada de Crystal. Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones:
2020-04-03 12:35:39 -04:00
2020-05-05 13:07:34 -04:00
- El directorio actual contiene un fichero `shard.yml`
- El directorio actual contiene un fichero `.cr`
2020-04-03 12:35:39 -04:00
2020-05-05 13:07:34 -04:00
### Opciones
2020-04-03 12:35:39 -04:00
2021-03-15 13:18:42 -04:00
| Opción | Por defecto | Descripción |
| ------------------- | ------------------------------------ | ---------------------------------------------------- |
| `symbol` | `"🔮 "` | Símbolo usado antes de la versión de Crystal. |
| `style` | `"bold red"` | El estilo del módulo. |
| `detect_extensions` | `["cr"]` | Qué extensiones deberían activar este módulo. |
| `detect_files` | `["shard.yml"]` | Qué nombres de archivo deberían activar este módulo. |
| `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. |
| `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. |
| `disabled` | `false` | Deshabilita el módulo `crystal` . |
2020-07-23 17:07:10 -04:00
### Variables
2020-09-30 16:26:13 -04:00
| Variable | Ejemplo | Descripción |
| --------- | --------- | -------------------------------------- |
2021-01-07 18:08:18 -05:00
| version | `v0.32.1` | La versión de `crystal` |
2020-09-30 16:26:13 -04:00
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
2020-07-23 17:07:10 -04:00
2021-04-05 10:55:57 -04:00
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
2020-04-03 12:35:39 -04:00
2020-05-05 13:07:34 -04:00
### Ejemplo
2020-04-03 12:35:39 -04:00
``` toml
# ~/.config/starship.toml
[ crystal ]
2020-07-23 17:07:10 -04:00
format = "via [✨ $version](bold blue) "
2020-04-03 12:35:39 -04:00
```
2020-09-30 16:26:13 -04:00
## Dart
2021-04-05 10:55:57 -04:00
El módulo `dart` muestra la versión actualmente instalada de Dart. Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones:
2020-09-30 16:26:13 -04:00
- El directorio actual contiene un archivo con la extensión `.dart`
- El directorio actual contiene un directorio `.dart_tool`
2021-03-15 13:18:42 -04:00
- El directorio actual contiene un archivo `pubspec.yaml` , `pubspec.yml` o `pubspec.lock`
2020-09-30 16:26:13 -04:00
### Opciones
2021-02-21 14:13:18 -05:00
| Opción | Por defecto | Descripción |
| ------------------- | ------------------------------------------------- | ------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. |
| `symbol` | `"🎯 "` | Una cadena de formato que representa el símbolo de Dart |
2021-03-15 13:18:42 -04:00
| `detect_extensions` | `['dart']` | Qué extensiones deberían activar este módulo. |
| `detect_files` | `["pubspec.yaml", "pubspec.yml", "pubspec.lock"]` | Qué nombres de archivo deberían activar este módulo. |
| `detect_folders` | `[".dart_tool"]` | Qué carpetas deberían activar este módulo. |
2021-02-21 14:13:18 -05:00
| `style` | `"bold blue"` | El estilo del módulo. |
2021-03-15 13:18:42 -04:00
| `disabled` | `false` | Deshabilita el módulo `dart` . |
2020-09-30 16:26:13 -04:00
### Variables
| Variable | Ejemplo | Descripción |
| --------- | -------- | -------------------------------------- |
2021-01-07 18:08:18 -05:00
| version | `v2.8.4` | La versión de `dart` |
2020-09-30 16:26:13 -04:00
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
2021-04-05 10:55:57 -04:00
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
2020-09-30 16:26:13 -04:00
### Ejemplo
``` toml
# ~/.config/starship.toml
[ dart ]
format = "via [🔰 $version](bold red) "
```
2020-01-15 12:23:25 -05:00
## Directory
2021-04-05 10:55:57 -04:00
El módulo `directory` muestra la ruta a tu directorio actual, truncado a tres carpetas padres. Tu directorio se truncará a la raíz del repositorio git en el que te encuentres.
2020-01-15 12:23:25 -05:00
2021-04-05 10:55:57 -04:00
Cuando usas el estilo fish de la opción pwd, en lugar de ocultar la ruta truncada, verás una versión acortada del nombre de cada directorio basada en el número que activaste para la opción.
2020-01-15 12:23:25 -05:00
2021-04-05 10:55:57 -04:00
Por ejemplo, dado `~/Dev/Nix/nixpkgs/pkgs` donde `nixpkgs` es la raíz del repositorio y la opción establecida a `1` . Ahora verás `~/D/N/nixpkgs/pkgs` , mientras que antes habría sido `nixpkgs/pkgs` .
2020-01-15 12:23:25 -05:00
2020-05-05 13:07:34 -04:00
### Opciones
2020-01-15 12:23:25 -05:00
2021-01-07 18:08:18 -05:00
| Opción | Por defecto | Descripción |
| ------------------- | -------------------------------------------------- | ------------------------------------------------------------------------------ |
| `truncation_length` | `3` | El número de directorios padre a los que se debe truncar el directorio actual. |
| `truncate_to_repo` | `true` | Trunca o no hasta la raíz del repositorio git en el que estés. |
| `format` | `"[$path]($style)[$read_only]($read_only_style) "` | El formato del módulo. |
| `style` | `"bold cyan"` | El estilo del módulo. |
| `disabled` | `false` | Desactiva el módulo `directory` . |
| `read_only` | `"🔒"` | El símbolo que indica si el directorio actual es de sólo lectura. |
| `read_only_style` | `"red"` | El estilo para el símbolo de sólo lectura. |
| `truncation_symbol` | `""` | El símbolo a prefijar a las rutas truncadas. ej: "…/" |
2021-02-06 12:46:15 -05:00
| `home_symbol` | `"~"` | El símbolo que indica el directorio personal. |
2020-01-15 12:23:25 -05:00
<details>
2021-04-05 10:55:57 -04:00
<summary>Este módulo tiene algunas opciones avanzadas de configuración que controlan cómo se muestra el directorio.</summary>
2020-01-15 12:23:25 -05:00
2021-03-15 13:18:42 -04:00
| Opciones avanzadas | Por defecto | Descripción |
| --------------------------- | ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `substitutions` | | Una tabla de sustituciones que se deben hacer a la ruta. |
| `fish_style_pwd_dir_length` | `0` | El número de caracteres a usar al aplicar la lógica de ruta pwd del intérprete de comandos de Fish. |
| `use_logical_path` | `true` | Si `true` renderiza la ruta lógica originada desde el intérprete de comandos a través de `PWD` o `--logical-path` . Si `false` en su lugar renderiza la ruta física del sistema de archivos con enlaces simbólicos resueltos. |
2020-01-15 12:23:25 -05:00
2021-04-05 10:55:57 -04:00
`substitutions` permite definir reemplazos arbitrarios para cadenas literales que ocurren en la ruta, por ejemplo prefijos largos de red o directorios de desarrollo (p. ej. Java). Ten en cuenta que esto desactivará el estilo PWD de fish.
2020-06-10 21:28:04 -04:00
``` toml
[ directory . substitutions ]
"/Volumes/network/path" = "/net"
"src/com/long/java/path" = "mypath"
```
2021-04-05 10:55:57 -04:00
`fish_style_pwd_dir_length` interactúa con las opciones de truncamiento estándar de una manera que puede sorprenderse primero: si no es cero, los componentes de la ruta que normalmente se truncarían se muestran con esa cantidad de caracteres. Por ejemplo, la ruta `/built/this/city/on/rock/and/roll` , que normalmente se mostraría como `rock/and/roll` , se mostraría como `/b/t/c/o/rock/and/roll` con `fish_style_pwd_dir_length = 1` --los componentes de ruta que normalmente se eliminarían se muestran con un solo carácter. Para `fish_style_pwd_dir_length = 2` , sería `/bu/th/ci/on/rock/and/roll` .
2020-04-03 12:35:39 -04:00
2020-01-15 12:23:25 -05:00
</details>
2020-07-23 17:07:10 -04:00
### Variables
2020-09-30 16:26:13 -04:00
| Variable | Ejemplo | Descripción |
| --------- | --------------------- | ------------------------------------- |
2021-01-07 18:08:18 -05:00
| path | `"D:/Projects"` | La ruta de directorio actual |
2020-09-30 16:26:13 -04:00
| style\* | `"black bold dimmed"` | Refleja el valor de la opción `style` |
2020-07-23 17:07:10 -04:00
2021-04-05 10:55:57 -04:00
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
2020-07-23 17:07:10 -04:00
2020-05-05 13:07:34 -04:00
### Ejemplo
2020-01-15 12:23:25 -05:00
``` toml
# ~/.config/starship.toml
[ directory ]
truncation_length = 8
2020-10-13 15:09:01 -04:00
truncation_symbol = "…/"
2020-01-15 12:23:25 -05:00
```
2020-09-30 16:26:13 -04:00
## Docker Context
2020-04-06 14:48:26 -04:00
2021-04-05 10:55:57 -04:00
El módulo `docker_context` muestra el [contexto de Docker ](https://docs.docker.com/engine/context/working-with-contexts/ ) actualmente activo si no está establecido en `por defecto` .
2020-04-06 14:48:26 -04:00
2020-05-05 13:07:34 -04:00
### Opciones
2020-04-06 14:48:26 -04:00
2021-03-15 13:18:42 -04:00
| Opción | Por defecto | Descripción |
| ------------------- | ------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- |
| `format` | `"via [$symbol$context]($style) "` | El formato del módulo. |
| `symbol` | `"🐳 "` | El símbolo usado antes de mostrar el contexto de Docker. |
| `only_with_files` | `true` | Mostrar solo cuando haya una coincidencia |
| `detect_extensions` | `[]` | Qué extensiones deberían activar este módulo (necesita que `solly_with_files` sea verdadero, con un valor "true"). |
| `detect_files` | `["docker-compose.yml", "docker-compose.yaml", "Dockerfile"]` | Qué nombres de archivo deberían activar este módulo (necesita que `solly_with_files` sea verdadero, con un valor "true"). |
| `detect_folders` | `[]` | Qué carpetas deberían activar este módulo (necesita que `solly_with_files` sea verdadero, con un valor "true"). |
| `style` | `"blue bold"` | El estilo del módulo. |
| `disabled` | `false` | Deshabilita el módulo `docker_context` . |
2020-07-23 17:07:10 -04:00
### Variables
2020-09-30 16:26:13 -04:00
| Variable | Ejemplo | Descripción |
| --------- | -------------- | -------------------------------------- |
2021-01-07 18:08:18 -05:00
| context | `test_context` | El contexto actual de docker |
2020-09-30 16:26:13 -04:00
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
2020-07-23 17:07:10 -04:00
2021-04-05 10:55:57 -04:00
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
2020-04-06 14:48:26 -04:00
2020-05-05 13:07:34 -04:00
### Ejemplo
2020-04-06 14:48:26 -04:00
``` toml
# ~/.config/starship.toml
[ docker_context ]
2020-07-23 17:07:10 -04:00
format = "via [🐋 $context](blue bold)"
2020-04-06 14:48:26 -04:00
```
2020-01-15 12:23:25 -05:00
## Dotnet
2021-04-05 10:55:57 -04:00
El módulo `dotnet` muestra la versión relevante de .NET Core SDK para el directorio actual. Si el SDK ha sido anclado en el directorio actual, se mostrará la versión fijada. De lo contrario, el módulo muestra la última versión instalada del SDK.
2020-01-15 12:23:25 -05:00
2021-04-05 10:55:57 -04:00
Por defecto, este módulo solo se mostrará en tu prompt cuando uno o más de de los siguientes archivos estén presentes en el directorio actual:
2020-07-23 17:07:10 -04:00
- `global.json`
- `project.json`
2020-11-28 23:45:59 -05:00
- `Directory.Build.props`
- `Directory.Build.targets`
2020-07-23 17:07:10 -04:00
- `Packages.props`
- `*.sln`
- `*.csproj`
- `*.fsproj`
- `*.xproj`
2021-04-05 10:55:57 -04:00
También necesitarás tener instalado .NET Core SDK para poder usarlo correctamente.
2020-01-15 12:23:25 -05:00
2021-04-05 10:55:57 -04:00
Internamente, este módulo utiliza su propio mecanismo para la detección de versiones. Normalmente es el doble de rápido que ejecutar `dotnet --version` , pero puede mostrar una versión incorrecta si tu proyecto .NET tiene un diseño de directorio inusual. Si la precisión es más importante que la velocidad, puede desactivar el mecanismo estableciendo `heuristic = false` en las opciones del módulo.
2020-01-15 12:23:25 -05:00
2021-04-05 10:55:57 -04:00
El módulo también mostrará el Target Framework Moniker ([https://docs.microsoft. om/es/dotnet/standard/frameworks#supported-target-framework-versions ](https://docs.microsoft.com/en-us/dotnet/standard/frameworks#supported-target-framework-versions )) cuando exista un archivo csproj en el directorio actual.
2020-07-23 17:07:10 -04:00
2020-05-05 13:07:34 -04:00
### Opciones
2020-01-15 12:23:25 -05:00
2021-02-21 14:13:18 -05:00
| Opción | Por defecto | Descripción |
| ------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
| `format` | `"[$symbol($version )(🎯 $tfm )]($style)"` | El formato del módulo. |
2021-04-05 10:55:57 -04:00
| `symbol` | `".NET "` | Símbolo usado antes de mostrar la versión de .NET |
2021-02-21 14:13:18 -05:00
| `heuristic` | `true` | Usa una detección de versiones más rápida para mantener a starship veloz. |
2021-03-15 13:18:42 -04:00
| `detect_extensions` | `["sln", "csproj", "fsproj", "xproj"]` | Qué extensiones deberían activar este módulo. |
| `detect_files` | `["global.json", "project.json", "Directory.Build.props", "Directory.Build.targets", "Packages.props"]` | Qué nombres de archivo deberían activar este módulo. |
| `detect_folders` | `[]` | Qué carpetas deberían activar estos módulos. |
2021-02-21 14:13:18 -05:00
| `style` | `"bold blue"` | El estilo del módulo. |
2021-03-15 13:18:42 -04:00
| `disabled` | `false` | Deshabilita el módulo `dotnet` . |
2020-07-23 17:07:10 -04:00
### Variables
2021-01-07 18:08:18 -05:00
| Variable | Ejemplo | Descripción |
| --------- | ---------------- | --------------------------------------------------------------- |
| version | `v3.1.201` | La version del sdk de `dotnet` |
| tfm | `netstandard2.0` | El Target Framework Moniker al que se dirige el proyecto actual |
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
2020-07-23 17:07:10 -04:00
2021-04-05 10:55:57 -04:00
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
2020-01-15 12:23:25 -05:00
2020-05-05 13:07:34 -04:00
### Ejemplo
2020-01-15 12:23:25 -05:00
``` toml
# ~/.config/starship.toml
[ dotnet ]
symbol = "🥅 "
style = "green"
heuristic = false
```
2020-04-03 12:35:39 -04:00
## Elixir
2021-04-05 10:55:57 -04:00
El módulo `elixir` muestra la version instalada actualmente de Elixir y Erlang/OTP. Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones:
2020-04-03 12:35:39 -04:00
2020-09-30 16:26:13 -04:00
- El directorio actual contiene un archivo `mix.exs` .
2020-04-03 12:35:39 -04:00
2020-05-05 13:07:34 -04:00
### Opciones
2020-04-03 12:35:39 -04:00
2021-02-21 14:13:18 -05:00
| Opción | Por defecto | Descripción |
| ------------------- | ----------------------------------------------------------- | -------------------------------------------------------------- |
| `symbol` | `"💧 "` | El símbolo usado antes de mostrar la version de Elixir/Erlang. |
2021-03-15 13:18:42 -04:00
| `detect_extensions` | `[]` | Qué extensiones deberían activar este módulo. |
| `detect_files` | `["mix.exs"]` | Qué nombres de archivo deberían activar este módulo. |
| `detect_folders` | `[]` | Qué carpetas deberían activar estos módulos. |
2021-02-21 14:13:18 -05:00
| `style` | `"bold purple"` | El estilo del módulo. |
2021-03-15 13:18:42 -04:00
| `format` | `'via [$symbol($version \(OTP $otp_version\) )]($style)'` | El formato para el módulo de elixir. |
| `disabled` | `false` | Deshabilita el módulo `elixir` . |
2020-07-23 17:07:10 -04:00
### Variables
2020-09-30 16:26:13 -04:00
| Variable | Ejemplo | Descripción |
| ----------- | ------- | -------------------------------------- |
2021-01-07 18:08:18 -05:00
| version | `v1.10` | La version de `elixir` |
| otp_version | | La version de otp de `elixir` |
2020-09-30 16:26:13 -04:00
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
2020-07-23 17:07:10 -04:00
2021-04-05 10:55:57 -04:00
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
2020-04-03 12:35:39 -04:00
2020-05-05 13:07:34 -04:00
### Ejemplo
2020-04-03 12:35:39 -04:00
``` toml
# ~/.config/starship.toml
[ elixir ]
symbol = "🔮 "
```
2020-02-07 16:47:30 -05:00
## Elm
2021-04-05 10:55:57 -04:00
El módulo `elm` muestra la versión actualmente instalada de Elm. Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones:
2020-02-07 16:47:30 -05:00
2020-09-30 21:23:36 -04:00
- El directorio actual contiene un fichero `elm.json`
- El directorio actual contiene un fichero `elm-package.json`
2020-11-28 23:45:59 -05:00
- El directorio actual contiene un archivo `.elm-version`
- El directorio actual contiene una carpeta `elm-stuff`
- El directorio actual contiene archivos `*.elm`
2020-02-07 16:47:30 -05:00
2020-05-05 13:07:34 -04:00
### Opciones
2020-02-07 16:47:30 -05:00
2021-02-21 14:13:18 -05:00
| Opción | Por defecto | Descripción |
| ------------------- | -------------------------------------------------- | ------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. |
| `symbol` | `"🌳 "` | Una cadena de formato que representa el símbolo de Elm. |
2021-03-15 13:18:42 -04:00
| `detect_extensions` | `["elm"]` | Qué extensiones deberían activar este módulo. |
| `detect_files` | `["elm.json", "elm-package.json", ".elm-version"]` | Qué nombres de archivo deberían activar este módulo. |
| `detect_folders` | `["elm-stuff"]` | Qué carpetas deberían activar estos módulos. |
2021-02-21 14:13:18 -05:00
| `style` | `"cyan bold"` | El estilo del módulo. |
2021-03-15 13:18:42 -04:00
| `disabled` | `false` | Deshabilita el módulo `elm` . |
2020-02-07 16:47:30 -05:00
2020-07-23 17:07:10 -04:00
### Variables
2020-09-30 16:26:13 -04:00
| Variable | Ejemplo | Descripción |
| --------- | --------- | -------------------------------------- |
2021-01-07 18:08:18 -05:00
| version | `v0.19.1` | La versión de `elm` |
2020-09-30 16:26:13 -04:00
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
2020-07-23 17:07:10 -04:00
2021-04-05 10:55:57 -04:00
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
2020-02-07 16:47:30 -05:00
2020-05-05 13:07:34 -04:00
### Ejemplo
2020-02-07 16:47:30 -05:00
``` toml
# ~/.config/starship.toml
[ elm ]
2020-07-23 17:07:10 -04:00
format = "via [ $version](cyan bold) "
2020-02-07 16:47:30 -05:00
```
2020-09-30 21:23:36 -04:00
## Variable de entorno
2020-05-05 13:07:34 -04:00
2021-04-05 10:55:57 -04:00
El módulo `env_var` muestra el valor actual de una variable de entorno seleccionada. El módulo se mostrará sólo si se cumplen cualquiera de las siguientes condiciones:
2020-05-05 13:07:34 -04:00
2020-11-28 23:45:59 -05:00
- La opción de configuración de `variable` coincide con una variable de entorno existente
- La opción de configuración de `variable` no está definida, pero la opción de configuración `predeterminada` se encuentra
2020-05-05 13:07:34 -04:00
### Opciones
2021-01-07 18:08:18 -05:00
| Opción | Por defecto | Descripción |
| ------------- | ------------------------------ | -------------------------------------------------------------------------------------- |
| `symbol` | | El símbolo usado antes de mostrar el valor de la variable. |
| `variable` | | La variable de entorno a mostrar. |
| `por defecto` | | El valor por defecto que se mostrará cuando la variable seleccionada no está definida. |
| `format` | `"with [$env_value]($style) "` | El formato del módulo. |
| `disabled` | `false` | Desactiva el módulo `env_var` . |
2020-07-23 17:07:10 -04:00
### Variables
2021-01-07 18:08:18 -05:00
| Variable | Ejemplo | Descripción |
| --------- | ------------------------------------- | ------------------------------------------- |
| env_value | `Windows NT` (si _ variable _ es `$OS` ) | El valor de entorno de la opción `variable` |
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | `black bold dimmed` | Refleja el valor de la opción `style` |
2020-07-23 17:07:10 -04:00
2021-04-05 10:55:57 -04:00
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
2020-05-05 13:07:34 -04:00
### Ejemplo
``` toml
# ~/.config/starship.toml
2020-05-15 11:55:21 -04:00
[ env_var ]
variable = "SHELL"
default = "unknown shell"
2020-05-05 13:07:34 -04:00
```
2020-01-15 12:23:25 -05:00
2020-05-15 11:55:21 -04:00
## Erlang
2020-01-15 12:23:25 -05:00
2021-04-05 10:55:57 -04:00
El módulo `erlang` muestra la versión instalada de Erlang/OTP. Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones:
2020-05-15 11:55:21 -04:00
2020-09-30 21:23:36 -04:00
- El directorio actual contiene un fichero `rebar.config` .
- El directorio actual contiene un fichero `erlang.mk` .
2020-01-15 12:23:25 -05:00
2020-05-05 13:07:34 -04:00
### Opciones
2020-01-15 12:23:25 -05:00
2021-02-21 14:13:18 -05:00
| Opción | Por defecto | Descripción |
| ------------------- | ------------------------------------ | ------------------------------------------------------- |
| `symbol` | `" "` | El símbolo usado antes de mostrar la versión de Erlang. |
| `style` | `"bold red"` | El estilo del módulo. |
2021-03-15 13:18:42 -04:00
| `detect_extensions` | `[]` | Qué extensiones deberían activar este módulo. |
| `detect_files` | `["rebar.config", "elang.mk"]` | Qué nombres de archivo deberían activar este módulo. |
| `detect_folders` | `[]` | Qué carpetas deberían activar estos módulos. |
2021-02-21 14:13:18 -05:00
| `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. |
2021-03-15 13:18:42 -04:00
| `disabled` | `false` | Deshabilita el módulo `erlang` . |
2020-07-23 17:07:10 -04:00
### Variables
2020-09-30 16:26:13 -04:00
| Variable | Ejemplo | Descripción |
| --------- | --------- | -------------------------------------- |
2021-01-07 18:08:18 -05:00
| version | `v22.1.3` | La versión de `erlang` |
2020-09-30 16:26:13 -04:00
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
2020-07-23 17:07:10 -04:00
2021-04-05 10:55:57 -04:00
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
2020-01-15 12:23:25 -05:00
2020-05-05 13:07:34 -04:00
### Ejemplo
2020-01-15 12:23:25 -05:00
``` toml
# ~/.config/starship.toml
2020-05-15 11:55:21 -04:00
[ erlang ]
2020-07-23 17:07:10 -04:00
format = "via [e $version](bold red) "
2020-01-15 12:23:25 -05:00
```
2020-09-30 16:26:13 -04:00
## Gcloud
2021-04-05 10:55:57 -04:00
El módulo `gcloud` muestra la configuración actual para el CLI de [`gcloud` ](https://cloud.google.com/sdk/gcloud ). Esto se basa en el archivo `~/.config/gcloud/active_config` , el archivo `~/.config/gcloud/configurations/config_{CONFIG NAME}` y la variable de entorno `CLOUDSDK_CONFIG` .
2020-09-30 16:26:13 -04:00
### Opciones
2021-01-07 18:08:18 -05:00
| Opción | Por defecto | Descripción |
| ---------------- | ------------------------------------------------ | ---------------------------------------------------------- |
| `format` | `'on [$symbol$account(\($region\))]($style) '` | El formato del módulo. |
| `symbol` | `"☁️ "` | El símbolo usado antes de mostrar el perfil actual de GCP. |
| `region_aliases` | | Tabla de alias de región a mostrar además del nombre GCP. |
| `style` | `"bold blue"` | El estilo del módulo. |
| `disabled` | `false` | Desactiva el módulo `gcloud` . |
2020-09-30 16:26:13 -04:00
### Variables
2021-01-07 18:08:18 -05:00
| Variable | Ejemplo | Descripción |
| --------- | ----------------- | ----------------------------------------------------------------------------- |
| region | `us-central1` | La región GCP actual |
| account | `foo@example.com` | El perfil actual de GCP |
| project | | El proyecto GCP actual |
| active | `por defecto` | El nombre de configuración activo escrito en `~/.config/gcloud/active_config` |
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
2020-09-30 16:26:13 -04:00
2021-04-05 10:55:57 -04:00
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
2020-09-30 16:26:13 -04:00
2020-09-30 21:23:36 -04:00
### Ejemplos
2020-09-30 16:26:13 -04:00
2020-11-28 23:45:59 -05:00
#### Mostrar cuenta y proyecto
2020-09-30 16:26:13 -04:00
``` toml
# ~/.config/starship.toml
[ gcloud ]
2020-10-13 15:09:01 -04:00
format = 'on [$symbol$account(\($project\))]($style) '
2020-09-30 16:26:13 -04:00
```
2020-11-28 23:45:59 -05:00
#### Mostrar solo el nombre de la configuración activa
2020-09-30 16:26:13 -04:00
``` toml
# ~/.config/starship.toml
[ gcloud ]
format = "[$symbol$active]($style) "
style = "bold yellow"
```
2020-11-28 23:45:59 -05:00
#### Mostrar los alias de cuenta y región
2020-09-30 16:26:13 -04:00
``` toml
# ~/.config/starship.toml
[ gcloud ]
symbol = "️🇬️ "
[ gcloud . region_aliases ]
us-central1 = "uc1"
asia-northeast1 = "an1"
```
2020-01-15 12:23:25 -05:00
## Git Branch
2021-04-05 10:55:57 -04:00
El módulo `git_branch` muestra la rama activa del repositorio en su directorio actual.
2020-01-15 12:23:25 -05:00
2020-05-05 13:07:34 -04:00
### Opciones
2020-01-15 12:23:25 -05:00
2021-01-07 18:08:18 -05:00
| Opción | Por defecto | Descripción |
| -------------------- | -------------------------------- | ------------------------------------------------------------------------------------------------------- |
| `always_show_remote` | `false` | Muestra el nombre de la rama de seguimiento remoto, incluso si es igual al nombre de la rama local. |
| `format` | `"on [$symbol$branch]($style) "` | El formato del módulo. Use `"$branch"` para referirse al nombre de la rama actual. |
| `symbol` | `" "` | Una cadena de formato que representa el símbolo de la rama git. |
| `style` | `"bold purple"` | El estilo del módulo. |
2021-04-05 10:55:57 -04:00
| `truncation_length` | `2^63 - 1` | Trunca una rama git a grafemas `N` . |
2021-01-07 18:08:18 -05:00
| `truncation_symbol` | `"…"` | El símbolo usado para indicar que un nombre de rama fue truncado. Puedes usar `""` para ningún símbolo. |
2021-04-05 10:55:57 -04:00
| `only_attached` | `false` | Mostrar solo el nombre de la rama cuando no esté en un estado `HEAD` . |
2021-01-07 18:08:18 -05:00
| `disabled` | `false` | Desactiva el módulo `git_branch` . |
2020-07-23 17:07:10 -04:00
### Variables
2021-04-05 10:55:57 -04:00
| Variable | Ejemplo | Descripción |
| ------------- | -------- | -------------------------------------------------------------------------------------------------------------- |
| branch | `master` | El nombre de la rama actual, vuelve a `HEAD` si no hay ninguna rama actual (por ejemplo, git detached `HEAD` ). |
| remote_name | `origin` | El nombre remoto. |
| remote_branch | `master` | El nombre de la rama rastreada en `remote_name` . |
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
2020-07-23 17:07:10 -04:00
2021-04-05 10:55:57 -04:00
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
2020-01-15 12:23:25 -05:00
2020-05-05 13:07:34 -04:00
### Ejemplo
2020-01-15 12:23:25 -05:00
``` toml
# ~/.config/starship.toml
[ git_branch ]
symbol = "🌱 "
truncation_length = 4
truncation_symbol = ""
```
2020-09-30 21:23:36 -04:00
## Git commit
2020-01-15 12:23:25 -05:00
2021-04-05 10:55:57 -04:00
El módulo `git_commit` muestra el hash de la confirmación actual y también la etiqueta (si existe) del repositorio en su directorio actual.
2020-01-15 12:23:25 -05:00
2020-05-05 13:07:34 -04:00
### Opciones
2020-01-15 12:23:25 -05:00
2021-04-05 10:55:57 -04:00
| Opción | Por defecto | Descripción |
| -------------------- | ------------------------------------------------------ | ----------------------------------------------------------------------- |
| `commit_hash_length` | `7` | La longitud del hash del commit de git mostrado. |
| `format` | `"[\\($hash\\)]($style) [\\($tag\\)]($style)"` | El formato del módulo. |
| `style` | `"bold green"` | El estilo del módulo. |
| `only_detached` | `true` | Only show git commit hash when in detached `HEAD` state |
| `tag_disabled` | `true` | Deshabilita mostrar información de etiquetas en el módulo `git_commit` . |
| `tag_symbol` | `"🏷 "` | Símbolo de etiqueta prefijando la información mostrada |
| `disabled` | `false` | Desactiva el módulo `git_commit` . |
2020-07-23 17:07:10 -04:00
### Variables
2020-09-30 16:26:13 -04:00
| Variable | Ejemplo | Descripción |
| --------- | --------- | ------------------------------------- |
2021-01-07 18:08:18 -05:00
| hash | `b703eb3` | El hash actual del commit de git |
2020-09-30 16:26:13 -04:00
| style\* | | Refleja el valor de la opción `style` |
2020-07-23 17:07:10 -04:00
2021-04-05 10:55:57 -04:00
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
2020-01-15 12:23:25 -05:00
2020-05-05 13:07:34 -04:00
### Ejemplo
2020-01-15 12:23:25 -05:00
``` toml
# ~/.config/starship.toml
[ git_commit ]
commit_hash_length = 4
2020-11-28 23:45:59 -05:00
tag_symbol = "🔖 "
2020-01-15 12:23:25 -05:00
```
2020-09-30 21:23:36 -04:00
## Git state
2020-01-15 12:23:25 -05:00
2021-04-05 10:55:57 -04:00
El módulo `git_state` se mostrará en directorios que son parte de un repositorio git, y donde hay una operación en curso, tales como: _ REBASING _ , _ BISECTING _ , etc. Si hay información de progreso (por ejemplo, REBASING 3/10), esa información será mostrada también.
2020-01-15 12:23:25 -05:00
2020-05-05 13:07:34 -04:00
### Opciones
2020-01-15 12:23:25 -05:00
2021-01-07 18:08:18 -05:00
| Opción | Por defecto | Descripción |
| -------------- | --------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
| `rebase` | `"REBASING"` | Una cadena de formato que se muestra cuando un `rebase` está en progreso. |
| `merge` | `"MERGING"` | Una cadena de formato que se muestra cuando un `merge` está en progreso. |
| `revert` | `"REVERTING"` | Una cadena de formato mostrada cuando un `revert` está en progreso. |
| `cherry_pick` | `"CHERRY-PICKING"` | Una cadena de formato que se muestra cuando un `cherry-pick` está en progreso. |
| `bisect` | `"BISECTING"` | Una cadena de formato que se muestra cuando un `bisect` está en progreso. |
| `am` | `"AM"` | Una cadena de formato que se muestra cuando un `apply-mailbox` (`git am` ) está en progeso. |
| `am_or_rebase` | `"AM/REBASE"` | Una cadena de formato que se muestra cuando un ambiguo `apply-builbox` o `rebase` está en progreso. |
| `style` | `"bold yellow"` | El estilo del módulo. |
| `format` | `'\([$state( $progress_current/$progress_total)]($style)\) '` | El formato del módulo. |
| `disabled` | `false` | Desactiva el módulo `git_state` . |
2020-07-23 17:07:10 -04:00
### Variables
2020-09-30 16:26:13 -04:00
| Variable | Ejemplo | Descripción |
| ---------------- | ---------- | ------------------------------------- |
2021-01-07 18:08:18 -05:00
| state | `REBASING` | El estado actual del repositorio |
| progress_current | `1` | El progreso de la operación actual |
| progress_total | `2` | El progreso total de la operación |
2020-09-30 16:26:13 -04:00
| style\* | | Refleja el valor de la opción `style` |
2020-07-23 17:07:10 -04:00
2021-04-05 10:55:57 -04:00
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
2020-01-15 12:23:25 -05:00
2020-05-05 13:07:34 -04:00
### Ejemplo
2020-01-15 12:23:25 -05:00
``` toml
# ~/.config/starship.toml
[ git_state ]
2020-10-13 15:09:01 -04:00
format = '[\($state( $progress_current of $progress_total)\)]($style) '
2020-07-23 17:07:10 -04:00
cherry_pick = "[🍒 PICKING](bold red)"
2020-01-15 12:23:25 -05:00
```
2020-09-30 21:23:36 -04:00
## Git status
2020-01-15 12:23:25 -05:00
2021-04-05 10:55:57 -04:00
El módulo `git_status` muestra símbolos que representan el estado del repositorio en su directorio actual.
2020-01-15 12:23:25 -05:00
2020-05-05 13:07:34 -04:00
### Opciones
2020-01-15 12:23:25 -05:00
2021-01-07 18:08:18 -05:00
| Opción | Por defecto | Descripción |
| ------------ | ----------------------------------------------- | ---------------------------------------- |
| `format` | `'([\[$all_status$ahead_behind\]]($style) )'` | El formato por defecto para `git_status` |
| `conflicted` | `"="` | Esta rama tiene conflictos de fusión. |
| `ahead` | `"⇡"` | El formato de `ahead` |
| `behind` | `"⇣"` | El formato de `behind` |
| `diverged` | `"⇕"` | El formato de `diverged` |
| `untracked` | `"?"` | El formato de `untracked` |
| `stashed` | `"$"` | El formato de `stashed` |
| `modified` | `"!"` | El formato de `modified` |
| `staged` | `"+"` | El formato de `staged` |
| `renamed` | `"»"` | El formato de `renamed` |
| `deleted` | `"✘"` | El formato de `deleted` |
| `style` | `"bold red"` | El estilo del módulo. |
| `disabled` | `false` | Desactiva el módulo `git_status` . |
2020-07-23 17:07:10 -04:00
### Variables
2021-04-05 10:55:57 -04:00
Las siguientes variables se pueden utilizar en `format` :
2021-01-07 18:08:18 -05:00
| Variable | Descripción |
| -------------- | -------------------------------------------------------------------------------------------------------- |
| `all_status` | Atajo para `$conflicted$stashed$deleted$renamed$modified$staged$untracked` |
| `ahead_behind` | Muestra la cadena de formato de `diverged` `ahead` o `behind` basado en el estado actual del repositorio |
| `conflicted` | Muestra `conflicted` cuando esta rama tiene conflictos de fusión. |
| `untracked` | Muestra `untracked` cuando hay archivos sin rastrear en el directorio de trabajo. |
| `stashed` | Muestra `stashed` cuando existe un "stash" para el repositorio local. |
| `modified` | Muestra `modified` cuando hay modificaciones de archivo en el directorio de trabajo. |
| `staged` | Muestra `staged` cuando se ha añadido un nuevo archivo al área de "stash". |
| `renamed` | Muestra `renamed` cuando un archivo renombrado ha sido añadido al área de "stash". |
| `deleted` | Muestra `deleted` cuando un archivo ha sido añadido al área de "stash". |
| style\* | Refleja el valor de la opción `style` |
2020-07-23 17:07:10 -04:00
2021-04-05 10:55:57 -04:00
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
2020-07-23 17:07:10 -04:00
2021-04-05 10:55:57 -04:00
Las siguientes variables pueden ser usadas en `diverged` :
2020-07-23 17:07:10 -04:00
2021-01-07 18:08:18 -05:00
| Variable | Descripción |
| -------------- | ------------------------------------------------------- |
| `ahead_count` | Número de commits por delante de la rama de seguimiento |
| `behind_count` | Número de commits detrás de la rama de seguimiento |
2020-07-23 17:07:10 -04:00
2021-04-05 10:55:57 -04:00
Las siguientes variales pueden ser usadas en `conflicted` , `ahead` , `behind` , `untracked` , `stashed` , `modified` , `staged` , `renamed` and `deleted` :
2020-07-23 17:07:10 -04:00
2021-01-07 18:08:18 -05:00
| Variable | Descripción |
| -------- | ----------------------------- |
| `count` | Muestra el número de archivos |
2020-01-15 12:23:25 -05:00
2020-05-05 13:07:34 -04:00
### Ejemplo
2020-01-15 12:23:25 -05:00
``` toml
# ~/.config/starship.toml
[ git_status ]
conflicted = "🏳"
ahead = "🏎💨"
behind = "😰"
diverged = "😵"
untracked = "🤷"
stashed = "📦"
modified = "📝"
2020-07-23 17:07:10 -04:00
staged = '[++\($count\)](green)'
2020-01-15 12:23:25 -05:00
renamed = "👅"
deleted = "🗑"
```
2021-04-05 10:55:57 -04:00
Mostrar el recuento delante/detrás de la rama que está siendo rastreada
2020-09-30 21:23:36 -04:00
2020-09-30 16:26:13 -04:00
``` toml
# ~/.config/starship.toml
[ git_status ]
ahead = "⇡${count}"
diverged = "⇕⇡${ahead_count}⇣${behind_count}"
behind = "⇣${count}"
```
2020-01-15 12:23:25 -05:00
## Golang
2021-04-05 10:55:57 -04:00
El módulo `golang` muestra la versión actualmente instalada de Golang. Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones:
2020-01-15 12:23:25 -05:00
2020-09-30 21:23:36 -04:00
- El directorio actual contiene un fichero `go.mod`
- El directorio actual contiene un fichero `go.sum`
- El directorio actual contiene un fichero `glide.yaml`
2020-11-28 23:45:59 -05:00
- El directorio actual contiene un archivo `Gopkg.yml`
- El directorio actual contiene un archivo `Gopkg.lock`
- El directorio actual contiene un archivo `.go-version`
- El directorio actual contiene un directorio `Godeps`
- El directorio actual contiene un archivo con la extensión `.go`
2020-01-15 12:23:25 -05:00
2020-05-05 13:07:34 -04:00
### Opciones
2020-01-15 12:23:25 -05:00
2021-02-21 14:13:18 -05:00
| Opción | Por defecto | Descripción |
| ------------------- | ------------------------------------------------------------------------------ | ------------------------------------------------------ |
| `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. |
| `symbol` | `"🐹 "` | Una cadena de formato que representa el símbolo de Go. |
2021-03-15 13:18:42 -04:00
| `detect_extensions` | `["go"]` | Qué extensiones deberían activar este módulo. |
| `detect_files` | `["go.mod", "go.sum", "glide.yaml", "Gopkg.yml", "Gopkg.lock", ".go-version"]` | Qué nombres de archivo deberían activar este módulo. |
| `detect_folders` | `["Godeps"]` | Qué carpetas deberían activar este módulo. |
2021-02-21 14:13:18 -05:00
| `style` | `"bold cyan"` | El estilo del módulo. |
2021-03-15 13:18:42 -04:00
| `disabled` | `false` | Deshabilita el módulo de `golang` . |
2020-07-23 17:07:10 -04:00
### Variables
2020-09-30 16:26:13 -04:00
| Variable | Ejemplo | Descripción |
| --------- | --------- | -------------------------------------- |
2021-01-07 18:08:18 -05:00
| version | `v1.12.1` | La versión de `go` |
2020-09-30 16:26:13 -04:00
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
2020-07-23 17:07:10 -04:00
2021-04-05 10:55:57 -04:00
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
2020-01-15 12:23:25 -05:00
2020-05-05 13:07:34 -04:00
### Ejemplo
2020-01-15 12:23:25 -05:00
``` toml
# ~/.config/starship.toml
[ golang ]
2020-07-23 17:07:10 -04:00
format = "via [🏎💨 $version](bold cyan) "
2020-01-15 12:23:25 -05:00
```
2020-02-04 12:11:36 -05:00
2020-07-23 17:07:10 -04:00
## Helm
2020-02-04 12:11:36 -05:00
2021-04-05 10:55:57 -04:00
El módulo `helm` muestra la versión instalada de Helm. Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones:
2020-07-23 17:07:10 -04:00
2020-09-30 21:23:36 -04:00
- El directorio actual contiene un fichero `helmfile.yaml`
2020-11-28 23:45:59 -05:00
- El directorio actual contiene un archivo `Chart.yaml`
2020-02-04 12:11:36 -05:00
2020-05-05 13:07:34 -04:00
### Opciones
2020-02-04 12:11:36 -05:00
2021-03-15 13:18:42 -04:00
| Opción | Por defecto | Descripción |
| ------------------- | ------------------------------------ | -------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. |
| `detect_extensions` | `[]` | Qué extensiones deberían activar este módulo. |
| `detect_files` | `["helmfile.yaml", "Chart.yaml"]` | 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 Helm. |
| `style` | `"bold white"` | El estilo del módulo. |
| `disabled` | `false` | Deshabilita el módulo `helm` . |
2020-07-23 17:07:10 -04:00
### Variables
2020-09-30 16:26:13 -04:00
| Variable | Ejemplo | Descripción |
| --------- | -------- | -------------------------------------- |
2021-01-07 18:08:18 -05:00
| version | `v3.1.1` | La versión de `helm` |
2020-09-30 16:26:13 -04:00
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
2020-02-04 12:11:36 -05:00
2021-04-05 10:55:57 -04:00
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
2020-02-04 12:11:36 -05:00
2020-05-05 13:07:34 -04:00
### Ejemplo
2020-02-04 12:11:36 -05:00
``` toml
# ~/.config/starship.toml
2020-07-23 17:07:10 -04:00
[ helm ]
format = "via [⎈ $version](bold white) "
2020-02-04 12:11:36 -05:00
```
2020-01-15 12:23:25 -05:00
## Hostname
2021-04-05 10:55:57 -04:00
El módulo `hostname` muestra el nombre de host del sistema.
2020-01-15 12:23:25 -05:00
2020-05-05 13:07:34 -04:00
### Opciones
2020-01-15 12:23:25 -05:00
2021-01-07 18:08:18 -05:00
| Opción | Por defecto | Descripción |
| ---------- | --------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `ssh_only` | `true` | Mostrar sólo el nombre de host cuando esté conectado a una sesión SSH. |
| `trim_at` | `"."` | Cadena en la que el nombre de host se corta, después de la primera partida. `"."` se detendrá después del primer punto. `""` deshabilitará cualquier truncamiento |
| `format` | `"[$hostname]($style) in "` | El formato del módulo. |
| `style` | `"bold dimmed green"` | El estilo del módulo. |
| `disabled` | `false` | Desactiva el módulo `hostname` . |
2020-07-23 17:07:10 -04:00
### Variables
2020-09-30 16:26:13 -04:00
| Variable | Ejemplo | Descripción |
| --------- | ------- | -------------------------------------- |
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
2020-07-23 17:07:10 -04:00
2021-04-05 10:55:57 -04:00
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
2020-01-15 12:23:25 -05:00
2020-05-05 13:07:34 -04:00
### Ejemplo
2020-01-15 12:23:25 -05:00
``` toml
# ~/.config/starship.toml
[ hostname ]
ssh_only = false
2020-07-23 17:07:10 -04:00
format = "on [$hostname](bold red) "
2020-01-15 12:23:25 -05:00
trim_at = ".companyname.com"
disabled = false
```
2020-04-03 12:35:39 -04:00
## Java
2021-04-05 10:55:57 -04:00
El módulo `java` muestra la versión actualmente instalada de Java. Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones:
2020-04-03 12:35:39 -04:00
2021-01-03 03:56:07 -05:00
- El directorio actual contiene un archivo `pom.xml` , `build.gradle.kts` , `build.sbt` , `.java-version` , `.deps.edn` , `project.clj` , o `build.boot`
- El directorio actual contiene un archivo con la extensión `.java` , `.class` , `.gradle` o `.jar` , `.clj` o `.cljc`
2020-04-03 12:35:39 -04:00
2020-05-05 13:07:34 -04:00
### Opciones
2020-04-03 12:35:39 -04:00
2021-03-15 13:18:42 -04:00
| Opción | Por defecto | Descripción |
| ------------------- | --------------------------------------------------------------------------------------------------------- | ------------------------------------------------------- |
| `format` | `"via [${symbol}(${version} )]($style)"` | El formato del módulo. |
| `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"]` | 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` . |
2020-07-23 17:07:10 -04:00
### Variables
2020-09-30 16:26:13 -04:00
| Variable | Ejemplo | Descripción |
| --------- | ------- | -------------------------------------- |
2021-01-07 18:08:18 -05:00
| version | `v14` | La versión de `java` |
2020-09-30 16:26:13 -04:00
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
2020-07-23 17:07:10 -04:00
2021-04-05 10:55:57 -04:00
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
2020-04-03 12:35:39 -04:00
2020-05-05 13:07:34 -04:00
### Ejemplo
2020-04-03 12:35:39 -04:00
``` toml
# ~/.config/starship.toml
[ java ]
symbol = "🌟 "
```
2020-01-15 12:23:25 -05:00
## Jobs
2021-04-05 10:55:57 -04:00
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 en ejecución si hay más de 1 tarea o más que el valor configurado de `threshold` , si existe.
2021-03-15 13:18:42 -04:00
::: aviso
2021-04-05 10:55:57 -04:00
Este módulo no está soportado en tcsh.
2021-03-15 13:18:42 -04:00
:::
2020-01-15 12:23:25 -05:00
2020-05-05 13:07:34 -04:00
### Opciones
2020-01-15 12:23:25 -05:00
2021-01-07 18:08:18 -05:00
| Opción | Por defecto | Descripción |
| ----------- | ----------------------------- | --------------------------------------------------------- |
| `threshold` | `1` | Muestra el número de tareas si se exceden. |
| `format` | `"[$symbol$number]($style) "` | El formato del módulo. |
| `symbol` | `"✦"` | Una cadena de formato que representa el número de tareas. |
| `style` | `"bold blue"` | El estilo del módulo. |
| `disabled` | `false` | Desactiva el módulo `jobs` . |
2020-07-23 17:07:10 -04:00
### Variables
2020-09-30 16:26:13 -04:00
| Variable | Ejemplo | Descripción |
| --------- | ------- | -------------------------------------- |
2021-01-07 18:08:18 -05:00
| number | `1` | El número de tareas |
2020-09-30 16:26:13 -04:00
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
2020-07-23 17:07:10 -04:00
2021-04-05 10:55:57 -04:00
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
2020-01-15 12:23:25 -05:00
2020-05-05 13:07:34 -04:00
### Ejemplo
2020-01-15 12:23:25 -05:00
``` toml
# ~/.config/starship.toml
[ jobs ]
symbol = "+ "
threshold = 4
```
2020-04-06 14:48:26 -04:00
## Julia
2021-04-05 10:55:57 -04:00
El módulo `julia` muestra la versión actualmente instalada de Julia. Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones:
2020-04-06 14:48:26 -04:00
2020-11-28 23:45:59 -05:00
- 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`
2020-04-06 14:48:26 -04:00
2020-05-05 13:07:34 -04:00
### Opciones
2020-04-06 14:48:26 -04:00
2021-03-15 13:18:42 -04:00
| Opción | Por defecto | Descripción |
| ------------------- | ------------------------------------ | --------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. |
| `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` . |
2020-07-23 17:07:10 -04:00
### Variables
2020-09-30 16:26:13 -04:00
| Variable | Ejemplo | Descripción |
| --------- | -------- | -------------------------------------- |
2021-01-07 18:08:18 -05:00
| version | `v1.4.0` | La versión de `julia` |
2020-09-30 16:26:13 -04:00
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
2020-07-23 17:07:10 -04:00
2021-04-05 10:55:57 -04:00
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
2020-04-06 14:48:26 -04:00
2020-05-05 13:07:34 -04:00
### Ejemplo
2020-04-06 14:48:26 -04:00
``` toml
# ~/.config/starship.toml
[ julia ]
2020-05-05 13:07:34 -04:00
symbol = "∴ "
2020-04-06 14:48:26 -04:00
```
2020-07-23 17:07:10 -04:00
2021-01-03 03:56:07 -05:00
## Kotlin
2021-04-05 10:55:57 -04:00
El módulo `kotlin` muestra la versión instalada de Kotlin. Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones:
2021-01-03 03:56:07 -05:00
2021-01-26 17:07:13 -05:00
- El directorio actual contiene un archivo `.kt` o `.kts`
2021-01-03 03:56:07 -05:00
### Opciones
2021-03-15 13:18:42 -04:00
| Opción | Por defecto | Descripción |
| ------------------- | ------------------------------------ | ----------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. |
| `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` . |
2021-01-03 03:56:07 -05:00
### Variables
| Variable | Ejemplo | Descripción |
| --------- | --------- | -------------------------------------- |
2021-01-26 17:07:13 -05:00
| version | `v1.4.21` | La versión de `kotlin` |
2021-01-03 03:56:07 -05:00
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
2021-04-05 10:55:57 -04:00
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
2021-01-03 03:56:07 -05:00
### Ejemplo
``` toml
# ~/.config/starship.toml
[ kotlin ]
symbol = "🅺 "
```
``` toml
# ~/.config/starship.toml
[ kotlin ]
2021-01-26 17:07:13 -05:00
# Utiliza el binario del Compilador de Kotlin para obtener la versión instalada
2021-01-03 03:56:07 -05:00
kotlin_binary = "kotlinc"
```
2020-01-15 12:23:25 -05:00
## Kubernetes
2021-04-05 10:55:57 -04:00
Muestra el nombre del contexto actual de Kubernetes y, si se establece, el espacio de nombres del archivo kubeconfig. El espacio de nombres necesita establecerse en el archivo kubeconfig, esto puede hacerse mediante `kubectl config set-context starship-cluster --namespace astronaut` . Si se establece la variable de entorno `$KUBECONFIG` , el módulo usará eso si no usará el `~/.kube/config` .
2020-01-15 12:23:25 -05:00
2021-04-05 10:55:57 -04:00
::: consejo
2020-01-15 12:23:25 -05:00
2021-04-05 10:55:57 -04:00
Este módulo está deshabilitado por defecto. Para habilitarlo, establece `disabled` a `false` en tu archivo de configuración.
2020-01-15 12:23:25 -05:00
:::
2020-05-05 13:07:34 -04:00
### Opciones
2020-01-15 12:23:25 -05:00
2021-01-07 18:08:18 -05:00
| Opción | Por defecto | 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. |
| `disabled` | `true` | Desactiva el módulo `kubernetes` . |
2020-07-23 17:07:10 -04:00
### Variables
2021-01-07 18:08:18 -05:00
| Variable | Ejemplo | Descripción |
| --------- | -------------------- | ----------------------------------------------------------- |
| context | `starship-cluster` | El contexto actual de kubernetes |
| namespace | `starship-namespace` | Si se establece, el espacio de nombres actual de kubernetes |
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
2020-07-23 17:07:10 -04:00
2021-04-05 10:55:57 -04:00
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
2020-01-15 12:23:25 -05:00
2020-05-05 13:07:34 -04:00
### Ejemplo
2020-01-15 12:23:25 -05:00
``` toml
# ~/.config/starship.toml
[ kubernetes ]
2020-10-13 15:09:01 -04:00
format = 'on [⛵ $context \($namespace\)](dimmed green) '
2020-01-15 12:23:25 -05:00
disabled = false
2020-04-06 14:48:26 -04:00
[ kubernetes . context_aliases ]
"dev.local.cluster.k8s" = "dev"
2020-01-15 12:23:25 -05:00
```
2021-01-07 18:08:18 -05:00
## Salto de línea
2020-01-15 12:23:25 -05:00
2021-04-05 10:55:57 -04:00
El módulo `line_break` separa el prompt en dos líneas.
2020-01-15 12:23:25 -05:00
2020-05-05 13:07:34 -04:00
### Opciones
2020-01-15 12:23:25 -05:00
2021-03-15 13:18:42 -04:00
| Opción | Por defecto | Descripción |
| ---------- | ----------- | ------------------------------------------------------------------------------ |
| `disabled` | `false` | Deshabilita el módulo `line_break` , haciendo que el prompt sea una sola línea. |
2020-01-15 12:23:25 -05:00
2020-05-05 13:07:34 -04:00
### Ejemplo
2020-01-15 12:23:25 -05:00
``` toml
# ~/.config/starship.toml
[ line_break ]
disabled = true
```
2020-11-28 23:45:59 -05:00
## Lua
2021-04-05 10:55:57 -04:00
El módulo `lua` muestra la versión instalada de Lua. Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones:
2020-11-28 23:45:59 -05:00
2021-01-07 18:08:18 -05:00
- 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`
2020-11-28 23:45:59 -05:00
### Opciones
2021-03-15 13:18:42 -04:00
| Opción | Por defecto | Descripción |
| ------------------- | ------------------------------------ | -------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. |
| `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` . |
2020-11-28 23:45:59 -05:00
### Variables
| Variable | Ejemplo | Descripción |
| --------- | -------- | -------------------------------------- |
2021-01-07 18:08:18 -05:00
| version | `v5.4.0` | La versión de `lua` |
2020-11-28 23:45:59 -05:00
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
2021-04-05 10:55:57 -04:00
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
2020-11-28 23:45:59 -05:00
### Ejemplo
``` toml
# ~/.config/starship.toml
[ lua ]
format = "via [🌕 $version](bold blue) "
```
2021-01-07 18:08:18 -05:00
## Memoria utilizada
2020-01-15 12:23:25 -05:00
2021-04-05 10:55:57 -04:00
El módulo `memory_usage` muestra la memoria del sistema actual y el uso de la memoria de intercambio.
2020-01-15 12:23:25 -05:00
2021-04-05 10:55:57 -04:00
Por defecto, el uso de la memoria de intercambio se muestra si no es cero.
2020-01-15 12:23:25 -05:00
2021-04-05 10:55:57 -04:00
::: consejo
2020-01-15 12:23:25 -05:00
2021-04-05 10:55:57 -04:00
Este módulo está deshabilitado por defecto. Para habilitarlo, establece `disabled` a `false` en tu archivo de configuración.
2020-01-15 12:23:25 -05:00
:::
2020-05-05 13:07:34 -04:00
### Opciones
2020-01-15 12:23:25 -05:00
2021-01-07 18:08:18 -05:00
| Opción | Por defecto | 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` . |
2020-07-23 17:07:10 -04:00
### Variables
2021-01-07 18:08:18 -05:00
| 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` |
2020-07-23 17:07:10 -04:00
2021-04-05 10:55:57 -04:00
\*: Esta variable sólo puede utilizarse como parte de una cadena de estilo \*\*: La información del archivo SWAP sólo se muestra si se detecta en el sistema actual
2020-01-15 12:23:25 -05:00
2020-05-05 13:07:34 -04:00
### Ejemplo
2020-01-15 12:23:25 -05:00
``` toml
# ~/.config/starship.toml
[ memory_usage ]
2020-04-03 12:35:39 -04:00
disabled = false
2020-01-15 12:23:25 -05:00
threshold = -1
symbol = " "
style = "bold dimmed green"
```
2020-04-03 12:35:39 -04:00
## Mercurial Branch
2020-02-07 16:47:30 -05:00
2021-04-05 10:55:57 -04:00
El módulo `hg_branch` muestra la rama activa del repositorio en su directorio actual.
2020-02-07 16:47:30 -05:00
2020-05-05 13:07:34 -04:00
### Opciones
2020-04-03 12:35:39 -04:00
2021-01-07 18:08:18 -05:00
| Opción | Por defecto | 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]($style) "` | El formato del módulo. |
2021-04-05 10:55:57 -04:00
| `truncation_length` | `2^63 - 1` | Truncates the hg branch name to `N` graphemes |
2021-01-07 18:08:18 -05:00
| `truncation_symbol` | `"…"` | El símbolo usado para indicar que un nombre de rama fue truncado. |
| `disabled` | `true` | Desactiva el módulo `hg_branch` . |
2020-07-23 17:07:10 -04:00
### Variables
2020-09-30 16:26:13 -04:00
| Variable | Ejemplo | Descripción |
| --------- | -------- | -------------------------------------- |
2021-01-07 18:08:18 -05:00
| branch | `master` | La rama de mercurial activa |
2020-09-30 16:26:13 -04:00
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
2020-07-23 17:07:10 -04:00
2021-04-05 10:55:57 -04:00
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
2020-04-03 12:35:39 -04:00
2020-05-05 13:07:34 -04:00
### Ejemplo
2020-04-03 12:35:39 -04:00
``` toml
# ~/.config/starship.toml
[ hg_branch ]
2020-07-23 17:07:10 -04:00
format = "on [🌱 $branch](bold purple)"
2020-04-03 12:35:39 -04:00
truncation_length = 4
truncation_symbol = ""
```
2020-06-10 21:28:04 -04:00
## Nim
2021-04-05 10:55:57 -04:00
El módulo `nim` muestra la versión instalada de Nim. Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones:
2020-07-23 17:07:10 -04:00
2021-01-07 18:08:18 -05:00
- 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`
2020-06-10 21:28:04 -04:00
### Opciones
2021-02-21 14:13:18 -05:00
| Opción | Por defecto | Descripción |
| ------------------- | ------------------------------------ | ---------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | El formato del módulo |
| `symbol` | `"👑 "` | El símbolo usado antes de mostrar la versión de Nim. |
2021-03-15 13:18:42 -04:00
| `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. |
2021-02-21 14:13:18 -05:00
| `style` | `"bold yellow"` | El estilo del módulo. |
2021-03-15 13:18:42 -04:00
| `disabled` | `false` | Deshabilita el módulo `nim` . |
2020-07-23 17:07:10 -04:00
### Variables
2020-09-30 16:26:13 -04:00
| Variable | Ejemplo | Descripción |
| --------- | -------- | -------------------------------------- |
2021-01-07 18:08:18 -05:00
| version | `v1.2.0` | La versión de `nimc` |
2020-09-30 16:26:13 -04:00
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
2020-07-23 17:07:10 -04:00
2021-04-05 10:55:57 -04:00
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
2020-06-10 21:28:04 -04:00
### Ejemplo
``` toml
# ~/.config/starship.toml
[ nim ]
style = "yellow"
symbol = "🎣 "
```
2020-04-03 12:35:39 -04:00
## Nix-shell
2021-04-05 10:55:57 -04:00
El módulo `nix_shell` muestra el entorno nix-shell. El módulo se mostrará dentro de un entorno nix-shell.
2020-02-07 16:47:30 -05:00
2020-05-05 13:07:34 -04:00
### Opciones
2020-02-07 16:47:30 -05:00
2021-01-07 18:08:18 -05:00
| Opción | Por defecto | 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. |
| `disabled` | `false` | Desactiva el módulo `nix_shell` . |
2020-07-23 17:07:10 -04:00
### Variables
2020-09-30 16:26:13 -04:00
| Variable | Ejemplo | Descripción |
| --------- | ------- | -------------------------------------- |
2021-01-07 18:08:18 -05:00
| state | `pure` | El estado de nix-shell |
| name | `lorri` | El nombre de nix-shell |
2020-09-30 16:26:13 -04:00
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
2020-07-23 17:07:10 -04:00
2021-04-05 10:55:57 -04:00
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
2020-02-07 16:47:30 -05:00
2020-05-05 13:07:34 -04:00
### Ejemplo
2020-02-07 16:47:30 -05:00
``` toml
# ~/.config/starship.toml
2020-04-03 12:35:39 -04:00
[ nix_shell ]
disabled = true
2020-07-23 17:07:10 -04:00
impure_msg = "[impure shell](bold red)"
pure_msg = "[pure shell](bold green)"
2020-10-13 15:09:01 -04:00
format = 'via [☃️ $state( \($name\))](bold blue) '
2020-02-07 16:47:30 -05:00
```
2020-01-15 12:23:25 -05:00
## NodeJS
2021-04-05 10:55:57 -04:00
El módulo `nodejs` muestra la versión instalada de NodeJS. Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones:
2020-01-15 12:23:25 -05:00
2021-01-07 18:08:18 -05:00
- El directorio actual contiene un archivo `package.json`
- El directorio actual contiene un archivo `.node-version`
- 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`
2020-01-15 12:23:25 -05:00
2020-05-05 13:07:34 -04:00
### Opciones
2020-01-15 12:23:25 -05:00
2021-04-05 10:55:57 -04:00
| Opción | Por defecto | Descripción |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------------------ |
| `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. |
| `symbol` | `" "` | Una cadena de formato que representa el símbolo de NodeJS. |
| `detect_extensions` | `["js", "mjs", "cjs", "ts"]` | 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` | The style for the module when an engines property in `package.json` does not match the NodeJS version. |
2020-07-23 17:07:10 -04:00
2021-04-05 10:55:57 -04:00
### Variables
2020-07-23 17:07:10 -04:00
2020-09-30 16:26:13 -04:00
| Variable | Ejemplo | Descripción |
| --------- | ---------- | -------------------------------------- |
2021-01-07 18:08:18 -05:00
| version | `v13.12.0` | La versión de `node` |
2020-09-30 16:26:13 -04:00
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
2020-07-23 17:07:10 -04:00
2021-04-05 10:55:57 -04:00
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
2020-01-15 12:23:25 -05:00
2020-05-05 13:07:34 -04:00
### Ejemplo
2020-01-15 12:23:25 -05:00
``` toml
# ~/.config/starship.toml
[ nodejs ]
2020-07-23 17:07:10 -04:00
format = "via [🤖 $version](bold green) "
2020-01-15 12:23:25 -05:00
```
2020-11-28 23:45:59 -05:00
## OCaml
2020-01-15 12:23:25 -05:00
2021-04-05 10:55:57 -04:00
El módulo `ocaml` muestra la versión actualmente instalada de OCaml. Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones:
2020-01-15 12:23:25 -05:00
2021-01-07 18:08:18 -05:00
- 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`
2020-01-15 12:23:25 -05:00
2020-11-28 23:45:59 -05:00
### Opciones
2021-04-05 10:55:57 -04:00
| Opción | Por defecto | Descripción |
| ------------------------- | -------------------------------------------------------------------------- | ------------------------------------------------------- |
| `format` | `"via [$symbol($version )(\($switch_indicator$switch_name\) )]($style)"` | La cadena de formato para el módulo. |
| `symbol` | `"🐫 "` | El símbolo usado antes de mostrar la versión de OCaml. |
| `global_switch_indicator` | `""` | The format string used to represent global OPAM switch. |
| `local_switch_indicator` | `"*"` | The format string used to represent local OPAM switch. |
| `detect_extensions` | `["opam", "ml", "mli", "re", "rei"]` | 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` | Disables the `ocaml` module. |
2020-11-28 23:45:59 -05:00
### Variables
2021-04-05 10:55:57 -04:00
| Variable | Ejemplo | Descripción |
| ---------------- | ------------ | ----------------------------------------------------------------- |
| version | `v4.10.0` | La versión de `ocaml` |
| switch_name | `my-project` | The active OPAM switch |
| switch_indicator | | Mirrors the value of `indicator` for currently active OPAM switch |
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
2020-11-28 23:45:59 -05:00
2021-04-05 10:55:57 -04:00
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
2020-11-28 23:45:59 -05:00
### Ejemplo
``` toml
# ~/.config/starship.toml
[ ocaml ]
format = "via [🐪 $version]($style) "
```
## OpenStack
2021-04-05 10:55:57 -04:00
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.
2020-01-15 12:23:25 -05:00
2020-05-05 13:07:34 -04:00
### Opciones
2020-01-15 12:23:25 -05:00
2021-01-07 18:08:18 -05:00
| Opción | Por defecto | 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. |
2021-04-05 10:55:57 -04:00
| `disabled` | `false` | Disables the `openstack` module. |
2020-07-23 17:07:10 -04:00
### Variables
2020-11-28 23:45:59 -05:00
| Variable | Ejemplo | Descripción |
| --------- | ------- | -------------------------------------- |
2021-01-07 18:08:18 -05:00
| cloud | `corp` | La nube OpenStack actual |
| project | `dev` | El proyecto OpenStack actual |
2020-11-28 23:45:59 -05:00
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
2020-07-23 17:07:10 -04:00
2021-04-05 10:55:57 -04:00
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
2020-01-15 12:23:25 -05:00
2020-05-05 13:07:34 -04:00
### Ejemplo
2020-01-15 12:23:25 -05:00
``` toml
# ~/.config/starship.toml
2020-11-28 23:45:59 -05:00
[ openstack ]
format = "on [$symbol$cloud(\\($project\\))]($style) "
style = "bold yellow"
symbol = "☁️ "
2020-01-15 12:23:25 -05:00
```
2021-01-07 18:08:18 -05:00
## Versión del paquete
2020-05-23 19:10:58 -04:00
2021-04-05 10:55:57 -04:00
El módulo `package` se muestra cuando el directorio actual es el repositorio de un paquete, y muestra su versión actual. El módulo soporta actualmente los paquetes `npm` , `cargo` , `poetry` , `composer` , `gradle` , `julia` , `mix` y `helm` .
2020-05-23 19:10:58 -04:00
2021-01-07 18:08:18 -05:00
- **npm** – La versión del paquete `npm` se extrae del `package.json` presente en el directorio actual
- **cargo** – La versión del paquete `cargo` se extrae del `Cargo.toml` presente en el directorio actual
- **poetry** – La versión del paquete `poetry` es extraída del `pyproject.toml` presente en el directorio actual
- **composer** - La versión del paquete `composer` se extrae del `composer.json` presente en el directorio actual
- **gradle** – La versión del paquete `gradle` es extraída del `build.gradle` presente
- **julia** - La versión del paquete se extrae del `Project.toml` presente
- **mix** - La versión del paquete `mix` se extrae del `mix.exs` presente
- **helm** - La versión del gráfico `helm` se extrae del `Chart.yaml` presente
- **maven** - La versión del paquete `maven` es extraída del `pom.xml` presente
2021-01-26 17:07:13 -05:00
- **meson** - La versión del paquete `meson` es extraída del `meson.build` presente
2020-11-28 23:45:59 -05:00
> ⚠️ 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.
2020-05-23 19:10:58 -04:00
### Opciones
2021-01-07 18:08:18 -05:00
| Opción | Por defecto | 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. |
| `style` | `"bold 208"` | El estilo del módulo. |
| `display_private` | `false` | Activar la visualización de la versión para los paquetes marcados como privados. |
| `disabled` | `false` | Desactiva el módulo `package` . |
2020-07-23 17:07:10 -04:00
### Variables
2020-11-28 23:45:59 -05:00
| Variable | Ejemplo | Descripción |
| --------- | -------- | -------------------------------------- |
2021-01-07 18:08:18 -05:00
| version | `v1.0.0` | La versión de su paquete |
2020-11-28 23:45:59 -05:00
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
2020-07-23 17:07:10 -04:00
2021-04-05 10:55:57 -04:00
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
2020-05-23 19:10:58 -04:00
### Ejemplo
``` toml
# ~/.config/starship.toml
2020-11-28 23:45:59 -05:00
[ package ]
format = "via [🎁 $version](208 bold) "
2020-05-23 19:10:58 -04:00
```
2020-09-30 16:26:13 -04:00
## Perl
2021-04-05 10:55:57 -04:00
El módulo `perl` muestra la versión actualmente instalada de Perl. Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones:
2020-09-30 16:26:13 -04:00
2021-01-07 18:08:18 -05:00
- 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`
2020-09-30 16:26:13 -04:00
### Opciones
2021-02-21 14:13:18 -05:00
| Opción | Por defecto | Descripción |
| ------------------- | -------------------------------------------------------------------------------------------------------- | ---------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | La cadena de formato para el módulo. |
| `symbol` | `"🐪 "` | El símbolo usado antes de mostrar la versión de Perl |
2021-03-15 13:18:42 -04:00
| `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. |
2021-02-21 14:13:18 -05:00
| `style` | `"bold 149"` | El estilo del módulo. |
2021-03-15 13:18:42 -04:00
| `disabled` | `false` | Deshabilita el módulo `perl` . |
2020-09-30 16:26:13 -04:00
### Variables
| Variable | Ejemplo | Descripción |
| --------- | --------- | -------------------------------------- |
2021-01-07 18:08:18 -05:00
| version | `v5.26.1` | La versión de `perl` |
2020-09-30 16:26:13 -04:00
| 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) "
```
2020-01-15 12:23:25 -05:00
## PHP
2021-04-05 10:55:57 -04:00
El módulo `php` muestra la versión instalada de PHP. Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones:
2020-01-15 12:23:25 -05:00
2021-01-07 18:08:18 -05:00
- El directorio actual contiene un archivo `composer.json`
- El directorio actual contiene un archivo `.php-version`
2021-03-15 13:18:42 -04:00
- El directorio actual contiene una extensión `.php`
2020-01-15 12:23:25 -05:00
2020-05-05 13:07:34 -04:00
### Opciones
2020-01-15 12:23:25 -05:00
2021-02-21 14:13:18 -05:00
| Opción | Por defecto | Descripción |
| ------------------- | ------------------------------------ | ---------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. |
| `symbol` | `"🐘 "` | El símbolo usado antes de mostrar la versión de PHP. |
2021-03-15 13:18:42 -04:00
| `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. |
2021-02-21 14:13:18 -05:00
| `style` | `"147 bold"` | El estilo del módulo. |
2021-03-15 13:18:42 -04:00
| `disabled` | `false` | Deshabilita el módulo `php` . |
2020-07-23 17:07:10 -04:00
### Variables
2020-09-30 16:26:13 -04:00
| Variable | Ejemplo | Descripción |
| --------- | -------- | -------------------------------------- |
2021-01-07 18:08:18 -05:00
| version | `v7.3.8` | La versión de `php` |
2020-09-30 16:26:13 -04:00
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
2020-07-23 17:07:10 -04:00
2021-04-05 10:55:57 -04:00
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
2020-01-15 12:23:25 -05:00
2020-05-05 13:07:34 -04:00
### Ejemplo
2020-01-15 12:23:25 -05:00
``` toml
# ~/.config/starship.toml
[ php ]
2020-07-23 17:07:10 -04:00
format = "via [🔹 $version](147 bold) "
2020-01-15 12:23:25 -05:00
```
2020-11-28 23:45:59 -05:00
## PureScript
2021-04-05 10:55:57 -04:00
El módulo `purescript` muestra la versión actualmente instalada de PureScript. Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones:
2020-11-28 23:45:59 -05:00
2021-01-07 18:08:18 -05:00
- El directorio actual contiene un archivo `spago.dhall`
2021-03-15 13:18:42 -04:00
- El directorio actual contiene un archivo con la extensión `.purs`
2020-11-28 23:45:59 -05:00
### Opciones
2021-02-21 14:13:18 -05:00
| Opción | Por defecto | Descripción |
| ------------------- | ------------------------------------ | ----------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. |
| `symbol` | `"<=> "` | El símbolo usado antes de mostrar la versión de PureScript. |
2021-03-15 13:18:42 -04:00
| `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. |
2021-02-21 14:13:18 -05:00
| `style` | `"bold white"` | El estilo del módulo. |
2021-03-15 13:18:42 -04:00
| `disabled` | `false` | Deshabilita el módulo `purescript` . |
2020-11-28 23:45:59 -05:00
### Variables
| Variable | Ejemplo | Descripción |
| --------- | -------- | -------------------------------------- |
2021-01-07 18:08:18 -05:00
| version | `0.13.5` | La versión de `purescript` |
2020-11-28 23:45:59 -05:00
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
2021-04-05 10:55:57 -04:00
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
2020-11-28 23:45:59 -05:00
### Ejemplo
``` toml
# ~/.config/starship.toml
[ purescript ]
format = "via [$symbol$version](bold white)"
```
2020-01-15 12:23:25 -05:00
## Python
2021-04-05 10:55:57 -04:00
El módulo `python` muestra la versión actualmente instalada de Python y el actual entorno virtual de Python si uno está activado.
2020-01-15 12:23:25 -05:00
2021-04-05 10:55:57 -04:00
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` .
2020-01-15 12:23:25 -05:00
2021-02-21 14:13:18 -05:00
Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones:
2020-01-15 12:23:25 -05:00
2021-01-07 18:08:18 -05:00
- El directorio actual contiene un archivo `.python-version`
- El directorio actual contiene un archivo `Pipfile`
- El directorio actual contiene un archivo `__init__.py`
2021-02-21 14:13:18 -05:00
- 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` .
2021-01-07 18:08:18 -05:00
- Un entorno virtual está activado actualmente
2020-01-15 12:23:25 -05:00
2020-05-05 13:07:34 -04:00
### Opciones
2020-01-15 12:23:25 -05:00
2021-02-21 14:13:18 -05:00
| Opción | Por defecto | Descripción |
| -------------------- | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------- |
2021-04-05 10:55:57 -04:00
| `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\) )]($style)'` | El formato del módulo. |
2021-02-21 14:13:18 -05:00
| `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` . |
2021-01-03 03:56:07 -05:00
2021-04-05 10:55:57 -04:00
::: consejo
2021-01-03 03:56:07 -05:00
2021-04-05 10:55:57 -04:00
La variable `python_binary` acepta una cadena o una lista de cadenas. 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.
2021-01-03 03:56:07 -05:00
2021-04-05 10:55:57 -04:00
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 `pithon3` o `pithon2` ). 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). Si ya no trabajas con Python 2 pero no puedes removerlo del sistema, cambiando esto a `"python3"` ocultará cualquier versión de Python 2, ver ejemplo a continuación.
2021-01-03 03:56:07 -05:00
:::
2020-07-23 17:07:10 -04:00
### Variables
2021-01-07 18:08:18 -05:00
| 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 "` | Ordena el valor de la opción `pyenv_prefix` |
| virtualenv | `"venv"` | El nombre actual del `virtualenv` |
2020-01-15 12:23:25 -05:00
2020-10-13 15:09:01 -04:00
### Ejemplo
2020-06-19 17:05:45 -04:00
``` toml
# ~/.config/starship.toml
[ python ]
2020-10-13 15:09:01 -04:00
symbol = "👾 "
pyenv_version_name = true
2020-06-19 17:05:45 -04:00
```
2020-01-15 12:23:25 -05:00
``` toml
# ~/.config/starship.toml
[ python ]
2021-01-07 18:08:18 -05:00
# Solo usa el binario `python3` para obtener la versión.
2020-10-13 15:09:01 -04:00
python_binary = "python3"
2020-01-15 12:23:25 -05:00
```
2021-02-21 14:13:18 -05:00
``` toml
# ~/.config/starship.toml
[ python ]
# No se dispara con archivos con extensión py
detect_extensions = [ ]
```
2020-01-15 12:23:25 -05:00
## Ruby
2021-04-05 10:55:57 -04:00
Por defecto, el módulo `ruby` muestra la versión actualmente instalada de Ruby. El módulo se mostrará si se cumplen alguna de las siguientes condiciones:
2020-01-15 12:23:25 -05:00
2021-01-07 18:08:18 -05:00
- El directorio actual contiene un archivo `Gemfile`
- El directorio actual contiene un archivo `.ruby-version`
- El directorio actual contiene un archivo `.rb`
2020-01-15 12:23:25 -05:00
2020-05-05 13:07:34 -04:00
### Opciones
2020-01-15 12:23:25 -05:00
2021-02-21 14:13:18 -05:00
| Opción | Por defecto | Descripción |
| ------------------- | ------------------------------------ | -------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. |
| `symbol` | `"💎 "` | Una cadena de formato que representa el símbolo de Ruby. |
2021-03-15 13:18:42 -04:00
| `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. |
2021-02-21 14:13:18 -05:00
| `style` | `"bold red"` | El estilo del módulo. |
2021-03-15 13:18:42 -04:00
| `disabled` | `false` | Deshabilita el módulo `ruby` . |
2020-07-23 17:07:10 -04:00
### Variables
2020-09-30 16:26:13 -04:00
| Variable | Ejemplo | Descripción |
| --------- | -------- | -------------------------------------- |
2021-01-07 18:08:18 -05:00
| version | `v2.5.1` | La versión de `ruby` |
2020-09-30 16:26:13 -04:00
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
2020-07-23 17:07:10 -04:00
2021-04-05 10:55:57 -04:00
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
2020-01-15 12:23:25 -05:00
2020-05-05 13:07:34 -04:00
### Ejemplo
2020-01-15 12:23:25 -05:00
``` toml
# ~/.config/starship.toml
[ ruby ]
symbol = "🔺 "
```
## Rust
2021-04-05 10:55:57 -04:00
Por defecto, el módulo `rust` muestra la versión actualmente instalada de Rust. El módulo se mostrará si se cumplen alguna de las siguientes condiciones:
2020-01-15 12:23:25 -05:00
2021-01-07 18:08:18 -05:00
- El directorio actual contiene un archivo `Cargo.toml`
- El directorio actual contiene un archivo con la extensión `.rs`
2020-01-15 12:23:25 -05:00
2020-05-05 13:07:34 -04:00
### Opciones
2020-01-15 12:23:25 -05:00
2021-02-21 14:13:18 -05:00
| Opción | Por defecto | Descripción |
| ------------------- | ------------------------------------ | ------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. |
| `symbol` | `"🦀 "` | Una cadena de formato que representa el símbolo de Rust |
2021-03-15 13:18:42 -04:00
| `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. |
2021-02-21 14:13:18 -05:00
| `style` | `"bold red"` | El estilo del módulo. |
2021-03-15 13:18:42 -04:00
| `disabled` | `false` | Deshabilita el módulo `rust` . |
2020-07-23 17:07:10 -04:00
### Variables
2020-09-30 16:26:13 -04:00
| Variable | Ejemplo | Descripción |
| --------- | ----------------- | -------------------------------------- |
2021-01-07 18:08:18 -05:00
| version | `v1.43.0-nightly` | La versión de `rustc` |
2020-09-30 16:26:13 -04:00
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
2020-07-23 17:07:10 -04:00
2021-04-05 10:55:57 -04:00
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
2020-01-15 12:23:25 -05:00
2020-05-05 13:07:34 -04:00
### Ejemplo
2020-01-15 12:23:25 -05:00
``` toml
# ~/.config/starship.toml
[ rust ]
2020-07-23 17:07:10 -04:00
format = "via [⚙️ $version](red bold)"
2020-01-15 12:23:25 -05:00
```
2021-03-15 13:18:42 -04:00
## Scala
2021-04-05 10:55:57 -04:00
El módulo `scala` muestra la versión actualmente instalada de Scala. Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones:
2021-03-15 13:18:42 -04:00
2021-04-05 10:55:57 -04:00
- 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`
2021-03-15 13:18:42 -04:00
### Opciones
2021-04-05 10:55:57 -04:00
| Opción | Por defecto | Descripción |
| ------------------- | ---------------------------------------- | --------------------------------------------------------- |
| `format` | `"via [${symbol}(${version} )]($style)"` | El formato del módulo. |
| `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` . |
2021-03-15 13:18:42 -04:00
### Variables
| Variable | Ejemplo | Descripción |
| --------- | -------- | -------------------------------------- |
2021-04-05 10:55:57 -04:00
| version | `2.13.5` | La versión de `scala` |
2021-03-15 13:18:42 -04:00
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
2021-04-05 10:55:57 -04:00
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
2021-03-15 13:18:42 -04:00
### Ejemplo
``` toml
# ~/.config/starship.toml
[ scala ]
symbol = "🌟 "
```
2021-02-21 14:13:18 -05:00
## Shell
2021-04-05 10:55:57 -04:00
El módulo `shell` muestra un indicador para el intérprete de comandos actualmente utilizado.
2021-02-21 14:13:18 -05:00
2021-04-05 10:55:57 -04:00
::: consejo
2021-02-21 14:13:18 -05:00
2021-04-05 10:55:57 -04:00
Este módulo está deshabilitado por defecto. Para habilitarlo, establece `disabled` a `false` en tu archivo de configuración.
2021-02-21 14:13:18 -05:00
:::
### Opciones
2021-04-05 10:55:57 -04:00
| Opción | Por defecto | 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. |
| `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. |
| `format` | `$indicator` | El formato del módulo. |
| `disabled` | `true` | Deshabilita el módulo `shell` . |
2021-02-21 14:13:18 -05:00
### Variables
2021-04-05 10:55:57 -04:00
| Variable | Por defecto | Descripción |
| --------- | ----------- | ------------------------------------------------------------------------------------ |
| indicator | | Ordena el valor de `indicator` para el intérprete de comandos actualmente utilizado. |
2021-02-21 14:13:18 -05:00
### Ejemplos
2021-04-05 10:55:57 -04:00
2021-02-21 14:13:18 -05:00
``` toml
# ~/.config/starship.toml
[ shell ]
fish_indicator = ""
powershell_indicator = "_"
disabled = false
```
2020-09-30 16:26:13 -04:00
## SHLVL
2021-04-05 10:55:57 -04:00
The `shlvl` module shows the current `SHLVL` ("shell level") environment variable, if it is set to a number and meets or exceeds the specified threshold.
2020-09-30 16:26:13 -04:00
### Opciones
2021-04-05 10:55:57 -04:00
| Opción | Por defecto | Descripción |
| ----------- | ---------------------------- | ------------------------------------------------------------- |
| `threshold` | `2` | Mostrar el umbral. |
| `format` | `"[$symbol$shlvl]($style) "` | El formato del módulo. |
| `symbol` | `"↕️ "` | The symbol used to represent the `SHLVL` . |
| `repeat` | `false` | Causes `symbol` to be repeated by the current `SHLVL` amount. |
| `style` | `"bold yellow"` | El estilo del módulo. |
| `disabled` | `true` | Deshabilita el módulo `shlvl` . |
2020-09-30 16:26:13 -04:00
### Variables
| Variable | Ejemplo | Descripción |
| --------- | ------- | -------------------------------------- |
2021-04-05 10:55:57 -04:00
| shlvl | `3` | The current value of `SHLVL` |
2020-09-30 16:26:13 -04:00
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
2021-04-05 10:55:57 -04:00
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
2020-09-30 16:26:13 -04:00
### Ejemplo
``` toml
# ~/.config/starship.toml
[ shlvl ]
disabled = false
format = "$shlvl level(s) down"
threshold = 3
```
2020-04-03 12:35:39 -04:00
## Singularity
2021-04-05 10:55:57 -04:00
El módulo `singularity` muestra la imagen de singularity actual, si se encuentra dentro de un contenedor y `$SINGULARITY_NAME` está establecido.
2020-04-03 12:35:39 -04:00
2020-05-05 13:07:34 -04:00
### Opciones
2020-04-03 12:35:39 -04:00
2021-04-05 10:55:57 -04:00
| Opción | Por defecto | 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 `singularity` . |
2020-07-23 17:07:10 -04:00
### Variables
2020-09-30 16:26:13 -04:00
| Variable | Ejemplo | Descripción |
| --------- | ------------ | -------------------------------------- |
2021-04-05 10:55:57 -04:00
| env | `centos.img` | La imagen de singularity actual |
2020-09-30 16:26:13 -04:00
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
2020-07-23 17:07:10 -04:00
2021-04-05 10:55:57 -04:00
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
2020-04-03 12:35:39 -04:00
2020-05-05 13:07:34 -04:00
### Ejemplo
2020-04-03 12:35:39 -04:00
``` toml
# ~/.config/starship.toml
[ singularity ]
2020-10-13 15:09:01 -04:00
format = '[📦 \[$env\]]($style) '
2020-04-03 12:35:39 -04:00
```
2020-11-28 23:45:59 -05:00
## Status
2020-09-30 16:26:13 -04:00
2021-04-05 10:55:57 -04:00
El módulo `status` muestra el código de salida del comando anterior. El módulo se mostrará sólo si el código de salida no es `0` .
2020-11-28 23:45:59 -05:00
2021-04-05 10:55:57 -04:00
::: consejo
2020-09-30 16:26:13 -04:00
2021-04-05 10:55:57 -04:00
Este módulo está deshabilitado por defecto. Para habilitarlo, establece `disabled` a `false` en tu archivo de configuración.
2021-01-07 18:08:18 -05:00
:::
2020-09-30 16:26:13 -04:00
2021-04-05 10:55:57 -04:00
::: advertencia Este módulo no es compatible con el intérprete de comandos Elvish. :::
2021-02-06 12:46:15 -05:00
2020-09-30 16:26:13 -04:00
### Opciones
2021-04-05 10:55:57 -04:00
| Opción | Por defecto | Descripción |
| ----------------------- | ----------------------------- | ------------------------------------------------------ |
| `format` | `"[$symbol$status]($style) "` | El formato del módulo |
| `symbol` | `"✖"` | El símbolo mostrado en un error 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` | Habilitar mapeo de señales desde el código de salida |
| `map_symbol` | `false` | Habilitar mapeo de símbolos desde el código de salida |
| `disabled` | `true` | Deshabilita el módulo `status` . |
2020-09-30 16:26:13 -04:00
### Variables
2021-04-05 10:55:57 -04:00
| Variable | Ejemplo | Descripción |
| -------------- | ------- | ------------------------------------------------------------------------------------ |
| status | `127` | El código de salida del último comando |
| 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ñalizada |
| 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 |
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
2020-09-30 16:26:13 -04:00
2021-04-05 10:55:57 -04:00
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
2020-09-30 16:26:13 -04:00
### Ejemplo
``` toml
2020-11-28 23:45:59 -05:00
2020-09-30 16:26:13 -04:00
# ~/.config/starship.toml
2020-11-28 23:45:59 -05:00
[ status ]
style = "bg:blue"
2021-01-03 03:56:07 -05:00
symbol = "🔴"
2021-02-06 12:46:15 -05:00
format = '[\[$symbol $common_meaning$signal_name$maybe_int\]]($style) '
2021-01-03 03:56:07 -05:00
map_symbol = true
2020-11-28 23:45:59 -05:00
disabled = false
2020-09-30 16:26:13 -04:00
2020-11-28 23:45:59 -05:00
```
2020-09-30 16:26:13 -04:00
2020-11-28 23:45:59 -05:00
## Swift
2020-09-30 16:26:13 -04:00
2021-04-05 10:55:57 -04:00
Por defecto, el módulo `swift` muestra la versión actualmente instalada de Swift. El módulo se mostrará si se cumplen alguna de las siguientes condiciones:
2020-09-30 16:26:13 -04:00
2021-04-05 10:55:57 -04:00
- El directorio actual contiene un archivo `Package.swift`
- El directorio actual contiene un archivo con la extensión `.swift`
2020-09-30 16:26:13 -04:00
### Opciones
2021-04-05 10:55:57 -04:00
| Opción | Por defecto | Descripción |
| ------------------- | ------------------------------------ | -------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. |
| `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` . |
2020-09-30 16:26:13 -04:00
### Variables
2020-11-28 23:45:59 -05:00
| Variable | Ejemplo | Descripción |
| --------- | -------- | -------------------------------------- |
2021-04-05 10:55:57 -04:00
| version | `v5.2.4` | La versión de `swift` |
2020-11-28 23:45:59 -05:00
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
2020-09-30 16:26:13 -04:00
2021-04-05 10:55:57 -04:00
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
2020-09-30 16:26:13 -04:00
### Ejemplo
2020-09-30 21:23:36 -04:00
2020-09-30 16:26:13 -04:00
``` toml
# ~/.config/starship.toml
2020-11-28 23:45:59 -05:00
[ swift ]
format = "via [🏎 $version](red bold)"
2020-09-30 16:26:13 -04:00
```
2020-01-15 12:23:25 -05:00
## Terraform
2021-04-05 10:55:57 -04:00
El módulo `terraform` muestra el espacio de trabajo y la versión actual de Terraform.
2021-01-26 17:07:13 -05:00
2021-04-05 10:55:57 -04:00
::: consejo
2021-01-26 17:07:13 -05:00
2021-04-05 10:55:57 -04:00
Por defecto la versión de Terraform no se muestra, ya que esto es lento en las versiones actuales de Terraform cuando muchos plugins están en uso. Si aún deseas activarlo, [sigue el ejemplo que se muestra a continuación ](#with-version ).
2021-01-26 17:07:13 -05:00
:::
2021-02-21 14:13:18 -05:00
Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones:
2020-01-15 12:23:25 -05:00
2021-04-05 10:55:57 -04:00
- El directorio actual contiene una carpeta `.terraform`
- El directorio actual contiene un archivo con las extensiones `.tf` o `.hcl`
2020-01-15 12:23:25 -05:00
2020-05-05 13:07:34 -04:00
### Opciones
2020-01-15 12:23:25 -05:00
2021-04-05 10:55:57 -04:00
| Opción | Por defecto | Descripción |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------------- |
| `format` | `"via [$symbol$workspace]($style) "` | La cadena de formato para el módulo. |
| `symbol` | `"💠"` | Una cadena de formato que se muestra antes del espacio de trabajo de Terraform. |
| `detect_extensions` | `["tf", "hcl"]` | 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` | Desactiva el módulo `terraform` . |
2020-07-23 17:07:10 -04:00
### Variables
2021-04-05 10:55:57 -04:00
| Variable | Ejemplo | Descripción |
| --------- | ------------- | ----------------------------------------- |
| version | `v0.12.24` | La versión de `terraform` |
| workspace | `por defecto` | 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` |
2020-07-23 17:07:10 -04:00
2021-04-05 10:55:57 -04:00
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
2020-01-15 12:23:25 -05:00
2020-05-05 13:07:34 -04:00
### Ejemplo
2020-01-15 12:23:25 -05:00
2020-11-28 23:45:59 -05:00
#### Con la versión
2020-07-23 17:07:10 -04:00
2020-01-15 12:23:25 -05:00
``` toml
# ~/.config/starship.toml
[ terraform ]
2020-07-23 17:07:10 -04:00
format = "[🏎💨 $version$workspace]($style) "
```
2020-11-28 23:45:59 -05:00
#### Sin la versión
2020-07-23 17:07:10 -04:00
``` toml
# ~/.config/starship.toml
[ terraform ]
format = "[🏎💨 $workspace]($style) "
2020-01-15 12:23:25 -05:00
```
2021-01-03 03:56:07 -05:00
## Hora
2020-01-15 12:23:25 -05:00
2021-04-05 10:55:57 -04:00
El módulo `time` muestra la hora **local ** actual. El valor de configuración de `format` es usado por la caja 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.
2020-01-15 12:23:25 -05:00
2021-04-05 10:55:57 -04:00
::: consejo
2020-01-15 12:23:25 -05:00
2021-04-05 10:55:57 -04:00
Este módulo está deshabilitado por defecto. Para habilitarlo, establece `disabled` a `false` en tu archivo de configuración.
2020-01-15 12:23:25 -05:00
:::
2020-05-05 13:07:34 -04:00
### Opciones
2020-01-15 12:23:25 -05:00
2021-04-05 10:55:57 -04:00
| Opción | Por defecto | 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` | ver abajo | La [cadena de formato de chrono ](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html ) utilizada para formatear la hora. |
| `style` | `"bold yellow"` | El estilo del módulo de la hora |
| `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 el módulo se mostrará. Las horas deben especificarse en formato de 24 horas |
2020-07-23 17:07:10 -04:00
2021-04-05 10:55:57 -04:00
Si `use_12hr` es `true` , entonces `time_format` por defecto es `"%r"` . De lo contrario, el valor por defecto es `"%T"` . Configurar manualmente `time_format` sobrescribirá la configuración `use_12hr` .
2020-07-23 17:07:10 -04:00
### Variables
2020-09-30 16:26:13 -04:00
| Variable | Ejemplo | Descripción |
| --------- | ---------- | ------------------------------------- |
2021-04-05 10:55:57 -04:00
| time | `13:08:10` | La hora actual. |
2020-09-30 16:26:13 -04:00
| style\* | | Refleja el valor de la opción `style` |
2020-01-15 12:23:25 -05:00
2021-04-05 10:55:57 -04:00
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
2020-01-15 12:23:25 -05:00
2020-05-05 13:07:34 -04:00
### Ejemplo
2020-01-15 12:23:25 -05:00
``` toml
# ~/.config/starship.toml
[ time ]
disabled = false
2020-10-13 15:09:01 -04:00
format = '🕙[\[ $time \]]($style) '
2020-07-23 17:07:10 -04:00
time_format = "%T"
2020-04-03 12:35:39 -04:00
utc_time_offset = "-5"
2020-06-10 21:28:04 -04:00
time_range = "10:00:00-14:00:00"
2020-01-15 12:23:25 -05:00
```
2021-02-21 14:13:18 -05:00
## Username
2020-01-15 12:23:25 -05:00
2021-04-05 10:55:57 -04:00
El módulo `username` muestra el nombre de usuario activo. El módulo se mostrará si se cumplen alguna de las siguientes condiciones:
2021-01-03 03:56:07 -05:00
2021-04-05 10:55:57 -04:00
- El usuario actual es root
- El usuario actual no es el mismo que el que está conectado
- El usuario está actualmente conectado como una sesión SSH
- La variable `show_always` se establece en true
2021-01-07 18:08:18 -05:00
2021-04-05 10:55:57 -04:00
::: consejo
2020-01-15 12:23:25 -05:00
2021-04-05 10:55:57 -04:00
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.
2021-01-07 18:08:18 -05:00
:::
2020-01-15 12:23:25 -05:00
2020-05-05 13:07:34 -04:00
### Opciones
2020-01-15 12:23:25 -05:00
2021-04-05 10:55:57 -04:00
| Opción | Por defecto | Descripción |
| ------------- | ----------------------- | ------------------------------------------ |
| `style_root` | `"bold red"` | El estilo usado cuando el usuario es root. |
| `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` . |
2020-07-23 17:07:10 -04:00
### Variables
2021-04-05 10:55:57 -04:00
| 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. |
| `user` | `"matchai"` | El ID de usuario conectado actualmente. |
2020-01-15 12:23:25 -05:00
2020-05-05 13:07:34 -04:00
### Ejemplo
2020-01-15 12:23:25 -05:00
``` toml
# ~/.config/starship.toml
[ username ]
2020-07-23 17:07:10 -04:00
style_user = "white bold"
style_root = "black bold"
format = "user: [$user]($style) "
disabled = false
show_always = true
2020-01-15 12:23:25 -05:00
```
2020-05-05 13:07:34 -04:00
2021-02-06 12:46:15 -05:00
## Vagrant
2021-04-05 10:55:57 -04:00
El módulo `vagrant` muestra la versión instalada de Vagrant. Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones:
2021-02-06 12:46:15 -05:00
2021-04-05 10:55:57 -04:00
- El directorio actual contiene un archivo `Vagrantfile`
2021-02-06 12:46:15 -05:00
### Opciones
2021-04-05 10:55:57 -04:00
| Opción | Por defecto | Descripción |
| ------------------- | ------------------------------------ | ----------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. |
| `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` | Disables the `vagrant` module. |
2021-02-06 12:46:15 -05:00
### Variables
| Variable | Ejemplo | Descripción |
| --------- | ---------------- | -------------------------------------- |
2021-04-05 10:55:57 -04:00
| version | `Vagrant 2.2.10` | La versión de `Vagrant` |
2021-02-06 12:46:15 -05:00
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
2021-04-05 10:55:57 -04:00
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
2021-02-06 12:46:15 -05:00
### Ejemplo
``` toml
# ~/.config/starship.toml
[ vagrant ]
format = "via [⍱ $version](bold white) "
```
2021-04-05 10:55:57 -04:00
## VCSH
The `vcsh` module displays the current active VCSH repository. The module will be shown only if a repository is currently in use.
### Opciones
| Opción | Por defecto | Descripción |
| ---------- | -------------------------------- | ------------------------------------------------------ |
| `symbol` | | The symbol used before displaying the repository name. |
| `style` | `"bold yellow"` | El estilo del módulo. |
| `format` | `"vcsh [$symbol$repo]($style) "` | El formato del módulo. |
| `disabled` | `false` | Disables the `vcsh` module. |
### Variables
| Variable | Ejemplo | Descripción |
| ----------- | ------------------------------------------- | -------------------------------------- |
| repositorio | `dotfiles` if in a VCSH repo named dotfiles | The active repository name |
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | `black bold dimmed` | Refleja el valor de la opción `style` |
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
### Ejemplo
``` toml
# ~/.config/starship.toml
[ vcsh ]
format = "[🆅 $repo](bold blue) "
```
2020-05-23 19:10:58 -04:00
## Zig
2021-04-05 10:55:57 -04:00
By default the the `zig` module shows the currently installed version of Zig. El módulo se mostrará si se cumplen alguna de las siguientes condiciones:
2020-05-23 19:10:58 -04:00
2021-04-05 10:55:57 -04:00
- El directorio actual contiene un archivo `.zig`
2020-05-23 19:10:58 -04:00
### Opciones
2021-02-21 14:13:18 -05:00
| Opción | Por defecto | Descripción |
| ------------------- | ------------------------------------ | ----------------------------------------------------- |
| `symbol` | `"↯ "` | The symbol used before displaying the version of Zig. |
| `style` | `"bold yellow"` | El estilo del módulo. |
| `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. |
| `disabled` | `false` | Disables the `zig` module. |
2021-03-15 13:18:42 -04:00
| `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. |
2020-07-23 17:07:10 -04:00
### Variables
2020-09-30 16:26:13 -04:00
| Variable | Ejemplo | Descripción |
| --------- | -------- | -------------------------------------- |
2021-04-05 10:55:57 -04:00
| version | `v0.6.0` | La versión de `zig` |
2020-09-30 16:26:13 -04:00
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
2020-07-23 17:07:10 -04:00
2021-04-05 10:55:57 -04:00
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
2020-05-23 19:10:58 -04:00
### Ejemplo
``` toml
# ~/.config/starship.toml
[ zig ]
symbol = "⚡️ "
```
2021-04-05 10:55:57 -04:00
## Comandos personalizados
2020-05-05 13:07:34 -04:00
2021-02-21 14:13:18 -05:00
The `custom` modules show the output of some arbitrary commands.
2020-05-05 13:07:34 -04:00
2021-02-21 14:13:18 -05:00
These modules will be shown if any of the following conditions are met:
2020-07-23 17:07:10 -04:00
2021-04-05 10:55:57 -04:00
- El directorio actual contiene un archivo cuyo nombre está en `files`
- El directorio actual contiene un directorio cuyo nombre está en `directories`
- El directorio actual contiene un archivo cuya extensión está en `extensions`
- El comando `when` devuelve 0
2020-05-05 13:07:34 -04:00
2021-04-05 10:55:57 -04:00
::: consejo
2020-05-05 13:07:34 -04:00
2021-02-21 14:13:18 -05:00
Multiple custom modules can be defined by using a `.` .
2020-05-05 13:07:34 -04:00
:::
2021-04-05 10:55:57 -04:00
::: consejo
2020-05-05 13:07:34 -04:00
2021-02-21 14:13:18 -05:00
The order in which custom modules are shown can be individually set by including `${custom.foo}` in the top level `format` (as it includes a dot, you need to use `${...}` ). By default, the `custom` module will simply show all custom modules in the order they were defined.
2020-09-30 16:26:13 -04:00
:::
2021-04-05 10:55:57 -04:00
::: consejo
2020-09-30 16:26:13 -04:00
2021-02-21 14:13:18 -05:00
[Issue #1252 ](https://github.com/starship/starship/discussions/1252 ) contains examples of custom modules. If you have an interesting example not covered there, feel free to share it there!
2020-05-05 13:07:34 -04:00
:::
### Opciones
2021-02-21 14:13:18 -05:00
| Opción | Por defecto | Descripción |
| ------------- | ------------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
2021-04-05 10:55:57 -04:00
| `comando` | | The command whose output should be printed. The command will be passed on stdin to the shell. |
| `cuando` | | A shell command used as a condition to show the module. The module will be shown if the command returns a `0` status code. |
| `shell` | | [Ver abajo ](#custom-command-shell ) |
| `descripción` | `"<custom module>"` | The description of the module that is shown when running `starship explain` . |
| `archivos` | `[]` | The files that will be searched in the working directory for a match. |
| `directorios` | `[]` | The directories that will be searched in the working directory for a match. |
| `extensiones` | `[]` | The extensions that will be searched in the working directory for a match. |
2021-02-21 14:13:18 -05:00
| `symbol` | `""` | The symbol used before displaying the command output. |
| `style` | `"bold green"` | El estilo del módulo. |
| `format` | `"[$symbol($output )]($style)"` | El formato del módulo. |
2021-04-05 10:55:57 -04:00
| `disabled` | `false` | Deshabilita este `módulo` personalizado. |
2020-07-23 17:07:10 -04:00
### Variables
2021-02-21 14:13:18 -05:00
| Variable | Descripción |
| --------- | -------------------------------------- |
2021-04-05 10:55:57 -04:00
| salida | The output of shell command in `shell` |
2021-02-21 14:13:18 -05:00
| symbol | Refleja el valor de la opción `symbol` |
| style\* | Refleja el valor de la opción `style` |
2020-07-23 17:07:10 -04:00
2021-04-05 10:55:57 -04:00
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
2020-05-05 13:07:34 -04:00
2021-03-15 13:18:42 -04:00
#### Comando personalizado del intérprete de comandos
2020-06-10 21:28:04 -04:00
2021-02-21 14:13:18 -05:00
`shell` accepts a non-empty list of strings, where:
2020-07-23 17:07:10 -04:00
2021-04-05 10:55:57 -04:00
- La primera cadena es la ruta al intérprete de comandos a usar para ejecutar el comando.
- Otros argumentos siguientes que son pasados al shell.
2020-06-10 21:28:04 -04:00
2021-02-21 14:13:18 -05:00
If unset, it will fallback to STARSHIP_SHELL and then to "sh" on Linux, and "cmd /C" on Windows.
2020-06-10 21:28:04 -04:00
2021-02-21 14:13:18 -05:00
The `command` will be passed in on stdin.
2020-09-30 16:26:13 -04:00
2021-02-21 14:13:18 -05:00
If `shell` is not given or only contains one element and Starship detects PowerShell will be used, the following arguments will automatically be added: `-NoProfile -Command -` . This behavior can be avoided by explicitly passing arguments to the shell, e.g.
2020-06-10 21:28:04 -04:00
``` toml
shell = [ "pwsh" , "-Command" , "-" ]
```
2021-02-21 14:13:18 -05:00
::: warning Make sure your custom shell configuration exits gracefully
2020-06-10 21:28:04 -04:00
2021-02-21 14:13:18 -05:00
If you set a custom command, make sure that the default Shell used by starship will properly execute the command with a graceful exit (via the `shell` option).
2020-06-10 21:28:04 -04:00
2021-02-21 14:13:18 -05:00
For example, PowerShell requires the `-Command` parameter to execute a one liner. Omitting this parameter might throw starship into a recursive loop where the shell might try to load a full profile environment with starship itself again and hence re-execute the custom command, getting into a never ending loop.
2020-06-10 21:28:04 -04:00
2021-02-21 14:13:18 -05:00
Parameters similar to `-NoProfile` in PowerShell are recommended for other shells as well to avoid extra loading time of a custom profile on every starship invocation.
2020-06-10 21:28:04 -04:00
2021-02-21 14:13:18 -05:00
Automatic detection of shells and proper parameters addition are currently implemented, but it's possible that not all shells are covered. [Please open an issue ](https://github.com/starship/starship/issues/new/choose ) with shell details and starship configuration if you hit such scenario.
2020-06-10 21:28:04 -04:00
:::
2020-05-05 13:07:34 -04:00
### Ejemplo
``` toml
# ~/.config/starship.toml
[ custom . foo ]
2021-04-05 10:55:57 -04:00
command = "echo foo" # mostrar resultado de command
2021-02-21 14:13:18 -05:00
files = [ "foo" ] # can specify filters
2020-05-05 13:07:34 -04:00
when = "" " test " $ HOME " == " $ PWD " " ""
2020-09-30 16:26:13 -04:00
format = " transcending [$output]($style)"
2020-06-10 21:28:04 -04:00
[ custom . time ]
command = "time /T"
files = [ "*.pst" ]
shell = [ "pwsh.exe" , "-NoProfile" , "-Command" , "-" ]
2020-05-05 13:07:34 -04:00
```