mirror of https://github.com/Llewellynvdm/starship.git synced 2024-12-26 03:27:30 +00:00

History

Matan Kushner e29b2ddc91 docs(i18n): new Crowdin updates (#3012 )		2021-09-21 09:36:29 -04:00
..
README.md	docs(i18n): new Crowdin updates (#3012 )	2021-09-21 09:36:29 -04:00

README.md

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. Esto se puede utilizar para diseñar 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) no mostrará nada si la variable region es None o una cadena vacía, de lo contrario @ seguido por el valor de la región.
(algún texto) siempre mostrará nada ya que no hay variables envueltas entre llaves.
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.
`right_format`	`""`	Ver Habilitar prompt derecho
`scan_timeout`	`30`	Tiempo de espera tras el que Starship escanea 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\
$singularity\
$kubernetes\
$directory\
$vcsh\
$git_branch\
$git_commit\
$git_state\
$git_metrics\
$git_status\
$hg_branch\
$docker_context\
$package\
$cmake\
$cobol\
$dart\
$deno\
$dotnet\
$elixir\
$elm\
$erlang\
$golang\
$helm\
$java\
$julia\
$kotlin\
$lua\
$nim\
$nodejs\
$ocaml\
$perl\
$php\
$purescript\
$python\
$rlang\
$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\
$jobs\
$battery\
$time\
$status\
$shell\
$character"""

Si solo quieres extender el formato predeterminado, puedes usar $all; los módulos que se añaden explícitamente al formato no serán duplicados. Por ejemplo.

# Mueve el directorio a la segunda línea
format="$all$directory$character"

AWS

El módulo aws muestra la región y el perfil AWS actuales. É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 se utiliza awsu el perfil se lee 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 = "on [$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 = "on [$symbol$profile]($style) "
style = "bold blue"
symbol = "🅰 "

Battery

El módulo battery muestra qué tan cargada está la batería del dispositivo y su estado de carga actual. 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), cuál símbolo 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 opciones de battery.

Opciones

La opción display es un arreglo 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]]  # "bold red" style and discharging_symbol when capacity is between 0% and 10%
threshold = 10
style = "bold red"

[[battery.display]]  # "bold yellow" style and 💦 symbol when capacity is between 10% and 30%
threshold = 30
style = "bold yellow"
discharging_symbol = 💦

# when capacity is over 30%, the battery indicator will not be displayed

Character

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

El caracter te dirá si el último comando fue exitoso 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 no es compatible con el intérprete de comandos Elvish y Nu.

:::

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

COBOL / GNUCOBOL

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

El directorio actual contiene cualquier archivo que termine en .cob o .COB
El directorio actual contiene cualquier archivo que termine en .cbl o .CBL

Opciones

Opción	Por defecto	Descripción
`symbol`	`"⚙️ "`	El símbolo usado antes de mostrar la versión de COBOL.
`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 blue"`	El estilo del módulo.
`detect_extensions`	`["cbl", "cob", "CBL", "COB"]`	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.
`disabled`	`false`	Deshabilita el módulo `cobol`.

Variables

Variable	Ejemplo	Descripción
version	`v3.1.2.0`	La versión de `cobol`
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.

::: advertencia No utilizar la trampa 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 como preexec pueden usar el framework bash_preexec de rcaloras. Simplemente definir los arreglos preexec_functions y precmd_functions antes de ejecutar eval $(starship init $0), y luego proceder de forma normal.

Opciones

Opción	Por defecto	Descripción
`min_time`	`2_000`	Duración más corta para mostrar el tiempo (en milisegundos).
`show_milliseconds`	`false`	Mostrar milisegundos además de segundos para la duración.
`format`	`"took [$duration]($style) "`	El formato del módulo.
`style`	`"bold yellow"`	El estilo del módulo.
`disabled`	`false`	Deshabilita 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ás corta para la notificació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 entorno actual Conda, si $CONDA_DEFAULT_ENV está configurado.

::: 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 ruta de entorno, si el entorno fue creado a través de `conda create -p [path]`. `0` significa sin truncamiento. Vea 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`	Deshabilita 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

El módulo cristal muestra la versión instalada de 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`	`"🔮 "`	El símbolo usado antes de mostrar la versión del 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`	Deshabilita 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`	Deshabilita 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

El módulo deno le muestra la versión instalada de 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) "

Opción	Por defecto	Descripción
`truncation_length`	`3`	The number of parent folders that the current directory should be truncated to.
`truncate_to_repo`	`true`	Whether or not to truncate to the root of the git repo that you're currently in.
`format`	`"[$path]($style)[$read_only]($read_only_style) "`	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 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 de inicio.

Opción avanzada	Por defecto	Descripción
`sustituciones`		A table of substitutions to be made to the path.
`fish_style_pwd_dir_length`	`0`	The number of characters to use when applying fish shell pwd path logic.
`use_logical_path`	`true`	If `true` render the logical path sourced from the shell via `PWD` or `--logical-path`. If `false` instead render the physical filesystem path with symlinks resolved.

Variable	Ejemplo	Descripción
path	`"D:/Projects"`	La ruta de directorio actual
style*	`"black bold dimmed"`	Refleja el valor de la opción `style`

Contexto de Docker

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`	`"🐳 "`	The symbol used before displaying the Docker context.
`only_with_files`	`true`	Mostrar solo cuando haya una coincidencia
`detect_extensions`	`[]`	Qué extensiones deben activar este módulo (necesita `solly_with_files` para ser verdadero).
`detect_files`	`["docker-compose.yml", "docker-compose.yaml", "Dockerfile"]`	Which filenames should trigger this module (needs `only_with_files` to be true).
`detect_folders`	`[]`	Which folders should trigger this module (needs `only_with_files` to be true).
`style`	`"blue bold"`	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 relevante del .NET Core SDK para el directorio actual. Si el SDK ha sido anclado en el directorio actual, se mostrará la versión fijada. Otherwise the module shows the latest installed version of the SDK.

By default this module will only be shown in your prompt when one or more of the following files are present in the current directory:

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

You'll also need the .NET Core SDK installed in order to use it correctly.

Internamente, este módulo utiliza su propio mecanismo para la detección de versiones. Typically it is twice as fast as running dotnet --version, but it may show an incorrect version if your .NET project has an unusual directory layout. If accuracy is more important than speed, you can disable the mechanism by setting heuristic = false in the module options.

The module will also show the Target Framework Moniker (https://docs.microsoft.com/en-us/dotnet/standard/frameworks#supported-target-framework-versions) when there is a csproj file in the current directory.

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 "`	The symbol used before displaying the version of dotnet.
`heuristic`	`true`	Use faster version detection to keep starship snappy.
`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`	Disables the `dotnet` module.

Variables

Variable	Ejemplo	Descripción
version	`v3.1.201`	The version of `dotnet` sdk
tfm	`netstandard2.0`	The Target Framework Moniker that the current project is targeting
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:

The current directory contains a mix.exs file.

Opciones

Opción	Por defecto	Descripción
`format`	`'via [$symbol($version $OTP $otp_version$ )]($style)'`	The format for the module elixir.
`version_format`	`"v${raw}"`	El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch`
`symbol`	`"💧 "`	The symbol used before displaying the version of 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`	Disables the `elixir` module.

Variables

Variable	Ejemplo	Descripción
version	`v1.10`	The version of `elixir`
otp_version		The otp version of `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:

The current directory contains a elm.json file
The current directory contains a elm-package.json file
The current directory contains a .elm-version file
The current directory contains a elm-stuff folder
The current directory contains a *.elm files

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 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`	Disables the `elm` module.

Variables

Variable	Ejemplo	Descripción
version	`v0.19.1`	The version of `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. The module will be shown only if any of the following conditions are met:

The variable configuration option matches an existing environment variable
The variable configuration option is not defined, but the default configuration option is

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

Example: following configuration will display value of USER environment variable

# ~/.config/starship.toml

[env_var.USER]
default = "unknown user"

:::

Opciones

Opción	Por defecto	Descripción
`symbol`		The symbol used before displaying the variable value.
`variable`		The environment variable to be displayed.
`default`		The default value to be displayed when the selected variable is not defined.
`format`	`"with [$env_value]($style) "`	El formato del módulo.
`disabled`	`false`	Disables the `env_var` module.

Variables

Variable	Ejemplo	Descripción
env_value	`Windows NT` (if variable would be `$OS`)	The environment value of option `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:

The current directory contains a rebar.config file.
The current directory contains a erlang.mk file.

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`	`" "`	The symbol used before displaying the version of 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`	Disables the `erlang` module.

Variables

Variable	Ejemplo	Descripción
version	`v22.1.3`	The version of `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) "

Llenar

The fill module fills any extra space on the line with a symbol. If multiple fill modules are present in a line they will split the space evenly between them. Esto es útil para alinear otros módulos.

Opciones

Opción	Por defecto	Descripción
`symbol`	`"."`	El símbolo utilizado para llenar la línea.
`style`	`"bold black"`	El estilo del módulo.

Ejemplo

# ~/.config/starship.toml
format="AA $fill BB $fill CC"

[fill]
symbol = "-"
style = "bold green"

Produces a prompt that looks like:

AA -------------------------------------------- BB -------------------------------------------- CC

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`	`"☁️ "`	The symbol used before displaying the current GCP profile.
`region_aliases`		Table of region aliases to display in addition to the GCP name.
`style`	`"bold blue"`	El estilo del módulo.
`disabled`	`false`	Deshabilita el módulo `gcloud`.

Variables

Variable	Ejemplo	Descripción
region	`us-central1`	The current GCP region
cuenta	`foo`	El perfil actual de GCP
dominio	`ejemplo.com`	The current GCP profile domain
proyecto		The current GCP project
activo	`default`	The active config name written in `~/.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`	Shows the remote tracking branch name, even if it is equal to the local branch name.
`format`	`"on [$symbol$branch]($style) "`	El formato del módulo. Use `"$branch"` to refer to the current branch name.
`symbol`	`" "`	A format string representing the symbol of git branch.
`style`	`"bold purple"`	El estilo del módulo.
`truncation_length`	`2^63 - 1`	Truncates a git branch to `N` graphemes.
`truncation_symbol`	`"…"`	The symbol used to indicate a branch name was truncated. You can use `""` for no symbol.
`only_attached`	`false`	Only show the branch name when not in a detached `HEAD` state.
`disabled`	`false`	Disables the `git_branch` module.

Variables

Variable	Ejemplo	Descripción
rama	`maestro`	The current branch name, falls back to `HEAD` if there's no current branch (e.g. git detached `HEAD`).
remote_name	`origen`	El nombre remoto.
remote_branch	`maestro`	The name of the branch tracked on `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`	The length of the displayed git commit hash.
`format`	`"[\$$hash$tag\$]($style) "`	El formato del módulo.
`style`	`"bold green"`	El estilo del módulo.
`only_detached`	`true`	Only show git commit hash when in detached `HEAD` state
`tag_disabled`	`true`	Disables showing tag info in `git_commit` module.
`tag_symbol`	`" 🏷 "`	Tag symbol prefixing the info shown
`disabled`	`false`	Disables the `git_commit` module.

Variables

Variable	Ejemplo	Descripción
hash	`b703eb3`	The current git commit hash
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"`	A format string displayed when a `rebase` is in progress.
`merge`	`"MERGING"`	A format string displayed when a `merge` is in progress.
`revertir`	`"REVERTING"`	A format string displayed when a `revert` is in progress.
`cherry_pick`	`"CHERRY-PICKING"`	A format string displayed when a `cherry-pick` is in progress.
`bisect`	`"BISECTING"`	A format string displayed when a `bisect` is in progress.
`am`	`"AM"`	A format string displayed when an `apply-mailbox` (`git am`) is in progress.
`am_or_rebase`	`"AM/REBASE"`	A format string displayed when an ambiguous `apply-mailbox` or `rebase` is in progress.
`style`	`"bold yellow"`	El estilo del módulo.
`format`	`'$[$state( $progress_current/$progress_total)]($style)$ '`	El formato del módulo.
`disabled`	`false`	Disables the `git_state` module.

Variables

Variable	Ejemplo	Descripción
state	`REBASING`	The current state of the repo
progress_current	`1`	The current operation progress
progress_total	`2`	The total operation progress
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.
`only_nonzero_diffs`	`true`	Render status only for changed items.
`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) )'`	The default format for `git_status`
`conflicted`	`"="`	This branch has merge conflicts.
`ahead`	`"⇡"`	The format of `ahead`
`behind`	`"⇣"`	The format of `behind`
`diverged`	`"⇕"`	The format of `diverged`
`up_to_date`	`""`	The format of `up_to_date`
`untracked`	`"?"`	The format of `untracked`
`stashed`	`"$"`	The format of `stashed`
`modificado`	`"!"`	The format of `modified`
`staged`	`"+"`	The format of `staged`
`renamed`	`"»"`	The format of `renamed`
`eliminado`	`"✘"`	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`	Shortcut for`$conflicted$stashed$deleted$renamed$modified$staged$untracked`
`ahead_behind`	Displays `diverged`, `ahead`, `behind` or `up_to_date` format string based on the current status of the repo.
`conflicted`	Displays `conflicted` when this branch has merge conflicts.
`untracked`	Displays `untracked` when there are untracked files in the working directory.
`stashed`	Displays `stashed` when a stash exists for the local repository.
`modificado`	Displays `modified` when there are file modifications in the working directory.
`staged`	Displays `staged` when a new file has been added to the staging area.
`renamed`	Displays `renamed` when a renamed file has been added to the staging area.
`deleted`	Displays `deleted` when a file's deletion has been added to the staging area.
style*	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`	Number of commits ahead of the tracking branch
`behind_count`	Number of commits behind the tracking branch

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

Variable	Descripción
`count`	Mostrar 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}"

Go

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

The current directory contains a go.mod file
The current directory contains a go.sum file
The current directory contains a glide.yaml file
The current directory contains a Gopkg.yml file
The current directory contains a Gopkg.lock file
The current directory contains a .go-version file
The current directory contains a Godeps directory
The current directory contains a file with the .go extension

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 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`	Deshabilita 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:

The current directory contains a helmfile.yaml file
The current directory contains a Chart.yaml file

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`	`"⎈ "`	A format string representing the symbol of Helm.
`style`	`"bold white"`	El estilo del módulo.
`disabled`	`false`	Disables the `helm` module.

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`	Only show hostname when connected to an SSH session.
`trim_at`	`"."`	String that the hostname is cut off at, after the first match. `"."` will stop after the first dot. `""` will disable any truncation
`format`	`"[$hostname]($style) in "`	El formato del módulo.
`style`	`"bold dimmed green"`	El estilo del módulo.
`disabled`	`false`	Disables the `hostname` module.

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:

The current directory contains a pom.xml, build.gradle.kts, build.sbt, .java-version, .deps.edn, project.clj, or build.boot file
The current directory contains a file with the .java, .class, .gradle, .jar, .clj, or .cljc extension

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`	`"☕ "`	A format string representing the symbol of Java
`style`	`"red dimmed"`	El estilo del módulo.
`disabled`	`false`	Disables the `java` module.

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 = "🌟 "

Trabajos

The jobs module shows the current number of jobs running. The module will be shown only if there are background jobs running. The module will show the number of jobs running if there are at least 2 jobs, or more than the number_threshold config value, if it exists. The module will show a symbol if there is at least 1 job, or more than the symbol_threshold config value, if it exists. You can set both values to 0 in order to always show the symbol and number of jobs, even if there are 0 jobs running.

The default functionality is:

0 jobs -> Nothing is shown.
1 job -> symbol is shown.
2 jobs or more -> symbol + number are shown.

::: aviso

This module is not supported on tcsh and nu.

:::

::: aviso

The threshold option is deprecated, but if you want to use it, the module will show the number of jobs running if there is more than 1 job, or more than the threshold config value, if it exists. If threshold is set to 0, then the module will also show when there are 0 jobs running.

:::

Opciones

Opción	Por defecto	Descripción
`threshold`*	`1`	Show number of jobs if exceeded.
`symbol_threshold`	`1`	Show `symbol` if the job count is at least `symbol_threshold`.
`number_threshold`	`2`	Show the number of jobs if the job count is at least `number_threshold`.
`format`	`"[$symbol$number]($style) "`	El formato del módulo.
`symbol`	`"✦"`	The string used to represent the `symbol` variable.
`style`	`"bold blue"`	El estilo del módulo.
`disabled`	`false`	Disables the `jobs` module.
*: This option is deprecated, please use the

number_threshold and symbol_threshold options instead.

Variables

Variable	Ejemplo	Descripción
número	`1`	The number of jobs
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 = "+ "
number_threshold = 4
symbol_threshold = 0

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:

The current directory contains a Project.toml file
The current directory contains a Manifest.toml file
The current directory contains a file with the .jl extension

Opciones

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`	`"ஃ "`	A format string representing the symbol of Julia.
`style`	`"bold purple"`	El estilo del módulo.
`disabled`	`false`	Disables the `julia` module.

Variables

Variable	Ejemplo	Descripción
version	`v1.4.0`	The version of `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 un .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`	`"🅺 "`	A format string representing the symbol of Kotlin.
`style`	`"bold blue"`	El estilo del módulo.
`kotlin_binary`	`"kotlin"`	Configures the kotlin binary that Starship executes when getting the version.
`disabled`	`false`	Disables the `kotlin` module.

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]
# Uses the Kotlin Compiler binary to get the installed version
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`	`"☸ "`	A format string representing the symbol displayed before the Cluster.
`format`	`'[$symbol$context( $$namespace$)]($style) in '`	El formato del módulo.
`style`	`"cyan bold"`	El estilo del módulo.
`context_aliases`		Table of context aliases to display.
`disabled`	`true`	Disables the `kubernetes` module.

Variables

Variable	Ejemplo	Descripción
context	`starship-cluster`	The current kubernetes context
namespace	`starship-namespace`	If set, the current kubernetes namespace
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"

Line Break

The line_break module separates the prompt into two lines.

Opciones

Opción	Por defecto	Descripción
`disabled`	`false`	Disables the `line_break` module, making the prompt a single line.

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:

The current directory contains a .lua-version file
The current directory contains a lua directory
The current directory contains a file with the .lua extension

Opciones

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 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"`	Configures the lua binary that Starship executes when getting the version.
`disabled`	`false`	Disables the `lua` module.

Variables

Variable	Ejemplo	Descripción
version	`v5.4.0`	The version of `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) "

Memory Usage

The memory_usage module shows current system memory and swap usage.

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

::: 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`	Hide the memory usage unless it exceeds this percentage.
`format`	`"via $symbol [${ram}( \| ${swap})]($style) "`	El formato del módulo.
`symbol`	`"🐏"`	The symbol used before displaying the memory usage.
`style`	`"bold dimmed white"`	El estilo del módulo.
`disabled`	`true`	Disables the `memory_usage` module.

Variables

Variable	Ejemplo	Descripción
ram	`31GiB/65GiB`	The usage/total RAM of the current system memory.
ram_pct	`48%`	The percentage of the current system memory.
swap**	`1GiB/4GiB`	The swap memory size of the current system swap memory file.
swap_pct**	`77%`	The swap memory percentage of the current system swap memory file.
symbol	`🐏`	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`	`" "`	The symbol used before the hg bookmark or branch name of the repo in your current directory.
`style`	`"bold purple"`	El estilo del módulo.
`format`	`"on [$symbol$branch]($style) "`	El formato del módulo.
`truncation_length`	`2^63 - 1`	Truncates the hg branch name to `N` graphemes
`truncation_symbol`	`"…"`	The symbol used to indicate a branch name was truncated.
`disabled`	`true`	Deshabilita el módulo `hg_branch`.

Variables

Variable	Ejemplo	Descripción
rama	`maestro`	La rama 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:

The current directory contains a nim.cfg file
The current directory contains a file with the .nim extension
The current directory contains a file with the .nims extension
The current directory contains a file with the .nimble extension

Opciones

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`	`"👑 "`	The symbol used before displaying the version of 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`	Disables the `nim` module.

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`	`"❄️ "`	A format string representing the symbol of nix-shell.
`style`	`"bold blue"`	El estilo del módulo.
`impure_msg`	`"impure"`	A format string shown when the shell is impure.
`pure_msg`	`"pure"`	A format string shown when the shell is pure.
`disabled`	`false`	Disables the `nix_shell` module.

Variables

Variable	Ejemplo	Descripción
state	`pure`	The state of the nix-shell
name	`lorri`	The name of the 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:

The current directory contains a package.json file
The current directory contains a .node-version file
The current directory contains a .nvmrc file
The current directory contains a node_modules directory
The current directory contains a file with the .js, .mjs or .cjs extension
The current directory contains a file with the .ts extension

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`	Disables the `nodejs` module.
`not_capable_style`	`bold red`	The style for the module when an engines property in package.json does not match the Node.js version.

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

OCamlz

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:

The current directory contains a file with .opam extension or _opam directory
The current directory contains a esy.lock directory
The current directory contains a dune or dune-project file
The current directory contains a jbuild or jbuild-ignore file
The current directory contains a .merlin file
The current directory contains a file with .ml, .mli, .re or .rei extension

Opciones

Opción	Por defecto	Descripción
`format`	`"via [$symbol($version )($$switch_indicator$switch_name$ )]($style)"`	The format string for the module.
`version_format`	`"v${raw}"`	El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch`
`symbol`	`"🐫 "`	The symbol used before displaying the version of OCaml.
`global_switch_indicator`	`""`	The format string used to represent global OPAM switch.
`local_switch_indicator`	`"*"`	The format string used to represent local OPAM switch.
`detect_extensions`	`["opam", "ml", "mli", "re", "rei"]`	Qué extensiones deberían activar este módulo.
`detect_files`	`["dune", "dune-project", "jbuild", "jbuild-ignore", ".merlin"]`	Qué nombres de archivo deberían activar este módulo.
`detect_folders`	`["_opam", "esy.lock"]`	Qué carpetas deberían activar este módulo.
`style`	`"bold yellow"`	El estilo del módulo.
`disabled`	`false`	Disables the `ocaml` module.

Variables

Variable	Ejemplo	Descripción
version	`v4.10.0`	La versión de `ocaml`
switch_name	`my-project`	The active OPAM switch
switch_indicator		Mirrors the value of `indicator` for currently active OPAM switch
symbol		Refleja el valor de la opción `symbol`
style*		Refleja el valor de la opción `style`

*: 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`	`"☁️ "`	The symbol used before displaying the current OpenStack cloud.
`style`	`"bold yellow"`	El estilo del módulo.
`disabled`	`false`	Disables the `openstack` module.

Variables

Variable	Ejemplo	Descripción
cloud	`corp`	The current OpenStack cloud
proyecto	`dev`	The current OpenStack project
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
V - 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`	`"📦 "`	The symbol used before displaying the version the package.
`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:

The current directory contains a Makefile.PL or Build.PL file
The current directory contains a cpanfile or cpanfile.snapshot file
The current directory contains a META.json file or META.yml file
The current directory contains a .perl-version file
The current directory contains a .pl, .pm or .pod

Opciones

Opción	Por defecto	Descripción
`format`	`"via [$symbol($version )]($style)"`	The format string for the module.
`version_format`	`"v${raw}"`	El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch`
`symbol`	`"🐪 "`	The symbol used before displaying the version of Perl
`detect_extensions`	`["pl", "pm", "pod"]`	Qué extensiones deberían activar este módulo.
`detect_files`	`["Makefile.PL", "Build.PL", "cpanfile", "cpanfile.snapshot", "META.json", "META.yml", ".perl-version"]`	Qué nombres de archivo deberían activar este módulo.
`detect_folders`	`[]`	Qué carpetas deberían activar este módulo.
`style`	`"bold 149"`	El estilo del módulo.
`disabled`	`false`	Deshabilita el módulo `perl`.

Variables

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

Ejemplo

# ~/.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:

The current directory contains a composer.json file
The current directory contains a .php-version file
The current directory contains a .php 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`	`"🐘 "`	The symbol used before displaying the version of 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:

The current directory contains a spago.dhall file
The current directory contains a file with the .purs 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`	`"<=> "`	The symbol used before displaying the version of 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`	Disables the `purescript` module.

Variables

Variable	Ejemplo	Descripción
version	`0.13.5`	The version of `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:

The current directory contains a .python-version file
The current directory contains a Pipfile file
The current directory contains a __init__.py file
The current directory contains a pyproject.toml file
The current directory contains a requirements.txt file
The current directory contains a setup.py file
The current directory contains a tox.ini file
The current directory contains a file with the .py extension.
A virtual environment is currently activated

Opciones

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`	`"🐍 "`	A format string representing the symbol of Python
`style`	`"yellow bold"`	El estilo del módulo.
`pyenv_version_name`	`false`	Use pyenv to get Python version
`pyenv_prefix`	`pyenv`	Prefix before pyenv version display, only used if pyenv is used
`python_binary`	`["python", "python3", "python2"]`	Configures the python binaries that Starship should executes when getting the version.
`detect_extensions`	`["py"]`	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`	Disables the `python` module.

::: 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"`	The version of `python`
symbol	`"🐍 "`	Refleja el valor de la opción `symbol`
style	`"yellow bold"`	Refleja el valor de la opción `style`
pyenv_prefix	`"pyenv "`	Mirrors the value of option `pyenv_prefix`
virtualenv	`"venv"`	The current `virtualenv` name

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`	La versión de `R`
symbol		Refleja el valor de la opción `symbol`
style	`"blue bold"`	Refleja el valor de la opción `style`

Ejemplo

# ~/.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:

The current directory contains a Gemfile file
The current directory contains a .ruby-version file
The current directory contains a .rb file

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 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`	Disables the `ruby` module.

Variables

Variable	Ejemplo	Descripción
version	`v2.5.1`	The version of `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:

The current directory contains a Cargo.toml file
The current directory contains a file with the .rs 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 Rust
`detect_extensions`	`["rs"]`	Qué extensiones deberían activar este módulo.
`detect_files`	`["Cargo.toml"]`	Qué nombres de archivo deberían activar este módulo.
`detect_folders`	`[]`	Qué carpetas deberían activar este módulo.
`style`	`"bold red"`	El estilo del módulo.
`disabled`	`false`	Deshabilita el módulo `rust`.

Variables

Variable	Ejemplo	Descripción
version	`v1.43.0-nightly`	The version of `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:

The current directory contains a build.sbt, .scalaenv or .sbtenv file
The current directory contains a file with the .scala or .sbt extension
The current directory contains a directory named .metals

Opciones

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`	`"🆂 "`	A format string representing the symbol of Scala.
`style`	`"red dimmed"`	El estilo del módulo.
`disabled`	`false`	Disables the `scala` module.

Variables

Variable	Ejemplo	Descripción
version	`2.13.5`	The version of `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`	A format string used to represent bash.
`fish_indicator`	`fsh`	A format string used to represent fish.
`zsh_indicator`	`zsh`	A format string used to represent zsh.
`powershell_indicator`	`psh`	A format string used to represent powershell.
`ion_indicator`	`ion`	A format string used to represent ion.
`elvish_indicator`	`esh`	A format string used to represent elvish.
`tcsh_indicator`	`tsh`	A format string used to represent tcsh.
`xonsh_indicator`	`xsh`	A format string used to represent xonsh.
`unknown_indicator`		The default value to be displayed when the shell is unknown.
`format`	`$indicator`	El formato del módulo.
`disabled`	`true`	Disables the `shell` module.

Variables

Variable	Por defecto	Descripción
indicador		Mirrors the value of `indicator` for currently used shell.

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`	Display threshold.
`format`	`"[$symbol$shlvl]($style) "`	El formato del módulo.
`symbol`	`"↕️ "`	The symbol used to represent the `SHLVL`.
`repeat`	`false`	Causes `symbol` to be repeated by the current `SHLVL` amount.
`style`	`"bold yellow"`	El estilo del módulo.
`disabled`	`true`	Disables the `shlvl` module.

Variables

Variable	Ejemplo	Descripción
shlvl	`3`	The current value of `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`	`""`	A format string displayed before the image name.
`style`	`"bold dimmed blue"`	El estilo del módulo.
`disabled`	`false`	Disables the `singularity` module.

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

Estado

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) "`	The format of the module
`symbol`	`"✖"`	El símbolo mostrado en un 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
estado	`127`	The exit code of the last command
int	`127`	The exit code of the last command
common_meaning	`ERROR`	Meaning of the code if not a signal
signal_number	`9`	Signal number corresponding to the exit code, only if signalled
signal_name	`KILL`	Name of the signal corresponding to the exit code, only if signalled
maybe_int	`7`	Contains the exit code number when no meaning has been found
pipestatus		Rendering of in pipeline programs's exit codes, this is only available in pipestatus_format
symbol		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:

The current directory contains a Package.swift file
The current directory contains a file with the .swift 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 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`	Disables the `swift` module.

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:

The current directory contains a .terraform folder
Current directory contains a file with the .tf or .hcl extensions

Opciones

Opción	Por defecto	Descripción
`format`	`"via [$symbol$workspace]($style) "`	The format string for the module.
`version_format`	`"v${raw}"`	El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch`
`symbol`	`"💠"`	A format string shown before the terraform workspace.
`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`	Disables the `terraform` module.

Variables

Variable	Ejemplo	Descripción
version	`v0.12.24`	The version of `terraform`
área de trabajo	`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) "`	The format string for the module.
`use_12hr`	`false`	Enables 12 hour formatting
`time_format`	ver abajo	The chrono format string used to format the time.
`style`	`"bold yellow"`	The style for the module time
`utc_time_offset`	`"local"`	Sets the UTC offset to use. Range from -24 < x < 24. Allows floats to accommodate 30/45 minute timezone offsets.
`disabled`	`true`	Disables the `time` module.
`time_range`	`"-"`	Sets the time range during which the module will be shown. Times must be specified in 24-hours format

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

Variables

Variable	Ejemplo	Descripción
tiempo	`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:

The current user is root
The current user isn't the same as the one that is logged in
The user is currently connected as an SSH session
The variable show_always is set to true

::: consejo

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"`	The style used when the user is root.
`style_user`	`"bold yellow"`	The style used for non-root users.
`format`	`"[$user]($style) in "`	El formato del módulo.
`show_always`	`false`	Always shows the `username` module.
`disabled`	`false`	Disables the `username` module.

Variables

Variable	Ejemplo	Descripción
`style`	`"red bold"`	Mirrors the value of option `style_root` when root is logged in and `style_user` otherwise.
`user`	`"matchai"`	The currently logged-in user ID.

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:

The current directory contains a Vagrantfile file

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 Vagrant.
`detect_extensions`	`[]`	Qué extensiones deberían activar este módulo.
`detect_files`	`["Vagrantfile"]`	Qué nombres de archivo deberían activar este módulo.
`detect_folders`	`[]`	Qué carpetas deberían activar este módulo.
`style`	`"cyan bold"`	El estilo del módulo.
`disabled`	`false`	Disables the `vagrant` module.

Variables

Variable	Ejemplo	Descripción
version	`Vagrant 2.2.10`	The version of `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) "

V

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

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.
`version_format`	`"v${raw}"`	El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch`
`symbol`	`"V "`	A format string representing the symbol of V
`detect_extensions`	`["v"]`	Qué extensiones deberían activar este módulo.
`detect_files`	`["v.mod", "vpkg.json", ".vpkg-lock.json" ]`	Qué nombres de archivo deberían activar este módulo.
`detect_folders`	`[]`	Qué carpetas deberían activar este módulo.
`style`	`"blue bold"`	El estilo del módulo.
`disabled`	`false`	Disables the `vlang` module.

Variables

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
[vlang]
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`		The symbol used before displaying the repository name.
`style`	`"bold yellow"`	El estilo del módulo.
`format`	`"vcsh [$symbol$repo]($style) "`	El formato del módulo.
`disabled`	`false`	Disables the `vcsh` module.

Variables

Variable	Ejemplo	Descripción
repositorio	`dotfiles` if in a VCSH repo named dotfiles	The active repository name
symbol		Refleja el valor de la opción `symbol`
style*	`black bold dimmed`	Refleja el valor de la opción `style`

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

Ejemplo

# ~/.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:

The current directory contains a .zig file

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`	`"↯ "`	The symbol used before displaying the version of Zig.
`style`	`"bold yellow"`	El estilo del módulo.
`disabled`	`false`	Disables the `zig` module.
`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`	The version of `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:

The current directory contains a file whose name is in files
The current directory contains a directory whose name is in directories
The current directory contains a file whose extension is in extensions
The when command returns 0
The current Operating System (std::env::consts::OS) matchs with os field if defined.

::: consejo

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`		The command whose output should be printed. The command will be passed on stdin to the shell.
`when`		A shell command used as a condition to show the module. The module will be shown if the command returns a `0` status code.
`shell`		See below
`description`	`"<custom module>"`	The description of the module that is shown when running `starship explain`.
`files`	`[]`	The files that will be searched in the working directory for a match.
`directories`	`[]`	The directories that will be searched in the working directory for a match.
`extensions`	`[]`	The extensions that will be searched in the working directory for a match.
`symbol`	`""`	The symbol used before displaying the command output.
`style`	`"bold green"`	El estilo del módulo.
`format`	`"[$symbol($output )]($style)"`	El formato del módulo.
`disabled`	`false`	Disables this `custom` module.
`os`		Operating System name on which the module will be shown (unix, linux, macos, windows, ... ) See possible values.

Variables

Variable	Descripción
output	The output of shell command in `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

Comando personalizado del intérprete de comandos

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

The first string is the path to the shell to use to execute the command.
Other following arguments are passed to the shell.

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

The command will be passed in on stdin.

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

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", "-"]

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.

Opción	Por defecto	Descripción
`format`	`'via [$symbol($version \(OTP $otp_version\) )]($style)'`	The format for the module elixir.
`version_format`	`"v${raw}"`	El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch`
`symbol`	`"💧 "`	The symbol used before displaying the version of 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`	Disables the `elixir` module.

Opción	Por defecto	Descripción
`format`	`'on [$symbol$account(@$domain)(\($region\))]($style) '`	El formato del módulo.
`symbol`	`"☁️ "`	The symbol used before displaying the current GCP profile.
`region_aliases`		Table of region aliases to display in addition to the GCP name.
`style`	`"bold blue"`	El estilo del módulo.
`disabled`	`false`	Deshabilita el módulo `gcloud`.

Opción	Por defecto	Descripción
`format`	`'via [$symbol$state( \($name\))]($style) '`	El formato del módulo.
`symbol`	`"❄️ "`	A format string representing the symbol of nix-shell.
`style`	`"bold blue"`	El estilo del módulo.
`impure_msg`	`"impure"`	A format string shown when the shell is impure.
`pure_msg`	`"pure"`	A format string shown when the shell is pure.
`disabled`	`false`	Disables the `nix_shell` module.

Opción	Por defecto	Descripción
`format`	`"via [$symbol($version )(\($switch_indicator$switch_name\) )]($style)"`	The format string for the module.
`version_format`	`"v${raw}"`	El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch`
`symbol`	`"🐫 "`	The symbol used before displaying the version of OCaml.
`global_switch_indicator`	`""`	The format string used to represent global OPAM switch.
`local_switch_indicator`	`"*"`	The format string used to represent local OPAM switch.
`detect_extensions`	`["opam", "ml", "mli", "re", "rei"]`	Qué extensiones deberían activar este módulo.
`detect_files`	`["dune", "dune-project", "jbuild", "jbuild-ignore", ".merlin"]`	Qué nombres de archivo deberían activar este módulo.
`detect_folders`	`["_opam", "esy.lock"]`	Qué carpetas deberían activar este módulo.
`style`	`"bold yellow"`	El estilo del módulo.
`disabled`	`false`	Disables the `ocaml` module.

Opción	Por defecto	Descripción
`format`	`"on [$symbol$cloud(\\($project\\))]($style) "`	El formato del módulo.
`symbol`	`"☁️ "`	The symbol used before displaying the current OpenStack cloud.
`style`	`"bold yellow"`	El estilo del módulo.
`disabled`	`false`	Disables the `openstack` module.

README.md Unescape Escape

Configuración

Registros

Terminología

Cadenas de Formato

Variable

Grupo de Texto

Cadenas de estilo

Cadenas de Formato Condicional

Caracteres de escape

Prompt

Opciones

Ejemplo

Formato por Defecto del Prompt

AWS

Opciones

Variables

Ejemplos

Mostrar todo

Mostrar región

Mostrar perfil

Battery

Opciones

Ejemplo

Indicador de batería

Opciones

Ejemplo

Character

Opciones

Variables

Ejemplos

Con formato de error personalizado

Sin formato de error personalizado

Con formato de vim personalizado

CMake

Opciones

Variables

COBOL / GNUCOBOL

Opciones

Variables

Tiempo de Ejecución

Opciones

Variables

Ejemplo

Conda

Opciones

Variables

Ejemplo

Crystal

Opciones

Variables

Ejemplo

Dart

Opciones

Variables

Ejemplo

Deno

Opciones

Variables

Ejemplo

Directory

Opciones

Variables

Ejemplo

Contexto de Docker

Opciones

Variables

Ejemplo

Dotnet

Opciones

Variables

Ejemplo

Elixir

Opciones

Variables

Ejemplo

Elm

Opciones

Variables

Ejemplo

README.md

Google Cloud (`gcloud`)