starship/docs/es-ES/config/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"

# El cual es equivalente a
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\
$pulumi\
$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) "

Directory

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

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

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

Opciones

Opción	Por defecto	Descripción
truncation_length	3	El número de directorios padre a los que se debe truncar el directorio actual.
truncate_to_repo	true	Trunca o no hasta la raíz del repositorio git en el que estés.
format	"[$path]($style)[$read_only]($read_only_style) "	El formato del módulo.
style	"bold cyan"	El estilo del módulo.
disabled	false	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.: "…/"
repo_root_style	None	The style for the root of the git repo when truncate_to_repo option is set to false.
home_symbol	"~"	The symbol indicating home directory.

Este módulo tiene algunas opciones avanzadas de configuración que controlan cómo se muestra el directorio.

Opción avanzada	Por defecto	Descripción
sustituciones		Una tabla de sustituciones que se deben hacer a la ruta.
fish_style_pwd_dir_length	0	El número de caracteres a usar al aplicar la lógica de ruta pwd de la shell de fish.
use_logical_path	true	Si true renderiza la ruta lógica originada desde el intérprete de comandos a través de PWD o --logical-path. Si false en su lugar renderiza la ruta física del sistema de archivos con enlaces simbólicos resueltos.

substitutions permite definir reemplazos arbitrarios para cadenas literales que ocurren en la ruta, por ejemplo prefijos largos de red o directorios de desarrollo (p. ej. Java). Ten en cuenta que esto desactivará el estilo PWD de fish.

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

fish_style_pwd_dir_length interactúa con las opciones de truncamiento estándar de una manera que puede sorprenderse primero: si no es cero, los componentes de la ruta que normalmente se truncarían se muestran con esa cantidad de caracteres. Por ejemplo, la ruta /built/this/city/on/rock/and/roll, que normalmente se mostraría como rock/and/roll, se mostraría como /b/t/c/o/rock/and/roll con fish_style_pwd_dir_length = 1--los componentes de ruta que normalmente se eliminarían se muestran con un solo carácter. Para fish_style_pwd_dir_length = 2, sería /bu/th/ci/on/rock/and/roll.

Variables

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

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

Ejemplo

# ~/.config/starship.toml

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

Contexto de Docker

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

Opciones

Opción	Por defecto	Descripción
format	"via [$symbol$context]($style) "	El formato del módulo.
symbol	"🐳 "	El símbolo usado antes de mostrar el contexto de Docker.
only_with_files	true	Mostrar solo cuando haya una coincidencia
detect_extensions	[]	Qué extensiones deben activar este módulo (necesita solly_with_files para ser verdadero).
detect_files	["docker-compose.yml", "docker-compose.yaml", "Dockerfile"]	Qué nombres de archivo deberían activar este módulo (necesita que solly_with_files sea verdadero, con un valor "true").
detect_folders	[]	Qué carpetas deberían activar este módulo (necesita que solly_with_files sea verdadero, con un valor "true").
style	"blue bold"	El estilo del módulo.
disabled	false	Deshabilita el módulo docker_context.

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. De lo contrario, el módulo muestra la última versión instalada del SDK.

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

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

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

Internamente, este módulo utiliza su propio mecanismo para la detección de versiones. Normalmente es el doble de rápido que ejecutar dotnet --version, pero puede mostrar una versión incorrecta si tu proyecto .NET tiene un diseño de directorio inusual. Si la precisión es más importante que la velocidad, puede desactivar el mecanismo estableciendo heuristic = false en las opciones del módulo.

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

Opciones

Opción	Por defecto	Descripción
format	"via [$symbol($version )(🎯 $tfm )]($style)"	El formato del módulo.
version_format	"v${raw}"	El formato de versión. Las variables disponibles son raw, major, minor, & patch
symbol	".NET "	Símbolo usado antes de mostrar la versión de .NET
heuristic	true	Usa una detección de versiones más rápida para mantener a starship veloz.
detect_extensions	["csproj", "fsproj", "xproj"]	Qué extensiones deberían activar este módulo.
detect_files	["global.json", "project.json", "Directory.Build.props", "Directory.Build.targets", "Packages.props"]	Qué nombres de archivo deberían activar este módulo.
detect_folders	[]	Qué carpetas deberían activar estos módulos.
style	"bold blue"	El estilo del módulo.
disabled	false	Deshabilita el módulo dotnet.

Variables

Variable	Ejemplo	Descripción
version	v3.1.201	La version del sdk de dotnet
tfm	netstandard2.0	El Target Framework Moniker al que se dirige el proyecto actual
symbol		Refleja el valor de la opción symbol
style*		Refleja el valor de la opción style

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

Ejemplo

# ~/.config/starship.toml

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

Elixir

El módulo elixir muestra la versión instalada de Elixir y Erlang/OTP. Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones:

• El directorio actual contiene un archivo mix.exs.

Opciones

Opción	Por defecto	Descripción
format	'via [$symbol($version \(OTP $otp_version\) )]($style)'	El formato para el módulo elixir.
version_format	"v${raw}"	El formato de versión. Las variables disponibles son raw, major, minor, & patch
symbol	"💧 "	El símbolo usado antes de mostrar la version de Elixir/Erlang.
detect_extensions	[]	Qué extensiones deberían activar este módulo.
detect_files	["mix.exs"]	Qué nombres de archivo deberían activar este módulo.
detect_folders	[]	Qué carpetas deberían activar estos módulos.
style	"bold purple"	El estilo del módulo.
disabled	false	Desactiva el módulo elixir.

Variables

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

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

Ejemplo

# ~/.config/starship.toml

[elixir]
symbol = "🔮 "

Elm

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

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

Opciones

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

Variables

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

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

Ejemplo

# ~/.config/starship.toml

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

Variable de entorno

El módulo env_var muestra el valor actual de una variable de entorno seleccionada. El módulo se mostrará sólo si se cumplen cualquiera de las siguientes condiciones:

• La opción de configuración de variable coincide con una variable de entorno existente
• La opción de configuración de variable no está definida, pero la opción de configuración predeterminada se encuentra

::: consejo Múltiples variables de entorno pueden mostrarse usando un .. (ver ejemplo) Si la opción de configuración de la variable no está definida, el módulo mostrará el valor de la variable bajo el nombre del texto después del caracter ..

Ejemplo: la siguiente configuración mostrará el valor de la variable de entorno USER

# ~/.config/starship.toml

[env_var.USER]
default = "unknown user"

:::

Opciones

Opción	Por defecto	Descripción
symbol	""	El símbolo usado antes de mostrar el valor de la variable.
variable		La variable de entorno a mostrar.
default		El valor por defecto que se mostrará cuando la variable seleccionada no está definida.
format	"with [$env_value]($style) "	El formato del módulo.
disabled	false	Desactiva el módulo env_var.

Variables

Variable	Ejemplo	Descripción
env_value	Windows NT (if variable would be $OS)	El valor de entorno de la opción variable
symbol		Refleja el valor de la opción symbol
style*	black bold dimmed	Refleja el valor de la opción style

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

Ejemplo

# ~/.config/starship.toml

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

Mostrando múltiples variables de entorno:

# ~/.config/starship.toml

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

Erlang

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

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

Opciones

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

Variables

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

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

Ejemplo

# ~/.config/starship.toml

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

Llenar

El módulo fill llena cualquier espacio extra en la línea con un símbolo. Si múltiples módulos fill están presentes en una línea, dividirán el espacio equitativamente entre ellos. 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.
disabled	false	Deshabilita el módulo fill

Ejemplo

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

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

Produce un prompt que se ve como:

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

Google Cloud (gcloud)

El módulo gcloud muestra la configuración actual para el CLI de gcloud. Esto se basa en el archivo ~/.config/gcloud/active_config, el archivo ~/.config/gcloud/configurations/config_{CONFIG NAME} y la variable de entorno CLOUDSDK_CONFIG.

Opciones

Opción	Por defecto	Descripción
format	'on [$symbol$account(@$domain)(\($region\))]($style) '	El formato del módulo.
symbol	"☁️ "	El símbolo usado antes de mostrar el perfil actual de GCP.
region_aliases		Tabla de alias de región a mostrar además del nombre GCP.
style	"bold blue"	El estilo del módulo.
disabled	false	Deshabilita el módulo gcloud.

Variables

Variable	Ejemplo	Descripción
region	us-central1	La región GCP actual
cuenta	foo	El perfil actual de GCP
dominio	ejemplo.com	El dominio actual del perfil GCP
proyecto		El proyecto GCP actual
activo	default	El nombre de configuración activo escrito en ~/.config/gcloud/active_config
symbol		Refleja el valor de la opción symbol
style*		Refleja el valor de la opción style

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

Ejemplos

Mostrar cuenta y proyecto

# ~/.config/starship.toml

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

Mostrar solo el nombre de la configuración activa

# ~/.config/starship.toml

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

Mostrar los alias de cuenta y región

# ~/.config/starship.toml

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

Git Branch

El módulo git_branch muestra la rama activa del repositorio en tu directorio actual.

Opciones

Opción	Por defecto	Descripción
always_show_remote	false	Muestra el nombre de la rama de seguimiento remoto, incluso si es igual al nombre de la rama local.
format	"on [$symbol$branch]($style) "	El formato del módulo. Use "$branch" para referirse al nombre de la rama actual.
symbol	" "	Una cadena de formato que representa el símbolo de la rama git.
style	"bold purple"	El estilo del módulo.
truncation_length	2^63 - 1	Trunca una rama git a grafemas N.
truncation_symbol	"…"	El símbolo usado para indicar que un nombre de rama fue truncado. Puedes usar "" para ningún símbolo.
only_attached	false	Mostrar solo el nombre de la rama cuando no esté en un estado HEAD.
disabled	false	Desactiva el módulo git_branch.

Variables

Variable	Ejemplo	Descripción
rama	maestro	El nombre de la rama actual, vuelve a HEAD si no hay ninguna rama actual (por ejemplo, git detached HEAD).
remote_name	origen	El nombre remoto.
remote_branch	maestro	El nombre de la rama rastreada en remote_name.
symbol		Refleja el valor de la opción symbol
style*		Refleja el valor de la opción style

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

Ejemplo

# ~/.config/starship.toml

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

Git commit

El módulo git_commit muestra el hash de la confirmación actual y también la etiqueta (si existe) del repositorio en su directorio actual.

Opciones

Opción	Por defecto	Descripción
commit_hash_length	7	La longitud del hash del commit de git mostrado.
format	"[\\($hash$tag\\)]($style) "	El formato del módulo.
style	"bold green"	El estilo del módulo.
only_detached	true	Mostrar solo el hash de la confirmación de git cuando esté en estado "detached HEAD"
tag_disabled	true	Deshabilita mostrar información de etiquetas en el módulo git_commit.
tag_symbol	" 🏷 "	Símbolo de etiqueta prefijando la información mostrada
disabled	false	Desactiva el módulo git_commit.

Variables

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

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

Ejemplo

# ~/.config/starship.toml

[git_commit]
commit_hash_length = 4
tag_symbol = "🔖 "

Git state

El módulo git_state se mostrará en directorios que son parte de un repositorio git, y donde hay una operación en curso, tales como: REBASING, BISECTING, etc. Si hay información de progreso (por ejemplo, REBASING 3/10), esa información será mostrada también.

Opciones

Opción	Por defecto	Descripción
rebase	"REBASING"	Una cadena de formato que se muestra cuando un rebase está en progreso.
merge	"MERGING"	Una cadena de formato que se muestra cuando un merge está en progreso.
revertir	"REVERTING"	Una cadena de formato mostrada cuando un revert está en progreso.
cherry_pick	"CHERRY-PICKING"	Una cadena de formato que se muestra cuando un cherry-pick está en progreso.
bisect	"BISECTING"	Una cadena de formato que se muestra cuando un bisect está en progreso.
am	"AM"	Una cadena de formato que se muestra cuando un apply-mailbox (git am) está en progeso.
am_or_rebase	"AM/REBASE"	Una cadena de formato que se muestra cuando un ambiguo apply-builbox o rebase está en progreso.
style	"bold yellow"	El estilo del módulo.
format	'\([$state( $progress_current/$progress_total)]($style)\) '	El formato del módulo.
disabled	false	Desactiva el módulo git_state.

Variables

Variable	Ejemplo	Descripción
state	REBASING	El estado actual del repositorio
progress_current	1	El progreso de la operación actual
progress_total	2	El progreso total de la operación
style*		Refleja el valor de la opción style

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

Ejemplo

# ~/.config/starship.toml

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

Métricas de Git

El módulo git_metrics mostrará el número de líneas añadidas y eliminadas en el repositorio git actual.

::: consejo

Este módulo está deshabilitado por defecto. Para activarlo, establece disabled a false en tu archivo de configuración.

:::

Opciones

Opción	Por defecto	Descripción
added_style	"bold green"	El estilo para el recuento añadido.
deleted_style	"bold red"	El estilo para el recuento eliminado.
only_nonzero_diffs	true	Mostrar sólo el estado de los elementos cambiados.
format	'([+$added]($added_style) )([-$deleted]($deleted_style) )'	El formato del módulo.
disabled	true	Deshabilita el módulo git_metrics.

Variables

Variable	Ejemplo	Descripción
added	1	El número actual de líneas añadidas
deleted	2	El número actual de líneas eliminadas
added_style*		Refleja el valor de la opción added_style
deleted_style*		Refleja el valor de la opción 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

El módulo git_status muestra símbolos que representan el estado del repositorio en su directorio actual.

Opciones

Opción	Por defecto	Descripción
format	'([\[$all_status$ahead_behind\]]($style) )'	El formato por defecto para git_status
conflicted	"="	Esta rama tiene conflictos de fusión.
ahead	"⇡"	El formato de ahead
behind	"⇣"	El formato de behind
diverged	"⇕"	El formato de diverged
up_to_date	""	El formato de up_to_date
untracked	"?"	El formato de untracked
stashed	"$"	El formato de stashed
modificado	"!"	El formato de modified
staged	"+"	El formato de staged
renamed	"»"	El formato de renamed
eliminado	"✘"	El formato de deleted
style	"bold red"	El estilo del módulo.
disabled	false	Desactiva el módulo git_status.

Variables

Las siguientes variables se pueden utilizar en format:

Variable	Descripción
all_status	Atajo para $conflicted$stashed$deleted$renamed$modified$staged$untracked
ahead_behind	Muestra la cadena de formato de diverged ahead o behind o up_to_date basado en el estado actual del repositorio.
conflicted	Muestra conflicted cuando esta rama tiene conflictos de fusión.
untracked	Muestra untracked cuando hay archivos sin rastrear en el directorio de trabajo.
stashed	Muestra stashed cuando existe un "stash" para el repositorio local.
modificado	Muestra modified cuando hay modificaciones de archivo en el directorio de trabajo.
staged	Muestra staged cuando se ha añadido un nuevo archivo al área de "stash".
renamed	Muestra renamed cuando un archivo renombrado ha sido añadido al área de "stash".
deleted	Muestra deleted cuando un archivo ha sido añadido al área de "stash".
style*	Refleja el valor de la opción style

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

Las siguientes variables pueden ser usadas en diverged:

Variable	Descripción
ahead_count	Número de commits por delante de la rama de seguimiento
behind_count	Número de commits detrás de la rama de seguimiento

Las siguientes variales pueden ser usadas en conflicted, ahead, behind, untracked, stashed, modified, staged, renamed y 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 = "🗑"

Mostrar el recuento delante/detrás de la rama que está siendo rastreada

# ~/.config/starship.toml

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

Go

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

• El directorio actual contiene un archivo go.mod
• El directorio actual contiene un archivo go.sum
• El directorio actual contiene un archivo glide.yaml
• El directorio actual contiene un archivo Gopkg.yml
• El directorio actual contiene un archivo Gopkg.lock
• El directorio actual contiene un archivo .go-version
• El directorio actual contiene un directorio Godeps
• El directorio actual contiene un archivo con la extensión .go

Opciones

Opción	Por defecto	Descripción
format	"via [$symbol($version )]($style)"	El formato del módulo.
version_format	"v${raw}"	El formato de versión. Las variables disponibles son raw, major, minor, & patch
symbol	"🐹 "	Una cadena de formato que representa el símbolo de Go.
detect_extensions	["go"]	Qué extensiones deberían activar este módulo.
detect_files	["go.mod", "go.sum", "glide.yaml", "Gopkg.yml", "Gopkg.lock", ".go-version"]	Qué nombres de archivo deberían activar este módulo.
detect_folders	["Godeps"]	Qué carpetas deberían activar este módulo.
style	"bold cyan"	El estilo del módulo.
disabled	false	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

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

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

Opciones

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

Variables

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

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

Ejemplo

# ~/.config/starship.toml

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

Hostname

El módulo hostname muestra el nombre de host del sistema.

Opciones

Opción	Por defecto	Descripción
ssh_only	true	Mostrar sólo el nombre de host cuando esté conectado a una sesión SSH.
trim_at	"."	Cadena en la que el nombre de host se corta, después de la primera partida. "." se detendrá después del primer punto. "" deshabilitará cualquier truncamiento
format	"[$hostname]($style) in "	El formato del módulo.
style	"bold dimmed green"	El estilo del módulo.
disabled	false	Desactiva el módulo hostname.

Variables

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

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

Ejemplo

# ~/.config/starship.toml

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

Java

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

• El directorio actual contiene un archivo pom.xml, build.gradle.kts, build.sbt, .java-version, .deps.edn, project.clj, o build.boot
• El directorio actual contiene un archivo con la extensión .java, .class, .gradle o .jar, .clj o .cljc

Opciones

Opción	Por defecto	Descripción
format	"via [${symbol}(${version} )]($style)"	El formato del módulo.
version_format	"v${raw}"	El formato de versión. Las variables disponibles son raw, major, minor, & patch
detect_extensions	["java", "class", "gradle", "jar", "cljs", "cljc"]	Qué extensiones deberían activar este módulo.
detect_files	["pom.xml", "build.gradle.kts", "build.sbt", ".java-version", ".deps.edn", "project.clj", "build.boot"]	Qué nombres de archivo deberían activar este módulo.
detect_folders	[]	Qué carpetas deberían activar estos módulos.
symbol	"☕ "	Una cadena de formato que representa el símbolo de Java
style	"red dimmed"	El estilo del módulo.
disabled	false	Desactiva el módulo java.

Variables

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

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

Ejemplo

# ~/.config/starship.toml

[java]
symbol = "🌟 "

Trabajos

El módulo jobs muestra el número actual de tareas en ejecución. El módulo se mostrará sólo si hay tareas en segundo plano ejecutándose. El módulo mostrará el número de tareas ejecutados si hay al menos 2 tareas, o más del valor de configuración de number_threshold, si existe. El módulo mostrará un símbolo si hay al menos 1 tarea, o más del valor de configuración de symbol_threshold, si existe. Puedes establecer ambos valores a 0 para siempre mostrar el símbolo y el número de tareas, incluso si hay 0 tareas en ejecución.

La funcionalidad por defecto es:

• 0 tareas -> Nada se muestra.
• 1 tarea -> symbol se muestra.
• 2 tareas o más -> symbol + number son mostrados.

::: aviso

Este módulo no está soportado por tcsh y nu.

:::

::: aviso

La opción threshold está obsoleta, pero si deseas usarla, el módulo mostrará el número de tareas en ejecución si hay más de 1 tarea, o más que el valor de configuración threshold, si existe. Si threshold se establece en 0, entonces el módulo también se mostrará cuando haya 0 tareas en ejecución.

:::

Opciones

Opción	Por defecto	Descripción
threshold*	1	Muestra el número de tareas si se exceden.
symbol_threshold	1	Muestra symbol si el conteo de tareas es al menos symbol_threshold.
number_threshold	2	Muestra el número de tareas si el conteo de tareas es al menos symbol_threshold.
format	"[$symbol$number]($style) "	El formato del módulo.
symbol	"✦"	La cadena utilizada para representar la variable symbol.
style	"bold blue"	El estilo del módulo.
disabled	false	Desactiva el módulo jobs.
*: Esta opción está desaprobada, por favor utiliza las opciones

number_threshold y symbol_threshold en su lugar.

Variables

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

*: Esta variable 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

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

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

Opciones

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

Variables

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

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

Ejemplo

# ~/.config/starship.toml

[julia]
symbol = "∴ "

Kotlin

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

• 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	"🅺 "	Una cadena de formato que representa el símbolo de Kotlin.
style	"bold blue"	El estilo del módulo.
kotlin_binary	"kotlin"	Configura el binario kotlin que Starship ejecuta al obtener la versión.
disabled	false	Deshabilita el módulo kotlin.

Variables

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

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

Ejemplo

# ~/.config/starship.toml

[kotlin]
symbol = "🅺 "

# ~/.config/starship.toml

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

Kubernetes

Muestra el nombre actual del contexto de Kubernetes y, si se establece, el espacio de nombres del archivo kubeconfig. El espacio de nombres necesita establecerse en el archivo kubeconfig, esto puede hacerse mediante kubectl config set-context starship-cluster --namespace astronaut. Si se establece la variable de entorno $KUBECONFIG, el módulo usará eso si no usará el ~/.kube/config.

::: consejo

Este módulo está deshabilitado por defecto. Para activarlo, establece disabled a false en tu archivo de configuración.

:::

Opciones

Opción	Por defecto	Descripción
symbol	"☸ "	Una cadena de formato que representa el símbolo mostrado antes del Cluster.
format	'[$symbol$context( \($namespace\))]($style) in '	El formato del módulo.
style	"cyan bold"	El estilo del módulo.
context_aliases		Tabla de alias de contexto a mostrar.
disabled	true	Desactiva el módulo kubernetes.

Variables

Variable	Ejemplo	Descripción
context	starship-cluster	El contexto actual de kubernetes
namespace	starship-namespace	Si se establece, el espacio de nombres actual de kubernetes
symbol		Refleja el valor de la opción symbol
style*		Refleja el valor de la opción style

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

Ejemplo

# ~/.config/starship.toml

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

Busqueda por Regex

Adicional al alias simple, context_aliases también soporta coincidencias extendidas y renombradas usando expresiones regulares.

La expresión regular debe coincidir en todo el contexto de kube. los grupos de captura pueden ser referenciados usando $name y $N en el reemplazo. Esto está más explicado en la documentación del crate regex.

Los nombres de cluster generados de forma larga y automática pueden ser identificados y abreviados usando expresiones regulares:

[kubernetes.context_aliases]
# los contextos de OpenShift llevan el espacio de nombres y el usuario en el contexto de kube: `namespace/name/user`:
".*/openshift-cluster/.*" = "openshift"
# Or better, to rename every OpenShift cluster at once:
".*/(?P<cluster>[\\w-]+)/.*" = "$cluster"

# Los contextos de GKE, AWS y otros proveedores de nube normalmente llevan información adicional, como la región/zona.
# La siguiente entrada coincide con el formato GKE (`gke_projectname_zone_cluster-name`)
# y renombra cada contexto de kube coincidente a un formato más legible (`gke-cluster-name`):
"gke_.*_(?P<cluster>[\\w-]+)" = "gke-$cluster"

Salto de línea

El módulo line_break separa el indicador en dos líneas.

Opciones

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

Ejemplo

# ~/.config/starship.toml

[line_break]
disabled = true

Lua

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

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

Opciones

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

Variables

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

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

Ejemplo

# ~/.config/starship.toml

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

Memoria utilizada

El módulo memory_usage muestra la memoria del sistema actual y el uso de memoria de intercambio.

Por defecto, el uso de swap se muestra si el intercambio total del sistema no es cero.

::: consejo

Este módulo está deshabilitado por defecto. Para activarlo, establece disabled a false en tu archivo de configuración.

:::

Opciones

Opción	Por defecto	Descripción
threshold	75	Ocultar el uso de memoria a menos que supere este porcentaje.
format	"via $symbol [${ram}( | ${swap})]($style) "	El formato del módulo.
symbol	"🐏"	El símbolo usado antes de mostrar el uso de memoria.
style	"bold dimmed white"	El estilo del módulo.
disabled	true	Desactiva el módulo memory_usage.

Variables

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

*: Esta variable sólo puede utilizarse como parte de una cadena de estilo **: La información del archivo SWAP sólo se muestra si se detecta en el sistema actual

Ejemplo

# ~/.config/starship.toml

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

Mercurial Branch

El módulo hg_branch muestra la rama activa del repositorio en su directorio actual.

Opciones

Opción	Por defecto	Descripción
symbol	" "	El símbolo usado antes del marcador hg o nombre de la rama del repositorio en su directorio actual.
style	"bold purple"	El estilo del módulo.
format	"on [$symbol$branch]($style) "	El formato del módulo.
truncation_length	2^63 - 1	Trunca el nombre de la rama hg a N grafemas
truncation_symbol	"…"	El símbolo usado para indicar que un nombre de rama fue truncado.
disabled	true	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

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

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

Opciones

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

Variables

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

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

Ejemplo

# ~/.config/starship.toml

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

Nix-shell

El módulo nix_shell muestra el entorno nix-shell. El módulo se mostrará dentro de un entorno nix-shell.

Opciones

Opción	Por defecto	Descripción
format	'via [$symbol$state( \($name\))]($style) '	El formato del módulo.
symbol	"❄️ "	Una cadena de formato que representa el símbolo de nix-shell.
style	"bold blue"	El estilo del módulo.
impure_msg	"impure"	Una cadena de formato que se muestra cuando el intérprete de comandos es impuro.
pure_msg	"pure"	Una cadena de formato que se muestra cuando el intérprete de comandos es puro.
disabled	false	Desactiva el módulo nix_shell.

Variables

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

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

Ejemplo

# ~/.config/starship.toml

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

Node.js

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

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

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 Node.js.
detect_extensions	["js", "mjs", "cjs", "ts"]	Qué extensiones deberían activar este módulo.
detect_files	["package.json", ".node-version"]	Qué nombres de archivo deberían activar este módulo.
detect_folders	["node_modules"]	Qué carpetas deberían activar este módulo.
style	"bold green"	El estilo del módulo.
disabled	false	Desactiva el módulo nodejs.
not_capable_style	bold red	El estilo para el módulo cuando una propiedad de motores en package.json no coincide con la versión de Node.js.

Variables

Variable	Ejemplo	Descripción
version	v13.12.0	La versión de node
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

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

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

Opciones

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

Variables

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

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

Ejemplo

# ~/.config/starship.toml

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

OpenStack

El módulo openstack muestra la nube OpenStack actual y el proyecto. El módulo solo está activo cuando la variable env OS_CLOUD está definida en cuyo caso leerá el archivo nubes. aml desde cualquiera de las ubicaciones por defecto para obtener el proyecto actual en uso.

Opciones

Opción	Por defecto	Descripción
format	"on [$symbol$cloud(\\($project\\))]($style) "	El formato del módulo.
symbol	"☁️ "	El símbolo usado antes de mostrar la nube OpenStack actual.
style	"bold yellow"	El estilo del módulo.
disabled	false	Deshabilita el módulo openstack.

Variables

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

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

Ejemplo

# ~/.config/starship.toml

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

Versión del paquete

El módulo package se muestra cuando el directorio actual es el repositorio de un paquete, y muestra su versión actual. The module currently supports npm, nimble, cargo, poetry, composer, gradle, julia, mix, helm and shards packages.

• npm – La versión del paquete npm se extrae del package.json presente en el directorio actual
• Cargo – La versión del paquete cargo se extrae del Cargo.toml presente en el directorio actual
• Nimble - La versión del paquete nimble se extrae del archivo *.nimble presente en el directorio actual con el comando nimble dump
• Poetry – La versión del paquete poetry se extrae del pyproject.toml presente en el directorio actual
• Python – La versión del paquete python se extrae del setup.cfg presente en el directorio actual
• Composer – La versión del paquete composer se extrae del composer.json presente en el directorio actual
• Gradle – La versión del paquete gradle se extrae del build.gradle presente en directorio actual
• Julia - La versión del paquete se extrae del Project.toml presente en el directorio actual
• Mix - La versión del paquete mix se extrae del mix.exs presente en el directorio actual
• Help - La versión del paquete helm se extrae del Chart.yaml presente en el directorio actual
• Maven - La versión de paquete maven se extrae del pom.xml presente en el directorio actual
• Meson - La versión del paquete meson se extrae del meson.build presente en el directorio actual
• Shards - The shards package version is extracted from the shard.yml 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	"📦 "	El símbolo usado antes de mostrar la versión del paquete.
version_format	"v${raw}"	El formato de versión. Las variables disponibles son raw, major, minor, & patch
style	"bold 208"	El estilo del módulo.
display_private	false	Activar la visualización de la versión para los paquetes marcados como privados.
disabled	false	Desactiva el módulo package.

Variables

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

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

Ejemplo

# ~/.config/starship.toml

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

Perl

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

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

Opciones

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

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

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

Opciones

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

Variables

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

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

Ejemplo

# ~/.config/starship.toml

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

Pulumi

El módulo pulumi muestra la pila Pulumi y la versión seleccionados actualmente.

::: consejo

Por defecto la versión de Pulumi no se muestra, ya que toma un orden de magnitud más largo para cargar que la mayoría de los plugins (~70ms). Si aún deseas activarlo, sigue el ejemplo que se muestra a continuación.

:::

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

• El directorio actual contiene Pulumi.yaml o Pulumi.yml
• Un directorio padre contiene Pulumi.yaml o Pulumi.yml

Opciones

Opción	Por defecto	Descripción
format	"via [$symbol$stack]($style) "	La cadena de formato para el módulo.
version_format	"v${raw}"	El formato de versión. Las variables disponibles son raw, major, minor, & patch
symbol	" "	Una cadena de formato que se muestra antes de la pila de Pulumi.
style	"bold 5"	El estilo del módulo.
disabled	false	Deshabilita el módulo pulumi.

Variables

Variable	Ejemplo	Descripción
version	v0.12.24	La versión de pulumi
stack	dev	La pila actual de Pulumi
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

Con la versión de Pulumi

# ~/.config/starship.toml

[pulumi]
format = "[🛥 ($version )$stack]($style) "

Sin versión de Pulumi

# ~/.config/starship.toml
[pulumi]
symbol = "🛥 "
format = "[$symbol$stack]($style) "

PureScript

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

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

Opciones

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

Variables

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

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

Ejemplo

# ~/.config/starship.toml

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

Python

El módulo python muestra la versión instalada de Python y el entorno virtual actual Python si uno está activado.

Si pyenv_version_name se establece en true, mostrará el nombre de la versión de pyenv. De lo contrario, se mostrará el número de versión de python --version.

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

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

Opciones

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

::: consejo

La variable python_binary acepta una cadena o una lista de cadenas. Starship intentará ejecutar cada binario hasta que obtenga un resultado. Ten en cuenta que sólo puedes cambiar el binario que Starship ejecuta para obtener la versión de Python no los argumentos que se utilizan.

Los valores por defecto y el orden para python_binary fue elegido para identificar primero la versión de Python en un entorno virtualenv/conda (que actualmente añade un python, no importa si apunta a python3 o python2). Esto tiene el efecto secundario que si todavía tienes un sistema de Python 2 instalado, puede ser recogido antes de cualquier Python 3 (al menos en las Distros de Linux que siempre enlazan /usr/bin/python a Python 2). Si ya no trabajas con Python 2 pero no puedes removerlo del sistema, cambiando esto a "python3" ocultará cualquier versión de Python 2, ver ejemplo a continuación.

:::

Variables

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

Ejemplo

# ~/.config/starship.toml

[python]
symbol = "👾 "
pyenv_version_name = true

# ~/.config/starship.toml

[python]
# Solo usa el binario `python3` para obtener la versión.
python_binary = "python3"

# ~/.config/starship.toml

[python]
# No se dispara con archivos con extensión py
detect_extensions = []

# ~/.config/starship.toml

[python]
# Muestra la versión de python desde dentro de un entorno virtual local.
#
# Ten en cuenta que esto solo funcionará cuando el venv esté dentro del proyecto y sólo
# funcionará en el directorio que contiene el directorio venv dir pero ¿tal vez esté bien?
python_binary = ["./venv/bin/python", "python", "python3", "python2"]

R

El módulo rlang muestra la versión instalada de R. El módulo se mostrará si se cumplen cualquiera de las siguientes condiciones:

• El directorio actual contiene un archivo con la extensión .R.
• El directorio actual contiene un archivo con la extensión .Rd.
• El directorio actual contiene un archivo con la extensión .Rmd.
• El directorio actual contiene un archivo con la extensión .Rproj.
• El directorio actual contiene un archivo con la extensión .Rsx.
• El directorio actual contiene un archivo .Rprofile
• El directorio actual contiene una carpeta .Rproj.user

Opciones

Opción	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 R.
style	"blue bold"	El estilo del módulo.
detect_extensions	["R", "Rd", "Rmd", "Rproj", "Rsx"]	Qué extensiones deben activar este módulo
detect_files	[".Rprofile"]	Qué nombres de archivo deben activar este módulo
detect_folders	[".Rproj.user"]	Qué carpetas deben activar este módulo
disabled	false	Deshabilita el módulo r.

Variables

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

Ejemplo

# ~/.config/starship.toml

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

Red

Por defecto, el módulo red muestra la versión actualmente instalada de Red. El módulo se mostrará si se cumplen alguna de las siguientes condiciones:

• El directorio actual contiene un archivo con extensión .red o .Red

Opciones

Opción	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 Red.
detect_extensions	["red"]	Qué extensiones deberían activar este módulo.
detect_files	[]	Qué nombres de archivo deberían activar este módulo.
detect_folders	[]	Qué carpetas deberían activar este módulo.
style	"red bold"	El estilo del módulo.
disabled	false	Deshabilita el módulo rojo.

Variables

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

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

Ejemplo

# ~/.config/starship.toml

[red]
symbol = "🔴 "

Ruby

Por defecto, el módulo ruby muestra la versión actualmente instalada de Ruby. El módulo se mostrará si se cumplen alguna de las siguientes condiciones:

• El directorio actual contiene un archivo Gemfile
• El directorio actual contiene un archivo .ruby-version
• El directorio actual contiene un archivo .rb
• The environment variables RUBY_VERSION or RBENV_VERSION are set

Starship gets the current Ruby version by running ruby -v.

Opciones

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

Variables

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

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

Ejemplo

# ~/.config/starship.toml

[ruby]
symbol = "🔺 "

Rust

By default the rust module shows the currently installed version of Rust. El módulo se mostrará si se cumplen alguna de las siguientes condiciones:

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

Opciones

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

Variables

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

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

Ejemplo

# ~/.config/starship.toml

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

Scala

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

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

Opciones

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

Variables

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

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

Ejemplo

# ~/.config/starship.toml

[scala]
symbol = "🌟 "

Shell

The shell module shows an indicator for currently used shell.

::: consejo

Este módulo está deshabilitado por defecto. Para activarlo, establece disabled a false en tu archivo de configuración.

:::

Opciones

Opción	Por defecto	Descripción
bash_indicator	bsh	Una cadena de formato usada para representar bash.
fish_indicator	fsh	Una cadena de formato usada para representar fish.
zsh_indicator	zsh	Una cadena de formato usada para representar zsh.
powershell_indicator	psh	Una cadena de formato usada para representar powershell.
ion_indicator	ion	Una cadena de formato usada para representar ion.
elvish_indicator	esh	Una cadena de formato usada para representar elvish.
tcsh_indicator	tsh	Una cadena de formato usada para representar tcsh.
xonsh_indicator	xsh	Una cadena de formato usada para representar xonsh.
unknown_indicator		El valor por defecto que se mostrará cuando se desconoce el intérprete.
format	"[$indicator]($style) "	El formato del módulo.
style	"white bold"	El estilo del módulo.
disabled	true	Deshabilita el módulo shell.

Variables

Variable	Por defecto	Descripción
indicator		Refleja el valor de indicator para el intérprete de comandos actualmente utilizado.
style*		Refleja el valor de la opción style.

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

Ejemplos

# ~/.config/starship.toml

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

SHLVL

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

Opciones

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

Variables

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

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

Ejemplo

# ~/.config/starship.toml

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

Singularity

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

Opciones

Opción	Por defecto	Descripción
format	'[$symbol\[$env\]]($style) '	El formato del módulo.
symbol	""	Una cadena de formato que se muestra antes del nombre de la imagen.
style	"bold dimmed blue"	El estilo del módulo.
disabled	false	Deshabilita el módulo de singularity.

Variables

Variable	Ejemplo	Descripción
env	centos.img	La imagen de Singularity actual
symbol		Refleja el valor de la opción symbol
style*		Refleja el valor de la opción style

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

Ejemplo

# ~/.config/starship.toml

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

Status

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

::: consejo

Este módulo está deshabilitado por defecto. Para activarlo, establece disabled a false en tu archivo de configuración.

:::

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

Opciones

Opción	Por defecto	Descripción
format	"[$symbol$status]($style) "	El formato del módulo
symbol	"✖"	El símbolo mostrado en el error del programa
success_symbol	"✔️"	El símbolo mostrado en el éxito del programa
not_executable_symbol	"🚫"	El símbolo mostrado cuando el archivo no es ejecutable
not_found_symbol	"🔍"	El símbolo mostrado cuando no se encuentra el comando
sigint_symbol	"🧱"	El símbolo mostrado en SIGINT (Ctrl + c)
signal_symbol	"⚡"	El símbolo mostrado en cualquier señal
style	"bold red"	El estilo del módulo.
recognize_signal_code	true	Habilita el mapeo de señales desde el código de salida
map_symbol	false	Habilita el mapeo de símbolos desde el código de salida
pipestatus	false	Habilita el reporte de pipstatus
pipestatus_separator	`	`
pipestatus_format	\\[$pipestatus\\] => [$symbol$common_meaning$signal_name$maybe_int]($style)	El formato del módulo cuando el comando es un pipeline
disabled	true	Deshabilita el módulo status.

Variables

Variable	Ejemplo	Descripción
status	127	El código de salida del último comando
int	127	El código de salida del último comando
common_meaning	ERROR	Comprobación del código si no es una señal
signal_number	9	Número de señal correspondiente al código de salida, sólo si está señalizado
signal_name	KILL	Nombre de la señal correspondiente al código de salida, sólo si está señalizada
maybe_int	7	Contiene el número de código de salida cuando no se ha encontrado ningún significado
pipestatus		Renderizado en los códigos de salida de los programas del pipeline, esto sólo está disponible en 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. El módulo se mostrará si se cumplen alguna de las siguientes condiciones:

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

Opciones

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

Variables

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

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

Ejemplo

# ~/.config/starship.toml

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

Terraform

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

::: consejo

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

:::

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

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

Opciones

Opción	Por defecto	Descripción
format	"via [$symbol$workspace]($style) "	La cadena de formato para el módulo.
version_format	"v${raw}"	El formato de versión. Las variables disponibles son raw, major, minor, & patch
symbol	"💠"	Una cadena de formato que se muestra antes del espacio de trabajo de terraform.
detect_extensions	["tf", "tfplan", "tfstate"]	Qué extensiones deberían activar este módulo.
detect_files	[]	Qué nombres de archivo deberían activar este módulo.
detect_folders	[".terraform"]	Qué carpetas deberían activar este módulo.
style	"bold 105"	El estilo del módulo.
disabled	false	Deshabilita el módulo terraform.

Variables

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

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

Ejemplo

Con la versión de Terraform

# ~/.config/starship.toml

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

Sin la versión de Terraform

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

Este módulo está deshabilitado por defecto. Para activarlo, establece disabled a false en tu archivo de configuración.

:::

Opciones

Opción	Por defecto	Descripción
format	"at [$time]($style) "	La cadena de formato para el módulo.
use_12hr	false	Habilita el formato de 12 horas
time_format	ver abajo	La cadena de formato de chrono utilizada para formatear la hora.
style	"bold yellow"	El estilo para la hora del módulo
utc_time_offset	"local"	Establece el desplazamiento UTC a utilizar. Rango de -24 < x < 24. Permite a los flotantes acomodar los desplazamientos de zona horaria de 30/45 minutos.
disabled	true	Deshabilita el módulo time.
time_range	"-"	Establece el intervalo de tiempo durante el cual el módulo se mostrará. La hora debe ser especificada en formato de 24 horas

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

Variables

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

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

Ejemplo

# ~/.config/starship.toml

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

Username

The username module shows active user's username. El módulo se mostrará si se cumplen alguna de las siguientes condiciones:

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

::: consejo

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

:::

Opciones

Opción	Por defecto	Descripción
style_root	"bold red"	El estilo usado cuando el usuario es root.
style_user	"bold yellow"	El estilo usado para usuarios no root.
format	"[$user]($style) in "	El formato del módulo.
show_always	false	Siempre muestra el módulo username.
disabled	false	Deshabilita el módulo username.

Variables

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

Ejemplo

# ~/.config/starship.toml

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

Vagrant

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

• El directorio actual contiene un archivo Vagrantfile

Opciones

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

Variables

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

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

Ejemplo

# ~/.config/starship.toml

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

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:

• El directorio actual contiene un archivo con la extensión .v
• El directorio actual contiene un archivo v.mod, vpkg.json o .vpkg-lock.json

Opciones

Opción	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 "	Una cadena de formato que representa el símbolo de V
detect_extensions	["v"]	Qué extensiones deberían activar este módulo.
detect_files	["v.mod", "vpkg.json", ".vpkg-lock.json" ]	Qué nombres de archivo deberían activar este módulo.
detect_folders	[]	Qué carpetas deberían activar este módulo.
style	"blue bold"	El estilo del módulo.
disabled	false	Deshabilita el módulo vlang.

Variables

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

Ejemplo

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

Variables

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

*: Esta variable 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. El módulo se mostrará si se cumplen alguna de las siguientes condiciones:

• El directorio actual contiene un archivo .zig

Opciones

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

Variables

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

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

Ejemplo

# ~/.config/starship.toml

[zig]
symbol = "⚡️ "

Comandos personalizados

The custom modules show the output of some arbitrary commands.

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

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

::: consejo

Multiple custom modules can be defined by using a ..

:::

::: consejo

The order in which custom modules are shown can be individually set by including ${custom.foo} in the top level format (as it includes a dot, you need to use ${...}). By default, the custom module will simply show all custom modules in the order they were defined.

:::

::: consejo

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

:::

::: warning Command output is printed unescaped to the prompt

Whatever output the command generates is printed unmodified in the prompt. This means if the output contains special sequences that are interpreted by your shell they will be expanded when displayed. These special sequences are shell specific, e.g. you can write a command module that writes bash sequences, e.g. \h, but this module will not work in a fish or zsh shell.

Format strings can also contain shell specific prompt sequences, e.g. Bash, Zsh.

:::

Opciones

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

Variables

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

*: Esta variable 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:

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

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

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"  # muestra la salida del comando
files = ["foo"]       # se puede especificar filtros pero los wildcards no son soportados
when = """ test "$HOME" == "$PWD" """
format = " transcending [$output]($style)"

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