starship/docs/es-ES/config
Matan Kushner 91fe1b747f
docs(i18n): new Crowdin updates (#2884)
* New translations README.md (German)

* New translations README.md (Arabic)

* New translations README.md (Spanish)

* New translations README.md (Sorani (Kurdish))

* New translations README.md (Chinese Simplified)

* New translations README.md (Chinese Simplified)

* New translations README.md (Russian)

* New translations README.md (Portuguese, Brazilian)

* New translations README.md (Vietnamese)

* New translations README.md (Chinese Simplified)

* New translations README.md (Turkish)

* New translations README.md (Russian)

* New translations README.md (Portuguese)

* New translations README.md (Polish)

* New translations README.md (Dutch)

* New translations README.md (Italian)

* New translations README.md (Chinese Traditional)

* New translations README.md (Spanish)

* New translations README.md (Sorani (Kurdish))

* New translations README.md (French)

* New translations README.md (Arabic)

* New translations README.md (German)

* New translations README.md (Japanese)

* New translations README.md (Korean)

* New translations README.md (French)

* New translations README.md (Portuguese, Brazilian)

* New translations README.md (Vietnamese)

* New translations README.md (Chinese Traditional)

* New translations README.md (Chinese Simplified)

* New translations README.md (Turkish)

* New translations README.md (Russian)

* New translations README.md (Portuguese)

* New translations README.md (Polish)

* New translations README.md (Dutch)

* New translations README.md (Korean)

* New translations README.md (Italian)

* New translations README.md (German)

* New translations README.md (Arabic)

* New translations README.md (Spanish)

* New translations README.md (Japanese)

* New translations README.md (Sorani (Kurdish))

* New translations README.md (Chinese Traditional)

* New translations README.md (Chinese Traditional)

* New translations README.md (Chinese Traditional)

* New translations README.md (Chinese Traditional)

* New translations README.md (Chinese Traditional)

* New translations README.md (Chinese Traditional)

* New translations README.md (Chinese Traditional)

* New translations README.md (Chinese Traditional)

* New translations README.md (Chinese Traditional)

* New translations README.md (Chinese Traditional)

* New translations README.md (Chinese Traditional)

* New translations README.md (Chinese Traditional)

* New translations README.md (Chinese Traditional)

* New translations README.md (Chinese Traditional)

* New translations README.md (Chinese Traditional)

* New translations README.md (Chinese Traditional)

* New translations README.md (Chinese Traditional)

* New translations README.md (Chinese Traditional)

* New translations README.md (Chinese Traditional)

* New translations README.md (Chinese Traditional)

* New translations README.md (Korean)

* New translations README.md (Portuguese)

* New translations README.md (Portuguese, Brazilian)

* New translations README.md (Vietnamese)

* New translations README.md (Chinese Traditional)

* New translations README.md (Chinese Simplified)

* New translations README.md (Turkish)

* New translations README.md (Russian)

* New translations README.md (Polish)

* New translations README.md (French)

* New translations README.md (Dutch)

* New translations README.md (Japanese)

* New translations README.md (Italian)

* New translations README.md (German)

* New translations README.md (Arabic)

* New translations README.md (Spanish)

* New translations README.md (Sorani (Kurdish))

* New translations README.md (French)

* New translations README.md (Korean)

* New translations README.md (Portuguese)

* New translations README.md (Portuguese, Brazilian)

* New translations README.md (Vietnamese)

* New translations README.md (Chinese Traditional)

* New translations README.md (Chinese Simplified)

* New translations README.md (Turkish)

* New translations README.md (Russian)

* New translations README.md (Polish)

* New translations README.md (French)

* New translations README.md (Dutch)

* New translations README.md (Japanese)

* New translations README.md (Italian)

* New translations README.md (German)

* New translations README.md (Arabic)

* New translations README.md (Spanish)

* New translations README.md (Sorani (Kurdish))

* New translations README.md (Korean)

* New translations README.md (Portuguese)

* New translations README.md (Portuguese, Brazilian)

* New translations README.md (Vietnamese)

* New translations README.md (Chinese Traditional)

* New translations README.md (Chinese Simplified)

* New translations README.md (Turkish)

* New translations README.md (Russian)

* New translations README.md (Polish)

* New translations README.md (French)

* New translations README.md (Dutch)

* New translations README.md (Japanese)

* New translations README.md (Italian)

* New translations README.md (German)

* New translations README.md (Arabic)

* New translations README.md (Spanish)

* New translations README.md (Sorani (Kurdish))

* New translations README.md (Russian)

* New translations README.md (Korean)

* New translations README.md (French)

* New translations README.md (Spanish)

* New translations README.md (Arabic)

* New translations README.md (German)

* New translations README.md (Italian)

* New translations README.md (Japanese)

* New translations README.md (Dutch)

* New translations README.md (Polish)

* New translations README.md (Portuguese)

* New translations README.md (Turkish)

* New translations README.md (Chinese Simplified)

* New translations README.md (Chinese Traditional)

* New translations README.md (Vietnamese)

* New translations README.md (Portuguese, Brazilian)

* New translations README.md (Sorani (Kurdish))

* New translations README.md (French)

* New translations README.md (Portuguese)

* New translations README.md (Portuguese, Brazilian)

* New translations README.md (Vietnamese)

* New translations README.md (Chinese Traditional)

* New translations README.md (Chinese Simplified)

* New translations README.md (Turkish)

* New translations README.md (Russian)

* New translations README.md (Polish)

* New translations README.md (Spanish)

* New translations README.md (Dutch)

* New translations README.md (Korean)

* New translations README.md (Japanese)

* New translations README.md (Italian)

* New translations README.md (German)

* New translations README.md (Arabic)

* New translations README.md (Sorani (Kurdish))

* New translations README.md (Portuguese, Brazilian)

* New translations README.md (Portuguese, Brazilian)

* New translations README.md (Portuguese, Brazilian)

* New translations README.md (Portuguese, Brazilian)

* New translations README.md (Portuguese, Brazilian)

* New translations README.md (Portuguese, Brazilian)

* New translations README.md (Portuguese, Brazilian)

* New translations README.md (Portuguese, Brazilian)

* New translations README.md (Portuguese, Brazilian)

* New translations README.md (Portuguese, Brazilian)

* New translations README.md (Portuguese, Brazilian)

* New translations README.md (Portuguese, Brazilian)

* New translations README.md (Portuguese, Brazilian)

* New translations README.md (Portuguese, Brazilian)

* New translations README.md (Portuguese, Brazilian)

* New translations README.md (Portuguese, Brazilian)

* New translations README.md (Portuguese, Brazilian)

* New translations README.md (Portuguese, Brazilian)

* New translations README.md (Portuguese, Brazilian)

* New translations README.md (Portuguese, Brazilian)

* New translations README.md (Portuguese, Brazilian)

* New translations README.md (French)

* New translations README.md (Spanish)

* New translations README.md (Arabic)

* New translations README.md (German)

* New translations README.md (Italian)

* New translations README.md (Japanese)

* New translations README.md (Korean)

* New translations README.md (Dutch)

* New translations README.md (Polish)

* New translations README.md (Portuguese)

* New translations README.md (Russian)

* New translations README.md (Turkish)

* New translations README.md (Chinese Simplified)

* New translations README.md (Vietnamese)

* New translations README.md (Chinese Traditional)

* New translations README.md (Vietnamese)

* New translations README.md (Korean)

* New translations README.md (French)

* New translations README.md (Spanish)

* New translations README.md (Arabic)

* New translations README.md (German)

* New translations README.md (Italian)

* New translations README.md (Japanese)

* New translations README.md (Dutch)

* New translations README.md (Polish)

* New translations README.md (Portuguese)

* New translations README.md (Russian)

* New translations README.md (Turkish)

* New translations README.md (Chinese Simplified)

* New translations README.md (Chinese Traditional)

* New translations README.md (Portuguese, Brazilian)

* New translations README.md (Sorani (Kurdish))

* New translations README.md (Sorani (Kurdish))

* New translations README.md (Portuguese, Brazilian)

* New translations README.md (Portuguese, Brazilian)

* New translations README.md (Turkish)

* New translations README.md (Portuguese, Brazilian)

* New translations README.md (Turkish)

* New translations README.md (Portuguese, Brazilian)

* New translations README.md (Turkish)

* New translations README.md (Portuguese, Brazilian)

* New translations README.md (Korean)

* New translations README.md (Portuguese)

* New translations README.md (Portuguese, Brazilian)

* New translations README.md (Vietnamese)

* New translations README.md (Chinese Traditional)

* New translations README.md (Chinese Simplified)

* New translations README.md (Turkish)

* New translations README.md (Russian)

* New translations README.md (Polish)

* New translations README.md (French)

* New translations README.md (Dutch)

* New translations README.md (Japanese)

* New translations README.md (Italian)

* New translations README.md (German)

* New translations README.md (Arabic)

* New translations README.md (Spanish)

* New translations README.md (Sorani (Kurdish))

* New translations README.md (Korean)

* New translations README.md (Portuguese)

* New translations README.md (Portuguese, Brazilian)

* New translations README.md (Vietnamese)

* New translations README.md (Chinese Traditional)

* New translations README.md (Chinese Simplified)

* New translations README.md (Turkish)

* New translations README.md (Russian)

* New translations README.md (Polish)

* New translations README.md (French)

* New translations README.md (Dutch)

* New translations README.md (Japanese)

* New translations README.md (Italian)

* New translations README.md (German)

* New translations README.md (Arabic)

* New translations README.md (Spanish)

* New translations README.md (Sorani (Kurdish))

* New translations README.md (Portuguese, Brazilian)

* New translations README.md (Portuguese, Brazilian)

* New translations README.md (Portuguese, Brazilian)

* New translations README.md (Portuguese, Brazilian)

* New translations README.md (Portuguese, Brazilian)

* New translations README.md (Portuguese, Brazilian)

* New translations README.md (Italian)
2021-08-14 15:24:51 +02:00
..
README.md docs(i18n): new Crowdin updates (#2884) 2021-08-14 15:24:51 +02:00

Configuración

Para comenzar a configurar Starship, crea el siguiente archivo: ~/.config/starship.toml.

mkdir -p ~/.config && touch ~/.config/starship.toml

Toda la configuración de Starship se realiza en este archivo TOML:

# Inserta una línea en blanco al inicio del prompt
add_newline = true

# 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"

# Deshabilita el módulo "package", ocultándolo por completo del prompt
[package]
disabled = true

Puedes cambiar la ubicación por defecto del archivo de configuración con la variable de entorno STARSHIP_CONFIG:

export STARSHIP_CONFIG=~/.starship/config.toml

El equivalente en PowerShell (Windows) es añadir esta línea a tu $PROFILE:

$ENV:STARSHIP_CONFIG = "$HOME\.starship\config.toml"

Registros

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:

export STARSHIP_CACHE=~/.starship/cache

El equivalente en PowerShell (Windows) es añadir esta línea a tu $PROFILE:

$ENV:STARSHIP_CACHE = "$HOME\AppData\Local\Temp"

Terminología

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.

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.

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.

Cadenas de Formato

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.

Variable

Una variable contiene un símbolo $ seguido por el nombre de la variable. El nombre de una variable solo contiene letras, números y _.

Por ejemplo:

  • $version es una cadena de formato con una variable llamada version.
  • $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.

Grupo de Texto

Un grupo de texto se compone de dos partes diferentes.

La primera parte, que está encerrada en un [], es una cadena de formato. Se puede agregar textos, variables, o incluso grupos de texto anidados.

En la segunda parte, que está encerrada entre (), es una cadena de estilo. Se puede utilizar el estilo de la primera parte.

Por ejemplo:

  • [en](bold red) imprimirá una cadena en con texto en negrita color rojo.
  • [⌘ $version](bold green) imprimirá un símbolo seguido por el contenido de la variable version, con texto en negrita color verde.
  • [a [b](red) c](green) imprimirá a b c con b en rojo, a y c en verde.

Cadenas de estilo

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.

  • "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 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

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.

Cadenas de Formato Condicional

Una cadena de formato condicional envuelto en ( y ) no se renderizará si todas las variables dentro están vacías.

Por ejemplo:

  • (@$region) will show nothing if the variable region is None or empty string, otherwise @ followed by the value of region.
  • (algún texto) siempre mostrará nada ya que no hay variables envueltas entre llaves.
  • 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\] ).

Caracteres de escape

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 (\).

  • $
  • \
  • [
  • ]
  • (
  • )

Se debe tener en cuenta que toml tiene su propia sintaxis de escape. 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 \.

Por ejemplo, cuando se desea imprimir un símbolo $ en una nueva línea, las siguientes configuraciones para la variable format son equivalentes:

# con cadena básica
format = "\n\\$"

# con cadena básica multilínea
format = """

\\$"""

# con cadena literal
format = '''

\$'''

Prompt

Esta es la lista de opciones de configuración del prompt.

Opciones

Opción Por defecto Descripción
format ver aquí Configura el formato del prompt.
scan_timeout 30 Tiempo de espera tras el que Starship escanea los archivos (en milisegundos).
command_timeout 500 Tiempo de espera para los comandos ejecutados por starship (en milisegundos).
add_newline true Inserta un línea en blanco entre las instrucciones del intérprete de comandos.

Ejemplo

# ~/.config/starship.toml

# Usar formato personalizado
format = """
[┌───────────────────>](bold green)
[│](bold green)$directory$rust$package
[└─>](bold green) """

# Espera 10 milisegundos para que starship revise los archivos del directorio actual.
scan_timeout = 10

# Deshabilita la línea en blanco al inicio del prompt
add_newline = false

Formato por Defecto del Prompt

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:

format = "$all"

# Which is equivalent to
format = """
$username\
$hostname\
$shlvl\
$kubernetes\
$directory\
$vcsh\
$git_branch\
$git_commit\
$git_state\
$git_metrics\
$git_status\
$hg_branch\
$docker_context\
$package\
$cmake\
$dart\
$deno\
$dotnet\
$elixir\
$elm\
$erlang\
$golang\
$helm\
$java\
$julia\
$kotlin\
$nim\
$nodejs\
$ocaml\
$perl\
$php\
$purescript\
$python\
$red\
$ruby\
$rust\
$scala\
$swift\
$terraform\
$vlang\
$vagrant\
$zig\
$nix_shell\
$conda\
$memory_usage\
$aws\
$gcloud\
$openstack\
$env_var\
$crystal\
$custom\
$cmd_duration\
$line_break\
$lua\
$jobs\
$battery\
$time\
$status\
$shell\
$character"""

AWS

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. Este módulo también muestra un temporizador de caducidad al usar credenciales temporales.

Cuando se utiliza aws-vault, el perfil se lee de la variable de entorno AWS_VAULT y la fecha de expiración de credenciales se lee de la variable de entorno AWS_SESSION_EXPIRATION.

Cuando uses awsu el perfil se obtiene de la variable de entorno AWSU_PROFILE.

Cuando se utiliza AWSume, el perfil se lee de la variable de entorno AWSUME_PROFILE y la fecha de expiración de credenciales se lee de la variable de entorno AWSUME_EXPIRATION.

Opciones

Opción Por defecto Descripción
format 'on [$symbol($profile )(\($region\) )(\[$duration\])]($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.
expiration_symbol X El símbolo mostrado cuando las credenciales temporales han caducado.
disabled false Desactiva el módulo AWS.

Variables

Variable Ejemplo Descripción
region ap-northeast-1 La región actual de AWS
profile astronauts El perfil actual de AWS
duration 2h27m20s La duración de la validez de las credenciales temporales
symbol Refleja el valor de la opción symbol
style* Refleja el valor de la opción style

*: Esta variable sólo puede ser usada como parte de una cadena de estilo

Ejemplos

Mostrar todo

# ~/.config/starship.toml

[aws]
format = 'on [$symbol($profile )(\($region\) )]($style)'
style = "bold blue"
symbol = "🅰 "
[aws.region_aliases]
ap-southeast-2 = "au"
us-east-1 = "va"

Mostrar región

# ~/.config/starship.toml

[aws]
format = "en [$symbol$region]($style) "
style = "bold blue"
symbol = "🅰 "
[aws.region_aliases]
ap-southeast-2 = "au"
us-east-1 = "va"

Mostrar perfil

# ~/.config/starship.toml

[aws]
format = "en [$symbol$profile]($style) "
style = "bold blue"
symbol = "🅰 "

Battery

El módulo battery muestra la cantidad de batería y si se está cargando o no. El módulo es solo visible cuando la batería está por debajo del 10%.

Opciones

Opción Por defecto Descripción
full_symbol " " Se muestra cuando la batería está cargada.
charging_symbol " " Se muestra cuando la batería se está cargando.
discharging_symbol " " Se muestra cuando la batería se está descargando.
unknown_symbol " " El símbolo que se muestra cuando el estado de la batería es desconocido.
empty_symbol " " El símbolo que se muestra cuando el estado de la batería está vacío.
format "[$symbol$percentage]($style) " El formato del módulo.
display ver aquí Define cuándo mostrar el indicador y el estilo.
disabled false Desactiva el módulo battery.

Ejemplo

# ~/.config/starship.toml

[battery]
full_symbol = "🔋 "
charging_symbol = "⚡️ "
discharging_symbol = "💀 "

Indicador de batería

La opción de configuración display se utiliza para definir cuándo debe mostrarse el indicador de batería (threshold), qué symbol se utilizaría (symbol), y cómo sería (style). Si no se provee ningún valor para display El valor por defecto es el siguiente:

[[battery.display]]
threshold = 10
style = "bold red"

El valor por defecto para las opciones charging_symbol y discharging_symbol son respectivamente los valores charging_symbol y discharging_symbol de las opción de battery.

Opciones

La opción display es un array de la siguiente tabla.

Opción Por defecto Descripción
threshold 10 El umbral para la opción de visualización.
style bold red El estilo usado cuando si la opción <0>display</0> está activa.
charging_symbol - Símbolo opcional que se muestra si la opción de visualización está en uso, por defecto en la opción charging_symbol de la batería.
discharging_symbol - Símbolo opcional que se muestra si la opción de visualización está en uso, por defecto en la opción discharging_symbol de la batería.

Ejemplo

[[battery.display]]  # estilo "bold red" y discharning_symbol cuando la capacidad está entre 0% y 10%
threshold = 10
style = "bold red"

[[battery.display]]  # estilo "bold yellow" y el símbolo 💦 cuando la capacidad está entre 10% y 30%
threshold = 30
style = "bold yellow"

# cuando la capadidad está por encima del 30% el indicador no se mostrará

Character

El módulo character muestra un carácter (normalmente una flecha) tras el texto que introduces en el terminal.

El carácter te dirá si el último comando funcionó o no. Se puede hacer de dos maneras:

  • Cambiando el color (red/green)
  • Cambiando la forma (./)

Por defecto sólo cambia el color. Si también se quiere cambiar su forma, ver este ejemplo.

::: aviso

error_symbol is not supported on elvish and nu shell.

:::

::: aviso

vicmd_symbol sólo es compatible con fish y zsh.

:::

Opciones

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.

Variables

Variable Ejemplo Descripción
symbol Un espejo de success_symbol, error_symbol o vicmd_symbol

Ejemplos

Con formato de error personalizado

# ~/.config/starship.toml

[character]
success_symbol = "[➜](bold green) "
error_symbol = "[✗](bold red) "

Sin formato de error personalizado

# ~/.config/starship.toml

[character]
success_symbol = "[➜](bold green) "
error_symbol = "[➜](bold red) "

Con formato de vim personalizado

# ~/.config/starship.toml

[character]
vicmd_symbol = "[V](bold green) "

CMake

El módulo cmake muestra la versión actualmente instalada de CMake. Por defecto el módulo se activará si se cumplen cualquiera de las siguientes condiciones:

  • El directorio actual contiene un archivo CMakeLists.txt
  • El directorio actual contiene un archivo CMakeCache.txt

Opciones

Opción Por defecto Descripción
format "via [$symbol($version )]($style)" El formato del módulo.
version_format "v${raw}" El formato de versión. Las variables disponibles son raw, major, minor, & patch
symbol "△ " El símbolo usado antes de la versión de cmake.
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.
disabled false Desactiva el módulo cmake.

Variables

Variable Ejemplo Descripción
version v3.17.3 La versión de cmake
symbol Refleja el valor de la opción symbol
style* Refleja el valor de la opción style

*: Esta variable sólo puede ser usada como parte de una cadena de estilo

Tiempo de Ejecución

El módulo cmd_duration muestra cuánto tiempo tardó el último comando en ejecutarse. El módulo se mostrará solo si el comando llevó dos segundos o más, o el valor de min_time, si existe.

::: warning No utilizar DEBUG en Bash

Si estás usando Starship con bash, no uses DEBUG después de ejecutar eval $(starship init $0), o el módulo se romperá.

:::

Los usuarios de bash que necesiten la funcionalidad preexec-like pueden usar el framework rcaloras's bash_preexec. Simplemente define los arrays preexec_functions y precmd_functions antes de ejecutar eval $(starship init $0), y continúa con normalidad. Basta con definir los arrays preexec_functions y precmd_functions antes de ejecutar eval $(starship init $0), y luego proceder como siempre.

Opciones

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).

::: consejo

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.

:::

Variables

Variable Ejemplo Descripción
duration 16m40s El tiempo que tardó en ejecutar el comando
style* Refleja el valor de la opción style

*: Esta variable sólo puede ser usada como parte de una cadena de estilo

Ejemplo

# ~/.config/starship.toml

[cmd_duration]
min_time = 500
format = "underwent [$duration](bold yellow)"

Conda

El módulo conda muestra el actual entorno conda, si la variable $CONDA_DEFAULT_ENV existe.

::: consejo

Esto no modifica el propio símbolo de sistema de conda. En caso de querer suprimirlo, ejecuta conda config --set changeps1 False.

:::

Opciones

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.
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.

Variables

Variable Ejemplo Descripción
environment astronauts El entorno conda actual
symbol Refleja el valor de la opción symbol
style* Refleja el valor de la opción style

*: Esta variable sólo puede ser usada como parte de una cadena de estilo

Ejemplo

# ~/.config/starship.toml

[conda]
format = "[$symbol$environment](dimmed green) "

Crystal

The crystal module shows the currently installed version of Crystal. Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones:

  • El directorio actual contiene un fichero shard.yml
  • El directorio actual contiene un fichero .cr

Opciones

Opción Por defecto Descripción
symbol "🔮 " Símbolo usado antes de la versión de Crystal.
format "via [$symbol($version )]($style)" El formato del módulo.
version_format "v${raw}" El formato de versión. Las variables disponibles son raw, major, minor, & patch
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.
disabled false Desactiva el módulo crystal.

Variables

Variable Ejemplo Descripción
version v0.32.1 La versión de crystal
symbol Refleja el valor de la opción symbol
style* Refleja el valor de la opción style

*: Esta variable sólo puede ser usada como parte de una cadena de estilo

Ejemplo

# ~/.config/starship.toml

[crystal]
format = "via [✨ $version](bold blue) "

Dart

El módulo dart muestra la versión instalada de Dart. Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones:

  • El directorio actual contiene un archivo con la extensión .dart
  • El directorio actual contiene un directorio .dart_tool
  • El directorio actual contiene un archivo pubspec.yaml, pubspec.yml o pubspec.lock

Opciones

Opción Por defecto Descripción
format "via [$symbol($version )]($style)" El formato del módulo.
version_format "v${raw}" El formato de versión. Las variables disponibles son raw, major, minor, & patch
symbol "🎯 " Una cadena de formato que representa el símbolo de Dart
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.
style "bold blue" El estilo del módulo.
disabled false Desactiva el módulo dart.

Variables

Variable Ejemplo Descripción
version v2.8.4 La versión de dart
symbol Refleja el valor de la opción symbol
style* Refleja el valor de la opción style

*: Esta variable sólo puede ser usada como parte de una cadena de estilo

Ejemplo

# ~/.config/starship.toml

[dart]
format = "via [🔰 $version](bold red) "

Deno

The deno module shows you your currently installed version of Deno. Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones:

  • El directorio actual contiene un archivo mod.ts, mod.js, deps.ts o deps.js

Opciones

Opción Por defecto Descripción
format "via [$symbol($version )]($style)" El formato del módulo.
version_format "v${raw}" El formato de versión. Las variables disponibles son raw, major, minor, & patch
symbol "🦕 " Una cadena de formato que representa el símbolo de Deno
detect_extensions [] Qué extensiones deberían activar este módulo.
detect_files ["mod.ts", "mod.js", "deps.ts", "deps.js"] Qué nombres de archivo deberían activar este módulo.
detect_folders [] Qué carpetas deberían activar este módulo.
style "green bold" El estilo del módulo.
disabled false Deshabilita el módulo deno.

Variables

Variable Ejemplo Descripción
version v1.8.3 La versión de deno
symbol Refleja el valor de la opción symbol
style* Refleja el valor de la opción style

Ejemplo

# ~/.config/starship.toml

[deno]
format = "via [🦕 $version](green bold) "

Directory

El módulo directory muestra la ruta hasta el directorio actual, mostrando tres directorios padre como máximo. Tu directorio se truncará a la raíz del repositorio git en el que estés.

Cuando usas el estilo fish de la opción pwd, en lugar de ocultar la ruta truncada, verás una versión acortada del nombre de cada directorio basada en el número que activa la opción.

Por ejemplo, dado ~/Dev/Nix/nixpkgs/pkgs donde nixpkgs es la raíz del repositorio y el valor de la opción es 1. En ese caso, verás ~/D/N/nixpkgs/pkgs, cuando antes hubiera sido nixpkgs/pkgs.

Opciones

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 Truncar o no hasta la raíz del repositorio git en el que se esté.
format "[$path]($style)[$read_only]($read_only_style) " El formato del módulo.
style "bold cyan" El estilo del módulo.
disabled false Deshabilita 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. p. ej.: "…/"
home_symbol "~" El símbolo que indica el directorio personal.
Este módulo tiene algunas opciones avanzadas de configuración que controlan cómo se muestra el directorio.
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.

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.

[directory.substitutions]
"/Volumes/network/path" = "/net"
"src/com/long/java/path" = "mypath"

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.

Variables

Variable Ejemplo Descripción
path "D:/Projects" La ruta del directorio actual
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

# ~/.config/starship.toml

[directory]
truncation_length = 8
truncation_symbol = "…/"

Docker Context

The docker_context module shows the currently active Docker context if it's not set to default or if the DOCKER_HOST or DOCKER_CONTEXT environment variables are set (as they are meant to override the context in use).

Opciones

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 only_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 only_with_files sea verdadero, con un valor "true").
detect_folders [] Qué carpetas deberían activar este módulo (necesita que only_with_files sea verdadero, con un valor "true").
style "blue bold" El estilo del módulo.
disabled false Deshabilita el módulo docker_context.

Variables

Variable Ejemplo Descripción
context test_context El contexto actual de docker
symbol Refleja el valor de la opción symbol
style* Refleja el valor de la opción style

*: Esta variable sólo puede ser usada como parte de una cadena de estilo

Ejemplo

# ~/.config/starship.toml

[docker_context]
format = "via [🐋 $context](blue bold)"

Dotnet

El módulo dotnet muestra la versión usada 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.

Por defecto, este módulo solo se mostrará en tu prompt cuando uno o más de de los siguientes archivos estén presentes en el directorio actual:

  • global.json
  • project.json
  • Directory.Build.props
  • Directory.Build.targets
  • Packages.props
  • *.csproj
  • *.fsproj
  • *.xproj

También necesitará tener instalado .NET Core SDK para poder usarlo correctamente.

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.

El módulo también mostrará el Target Framework Moniker (https://docs.microsoft. om/es/dotnet/standard/frameworks#supported-target-framework-versions) cuando exista un archivo csproj en el directorio actual.

Opciones

Opción Por defecto Descripción
format "via [$symbol($version )(🎯 $tfm )]($style)" El formato del módulo.
version_format "v${raw}" El formato de versión. Las variables disponibles son raw, major, minor, & patch
symbol ".NET " Símbolo usado antes de mostrar la versión de .NET
heuristic true Usa una detección de versiones más rápida para mantener a starship veloz.
detect_extensions ["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.
style "bold blue" El estilo del módulo.
disabled false Deshabilita el módulo dotnet.

Variables

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

*: Esta variable sólo puede ser usada como parte de una cadena de estilo

Ejemplo

# ~/.config/starship.toml

[dotnet]
symbol = "🥅 "
style = "green"
heuristic = false

Elixir

The elixir module shows the currently installed version of Elixir and Erlang/OTP. Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones:

  • El directorio actual contiene un archivo mix.exs.

Opciones

Opción Por defecto Descripción
format 'via [$symbol($version \(OTP $otp_version\) )]($style)' El formato para el módulo elixir.
version_format "v${raw}" El formato de versión. Las variables disponibles son raw, major, minor, & patch
symbol "💧 " El símbolo usado antes de mostrar la version de Elixir/Erlang.
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.
style "bold purple" El estilo del módulo.
disabled false Desactiva el módulo elixir.

Variables

Variable Ejemplo Descripción
version v1.10 La version de elixir
otp_version La versión de otp de elixir
symbol Refleja el valor de la opción symbol
style* Refleja el valor de la opción style

*: Esta variable sólo puede ser usada como parte de una cadena de estilo

Ejemplo

# ~/.config/starship.toml

[elixir]
symbol = "🔮 "

Elm

The elm module shows the currently installed version of Elm. Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones:

  • El directorio actual contiene un archivo elm.json
  • El directorio actual contiene un archivo elm-package.json
  • El directorio actual contiene un archivo .elm-version
  • El directorio actual contiene una carpeta elm-stuff
  • El directorio actual contiene archivos *.elm

Opciones

Opción Por defecto Descripción
format "via [$symbol($version )]($style)" El formato del módulo.
version_format "v${raw}" El formato de versión. Las variables disponibles son raw, major, minor, & patch
symbol "🌳 " Una cadena de formato que representa el símbolo de Elm.
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.
style "cyan bold" El estilo del módulo.
disabled false Desactiva el módulo elm.

Variables

Variable Ejemplo Descripción
version v0.19.1 La versión de elm
symbol Refleja el valor de la opción symbol
style* Refleja el valor de la opción style

*: Esta variable sólo puede ser usada como parte de una cadena de estilo

Ejemplo

# ~/.config/starship.toml

[elm]
format = "via [ $version](cyan bold) "

Variable de entorno

The env_var module displays the current value of a selected environment variables. El módulo se mostrará sólo si se cumplen cualquiera de las siguientes condiciones:

  • 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 se encuentra por defecto

::: tip Multiple environmental variables can be displayed by using a .. (see example) If the variable configuration option is not set, the module will display value of variable under the name of text after the . character.

Example: following configuration will display value of USER environment variable

# ~/.config/starship.toml

[env_var.USER]
default = "unknown user"

:::

Opciones

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.
default 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 Deshabilita el módulo env_var.

Variables

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

*: Esta variable sólo puede ser usada como parte de una cadena de estilo

Ejemplo

# ~/.config/starship.toml

[env_var]
variable = "SHELL"
default = "unknown shell"

Displaying multiple environmental variables:

# ~/.config/starship.toml

[env_var.SHELL]
variable = "SHELL"
default = "unknown shell"
[env_var.USER]
default = "unknown user"

Erlang

The erlang module shows the currently installed version of Erlang/OTP. Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones:

  • El directorio actual contiene un fichero rebar.config.
  • El directorio actual contiene un fichero erlang.mk.

Opciones

Opción Por defecto Descripción
format "via [$symbol($version )]($style)" El formato del módulo.
version_format "v${raw}" El formato de versión. Las variables disponibles son raw, major, minor, & patch
symbol " " El símbolo usado antes de mostrar la versión de Erlang.
style "bold red" El estilo del módulo.
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.
disabled false Desactiva el módulo erlang.

Variables

Variable Ejemplo Descripción
version v22.1.3 La versión de erlang
symbol Refleja el valor de la opción symbol
style* Refleja el valor de la opción style

*: Esta variable sólo puede ser usada como parte de una cadena de estilo

Ejemplo

# ~/.config/starship.toml

[erlang]
format = "via [e $version](bold red) "

Google Cloud (gcloud)

The gcloud module shows the current configuration for gcloud CLI. This is based on the ~/.config/gcloud/active_config file and the ~/.config/gcloud/configurations/config_{CONFIG NAME} file and the CLOUDSDK_CONFIG env var.

Opciones

Opción Por defecto Descripción
format 'on [$symbol$account(@$domain)(\($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 Deshabilita el módulo gcloud.

Variables

Variable Ejemplo Descripción
region us-central1 La región GCP actual
account foo El perfil actual de GCP
domain example.com The current GCP profile domain
project El proyecto GCP actual
active default 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

*: Esta variable sólo puede ser usada como parte de una cadena de estilo

Ejemplos

Mostrar cuenta y proyecto

# ~/.config/starship.toml

[gcloud]
format = 'on [$symbol$account(@$domain)(\($project\))]($style) '

Mostrar solo el nombre de la configuración activa

# ~/.config/starship.toml

[gcloud]
format = "[$symbol$active]($style) "
style = "bold yellow"

Mostrar los alias de cuenta y región

# ~/.config/starship.toml

[gcloud]
symbol = "️🇬️ "
[gcloud.region_aliases]
us-central1 = "uc1"
asia-northeast1 = "an1"

Git Branch

The git_branch module shows the active branch of the repo in your current directory.

Opciones

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. Usar "$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.
truncation_length 2^63 - 1 Trunca el nombre de la rama a N grafemas.
truncation_symbol "…" El símbolo usado para indicar que un nombre de rama fue truncado. Se puede utilizar "" para ningún símbolo.
only_attached false Mostrar solo el hash de la confirmación de git cuando esté en estado "detached HEAD"
disabled false Deshabilita el módulo git_branch.

Variables

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

*: Esta variable sólo puede ser usada como parte de una cadena de estilo

Ejemplo

# ~/.config/starship.toml

[git_branch]
symbol = "🌱 "
truncation_length = 4
truncation_symbol = ""

Git commit

The git_commit module shows the current commit hash and also the tag (if any) of the repo in your current directory.

Opciones

Opción Por defecto Descripción
commit_hash_length 7 La longitud del hash de la confirmación de git mostrado.
format "[\\($hash$tag\\)]($style) " El formato del módulo.
style "bold green" El estilo del módulo.
only_detached true Mostrar solo el hash de la confirmación de git cuando esté en estado "detached HEAD"
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 Deshabilita el módulo git_commit.

Variables

Variable Ejemplo Descripción
hash b703eb3 El hash actual de la confirmación de git
style* Refleja el valor de la opción style

*: Esta variable sólo puede ser usada como parte de una cadena de estilo

Ejemplo

# ~/.config/starship.toml

[git_commit]
commit_hash_length = 4
tag_symbol = "🔖 "

Git State

The git_state module will show in directories which are part of a git repository, and where there is an operation in progress, such as: REBASING, BISECTING, etc. If there is progress information (e.g., REBASING 3/10), that information will be shown too.

Opciones

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-mailbox 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 Deshabilita el módulo git_state.

Variables

Variable Ejemplo Descripción
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
style* Refleja el valor de la opción style

*: Esta variable sólo puede ser usada como parte de una cadena de estilo

Ejemplo

# ~/.config/starship.toml

[git_state]
format = '[\($state( $progress_current of $progress_total)\)]($style) '
cherry_pick = "[🍒 PICKING](bold red)"

Git Metrics

The git_metrics module will show the number of added and deleted lines in the current git repository.

::: consejo

This module is disabled by default. To enable it, set disabled to false in your configuration file.

:::

Opciones

Opción Por defecto Descripción
added_style "bold green" The style for the added count.
deleted_style "bold red" The style for the deleted count.
format '[+$added]($added_style) [-$deleted]($deleted_style) ' El formato del módulo.
disabled true Disables the git_metrics module.

Variables

Variable Ejemplo Descripción
added 1 The current number of added lines
deleted 2 The current number of deleted lines
added_style* Mirrors the value of option added_style
deleted_style* Mirrors the value of option deleted_style

*: Esta variable sólo puede ser usada como parte de una cadena de estilo

Ejemplo

# ~/.config/starship.toml

[git_metrics]
added_style = "bold blue"
format = '[+$added]($added_style)/[-$deleted]($deleted_style) '

Git status

The git_status module shows symbols representing the state of the repo in your current directory.

Opciones

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
up_to_date "" The format of up_to_date
untracked "?" The format of untracked
stashed "$" The format of stashed
modified "!" The format of modified
staged "+" The format of staged
renamed "»" The format of renamed
deleted "✘" The format of deleted
style "bold red" El estilo del módulo.
disabled false Disables the git_status module.

Variables

The following variables can be used in format:

Variable Descripción
all_status Atajo para $conflicted$stashed$deleted$renamed$modified$staged$untracked
ahead_behind Displays diverged, ahead, behind or up_to_date format string based on the current status of the repo.
conflicted 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

*: Esta variable sólo puede ser usada como parte de una cadena de estilo

The following variables can be used in diverged:

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

The following variables can be used in conflicted, ahead, behind, untracked, stashed, modified, staged, renamed and deleted:

Variable Descripción
count Muestra el número de archivos

Ejemplo

# ~/.config/starship.toml

[git_status]
conflicted = "🏳"
ahead = "🏎💨"
behind = "😰"
diverged = "😵"
up_to_date = "✓"
untracked = "🤷‍"
stashed = "📦"
modified = "📝"
staged = '[++\($count\)](green)'
renamed = "👅"
deleted = "🗑"

Show ahead/behind count of the branch being tracked

# ~/.config/starship.toml

[git_status]
ahead = "⇡${count}"
diverged = "⇕⇡${ahead_count}⇣${behind_count}"
behind = "⇣${count}"

Golang

The golang module shows the currently installed version of Golang. Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones:

  • El directorio actual contiene un archivo go.mod
  • El directorio actual contiene un archivo go.sum
  • El directorio actual contiene un archivo glide.yaml
  • 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

Opciones

Opción Por defecto Descripción
format "via [$symbol($version )]($style)" El formato del módulo.
version_format "v${raw}" El formato de versión. Las variables disponibles son raw, major, minor, & patch
symbol "🐹 " Una cadena de formato que representa el símbolo de Go.
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.
style "bold cyan" El estilo del módulo.
disabled false Desactiva el módulo de golang.

Variables

Variable Ejemplo Descripción
version v1.12.1 La versión de go
symbol Refleja el valor de la opción symbol
style* Refleja el valor de la opción style

*: Esta variable sólo puede ser usada como parte de una cadena de estilo

Ejemplo

# ~/.config/starship.toml

[golang]
format = "via [🏎💨 $version](bold cyan) "

Helm

The helm module shows the currently installed version of Helm. Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones:

  • El directorio actual contiene un fichero helmfile.yaml
  • El directorio actual contiene un archivo Chart.yaml

Opciones

Opción Por defecto Descripción
format "via [$symbol($version )]($style)" El formato del módulo.
version_format "v${raw}" El formato de versión. Las variables disponibles son raw, major, minor, & patch
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 Desactiva el módulo helm.

Variables

Variable Ejemplo Descripción
version v3.1.1 La versión de helm
symbol Refleja el valor de la opción symbol
style* Refleja el valor de la opción style

*: Esta variable sólo puede ser usada como parte de una cadena de estilo

Ejemplo

# ~/.config/starship.toml

[helm]
format = "via [⎈ $version](bold white) "

Hostname

The hostname module shows the system hostname.

Opciones

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.

Variables

Variable Ejemplo Descripción
symbol Refleja el valor de la opción symbol
style* Refleja el valor de la opción style

*: Esta variable sólo puede ser usada como parte de una cadena de estilo

Ejemplo

# ~/.config/starship.toml

[hostname]
ssh_only = false
format =  "on [$hostname](bold red) "
trim_at = ".companyname.com"
disabled = false

Java

The java module shows the currently installed version of Java. Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones:

  • 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

Opciones

Opción Por defecto Descripción
format "via [${symbol}(${version} )]($style)" El formato del módulo.
version_format "v${raw}" El formato de versión. Las variables disponibles son raw, major, minor, & patch
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 Desactiva el módulo java.

Variables

Variable Ejemplo Descripción
version v14 La versión de java
symbol Refleja el valor de la opción symbol
style* Refleja el valor de la opción style

*: Esta variable sólo puede ser usada como parte de una cadena de estilo

Ejemplo

# ~/.config/starship.toml

[java]
symbol = "🌟 "

Jobs

The jobs module shows the current number of jobs running. The module will be shown only if there are background jobs running. The module will show the number of jobs running if there is more than 1 job, or more than the threshold config value, if it exists. If threshold is set to 0, then the module will also show when there are 0 jobs running.

::: aviso

This module is not supported on tcsh and nu.

:::

Opciones

Opción Por defecto Descripción
threshold 1 Muestra el número de tareas si se exceden.
format "[$symbol$number]($style) " El formato del módulo.
symbol "✦" Una cadena de formato que representa el número de tareas.
style "bold blue" El estilo del módulo.
disabled false Desactiva el módulo jobs.

Variables

Variable Ejemplo Descripción
number 1 El número de tareas
symbol Refleja el valor de la opción symbol
style* Refleja el valor de la opción style

*: Esta variable sólo puede ser usada como parte de una cadena de estilo

Ejemplo

# ~/.config/starship.toml

[jobs]
symbol = "+ "
threshold = 4

Julia

The julia module shows the currently installed version of Julia. Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones:

  • El directorio actual contiene un archivo Project.toml
  • El directorio actual contiene un archivo Manifest.toml
  • El directorio actual contiene un archivo con la extensión .jl

Opciones

Opción Por defecto Descripción
format "via [$symbol($version )]($style)" El formato del módulo.
version_format "v${raw}" El formato de versión. Las variables disponibles son raw, major, minor, & patch
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 Desactiva el módulo julia.

Variables

Variable Ejemplo Descripción
version v1.4.0 La versión de julia
symbol Refleja el valor de la opción symbol
style* Refleja el valor de la opción style

*: Esta variable sólo puede ser usada como parte de una cadena de estilo

Ejemplo

# ~/.config/starship.toml

[julia]
symbol = "∴ "

Kotlin

The kotlin module shows the currently installed version of Kotlin. Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones:

  • El directorio actual contiene un archivo .kt o .kts

Opciones

Opción Por defecto Descripción
format "via [$symbol($version )]($style)" El formato del módulo.
version_format "v${raw}" El formato de versión. Las variables disponibles son raw, major, minor, & patch
detect_extensions ["kt", "kts"] Qué extensiones deberían activar este módulo.
detect_files [] Qué nombres de archivo deberían activar este módulo.
detect_folders [] Qué carpetas deberían activar estos módulos.
symbol "🅺 " Una cadena de formato que representa el símbolo de Kotlin.
style "bold blue" El estilo del módulo.
kotlin_binary "kotlin" Configura el binario kotlin que Starship ejecuta al obtener la versión.
disabled false Deshabilita el módulo kotlin.

Variables

Variable Ejemplo Descripción
version v1.4.21 La versión de kotlin
symbol Refleja el valor de la opción symbol
style* Refleja el valor de la opción style

*: Esta variable sólo puede ser usada como parte de una cadena de estilo

Ejemplo

# ~/.config/starship.toml

[kotlin]
symbol = "🅺 "
# ~/.config/starship.toml

[kotlin]
# Utiliza el binario del Compilador de Kotlin para obtener la versión instalada
kotlin_binary = "kotlinc"

Kubernetes

Displays the current Kubernetes context name and, if set, the namespace from the kubeconfig file. The namespace needs to be set in the kubeconfig file, this can be done via kubectl config set-context starship-cluster --namespace astronaut. If the $KUBECONFIG env var is set the module will use that if not it will use the ~/.kube/config.

::: consejo

This module is disabled by default. To enable it, set disabled to false in your configuration file.

:::

Opciones

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.

Variables

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

*: Esta variable sólo puede ser usada como parte de una cadena de estilo

Ejemplo

# ~/.config/starship.toml

[kubernetes]
format = 'on [⛵ $context \($namespace\)](dimmed green) '
disabled = false
[kubernetes.context_aliases]
"dev.local.cluster.k8s" = "dev"
".*/openshift-cluster/.*" = "openshift"
"gke_.*_(?P<cluster>[\\w-]+)" = "gke-$cluster"

Regex Matching

Additional to simple aliasing, context_aliases also supports extended matching and renaming using regular expressions.

The regular expression must match on the entire kube context, capture groups can be referenced using $name and $N in the replacement. This is more explained in the regex crate documentation.

Long and automatically generated cluster names can be identified and shortened using regular expressions:

[kubernetes.context_aliases]
# OpenShift contexts carry the namespace and user in the kube context: `namespace/name/user`:
".*/openshift-cluster/.*" = "openshift"
# Or better, to rename every OpenShift cluster at once:
".*/(?P<cluster>[\\w-]+)/.*" = "$cluster"

# Contexts from GKE, AWS and other cloud providers usually carry additional information, like the region/zone.
# The following entry matches on the GKE format (`gke_projectname_zone_cluster-name`)
# and renames every matching kube context into a more readable format (`gke-cluster-name`):
"gke_.*_(?P<cluster>[\\w-]+)" = "gke-$cluster"

Salto de línea

The line_break module separates the prompt into two lines.

Opciones

Opción Por defecto Descripción
disabled false Deshabilita el módulo line_break, haciendo que el mensaje sea una sola línea.

Ejemplo

# ~/.config/starship.toml

[line_break]
disabled = true

Lua

The lua module shows the currently installed version of Lua. Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones:

  • El directorio actual contiene un archivo .lua-version
  • El directorio actual contiene un directorio lua
  • El directorio actual contiene un archivo con la extensión .lua

Opciones

Opción Por defecto Descripción
format "via [$symbol($version )]($style)" El formato del módulo.
version_format "v${raw}" El formato de versión. Las variables disponibles son raw, major, minor, & patch
symbol "🌙 " 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 de lua que Starship ejecuta al obtener la versión.
disabled false Desactiva el módulo lua.

Variables

Variable Ejemplo Descripción
version v5.4.0 La versión de lua
symbol Refleja el valor de la opción symbol
style* Refleja el valor de la opción style

*: Esta variable sólo puede ser usada como parte de una cadena de estilo

Ejemplo

# ~/.config/starship.toml

[lua]
format = "via [🌕 $version](bold blue) "

Memoria utilizada

The memory_usage module shows current system memory and swap usage.

By default the swap usage is displayed if the total system swap is non-zero.

::: consejo

This module is disabled by default. To enable it, set disabled to false in your configuration file.

:::

Opciones

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.

Variables

Variable Ejemplo Descripción
ram 31GiB/65GiB La memoria RAM usada/total del sistema actual.
ram_pct 48% El porcentaje de la memoria actual del sistema.
swap** 1GiB/4GiB El tamaño de la memoria de intercambio del archivo de memoria del sistema actual.
swap_pct** 77% El porcentaje de memoria de intercambio del archivo de memoria del sistema actual.
symbol 🐏 Refleja el valor de la opción symbol
style* Refleja el valor de la opción style

*: This variable can only be used as a part of a style string **: The SWAP file information is only displayed if detected on the current system

Ejemplo

# ~/.config/starship.toml

[memory_usage]
disabled = false
threshold = -1
symbol = " "
style = "bold dimmed green"

Mercurial Branch

The hg_branch module shows the active branch of the repo in your current directory.

Opciones

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.
truncation_length 2^63 - 1 Trunca el nombre de la rama hg a N grafemas
truncation_symbol "…" El símbolo usado para indicar que un nombre de rama fue truncado.
disabled true Desactiva el módulo hg_branch.

Variables

Variable Ejemplo Descripción
branch master La rama de mercurial activa
symbol Refleja el valor de la opción symbol
style* Refleja el valor de la opción style

*: Esta variable sólo puede ser usada como parte de una cadena de estilo

Ejemplo

# ~/.config/starship.toml

[hg_branch]
format = "on [🌱 $branch](bold purple)"
truncation_length = 4
truncation_symbol = ""

Nim

The nim module shows the currently installed version of Nim. Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones:

  • El directorio actual contiene un archivo nim.cfg
  • El directorio actual contiene un archivo con la extensión .nim
  • El directorio actual contiene un archivo con la extensión .nims
  • El directorio actual contiene un archivo con la extensión .nimble

Opciones

Opción Por defecto Descripción
format "via [$symbol($version )]($style)" El formato del módulo
version_format "v${raw}" El formato de versión. Las variables disponibles son raw, major, minor, & patch
symbol "👑 " El símbolo usado antes de mostrar la versión de Nim.
detect_extensions ["nim", "nims", "nimble"] Qué extensiones deberían activar este módulo.
detect_files ["nim.cfg"] Qué nombres de archivo deberían activar este módulo.
detect_folders [] Qué carpetas deberían activar este módulo.
style "bold yellow" El estilo del módulo.
disabled false Desactiva el módulo nim.

Variables

Variable Ejemplo Descripción
version v1.2.0 La versión de nimc
symbol Refleja el valor de la opción symbol
style* Refleja el valor de la opción style

*: Esta variable sólo puede ser usada como parte de una cadena de estilo

Ejemplo

# ~/.config/starship.toml

[nim]
style = "yellow"
symbol = "🎣 "

Nix-shell

The nix_shell module shows the nix-shell environment. The module will be shown when inside a nix-shell environment.

Opciones

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.

Variables

Variable Ejemplo Descripción
state pure El estado de nix-shell
name lorri El nombre de nix-shell
symbol Refleja el valor de la opción symbol
style* Refleja el valor de la opción style

*: Esta variable sólo puede ser usada como parte de una cadena de estilo

Ejemplo

# ~/.config/starship.toml

[nix_shell]
disabled = true
impure_msg = "[impure shell](bold red)"
pure_msg = "[pure shell](bold green)"
format = 'via [☃️ $state( \($name\))](bold blue) '

Node.js

The nodejs module shows the currently installed version of Node.js. Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones:

  • El directorio actual contiene un archivo package.json
  • El directorio actual contiene un archivo .node-version
  • The current directory contains a .nvmrc file
  • El directorio actual contiene un directorio node_modules
  • El directorio actual contiene un archivo con la extensión .js, .mjs o .cjs
  • El directorio actual contiene un archivo con la extensión .ts

Opciones

Opción Por defecto Descripción
format "via [$symbol($version )]($style)" El formato del módulo.
version_format "v${raw}" El formato de versión. Las variables disponibles son raw, major, minor, & patch
symbol " " A format string representing the symbol of Node.js.
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 Desactiva 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 Node.js version.

Variables

Variable Ejemplo Descripción
version v13.12.0 La versión de node
symbol Refleja el valor de la opción symbol
style* Refleja el valor de la opción style

*: Esta variable sólo puede ser usada como parte de una cadena de estilo

Ejemplo

# ~/.config/starship.toml

[nodejs]
format = "via [🤖 $version](bold green) "

OCaml

The ocaml module shows the currently installed version of OCaml. Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones:

  • El directorio actual contiene un archivo con extensión .opam o directorio _opam
  • El directorio actual contiene un directorio esy.lock
  • El directorio actual contiene un archivo dune o dune-project
  • El directorio actual contiene un archivo jbuild o jbuild-ignore
  • El directorio actual contiene un archivo .merlin
  • El directorio actual contiene un archivo con la extensión .ml, .mli, .re o .rei

Opciones

Opción Por defecto Descripción
format "via [$symbol($version )(\($switch_indicator$switch_name\) )]($style)" La cadena de formato para el módulo.
version_format "v${raw}" El formato de versión. Las variables disponibles son raw, major, minor, & patch
symbol "🐫 " El símbolo usado antes de mostrar la versión de OCaml.
global_switch_indicator "" La cadena de formato usada para representar el interruptor global de OPAM.
local_switch_indicator "*" La cadena de formato usada para representar el interruptor local de OPAM.
detect_extensions ["opam", "ml", "mli", "re", "rei"] Qué extensiones deberían activar este módulo.
detect_files ["dune", "dune-project", "jbuild", "jbuild-ignore", ".merlin"] Qué nombres de archivo deberían activar este módulo.
detect_folders ["_opam", "esy.lock"] Qué carpetas deberían activar este módulo.
style "bold yellow" El estilo del módulo.
disabled false Desactiva el módulo ocaml.

Variables

Variable Ejemplo Descripción
version v4.10.0 La versión de ocaml
switch_name my-project El interruptor OPAM activo
switch_indicator Refleja el valor de indicator para el interruptor OPAM activo actualmente
symbol Refleja el valor de la opción symbol
style* Refleja el valor de la opción style

*: Esta variable sólo puede ser usada como parte de una cadena de estilo

Ejemplo

# ~/.config/starship.toml

[ocaml]
format = "via [🐪 $version]($style) "

OpenStack

The openstack module shows the current OpenStack cloud and project. The module only active when the OS_CLOUD env var is set, in which case it will read clouds.yaml file from any of the default locations. to fetch the current project in use.

Opciones

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.
disabled false Deshabilita el módulo openstack.

Variables

Variable Ejemplo Descripción
cloud corp La nube OpenStack actual
project dev El proyecto OpenStack actual
symbol Refleja el valor de la opción symbol
style* Refleja el valor de la opción style

*: Esta variable sólo puede ser usada como parte de una cadena de estilo

Ejemplo

# ~/.config/starship.toml

[openstack]
format = "on [$symbol$cloud(\\($project\\))]($style) "
style = "bold yellow"
symbol = "☁️ "

Versión del paquete

The package module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports npm, nimble, cargo, poetry, composer, gradle, julia, mix and helm packages.

  • npm The npm package version is extracted from the package.json present in the current directory
  • cargo The cargo package version is extracted from the Cargo.toml present in the current directory
  • nimble - The nimble package version is extracted from the *.nimble file present in the current directory with the nimble dump command
  • poetry The poetry package version is extracted from the pyproject.toml present in the current directory
  • python - The python package version is extracted from the setup.cfg present in the current directory
  • composer The composer package version is extracted from the composer.json present in the current directory
  • gradle The gradle package version is extracted from the build.gradle present
  • julia - The package version is extracted from the Project.toml present
  • mix - The mix package version is extracted from the mix.exs present
  • helm - The helm chart version is extracted from the Chart.yaml present
  • maven - The maven package version is extracted from the pom.xml present
  • meson - The meson package version is extracted from the meson.build present
  • vlang - The vlang package version is extracted from the v.mod present

⚠️ La versión que se muestra es la del paquete cuyo código fuente está en tu directorio actual, no en tu gestor de paquetes.

Opciones

Opción 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.
version_format "v${raw}" El formato de versión. Las variables disponibles son raw, major, minor, & patch
style "bold 208" El estilo del módulo.
display_private false Enable displaying version for packages marked as private.
disabled false Disables the package module.

Variables

Variable Ejemplo Descripción
version v1.0.0 La versión de su paquete
symbol Refleja el valor de la opción symbol
style* Refleja el valor de la opción style

*: Esta variable sólo puede ser usada como parte de una cadena de estilo

Ejemplo

# ~/.config/starship.toml

[package]
format = "via [🎁 $version](208 bold) "

Perl

The perl module shows the currently installed version of Perl. Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones:

  • El directorio actual contiene un archivo Makefile.PL o Build.PL
  • El directorio actual contiene un archivo cpanfile o cpanfile.snapshot
  • El directorio actual contiene un archivo META.json o META.yml
  • El directorio actual contiene un archivo .perl-version
  • El directorio actual contiene un .pl, .pm o .pod

Opciones

Opción Por defecto Descripción
format "via [$symbol($version )]($style)" La cadena de formato para el módulo.
version_format "v${raw}" El formato de versión. Las variables disponibles son raw, major, minor, & patch
symbol "🐪 " El símbolo usado antes de mostrar la versión de Perl
detect_extensions ["pl", "pm", "pod"] Qué extensiones deberían activar este módulo.
detect_files ["Makefile.PL", "Build.PL", "cpanfile", "cpanfile.snapshot", "META.json", "META.yml", ".perl-version"] Qué nombres de archivo deberían activar este módulo.
detect_folders [] Qué carpetas deberían activar este módulo.
style "bold 149" El estilo del módulo.
disabled false Desactiva el módulo perl.

Variables

Variable Ejemplo Descripción
version v5.26.1 La versión de perl
symbol Refleja el valor de la opción symbol
style* Refleja el valor de la opción style

Ejemplo

# ~/.config/starship.toml

[perl]
format = "via [🦪 $version]($style) "

PHP

The php module shows the currently installed version of PHP. Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones:

  • El directorio actual contiene un archivo composer.json
  • El directorio actual contiene un archivo .php-version
  • El directorio actual contiene una extensión .php

Opciones

Opción Por defecto Descripción
format "via [$symbol($version )]($style)" El formato del módulo.
version_format "v${raw}" El formato de versión. Las variables disponibles son raw, major, minor, & patch
symbol "🐘 " El símbolo usado antes de mostrar la versión de PHP.
detect_extensions ["php"] Qué extensiones deberían activar este módulo.
detect_files ["composer.json", ".php-version"] Qué nombres de archivo deberían activar este módulo.
detect_folders [] Qué carpetas deberían activar este módulo.
style "147 bold" El estilo del módulo.
disabled false Desactiva el módulo php.

Variables

Variable Ejemplo Descripción
version v7.3.8 La versión de php
symbol Refleja el valor de la opción symbol
style* Refleja el valor de la opción style

*: Esta variable sólo puede ser usada como parte de una cadena de estilo

Ejemplo

# ~/.config/starship.toml

[php]
format = "via [🔹 $version](147 bold) "

PureScript

The purescript module shows the currently installed version of PureScript version. Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones:

  • El directorio actual contiene un archivo spago.dhall
  • El directorio actual contiene un archivo con la extensión .purs

Opciones

Opción Por defecto Descripción
format "via [$symbol($version )]($style)" El formato del módulo.
version_format "v${raw}" El formato de versión. Las variables disponibles son raw, major, minor, & patch
symbol "<=> " El símbolo usado antes de mostrar la versión de PureScript.
detect_extensions ["purs"] Qué extensiones deberían activar este módulo.
detect_files ["spago.dhall"] Qué nombres de archivo deberían activar este módulo.
detect_folders [] Qué carpetas deberían activar este módulo.
style "bold white" El estilo del módulo.
disabled false Deshabilita el módulo purescript.

Variables

Variable Ejemplo Descripción
version 0.13.5 La versión de purescript
symbol Refleja el valor de la opción symbol
style* Refleja el valor de la opción style

*: Esta variable sólo puede ser usada como parte de una cadena de estilo

Ejemplo

# ~/.config/starship.toml

[purescript]
format = "via [$symbol$version](bold white)"

Python

The python module shows the currently installed version of Python and the current Python virtual environment if one is activated.

If pyenv_version_name is set to true, it will display the pyenv version name. Otherwise, it will display the version number from python --version.

Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones:

  • El directorio actual contiene un archivo .python-version
  • El directorio actual contiene un archivo Pipfile
  • El directorio actual contiene un archivo __init__.py
  • El directorio actual contiene un archivo pyproject.toml
  • El directorio actual contiene un archivo requirements.txt
  • El directorio actual contiene un archivo setup.py
  • El directorio actual contiene un archivo tox.ini
  • El directorio actual contiene un archivo con la extensión .py.
  • Un entorno virtual está activado actualmente

Opciones

Opción Por defecto Descripción
format 'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\) )]($style)' El formato del módulo.
version_format "v${raw}" El formato de versión. Las variables disponibles son raw, major, minor, & patch
symbol "🐍 " Una cadena de formato que representa el símbolo de Python
style "yellow bold" El estilo del módulo.
pyenv_version_name false Usar pyenv para obtener la versión de Python
pyenv_prefix pyenv Prefijo antes de mostrar la versión de pyenv sólo se utiliza si se utiliza pyenv
python_binary ["python", "python3", "python2"] Configura los binarios de python que Starship debería ejecutar al obtener la versión.
detect_extensions ["py"] Qué extensiones deben activar este módulo
detect_files [".python-version", "Pipfile", "__init__.py", "pyproject.toml", "requirements.txt", "setup.py", "tox.ini"] Qué nombres de archivo deben activar este módulo
detect_folders [] Qué carpetas deben activar este módulo
disabled false Desactiva el módulo python.

::: consejo

The python_binary variable accepts either a string or a list of strings. Starship will try executing each binary until it gets a result. Note you can only change the binary that Starship executes to get the version of Python not the arguments that are used.

The default values and order for python_binary was chosen to first identify the Python version in a virtualenv/conda environments (which currently still add a python, no matter if it points to python3 or python2). This has the side effect that if you still have a system Python 2 installed, it may be picked up before any Python 3 (at least on Linux Distros that always symlink /usr/bin/python to Python 2). If you do not work with Python 2 anymore but cannot remove the system Python 2, changing this to "python3" will hide any Python version 2, see example below.

:::

Variables

Variable Ejemplo Descripción
version "v3.8.1" La versión de python
symbol "🐍 " Refleja el valor de la opción symbol
style "yellow bold" Refleja el valor de la opción style
pyenv_prefix "pyenv " Ordena el valor de la opción pyenv_prefix
virtualenv "venv" El nombre actual del virtualenv

Ejemplo

# ~/.config/starship.toml

[python]
symbol = "👾 "
pyenv_version_name = true
# ~/.config/starship.toml

[python]
# Only use the `python3` binary to get the version.
python_binary = "python3"
# ~/.config/starship.toml

[python]
# Don't trigger for files with the py extension
detect_extensions = []
# ~/.config/starship.toml

[python]
# Display the version of python from inside a local venv.
#
# Note this will only work when the venv is inside the project and it will only
# work in the directory that contains the venv dir but maybe this is ok?
python_binary = ["./venv/bin/python", "python", "python3", "python2"]

R

The rlang module shows the currently installed version of R. The module will be shown if any of the following conditions are met:

  • The current directory contains a file with the .R extension.
  • The current directory contains a file with the .Rd extension.
  • The current directory contains a file with the .Rmd extension.
  • The current directory contains a file with the .Rproj extension.
  • The current directory contains a file with the .Rsx extension.
  • The current directory contains a .Rprofile file
  • The current directory contains a .Rproj.user folder

Opciones

Opción Por defecto Descripción
format "via [$symbol($version )]($style)" El formato del módulo.
version_format "v${raw}" El formato de versión. Las variables disponibles son raw, major, minor, & patch
symbol "📐" A format string representing the symbol of R.
style "blue bold" El estilo del módulo.
detect_extensions ["R", "Rd", "Rmd", "Rproj", "Rsx"] Qué extensiones deben activar este módulo
detect_files [".Rprofile"] Qué nombres de archivo deben activar este módulo
detect_folders [".Rproj.user"] Qué carpetas deben activar este módulo
disabled false Disables the r module.

Variables

Variable Ejemplo Descripción
version v4.0.5 The version of R
symbol Refleja el valor de la opción symbol
style "blue bold" Refleja el valor de la opción style

Ejemplo

# ~/.config/starship.toml

[rlang]
format = "with [📐 $version](blue bold) "

Red

By default the red module shows the currently installed version of Red. The module will be shown if any of the following conditions are met:

  • The current directory contains a file with .red or .reds extension

Opciones

Opción Por defecto Descripción
format "via [$symbol($version )]($style)" El formato del módulo.
version_format "v${raw}" El formato de versión. Las variables disponibles son raw, major, minor, & patch
symbol "🔺 " A format string representing the symbol of Red.
detect_extensions ["red"] Qué extensiones deberían activar este módulo.
detect_files [] Qué nombres de archivo deberían activar este módulo.
detect_folders [] Qué carpetas deberían activar este módulo.
style "red bold" El estilo del módulo.
disabled false Disables the red module.

Variables

Variable Ejemplo Descripción
version v2.5.1 The version of red
symbol Refleja el valor de la opción symbol
style* Refleja el valor de la opción style

*: Esta variable sólo puede ser usada como parte de una cadena de estilo

Ejemplo

# ~/.config/starship.toml

[red]
symbol = "🔴 "

Ruby

By default the ruby module shows the currently installed version of Ruby. The module will be shown if any of the following conditions are met:

  • El directorio actual contiene un archivo Gemfile
  • El directorio actual contiene un archivo .ruby-version
  • El directorio actual contiene un archivo .rb

Opciones

Opción Por defecto Descripción
format "via [$symbol($version )]($style)" El formato del módulo.
version_format "v${raw}" El formato de versión. Las variables disponibles son raw, major, minor, & patch
symbol "💎 " Una cadena de formato que representa el símbolo de Ruby.
detect_extensions ["rb"] Qué extensiones deberían activar este módulo.
detect_files ["Gemfile", ".ruby-version"] Qué nombres de archivo deberían activar este módulo.
detect_folders [] Qué carpetas deberían activar este módulo.
style "bold red" El estilo del módulo.
disabled false Desactiva el módulo ruby.

Variables

Variable Ejemplo Descripción
version v2.5.1 La versión de ruby
symbol Refleja el valor de la opción symbol
style* Refleja el valor de la opción style

*: Esta variable sólo puede ser usada como parte de una cadena de estilo

Ejemplo

# ~/.config/starship.toml

[ruby]
symbol = "🔺 "

Rust

By default the rust module shows the currently installed version of Rust. The module will be shown if any of the following conditions are met:

  • El directorio actual contiene un archivo Cargo.toml
  • El directorio actual contiene un archivo con la extensión .rs

Opciones

Opción Por defecto Descripción
format "via [$symbol($version )]($style)" El formato del módulo.
version_format "v${raw}" El formato de versión. Las variables disponibles son raw, major, minor, & patch
symbol "🦀 " Una cadena de formato que representa el símbolo de Rust
detect_extensions ["rs"] Qué extensiones deberían activar este módulo.
detect_files ["Cargo.toml"] Qué nombres de archivo deberían activar este módulo.
detect_folders [] Qué carpetas deberían activar este módulo.
style "bold red" El estilo del módulo.
disabled false Desactiva el módulo rust.

Variables

Variable Ejemplo Descripción
version v1.43.0-nightly La versión de rustc
symbol Refleja el valor de la opción symbol
style* Refleja el valor de la opción style

*: Esta variable sólo puede ser usada como parte de una cadena de estilo

Ejemplo

# ~/.config/starship.toml

[rust]
format = "via [⚙️ $version](red bold)"

Scala

The scala module shows the currently installed version of Scala. Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones:

  • El directorio actual contiene un archivo build.sbt, .scalaenv o .sbtenv
  • El directorio actual contiene un archivo con la extensión .scala o .sbt
  • El directorio actual contiene un directorio llamado .metals

Opciones

Opción Por defecto Descripción
format "via [${symbol}(${version} )]($style)" El formato del módulo.
version_format "v${raw}" El formato de versión. Las variables disponibles son raw, major, minor, & patch
detect_extensions ["sbt", "scala"] Qué extensiones deberían activar este módulo.
detect_files [".scalaenv", ".sbtenv", "build.sbt"] Qué nombres de archivo deberían activar este módulo.
detect_folders [".metals"] Qué carpetas deberían activar estos módulos.
symbol "🆂 " Una cadena de formato que representa el símbolo de Scala.
style "red dimmed" El estilo del módulo.
disabled false Deshabilita el módulo scala.

Variables

Variable Ejemplo Descripción
version 2.13.5 La versión de scala
symbol Refleja el valor de la opción symbol
style* Refleja el valor de la opción style

*: Esta variable sólo puede ser usada como parte de una cadena de estilo

Ejemplo

# ~/.config/starship.toml

[scala]
symbol = "🌟 "

Shell

The shell module shows an indicator for currently used shell.

::: consejo

This module is disabled by default. To enable it, set disabled to false in your configuration file.

:::

Opciones

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 Una cadena de formato usada para representar tcsh.
xonsh_indicator xsh A format string used to represent xonsh.
unknown_indicator The default value to be displayed when the shell is unknown.
format $indicator El formato del módulo.
disabled true Disables the shell module.

Variables

Variable Por defecto Descripción
indicator Ordena el valor de indicator para el intérprete de comandos actualmente utilizado.

Ejemplos

# ~/.config/starship.toml

[shell]
fish_indicator = ""
powershell_indicator = "_"
unknown_indicator = "mystery shell"
disabled = false

SHLVL

The shlvl module shows the current SHLVL ("shell level") environment variable, if it is set to a number and meets or exceeds the specified threshold.

Opciones

Opción Por defecto Descripción
threshold 2 Mostrar umbral.
format "[$symbol$shlvl]($style) " El formato del módulo.
symbol "↕️ " El símbolo utilizado para representar el SHLVL.
repeat false Hace que el symbol se repita con la cantidad actual de SHLVL.
style "bold yellow" El estilo del módulo.
disabled true Desactiva el módulo shlvl.

Variables

Variable Ejemplo Descripción
shlvl 3 El valor actual de SHLVL
symbol Refleja el valor de la opción symbol
style* Refleja el valor de la opción style

*: Esta variable sólo puede ser usada como parte de una cadena de estilo

Ejemplo

# ~/.config/starship.toml

[shlvl]
disabled = false
format = "$shlvl level(s) down"
threshold = 3

Singularity

The singularity module shows the current Singularity image, if inside a container and $SINGULARITY_NAME is set.

Opciones

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 Desactiva el módulo singularity.

Variables

Variable Ejemplo Descripción
env centos.img The current Singularity image
symbol Refleja el valor de la opción symbol
style* Refleja el valor de la opción style

*: Esta variable sólo puede ser usada como parte de una cadena de estilo

Ejemplo

# ~/.config/starship.toml

[singularity]
format = '[📦 \[$env\]]($style) '

Status

The status module displays the exit code of the previous command. The module will be shown only if the exit code is not 0.

::: consejo

This module is disabled by default. To enable it, set disabled to false in your configuration file.

:::

::: warning This module is not supported on elvish and nu shell. :::

Opciones

Opción Por defecto Descripción
format "[$symbol$status]($style) " El formato del módulo
symbol "✖" El símbolo mostrado en error del programa
success_symbol "✔️" The symbol displayed on program success
not_executable_symbol "🚫" The symbol displayed when file isn't executable
not_found_symbol "🔍" The symbol displayed when the command can't be found
sigint_symbol "🧱" The symbol displayed on SIGINT (Ctrl + c)
signal_symbol "⚡" The symbol displayed on any signal
style "bold red" El estilo del módulo.
recognize_signal_code true Enable signal mapping from exit code
map_symbol false Enable symbols mapping from exit code
pipestatus false Enable pipestatus reporting
pipestatus_separator ` `
pipestatus_format \\[$pipestatus\\] => [$symbol$common_meaning$signal_name$maybe_int]($style) The format of the module when the command is a pipeline
disabled true Disables the status module.

Variables

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
pipestatus Rendering of in pipeline programs's exit codes, this is only available in pipestatus_format
symbol Refleja el valor de la opción symbol
style* Refleja el valor de la opción style

*: Esta variable sólo puede ser usada como parte de una cadena de estilo

Ejemplo


# ~/.config/starship.toml

[status]
style = "bg:blue"
symbol = "🔴"
format = '[\[$symbol $common_meaning$signal_name$maybe_int\]]($style) '
map_symbol = true
disabled = false

Swift

By default the swift module shows the currently installed version of Swift. The module will be shown if any of the following conditions are met:

  • El directorio actual contiene un archivo Package.swift
  • El directorio actual contiene un archivo con la extensión .swift

Opciones

Opción Por defecto Descripción
format "via [$symbol($version )]($style)" El formato del módulo.
version_format "v${raw}" El formato de versión. Las variables disponibles son raw, major, minor, & patch
symbol "🐦 " 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 Desactiva el módulo swift.

Variables

Variable Ejemplo Descripción
version v5.2.4 La versión de swift
symbol Refleja el valor de la opción symbol
style* Refleja el valor de la opción style

*: Esta variable sólo puede ser usada como parte de una cadena de estilo

Ejemplo

# ~/.config/starship.toml

[swift]
format = "via [🏎  $version](red bold)"

Terraform

The terraform module shows the currently selected Terraform workspace and version.

::: consejo

By default the Terraform version is not shown, since this is slow for current versions of Terraform when a lot of plugins are in use. If you still want to enable it, follow the example shown below.

:::

Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones:

  • El directorio actual contiene una carpeta .terraform
  • El directorio actual contiene un archivo con las extensiones .tf o .hcl

Opciones

Opción Por defecto Descripción
format "via [$symbol$workspace]($style) " La cadena de formato para el módulo.
version_format "v${raw}" El formato de versión. Las variables disponibles son raw, major, minor, & patch
symbol "💠" Una cadena de formato que se muestra antes del espacio de trabajo 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.

Variables

Variable Ejemplo Descripción
version v0.12.24 La versión de terraform
workspace default The current Terraform workspace
symbol Refleja el valor de la opción symbol
style* Refleja el valor de la opción style

*: Esta variable sólo puede ser usada como parte de una cadena de estilo

Ejemplo

With Terraform Version

# ~/.config/starship.toml

[terraform]
format = "[🏎💨 $version$workspace]($style) "

Without Terraform version

# ~/.config/starship.toml

[terraform]
format = "[🏎💨 $workspace]($style) "

Hora

The time module shows the current local time. The format configuration value is used by the chrono crate to control how the time is displayed. Take a look at the chrono strftime docs to see what options are available.

::: consejo

This module is disabled by default. To enable it, set disabled to false in your configuration file.

:::

Opciones

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 see below La cadena de formato de chrono utilizada para formatear la hora.
style "bold yellow" El estilo para la hora del módulo
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 Desactiva el módulo time.
time_range "-" Establece el intervalo de tiempo durante el cual el módulo se mostrará. La hora debe ser especificada en formato de 24 horas

If use_12hr is true, then time_format defaults to "%r". Otherwise, it defaults to "%T". Manually setting time_format will override the use_12hr setting.

Variables

Variable Ejemplo Descripción
time 13:08:10 La hora actual.
style* Refleja el valor de la opción style

*: Esta variable sólo puede ser usada como parte de una cadena de estilo

Ejemplo

# ~/.config/starship.toml

[time]
disabled = false
format = '🕙[\[ $time \]]($style) '
time_format = "%T"
utc_time_offset = "-5"
time_range = "10:00:00-14:00:00"

Nombre de usuario

The username module shows active user's username. The module will be shown if any of the following conditions are met:

  • El usuario actual es root
  • El usuario actual no es el mismo que el que está conectado
  • El usuario está actualmente conectado como una sesión SSH
  • La variable show_always se establece en true

::: consejo

SSH connection is detected by checking environment variables SSH_CONNECTION, SSH_CLIENT, and SSH_TTY. If your SSH host does not set up these variables, one workaround is to set one of them with a dummy value.

:::

Opciones

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 Desactiva el módulo username.

Variables

Variable Ejemplo Descripción
style "red bold" Refleja el valor de la opción style_root cuando root inició sesión y style_user por otra parte.
user "matchai" El ID de usuario conectado actualmente.

Ejemplo

# ~/.config/starship.toml

[username]
style_user = "white bold"
style_root = "black bold"
format = "user: [$user]($style) "
disabled = false
show_always = true

Vagrant

The vagrant module shows the currently installed version of Vagrant. Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones:

  • El directorio actual contiene un archivo Vagrantfile

Opciones

Opción Por defecto Descripción
format "via [$symbol($version )]($style)" El formato del módulo.
version_format "v${raw}" El formato de versión. Las variables disponibles son raw, major, minor, & patch
symbol "⍱ " Una cadena de formato que representa el símbolo de Vagrant.
detect_extensions [] Qué extensiones deberían activar este módulo.
detect_files ["Vagrantfile"] Qué nombres de archivo deberían activar este módulo.
detect_folders [] Qué carpetas deberían activar este módulo.
style "cyan bold" El estilo del módulo.
disabled false Deshabilita el módulo vagrant.

Variables

Variable Ejemplo Descripción
version Vagrant 2.2.10 La versión de Vagrant
symbol Refleja el valor de la opción symbol
style* Refleja el valor de la opción style

*: Esta variable sólo puede ser usada como parte de una cadena de estilo

Ejemplo

# ~/.config/starship.toml

[vagrant]
format = "via [⍱ $version](bold white) "

VLang

The vlang module shows you your currently installed version of V. By default the module will be shown if any of the following conditions are met:

  • The current directory contains a file with .v extension
  • The current directory contains a v.mod, vpkg.json or .vpkg-lock.json file

Opciones

Opción Por defecto Descripción
format "via [$symbol($version )]($style)" El formato del módulo.
symbol "V " A format string representing the symbol of V
detect_extensions ["v"] Qué extensiones deberían activar este módulo.
detect_files ["v.mod", "vpkg.json", ".vpkg-lock.json" ] Qué nombres de archivo deberían activar este módulo.
detect_folders [] Qué carpetas deberían activar este módulo.
style "blue bold" El estilo del módulo.
disabled false Disables the vlang module.

Variables

Variable Ejemplo Descripción
version v0.2 The version of v
symbol Refleja el valor de la opción symbol
style* Refleja el valor de la opción style

Ejemplo

# ~/.config/starship.toml
[v]
format = "via [V $version](blue bold) "

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 El símbolo usado antes de mostrar el nombre del repositorio.
style "bold yellow" El estilo del módulo.
format "vcsh [$symbol$repo]($style) " El formato del módulo.
disabled false Deshabilita el módulo vcsh.

Variables

Variable Ejemplo Descripción
repositorio dotfiles si está en un repositorio VCSH nombrado dotfiles El nombre del repositorio activo
symbol Refleja el valor de la opción symbol
style* black bold dimmed Refleja el valor de la opción style

*: Esta variable sólo puede ser usada como parte de una cadena de estilo

Ejemplo

# ~/.config/starship.toml

[vcsh]
format = "[🆅 $repo](bold blue) "

Zig

By default the the zig module shows the currently installed version of Zig. The module will be shown if any of the following conditions are met:

  • El directorio actual contiene un archivo .zig

Opciones

Opción Por defecto Descripción
format "via [$symbol($version )]($style)" El formato del módulo.
version_format "v${raw}" El formato de versión. Las variables disponibles son raw, major, minor, & patch
symbol "↯ " El símbolo usado antes de mostrar la versión de Zig.
style "bold yellow" El estilo del módulo.
disabled false Desactiva el módulo zig.
detect_extensions ["zig"] Qué extensiones deberían activar este módulo.
detect_files [] Qué nombres de archivo deberían activar este módulo.
detect_folders [] Qué carpetas deberían activar este módulo.

Variables

Variable Ejemplo Descripción
version v0.6.0 La versión de zig
symbol Refleja el valor de la opción symbol
style* Refleja el valor de la opción style

*: Esta variable sólo puede ser usada como parte de una cadena de estilo

Ejemplo

# ~/.config/starship.toml

[zig]
symbol = "⚡️ "

Comandos personalizados

The custom modules show the output of some arbitrary commands.

These modules will be shown if any of the following conditions are met:

  • El directorio actual contiene un archivo cuyo nombre está en files
  • El directorio actual contiene un directorio cuyo nombre está en directories
  • El directorio actual contiene un archivo cuya extensión está en extensions
  • El comando when devuelve 0
  • El sistema operativo actual (std::env::consts::OS) coincide con el campo os si está definido.

::: consejo

Multiple custom modules can be defined by using a ..

:::

::: consejo

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.

:::

::: consejo

Issue #1252 contains examples of custom modules. If you have an interesting example not covered there, feel free to share it there!

:::

Opciones

Opción Por defecto Descripción
command El comando cuya salida debe ser impresa. El comando se pasará en stdin al shell.
when Comando de shell usado como condición para mostrar el módulo. El módulo se mostrará si el comando devuelve un código de estado 0.
shell Ver abajo
description "<custom module>" La descripción del módulo que se muestra al ejecutar starship explain.
files [] Los archivos que se buscarán en el directorio de trabajo para obtener una coincidencia.
directories [] Los directorios que se buscarán en el directorio de trabajo para una coincidencia.
extensions [] Las extensiones que se buscarán en el directorio de trabajo para obtener una coincidencia.
symbol "" El símbolo usado antes de mostrar la salida del comando.
style "bold green" El estilo del módulo.
format "[$symbol($output )]($style)" El formato del módulo.
disabled false Desactiva este módulo custom.
os Nombre del sistema operativo en el que se mostrará el módulo (unix, linux, macos, windows, ... ) Ver valores posibles.

Variables

Variable Descripción
output La salida del comando de shell en shell
symbol Refleja el valor de la opción symbol
style* Refleja el valor de la opción style

*: Esta variable sólo puede ser usada como parte de una cadena de estilo

Custom command shell

shell accepts a non-empty list of strings, where:

  • La primera cadena es la ruta al intérprete de comandos a usar para ejecutar el comando.
  • Otros argumentos siguientes son pasados al shell.

If unset, it will fallback to STARSHIP_SHELL and then to "sh" on Linux, and "cmd /C" on Windows.

The command will be passed in on stdin.

If shell is not given or only contains one element and Starship detects PowerShell will be used, the following arguments will automatically be added: -NoProfile -Command -. This behavior can be avoided by explicitly passing arguments to the shell, e.g.

shell = ["pwsh", "-Command", "-"]

::: warning Make sure your custom shell configuration exits gracefully

If you set a custom command, make sure that the default Shell used by starship will properly execute the command with a graceful exit (via the shell option).

For example, PowerShell requires the -Command parameter to execute a one liner. Omitting this parameter might throw starship into a recursive loop where the shell might try to load a full profile environment with starship itself again and hence re-execute the custom command, getting into a never ending loop.

Parameters similar to -NoProfile in PowerShell are recommended for other shells as well to avoid extra loading time of a custom profile on every starship invocation.

Automatic detection of shells and proper parameters addition are currently implemented, but it's possible that not all shells are covered. Please open an issue with shell details and starship configuration if you hit such scenario.

:::

Ejemplo

# ~/.config/starship.toml

[custom.foo]
command = "echo foo"  # shows output of command
files = ["foo"]       # can specify filters
when = """ test "$HOME" == "$PWD" """
format = " transcending [$output]($style)"

[custom.time]
command = "time /T"
files = ["*.pst"]
shell = ["pwsh.exe", "-NoProfile", "-Command", "-"]