96 KiB
Configuración
::: tip
🔥 Este apartado está bajo construcción. Habrá nuevas opciones de configuración disponibles en próximas versiones.
:::
Para iniciar la configuración de starship, crea el siguiente fichero: ~/.config.toml
.
mkdir -p ~/.config && touch ~/.config/starship.toml
Toda la configuración de starship se incluye en este fichero TOML:
# Don't print a new line at the start of the prompt
add_newline = false
# Replace the "❯" symbol in the prompt with "➜"
[character] # The name of the module we are configuring is "character"
success_symbol = "[➜](bold green)" # The "success_symbol" segment is being set to "➜" with the color "bold green"
# Disable the package module, hiding it from the prompt completely
[package]
disabled = true
Puedes modificar la ubicación por defecto del fichero starship.toml
con la variable de entorno STARSHIP_CONFIG
:
export STARSHIP_CONFIG=~/.starship
El equivalente en PowerShell (Windows) es añadir esta línea a tu $PROFILE
:
$ENV:STARSHIP_CONFIG = "$HOME\.starship"
Terminología
Módulo: un componente en el símbolo de sistema que provee de 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: Smaller sub-components that contains information provided by the module. For example, the "version" variable in the "nodejs" module contains the current version of NodeJS.
By convention, most modules have a prefix of default terminal color (e.g. via
in "nodejs") and an empty space as a suffix.
Format Strings
Format strings are the format that a module prints all its variables with. Most modules have an entry called format
that configures the display format of the module. You can use texts, variables and text groups in a format string.
Variable
A variable contains a $
symbol followed by the name of the variable. The name of a variable only contains letters, numbers and _
.
For example:
$version
is a format string with a variable namedversion
.$git_branch$git_commit
is a format string with two variables namedgit_branch
andgit_commit
.$git_branch $git_commit
has the two variables separated with a space.
Text Group
A text group is made up of two different parts.
The first part, which is enclosed in a []
, is a format string. You can add texts, variables, or even nested text groups in it.
In the second part, which is enclosed in a ()
, is a style string. This can be used style the first part.
For example:
[on](red bold)
will print a stringon
with bold text colored red.[⬢ $version](bold green)
will print a symbol⬢
followed by the content of variableversion
, with bold text colored green.[a [b](red) c](green)
will printa b c
withb
red, anda
andc
green.
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 textos estilados 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.
Conditional Format Strings
A conditional format string wrapped in (
and )
will not render if all variables inside are empty.
For example:
(@$region)
will show nothing if the variableregion
isNone
, otherwise@
followed by the value of region.(some text)
will always show nothing since there are no variables wrapped in the braces.- When
$all
is a shortcut for\[$a$b\]
,($all)
will show nothing only if$a
and$b
are bothNone
. This works the same as(\[$a$b\] )
.
Escapable characters
The following symbols have special usage in a format string. If you want to print the following symbols, you have to escape them with a backslash (\
).
- $
- \
- [
- ]
- (
- )
Note that toml
has its own escape syntax. It is recommended to use a literal string (''
) in your config. If you want to use a basic string (""
), pay attention to escape the backslash \
.
For example, when you want to print a $
symbol on a new line, the following configs for format
are equivalent:
# with basic string
format = "\n\\$"
# with multiline basic string
format = """
\\$"""
# with literal string
format = '''
\$'''
Símbolo del sistema
Esta es la lista de opciones de configuración.
Opciones
Option | Por defecto | Descripción |
---|---|---|
format |
link | Configure the format of the prompt. |
scan_timeout |
30 |
Tiempo de espera tras el que starship escanea archivos (en milisegundos). |
Ejemplo
# ~/.config/starship.toml
# Disable the newline at the start of the prompt
format = "$all"
# Use custom format
format = """
[┌───────────────────>](bold green)
[│](bold green)$directory$rust$package
[└─>](bold green) """
# Wait 10 milliseconds for starship to check files under the current directory.
scan_timeout = 10
Default Prompt Format
The default format
is used to define the format of the prompt, if empty or no format
is provided. El valor por defecto es el siguiente:
format = "\n$all"
# Which is equivalent to
format = """
$username\
$hostname\
$kubernetes\
$directory\
$git_branch\
$git_commit\
$git_state\
$git_status\
$hg_branch\
$docker_context\
$package\
$cmake\
$dotnet\
$elixir\
$elm\
$erlang\
$golang\
$helm\
$java\
$julia\
$nim\
$nodejs\
$ocaml\
$php\
$purescript\
$python\
$ruby\
$rust\
$terraform\
$zig\
$nix_shell\
$conda\
$memory_usage\
$aws\
$env_var\
$crystal\
$cmd_duration\
$custom\
$line_break\
$jobs\
$battery\
$time\
$character"""
AWS
El módulo aws
muestra la región actual de AWS y el perfil. Éste se basa en las variables de entorno AWS_REGION
, AWS_DEFAULT_REGION
, y AWS_PROFILE
del fichero ~/.aws/config
.
Cuando uses aws-vault el perfil se obtiene de la variable de entorno AWS_VAULT
.
Opciones
Option | Por defecto | Descripción |
---|---|---|
format |
"on [$symbol$profile(\\($region\\))]($style) " |
The format for the module. |
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. |
disabled |
false |
Desactiva el módulo AWS. |
Variables
Variable | Ejemplo | Descripción |
---|---|---|
region | ap-northeast-1 |
The current AWS region |
profile | astronauts |
The current AWS profile |
symbol | Mirrors the value of option symbol |
|
style* | Mirrors the value of option style |
*: This variable can only be used as a part of a style string
Examples
Display everything
# ~/.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"
Display region
# ~/.config/starship.toml
[aws]
format = "on [$symbol$region]($style) "
style = "bold blue"
symbol = "🅰 "
[aws.region_aliases]
ap-southeast-2 = "au"
us-east-1 = "va"
Display profile
# ~/.config/starship.toml
[aws]
format = "on [$symbol$profile]($style) "
style = "bold blue"
symbol = "🅰 "
Battery
El módulo battery
muestra la cantidad de batería y si está cargando o no. El módulo es solo visible cuando la batería está por debajo del 10%.
Opciones
Option | Por defecto | Descripción |
---|---|---|
full_symbol |
"•" |
Se muestra cuando la batería está cargada. |
charging_symbol |
"⇡" |
Se muestra cuando la batería está cargando. |
discharging_symbol |
"⇣" |
Se muestra cuando la batería se está descargando. |
format |
"[$symbol$percentage]($style) " |
The format for the module. |
display |
link | Define cuándo mostrar el indicador y el estilo. |
disabled |
false |
Desactiva el módulo battery . |
Hay otras opciones para algunos estados de la batería menos comunes.
Variable | Descripción |
---|---|
unknown_symbol |
The symbol shown when the battery state is unknown. |
empty_symbol |
The symbol shown when the battery state is empty. |
Note: Battery indicator will be hidden if the status is unknown
or empty
unless you specify the option in the config.
Ejemplo
# ~/.config/starship.toml
[battery]
full_symbol = "🔋"
charging_symbol = "⚡️"
discharging_symbol = "💀"
Indicador de batería
La configuración de la opción display
es usada para definir cuándo se debe mostrar el indicador de batería y cómo debe mostrarse. Si no se provee ningún valor para display
El valor por defecto es el siguiente:
[[battery.display]]
threshold = 10
style = "bold red"
Opciones
La opción display
es un array de la siguiente tabla.
Variable | Descripción |
---|---|
threshold |
El umbral para la opción de visualización. |
style |
El estilo usado cuando si la opción <0>display</0> está activa. |
Ejemplo
[[battery.display]] # "bold red" cuando la carga está entre 0% y 10%
threshold = 10
style = "bold red"
[[battery.display]] # "bold yellow" cuando la carga está entre 10% y 30%
threshold = 30
style = "bold yellow"
# cuando la carga está por encima del 30% el indicador no se mostrará
Character
El módulo character
muestra un carater (normalmente una flecha) tras el texto que introduces en el terminal.
El carácter te dirá si el último comando funcionó o no. It can do this in two ways:
- changing color (
red
/green
) - changing shape (
❯
/✖
)
By default it only changes color. If you also want to change it's shape take a look at this example.
Opciones
Option | Por defecto | Descripción |
---|---|---|
format |
"$symbol " |
The format string used before the text input. |
success_symbol |
"[❯](bold green)" |
The format string used before the text input if the previous command succeeded. |
error_symbol |
"[❯](bold red)" |
The format string used before the text input if the previous command failed. |
vicmd_symbol |
"[❮](bold green)" |
The format string used before the text input if the shell is in vim normal mode. |
disabled |
false |
Desactiva el módulo character . |
Variables
Variable | Ejemplo | Descripción |
---|---|---|
symbol | A mirror of either success_symbol , error_symbol or vicmd_symbol |
Examples
With custom error shape
# ~/.config/starship.toml
[character]
success_symbol = "[➜](bold green) "
error_symbol = "[✗](bold red) "
Without custom error shape
# ~/.config/starship.toml
[character]
success_symbol = "[➜](bold green) "
error_symbol = "[➜](bold red) "
With custom vim shape
# ~/.config/starship.toml
[character]
vicmd_symbol = "[V](bold green) "
CMake
The cmake
module shows the currently installed version of CMake if:
- The current directory contains a
CMakeLists.txt
file
Opciones
Option | Por defecto | Descripción |
---|---|---|
format |
"via [$symbol$version]($style) " |
The format for the module. |
symbol |
"🛆 " |
The symbol used before the version of cmake. |
style |
"bold blue" |
El estilo del módulo. |
disabled |
false |
Disables the cmake module. |
Variables
Variable | Ejemplo | Descripción |
---|---|---|
version | v3.17.3 |
The version of cmake |
symbol | Mirrors the value of option symbol |
|
style* | Mirrors the value of option style |
*: This variable can only be used as a part of a style string
Tiempo de ejecución
El módulo cmd_duration
muestra cuánto tiempo tardó el último comando en ejecutarse. El módulo se mostrará solo si el comando llevó dos segundos o más, o el valor de min_time
, si existe.
::: warning No utilizar DEBUG en Bash
Si estás usando Starship con bash
, no uses DEBUG
después de ejecutar eval $(starship init $0)
, o el módulo se romperá.
:::
Los usuarios de bash que necesiten la funcionalidad preexec-like pueden usar el framework rcaloras's bash_preexec. Simplemente define los arrays preexec_functions y precmd_functions antes de ejecutar eval $(starship init $0), y continúa con normalidad. Basta con definir los arrays preexec_functions
y precmd_functions
antes de ejecutar eval $(starship init $0)
, y luego proceder como siempre.
Opciones
Option | Por defecto | Descripción |
---|---|---|
min_time |
2_000 |
Duración mínima para mostrar el tiempo de ejecución (en milisegundos) |
show_milliseconds |
false |
Muestra la duración con precisión en milisegundos. |
format |
"took [$duration]($style) " |
The format for the module. |
style |
"bold yellow" |
El estilo del módulo. |
disabled |
false |
Desactiva el módulo cmd_duration . |
Variables
Variable | Ejemplo | Descripción |
---|---|---|
duration | 16m40s |
The time it took to execute the command |
style* | Mirrors the value of option style |
*: This variable can only be used as a part of a style string
Ejemplo
# ~/.config/starship.toml
[cmd_duration]
min_time = 500
format = "underwent [$duration](bold yellow)"
Conda
El módulo conda
muestra el actual entorno conda, si la variable $CONDA_DEFAULT_ENV
existe.
::: tip
Esto no modifica el propio símbolo de sistema de conda. En caso de querer suprimirlo, ejecuta conda config --set changeps1 False
.
:::
Opciones
Option | Por defecto | Descripción |
---|---|---|
truncation_length |
1 |
El número de directorios a los que se debe truncar la variable de entorno, si el entorno fue creado usando conda create -p [path] . 0 significa sin truncamiento. Mirar también el módulo directory . |
symbol |
"🅒 " |
El símbolo usado antes del nombre del entorno. |
style |
"bold green" |
El estilo del módulo. |
format |
"[$symbol$environment]($style) " |
The format for the module. |
disabled |
false |
Desactiva el módulo conda . |
Variables
Variable | Ejemplo | Descripción |
---|---|---|
environment | astronauts |
The current conda environment |
symbol | Mirrors the value of option symbol |
|
style* | Mirrors the value of option style |
*: This variable can only be used as a part of a style string
Ejemplo
# ~/.config/starship.toml
[conda]
format = "[$symbol$environment](dimmed green) "
Crystal
El módulo crystal
muestra la versión actual de Crystal. El módulo se muestra si algunas de las siguientes condiciones se cumplen:
- El directorio actual contiene un fichero
shard.yml
- El directorio actual contiene un fichero
.cr
Opciones
Option | Por defecto | Descripción |
---|---|---|
symbol |
"🔮 " |
Símbolo usado antes de la versión de Crystal. |
style |
"bold red" |
El estilo del módulo. |
format |
"via [$symbol$version]($style) " |
The format for the module. |
disabled |
false |
Desactiva el módulo crystal . |
Variables
Variable | Ejemplo | Descripción |
---|---|---|
version | v0.32.1 |
The version of crystal |
symbol | Mirrors the value of option symbol |
|
style* | Mirrors the value of option style |
*: This variable can only be used as a part of a style string
Ejemplo
# ~/.config/starship.toml
[crystal]
format = "via [✨ $version](bold blue) "
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
Variable | 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)[$lock_symbol]($lock_style) " |
The format for the module. |
style |
"bold cyan" |
El estilo del módulo. |
disabled |
false |
Desactiva el módulo directory . |
read_only_symbol |
"🔒" |
The symbol indicating current directory is read only. |
read_only_symbol_style |
"red" |
The style for the read only symbol. |
Este módulo tiene algunas opciones avanzadas de configuración que controlan cómo se muestra el directorio.
Advanced Option | Por defecto | Descripción |
---|---|---|
substitutions |
A table of substitutions to be made to the path. | |
fish_style_pwd_dir_length |
0 |
The number of characters to use when applying fish shell pwd path logic. |
use_logical_path |
true |
Displays the logical path provided by the shell (PWD ) instead of the path from the OS. |
substitutions
allows you to define arbitrary replacements for literal strings that occur in the path, for example long network prefixes or development directories (i.e. Java). Note that this will disable the fish style PWD.
[directory.substitutions]
"/Volumes/network/path" = "/net"
"src/com/long/java/path" = "mypath"
fish_style_pwd_dir_length
interacts with the standard truncation options in a way that can be surprising at first: if it's non-zero, the components of the path that would normally be truncated are instead displayed with that many characters. For example, the path /built/this/city/on/rock/and/roll
, which would normally be displayed as as rock/and/roll
, would be displayed as /b/t/c/o/rock/and/roll
with fish_style_pwd_dir_length = 1
--the path components that would normally be removed are displayed with a single character. For fish_style_pwd_dir_length = 2
, it would be /bu/th/ci/on/rock/and/roll
.
Variables
Variable | Ejemplo | Descripción |
---|---|---|
path | "D:/Projects" |
The current directory path |
style* | "black bold dimmed" |
Mirrors the value of option style |
*: This variable can only be used as a part of a style string
Ejemplo
# ~/.config/starship.toml
[directory]
truncation_length = 8
Docker context
El módulo docker_context
muestra el Docker context activo si no está a default
.
Opciones
Option | Por defecto | Descripción |
---|---|---|
format |
"via [$symbol$context]($style) " |
The format for the module. |
symbol |
"🐳 " |
The symbol used before displaying the Docker context. |
style |
"blue bold" |
El estilo del módulo. |
only_with_files |
false |
Solo lo muestra cuando hay un archivo docker-compose.yml o Dockerfile en el directorio actual. |
disabled |
true |
Desactiva el módulo docker_context . |
Variables
Variable | Ejemplo | Descripción |
---|---|---|
context | test_context |
The current docker context |
symbol | Mirrors the value of option symbol |
|
style* | Mirrors the value of option style |
*: This variable can only be used as a part of a style string
Ejemplo
# ~/.config/starship.toml
[docker_context]
format = "via [🐋 $context](blue bold)"
Dotnet
El módulo dotnet
muestra la versión usada de .NET Core SDK para el directorio actual. Si el SDK ha sido anclado en el directorio actual, se mostrará la versión fijada. De lo contrario, el módulo muestra la última versión instalada del SDK.
This module will only be shown in your prompt when one or more of the following files are present in the current directory:
global.json
project.json
Directory.Build.props
Directory.Build.targets
Packages.props
*.sln
*.csproj
*.fsproj
*.xproj
You'll also need the .NET Core SDK installed in order to use it correctly.
Internally, this module uses its own mechanism for version detection. Typically it is twice as fast as running dotnet --version
, but it may show an incorrect version if your .NET project has an unusual directory layout. If accuracy is more important than speed, you can disable the mechanism by setting heuristic = false
in the module options.
The module will also show the Target Framework Moniker (https://docs.microsoft.com/en-us/dotnet/standard/frameworks#supported-target-framework-versions) when there is a csproj file in the current directory.
Opciones
Option | Por defecto | Descripción |
---|---|---|
format |
"v[$symbol$version( 🎯 $tfm)]($style) " |
The format for the module. |
symbol |
"•NET " |
Símbolo usado antes de mostrar la versión de .NET |
heuristic |
true |
Use faster version detection to keep starship snappy. |
style |
"bold blue" |
El estilo del módulo. |
disabled |
false |
Deshabilita el módulo dotnet . |
Variables
Variable | Ejemplo | Descripción |
---|---|---|
version | v3.1.201 |
The version of dotnet sdk |
tfm | netstandard2.0 |
The Target Framework Moniker that the current project is targeting |
symbol | Mirrors the value of option symbol |
|
style* | Mirrors the value of option style |
*: This variable can only be used as a part of a style string
Ejemplo
# ~/.config/starship.toml
[dotnet]
symbol = "🥅 "
style = "green"
heuristic = false
Elixir
The elixir
module shows the currently installed version of Elixir and Erlang/OTP. El módulo se muestra si algunas de las siguientes condiciones se cumplen:
- El directorio actual contiene un fichero
mix.exs
.
Opciones
Option | Por defecto | Descripción |
---|---|---|
symbol |
"💧 " |
The symbol used before displaying the version of Elixir/Erlang. |
style |
"bold purple" |
El estilo del módulo. |
format |
"via [$symbol$version \\(OTP $otp_version\\)]($style) " |
The format for the module elixir. |
disabled |
false |
Disables the elixir module. |
Variables
Variable | Ejemplo | Descripción |
---|---|---|
version | v1.10 |
The version of elixir |
otp_version | The otp version of elixir |
|
symbol | Mirrors the value of option symbol |
|
style* | Mirrors the value of option style |
*: This variable can only be used as a part of a style string
Ejemplo
# ~/.config/starship.toml
[elixir]
symbol = "🔮 "
Elm
The elm
module shows the currently installed version of Elm. El módulo se muestra si algunas de las siguientes condiciones se cumplen:
- El directorio actual contiene un fichero
elm.json
- El directorio actual contiene un fichero
elm-package.json
- The current directory contains a
.elm-version
file - The current directory contains a
elm-stuff
folder - The current directory contains a
*.elm
files
Opciones
Option | Por defecto | Descripción |
---|---|---|
format |
"via [$symbol$version]($style) " |
The format for the module. |
symbol |
"🌳 " |
A format string representing the symbol of Elm. |
style |
"cyan bold" |
El estilo del módulo. |
disabled |
false |
Disables the elm module. |
Variables
Variable | Ejemplo | Descripción |
---|---|---|
version | v0.19.1 |
The version of elm |
symbol | Mirrors the value of option symbol |
|
style* | Mirrors the value of option style |
*: This variable can only be used as a part of a style string
Ejemplo
# ~/.config/starship.toml
[elm]
format = "via [ $version](cyan bold) "
Variable de entorno
The env_var
module displays the current value of a selected environment variable. The module will be shown only if any of the following conditions are met:
- The
variable
configuration option matches an existing environment variable - The
variable
configuration option is not defined, but thedefault
configuration option is
Opciones
Option | Por defecto | Descripción |
---|---|---|
symbol |
The symbol used before displaying the variable value. | |
variable |
The environment variable to be displayed. | |
por defecto |
The default value to be displayed when the selected variable is not defined. | |
format |
"with [$env_value]($style) " |
The format for the module. |
disabled |
false |
Disables the env_var module. |
Variables
Variable | Ejemplo | Descripción |
---|---|---|
env_value | Windows NT (if variable would be $OS ) |
The environment value of option variable |
symbol | Mirrors the value of option symbol |
|
style* | black bold dimmed |
Mirrors the value of option style |
*: This variable can only be used as a part of a style string
Ejemplo
# ~/.config/starship.toml
[env_var]
variable = "SHELL"
default = "unknown shell"
Erlang
The erlang
module shows the currently installed version of Erlang/OTP. El módulo se muestra si algunas de las siguientes condiciones se cumplen:
- El directorio actual contiene un fichero
rebar.config
. - El directorio actual contiene un fichero
erlang.mk
.
Opciones
Option | Por defecto | Descripción |
---|---|---|
symbol |
"🖧 " |
The symbol used before displaying the version of erlang. |
style |
"bold red" |
El estilo del módulo. |
format |
"via [$symbol$version]($style) " |
The format for the module. |
disabled |
false |
Disables the erlang module. |
Variables
Variable | Ejemplo | Descripción |
---|---|---|
version | v22.1.3 |
The version of erlang |
symbol | Mirrors the value of option symbol |
|
style* | Mirrors the value of option style |
*: This variable can only be used as a part of a style string
Ejemplo
# ~/.config/starship.toml
[erlang]
format = "via [e $version](bold red) "
Git Branch
The git_branch
module shows the active branch of the repo in your current directory.
Opciones
Option | Por defecto | Descripción |
---|---|---|
format |
"on [$symbol$branch]($style) " |
The format for the module. Use "$branch" to refer to the current branch name. |
symbol |
" " |
A format string representing the symbol of git branch. |
style |
"bold purple" |
El estilo del módulo. |
truncation_length |
2^63 - 1 |
Truncates a git branch to X graphemes. |
truncation_symbol |
"…" |
The symbol used to indicate a branch name was truncated. You can use "" for no symbol. |
disabled |
false |
Disables the git_branch module. |
Variables
Variable | Ejemplo | Descripción |
---|---|---|
branch | master |
The current branch name, falls back to HEAD if there's no current branch (e.g. git detached HEAD). |
symbol | Mirrors the value of option symbol |
|
style* | Mirrors the value of option style |
*: This variable can only be used as a part of a style string
Ejemplo
# ~/.config/starship.toml
[git_branch]
symbol = "🌱 "
truncation_length = 4
truncation_symbol = ""
Git commit
The git_commit
module shows the current commit hash of the repo in your current directory.
Opciones
Option | Por defecto | Descripción |
---|---|---|
commit_hash_length |
7 |
The length of the displayed git commit hash. |
format |
"[\\($hash\\)]($style) " |
The format for the module. |
style |
"bold green" |
El estilo del módulo. |
only_detached |
true |
Only show git commit hash when in detached HEAD state |
disabled |
false |
Disables the git_commit module. |
Variables
Variable | Ejemplo | Descripción |
---|---|---|
hash | b703eb3 |
The current git commit hash |
style* | Mirrors the value of option style |
*: This variable can only be used as a part of a style string
Ejemplo
# ~/.config/starship.toml
[git_commit]
commit_hash_length = 4
Git state
The git_state
module will show in directories which are part of a git repository, and where there is an operation in progress, such as: REBASING, BISECTING, etc. If there is progress information (e.g., REBASING 3/10), that information will be shown too.
Opciones
Option | Por defecto | Descripción |
---|---|---|
rebase |
"REBASING" |
A format string displayed when a rebase is in progress. |
merge |
"MERGING" |
A format string displayed when a merge is in progress. |
revert |
"REVERTING" |
A format string displayed when a revert is in progress. |
cherry_pick |
"CHERRY-PICKING" |
A format string displayed when a cherry-pick is in progress. |
bisect |
"BISECTING" |
A format string displayed when a bisect is in progress. |
am |
"AM" |
A format string displayed when an apply-mailbox (git am ) is in progress. |
am_or_rebase |
"AM/REBASE" |
A format string displayed when an ambiguous apply-mailbox or rebase is in progress. |
style |
"bold yellow" |
El estilo del módulo. |
format |
"[\\($state( $progress_current/$progress_total)\\)]($style) " |
The format for the module. |
disabled |
false |
Disables the git_state module. |
Variables
Variable | Ejemplo | Descripción |
---|---|---|
state | REBASING |
The current state of the repo |
progress_current | 1 |
The current operation progress |
progress_total | 2 |
The total operation progress |
style* | Mirrors the value of option style |
*: This variable can only be used as a part of a style string
Ejemplo
# ~/.config/starship.toml
[git_state]
format = "[\\($state( $progress_current of $progress_total)\\)]($style) "
cherry_pick = "[🍒 PICKING](bold red)"
Git status
The git_status
module shows symbols representing the state of the repo in your current directory.
Opciones
Option | Por defecto | Descripción |
---|---|---|
format |
"([$all_status$ahead_behind] )" | The default format for git_status |
conflicted |
"=" |
This branch has merge conflicts. |
ahead |
"⇡" |
The format of ahead |
behind |
"⇣" |
The format of behind |
diverged |
"⇕" |
The format of diverged |
untracked |
"?" |
The format of untracked |
stashed |
"$" |
The format of stashed |
modified |
"!" |
The format of modified |
staged |
"+" |
The format of staged |
renamed |
"»" |
The format of renamed |
deleted |
"✘" |
The format of deleted |
show_sync_count |
false |
Show ahead/behind count of the branch being tracked. |
style |
"bold red" |
El estilo del módulo. |
disabled |
false |
Disables the git_status module. |
Variables
The following variables can be used in format
:
Variable | Descripción |
---|---|
all_status |
Shortcut for$conflicted$stashed$deleted$renamed$modified$staged$untracked |
ahead_behind |
Displays diverged ahead or behind format string based on the current status of the repo |
conflicted |
Displays conflicted when this branch has merge conflicts. |
untracked |
Displays untracked when there are untracked files in the working directory. |
stashed |
Displays stashed when a stash exists for the local repository. |
modified |
Displays modified when there are file modifications in the working directory. |
staged |
Displays staged when a new file has been added to the staging area. |
renamed |
Displays renamed when a renamed file has been added to the staging area. |
deleted |
Displays deleted when a file's deletion has been added to the staging area. |
style* | Mirrors the value of option style |
*: This variable can only be used as a part of a style string
The following variables can be used in diverged
:
Variable | Descripción |
---|---|
ahead_count |
Number of commits ahead of the tracking branch |
behind_count |
Number of commits behind the tracking branch |
The following variables can be used in conflicted
, ahead
, behind
, untracked
, stashed
, modified
, staged
, renamed
and deleted
:
Variable | Descripción |
---|---|
count |
Show the number of files |
Ejemplo
# ~/.config/starship.toml
[git_status]
conflicted = "🏳"
ahead = "🏎💨"
behind = "😰"
diverged = "😵"
untracked = "🤷"
stashed = "📦"
modified = "📝"
staged = '[++\($count\)](green)'
renamed = "👅"
deleted = "🗑"
Golang
The golang
module shows the currently installed version of Golang. El módulo se muestra si algunas de las siguientes condiciones se cumplen:
- El directorio actual contiene un fichero
go.mod
- El directorio actual contiene un fichero
go.sum
- El directorio actual contiene un fichero
glide.yaml
- The current directory contains a
Gopkg.yml
file - The current directory contains a
Gopkg.lock
file - The current directory contains a
.go-version
file - The current directory contains a
Godeps
directory - The current directory contains a file with the
.go
extension
Opciones
Option | Por defecto | Descripción |
---|---|---|
format |
"via [$symbol$version]($style) " |
The format for the module. |
symbol |
"🐹 " |
A format string representing the symbol of Go. |
style |
"bold cyan" |
El estilo del módulo. |
disabled |
false |
Disables the golang module. |
Variables
Variable | Ejemplo | Descripción |
---|---|---|
version | v1.12.1 |
The version of go |
symbol | Mirrors the value of option symbol |
|
style* | Mirrors the value of option style |
*: This variable can only be used as a part of a style string
Ejemplo
# ~/.config/starship.toml
[golang]
format = "via [🏎💨 $version](bold cyan) "
Helm
The helm
module shows the currently installed version of Helm. El módulo se muestra si algunas de las siguientes condiciones se cumplen:
- El directorio actual contiene un fichero
helmfile.yaml
- The current directory contains a
Chart.yaml
file
Opciones
Option | Por defecto | Descripción |
---|---|---|
format |
"via [$symbol$version]($style) " |
The format for the module. |
symbol |
"⎈ " |
A format string representing the symbol of Helm. |
style |
"bold white" |
El estilo del módulo. |
disabled |
false |
Disables the helm module. |
Variables
Variable | Ejemplo | Descripción |
---|---|---|
version | v3.1.1 |
The version of helm |
symbol | Mirrors the value of option symbol |
|
style* | Mirrors the value of option style |
*: This variable can only be used as a part of a style string
Ejemplo
# ~/.config/starship.toml
[helm]
format = "via [⎈ $version](bold white) "
Hostname
The hostname
module shows the system hostname.
Opciones
Option | Por defecto | Descripción |
---|---|---|
ssh_only |
true |
Only show hostname when connected to an SSH session. |
trim_at |
"." |
String that the hostname is cut off at, after the first match. "." will stop after the first dot. "" will disable any truncation |
format |
"on [$hostname]($style) " |
The format for the module. |
style |
"bold dimmed green" |
El estilo del módulo. |
disabled |
false |
Disables the hostname module. |
Variables
Variable | Ejemplo | Descripción |
---|---|---|
number | 1 |
The number of jobs |
symbol | Mirrors the value of option symbol |
|
style* | Mirrors the value of option style |
*: This variable can only be used as a part of a style string
Ejemplo
# ~/.config/starship.toml
[hostname]
ssh_only = false
format = "on [$hostname](bold red) "
trim_at = ".companyname.com"
disabled = false
Java
The java
module shows the currently installed version of Java. El módulo se muestra si algunas de las siguientes condiciones se cumplen:
- The current directory contains a
pom.xml
,build.gradle.kts
,build.sbt
or.java-version
file - The current directory contains a file with the
.java
,.class
,.gradle
or.jar
extension
Opciones
Option | Por defecto | Descripción |
---|---|---|
format |
"via [${symbol}${version}]($style) " |
The format for the module. |
symbol |
"☕ " |
A format string representing the symbol of Java |
style |
"red dimmed" |
El estilo del módulo. |
disabled |
false |
Disables the java module. |
Variables
Variable | Ejemplo | Descripción |
---|---|---|
version | v14 |
The version of java |
symbol | Mirrors the value of option symbol |
|
style* | Mirrors the value of option style |
*: This variable can only be used as a part of a style string
Ejemplo
# ~/.config/starship.toml
[java]
symbol = "🌟 "
Jobs
The jobs
module shows the current number of jobs running. The module will be shown only if there are background jobs running. The module will show the number of jobs running if there is more than 1 job, or more than the threshold
config value, if it exists.
Opciones
Option | Por defecto | Descripción |
---|---|---|
threshold |
1 |
Show number of jobs if exceeded. |
format |
"[$symbol$number]($style) " |
The format for the module. |
symbol |
"✦" |
A format string representing the number of jobs. |
style |
"bold blue" |
El estilo del módulo. |
disabled |
false |
Disables the jobs module. |
Variables
Variable | Ejemplo | Descripción |
---|---|---|
number | 1 |
The number of jobs |
symbol | Mirrors the value of option symbol |
|
style* | Mirrors the value of option style |
*: This variable can only be used as a part of a style string
Ejemplo
# ~/.config/starship.toml
[jobs]
symbol = "+ "
threshold = 4
Julia
The julia
module shows the currently installed version of Julia. El módulo se muestra si algunas de las siguientes condiciones se cumplen:
- The current directory contains a
Project.toml
file - The current directory contains a
Manifest.toml
file - The current directory contains a file with the
.jl
extension
Opciones
Option | Por defecto | Descripción |
---|---|---|
format |
"via [$symbol$version]($style) " |
The format for the module. |
symbol |
"ஃ " |
A format string representing the symbol of Julia. |
style |
"bold purple" |
El estilo del módulo. |
disabled |
false |
Disables the julia module. |
Variables
Variable | Ejemplo | Descripción |
---|---|---|
version | v1.4.0 |
The version of julia |
symbol | Mirrors the value of option symbol |
|
style* | Mirrors the value of option style |
*: This variable can only be used as a part of a style string
Ejemplo
# ~/.config/starship.toml
[julia]
symbol = "∴ "
Kubernetes
Displays the current Kubernetes context name and, if set, the namespace from the kubeconfig file. The namespace needs to be set in the kubeconfig file, this can be done via kubectl config set-context starship-cluster --namespace astronaut
. If the $KUBECONFIG
env var is set the module will use that if not it will use the ~/.kube/config
.
::: tip
This module is disabled by default. To enable it, set disabled
to false
in your configuration file.
:::
Opciones
Option | Por defecto | Descripción |
---|---|---|
symbol |
"☸ " |
A format string representing the symbol displayed before the Cluster. |
format |
"on [$symbol$context( \\($namespace\\))]($style) " |
The format for the module. |
style |
"cyan bold" |
El estilo del módulo. |
namespace_spaceholder |
none |
The value to display if no namespace was found. |
context_aliases |
Table of context aliases to display. | |
disabled |
true |
Disables the kubernetes module. |
Variables
Variable | Ejemplo | Descripción |
---|---|---|
context | starship-cluster |
The current kubernetes context |
namespace | starship-namespace |
If set, the current kubernetes namespace |
symbol | Mirrors the value of option symbol |
|
style* | Mirrors the value of option style |
*: This variable can only be used as a part of a style string
Ejemplo
# ~/.config/starship.toml
[kubernetes]
format = "on [⛵ $context \\($namespace\\)](dimmed green) "
disabled = false
[kubernetes.context_aliases]
"dev.local.cluster.k8s" = "dev"
Salto de línea
The line_break
module separates the prompt into two lines.
Opciones
Option | Por defecto | Descripción |
---|---|---|
disabled |
false |
Disables the line_break module, making the prompt a single line. |
Ejemplo
# ~/.config/starship.toml
[line_break]
disabled = true
Memoria utilizada
The memory_usage
module shows current system memory and swap usage.
By default the swap usage is displayed if the total system swap is non-zero.
::: tip
This module is disabled by default. To enable it, set disabled
to false
in your configuration file.
:::
Opciones
Option | Por defecto | Descripción |
---|---|---|
threshold |
75 |
Hide the memory usage unless it exceeds this percentage. |
format |
`"via $symbol [${ram}( | ${swap})]($style) "` |
symbol |
"🐏" |
The symbol used before displaying the memory usage. |
style |
"bold dimmed white" |
El estilo del módulo. |
disabled |
true |
Disables the memory_usage module. |
Variables
Variable | Ejemplo | Descripción |
---|---|---|
ram | 31GiB/65GiB |
The usage/total RAM of the current system memory. |
ram_pct | 48% |
The percentage of the current system memory. |
swap** | 1GiB/4GiB |
The swap memory size of the current system swap memory file. |
swap_pct** | 77% |
The swap memory percentage of the current system swap memory file. |
symbol | 🐏 |
Mirrors the value of option symbol |
style* | Mirrors the value of option style |
*: This variable can only be used as a part of a style string **: The SWAP file information is only displayed if detected on the current system
Ejemplo
# ~/.config/starship.toml
[memory_usage]
disabled = false
show_percentage = true
show_swap = true
threshold = -1
symbol = " "
separator = "/"
style = "bold dimmed green"
Mercurial Branch
The hg_branch
module shows the active branch of the repo in your current directory.
Opciones
Option | Por defecto | Descripción |
---|---|---|
symbol |
" " |
The symbol used before the hg bookmark or branch name of the repo in your current directory. |
style |
"bold purple" |
El estilo del módulo. |
format |
"on [$symbol$branch]($style) " |
The format for the module. |
truncation_length |
2^63 - 1 |
Truncates the hg branch name to X graphemes |
truncation_symbol |
"…" |
The symbol used to indicate a branch name was truncated. |
disabled |
true |
Disables the hg_branch module. |
Variables
Variable | Ejemplo | Descripción |
---|---|---|
branch | master |
The active mercurial branch |
symbol | Mirrors the value of option symbol |
|
style* | Mirrors the value of option style |
*: This variable can only be used as a part of a style string
Ejemplo
# ~/.config/starship.toml
[hg_branch]
format = "on [🌱 $branch](bold purple)"
truncation_length = 4
truncation_symbol = ""
Nim
The nim
module shows the currently installed version of Nim. El módulo se muestra si algunas de las siguientes condiciones se cumplen:
- El directorio actual contiene un fichero
nim.cfg
- The current directory contains a file with the
.nim
extension - The current directory contains a file with the
.nims
extension - The current directory contains a file with the
.nimble
extension
Opciones
Option | Por defecto | Descripción |
---|---|---|
format |
"via [$symbol$version]($style) " |
The format for the module |
symbol |
"👑 " |
The symbol used before displaying the version of Nim. |
style |
"bold yellow" |
El estilo del módulo. |
disabled |
false |
Disables the nim module. |
Variables
Variable | Ejemplo | Descripción |
---|---|---|
version | v1.2.0 |
The version of nimc |
symbol | Mirrors the value of option symbol |
|
style* | Mirrors the value of option style |
*: This variable can only be used as a part of a style string
Ejemplo
# ~/.config/starship.toml
[nim]
style = "yellow"
symbol = "🎣 "
Nix-shell
The nix_shell
module shows the nix-shell environment. The module will be shown when inside a nix-shell environment.
Opciones
Option | Por defecto | Descripción |
---|---|---|
format |
"via [$symbol$state( \\($name\\))]($style) " |
The format for the module. |
symbol |
"❄️ " |
A format string representing the symbol of nix-shell. |
style |
"bold blue" |
El estilo del módulo. |
impure_msg |
"impure" |
A format string shown when the shell is impure. |
pure_msg |
"pure" |
A format string shown when the shell is pure. |
disabled |
false |
Disables the nix_shell module. |
Variables
Variable | Ejemplo | Descripción |
---|---|---|
state | pure |
The state of the nix-shell |
name | lorri |
The name of the nix-shell |
symbol | Mirrors the value of option symbol |
|
style* | Mirrors the value of option style |
*: This variable can only be used as a part of a style string
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) "
NodeJS
The nodejs
module shows the currently installed version of NodeJS. El módulo se muestra si algunas de las siguientes condiciones se cumplen:
- El directorio actual contiene un fichero
package.json
- The current directory contains a
.node-version
file - The current directory contains a
node_modules
directory - The current directory contains a file with the
.js
,.mjs
or.cjs
extension - The current directory contains a file with the
.ts
extension
Opciones
Option | Por defecto | Descripción |
---|---|---|
format |
"via [$symbol$version]($style) " |
The format for the module. |
symbol |
"⬢ " |
A format string representing the symbol of NodeJS. |
style |
"bold green" |
El estilo del módulo. |
disabled |
false |
Disables the nodejs module. |
Variables
Variable | Ejemplo | Descripción |
---|---|---|
version | v13.12.0 |
The version of node |
symbol | Mirrors the value of option symbol |
|
style* | Mirrors the value of option style |
*: This variable can only be used as a part of a style string
Ejemplo
# ~/.config/starship.toml
[nodejs]
format = "via [🤖 $version](bold green) "
Versión del paquete
The package
module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports npm
, cargo
, poetry
, composer
, gradle
, julia
and mix
packages.
- npm – The
npm
package version is extracted from thepackage.json
present in the current directory - cargo – The
cargo
package version is extracted from theCargo.toml
present in the current directory - poetry – The
poetry
package version is extracted from thepyproject.toml
present in the current directory - composer – The
composer
package version is extracted from thecomposer.json
present in the current directory - gradle – The
gradle
package version is extracted from thebuild.gradle
present - julia - The package version is extracted from the
Project.toml
present - mix - The
mix
package version is extracted from themix.exs
present
⚠️ The version being shown is that of the package whose source code is in your current directory, not your package manager.
Opciones
Option | Por defecto | Descripción |
---|---|---|
format |
"via [$symbol$version]($style) " |
The format for the module. |
symbol |
"📦 " |
The symbol used before displaying the version the package. |
style |
"bold 208" |
El estilo del módulo. |
display_private |
false |
Enable displaying version for packages marked as private. |
disabled |
false |
Disables the package module. |
Variables
Variable | Ejemplo | Descripción |
---|---|---|
version | v1.0.0 |
The version of your package |
symbol | Mirrors the value of option symbol |
|
style* | Mirrors the value of option style |
*: This variable can only be used as a part of a style string
Ejemplo
# ~/.config/starship.toml
[package]
format = "via [🎁 $version](208 bold) "
OCaml
The ocaml
module shows the currently installed version of OCaml. El módulo se muestra si algunas de las siguientes condiciones se cumplen:
- The current directory contains a file with
.opam
extension or_opam
directory - The current directory contains a
esy.lock
directory - The current directory contains a
dune
ordune-project
file - The current directory contains a
jbuild
orjbuild-ignore
file - The current directory contains a
.merlin
file - The current directory contains a file with
.ml
,.mli
,.re
or.rei
extension
Opciones
Option | Por defecto | Descripción |
---|---|---|
format |
"via [$symbol$version]($style) " |
The format string for the module. |
symbol |
"🐫 " |
The symbol used before displaying the version of OCaml. |
style |
"bold yellow" |
El estilo del módulo. |
disabled |
false |
Disables the ocaml module. |
Variables
Variable | Ejemplo | Descripción |
---|---|---|
version | v4.10.0 |
The version of ocaml |
symbol | Mirrors the value of option symbol |
|
style* | Mirrors the value of option style |
*: This variable can only be used as a part of a style string
Ejemplo
# ~/.config/starship.toml
[ocaml]
format = "via [🐪 $version]($style) "
PHP
The php
module shows the currently installed version of PHP. El módulo se muestra si algunas de las siguientes condiciones se cumplen:
- El directorio actual contiene un fichero
composer.json
- The current directory contains a
.php-version
file - The current directory contains a
.php
file
Opciones
Option | Por defecto | Descripción |
---|---|---|
format |
"via [$symbol$version]($style) " |
The format for the module. |
symbol |
"🐘 " |
The symbol used before displaying the version of PHP. |
style |
"147 bold" |
El estilo del módulo. |
disabled |
false |
Disables the php module. |
Variables
Variable | Ejemplo | Descripción |
---|---|---|
version | v7.3.8 |
The version of php |
symbol | Mirrors the value of option symbol |
|
style* | Mirrors the value of option style |
*: This variable can only be used as a part of a style string
Ejemplo
# ~/.config/starship.toml
[php]
format = "via [🔹 $version](147 bold) "
Python
The python
module shows the currently installed version of Python and the current Python virtual environment if one is activated.
If pyenv_version_name
is set to true
, it will display the pyenv version name. Otherwise, it will display the version number from python --version
.
El módulo se muestra si algunas de las siguientes condiciones se cumplen:
- The current directory contains a
.python-version
file - El directorio actual contiene un fichero
requirements.txt
- El directorio actual contiene un fichero
pyproject.toml
- The current directory contains a file with the
.py
extension (andscan_for_pyfiles
is true) - The current directory contains a
Pipfile
file - El directorio actual contiene un fichero
tox.ini
- El directorio actual contiene un fichero
setup.py
- The current directory contains a
__init__.py
file - A virtual environment is currently activated
Opciones
Option | Por defecto | Descripción |
---|---|---|
format |
"via [${symbol}${version}( \\($virtualenv\\))]($style) " |
The format for the module. |
symbol |
"🐍 " |
A format string representing the symbol of Python |
style |
"yellow bold" |
El estilo del módulo. |
pyenv_version_name |
false |
Use pyenv to get Python version |
scan_for_pyfiles |
true |
If false, Python files in the current directory will not show this module. |
disabled |
false |
Disables the python module. |
Variables
Variable | Ejemplo | Descripción |
---|---|---|
version | "v3.8.1" |
The version of python |
symbol | "🐍 " |
Mirrors the value of option symbol |
style | "yellow bold" |
Mirrors the value of option style |
virtualenv | "venv" |
The current virtualenv name |
This module has some advanced configuration options.
Variable | Por defecto | Descripción |
---|---|---|
python_binary |
python |
Configures the python binary that Starship executes when getting the version. |
The python_binary
variable changes the binary that Starship executes to get the version of Python, it doesn't change the arguments that are used.
# ~/.config/starship.toml
[python]
python_binary = "python3"
Ejemplo
# ~/.config/starship.toml
[python]
symbol = "👾 "
pyenv_version_name = true
pyenv_prefix = "foo "
Ruby
The ruby
module shows the currently installed version of Ruby. El módulo se muestra si algunas de las siguientes condiciones se cumplen:
- The current directory contains a
Gemfile
file - The current directory contains a
.ruby-version
file - The current directory contains a
.rb
file
Opciones
Option | Por defecto | Descripción |
---|---|---|
format |
"via [$symbol$version]($style) " |
The format for the module. |
symbol |
"💎 " |
A format string representing the symbol of Ruby. |
style |
"bold red" |
El estilo del módulo. |
disabled |
false |
Disables the ruby module. |
Variables
Variable | Ejemplo | Descripción |
---|---|---|
version | v2.5.1 |
The version of ruby |
symbol | Mirrors the value of option symbol |
|
style* | Mirrors the value of option style |
*: This variable can only be used as a part of a style string
Ejemplo
# ~/.config/starship.toml
[ruby]
symbol = "🔺 "
Rust
The rust
module shows the currently installed version of Rust. El módulo se muestra si algunas de las siguientes condiciones se cumplen:
- The current directory contains a
Cargo.toml
file - The current directory contains a file with the
.rs
extension
Opciones
Option | Por defecto | Descripción |
---|---|---|
format |
"via [$symbol$version]($style) " |
The format for the module. |
symbol |
"🦀 " |
A format string representing the symbol of Rust |
style |
"bold red" |
El estilo del módulo. |
disabled |
false |
Disables the rust module. |
Variables
Variable | Ejemplo | Descripción |
---|---|---|
version | v1.43.0-nightly |
The version of rustc |
symbol | Mirrors the value of option symbol |
|
style* | Mirrors the value of option style |
*: This variable can only be used as a part of a style string
Ejemplo
# ~/.config/starship.toml
[rust]
format = "via [⚙️ $version](red bold)"
Singularity
The singularity
module shows the current singularity image, if inside a container and $SINGULARITY_NAME
is set.
Opciones
Option | Por defecto | Descripción |
---|---|---|
format |
"[$symbol\\[$env\\]]($style) " |
The format for the module. |
symbol |
"" |
A format string displayed before the image name. |
style |
"bold dimmed blue" |
El estilo del módulo. |
disabled |
false |
Disables the singularity module. |
Variables
Variable | Ejemplo | Descripción |
---|---|---|
env | centos.img |
The current singularity image |
symbol | Mirrors the value of option symbol |
|
style* | Mirrors the value of option style |
*: This variable can only be used as a part of a style string
Ejemplo
# ~/.config/starship.toml
[singularity]
format = "[📦 \\[$env\\]]($style) "
Terraform
The terraform
module shows the currently selected terraform workspace and version. By default the terraform version is not shown, since this is slow on current versions of terraform when a lot of plugins are in use. If you still want to enable it, follow the example shown below. El módulo se muestra si algunas de las siguientes condiciones se cumplen:
- The current directory contains a
.terraform
folder - Current directory contains a file with the
.tf
extension
Opciones
Option | Por defecto | Descripción |
---|---|---|
format |
"via [$symbol$workspace]($style) " |
The format string for the module. |
symbol |
"💠 " |
A format string shown before the terraform workspace. |
style |
"bold 105" |
El estilo del módulo. |
disabled |
false |
Disables the terraform module. |
Variables
Variable | Ejemplo | Descripción |
---|---|---|
version | v0.12.24 |
The version of terraform |
workspace | por defecto |
The current terraform workspace |
symbol | Mirrors the value of option symbol |
|
style* | Mirrors the value of option style |
*: This variable can only be used as a part of a style string
Ejemplo
With Version
# ~/.config/starship.toml
[terraform]
format = "[🏎💨 $version$workspace]($style) "
Without version
# ~/.config/starship.toml
[terraform]
format = "[🏎💨 $workspace]($style) "
Hora
The time
module shows the current local time. The format
configuration value is used by the chrono
crate to control how the time is displayed. Take a look at the chrono strftime docs to see what options are available.
::: tip
This module is disabled by default. To enable it, set disabled
to false
in your configuration file.
:::
Opciones
Option | Por defecto | Descripción |
---|---|---|
format |
"at [$time]($style) " |
The format string for the module. |
use_12hr |
false |
Activa el formato de 12 horas |
time_format |
see below | The chrono format string used to format the time. |
style |
"bold yellow" |
El estilo del módulo de la hora |
utc_time_offset |
"local" |
Sets the UTC offset to use. Range from -24 < x < 24. Allows floats to accommodate 30/45 minute timezone offsets. |
disabled |
true |
Disables the time module. |
time_range |
"-" |
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 |
---|---|---|
hora | 13:08:10 |
The current time. |
style* | Mirrors the value of option style |
*: This variable can only be used as a part of a style string
Ejemplo
# ~/.config/starship.toml
[time]
disabled = false
format = "🕙[\\[ $time \\]]($style) "
time_format = "%T"
utc_time_offset = "-5"
time_range = "10:00:00-14:00:00"
Nombre de usuario
The username
module shows active user's username. El módulo se muestra si algunas de las siguientes condiciones se cumplen:
- The current user is root
- The current user isn't the same as the one that is logged in
- The user is currently connected as an SSH session
- The variable
show_always
is set to true
Opciones
Option | Por defecto | Descripción |
---|---|---|
style_root |
"bold red" |
The style used when the user is root. |
style_user |
"bold yellow" |
The style used for non-root users. |
format |
"via [$user]($style) " |
The format for the module. |
show_always |
false |
Always shows the username module. |
disabled |
false |
Disables the username module. |
Variables
Variable | Ejemplo | Descripción |
---|---|---|
style |
"red bold" |
Mirrors the value of option style_root when root is logged in and style_user otherwise. |
user |
"matchai" |
The currently logged-in user ID. |
Ejemplo
# ~/.config/starship.toml
[username]
style_user = "white bold"
style_root = "black bold"
format = "user: [$user]($style) "
disabled = false
show_always = true
Zig
The zig
module shows the currently installed version of Zig. El módulo se muestra si algunas de las siguientes condiciones se cumplen:
- The current directory contains a
.zig
file
Opciones
Option | Por defecto | Descripción |
---|---|---|
symbol |
"↯ " |
The symbol used before displaying the version of Zig. |
style |
"bold yellow" |
El estilo del módulo. |
format |
"via [$symbol$version]($style) " |
The format for the module. |
disabled |
false |
Disables the zig module. |
Variables
Variable | Ejemplo | Descripción |
---|---|---|
version | v0.6.0 |
The version of zig |
symbol | Mirrors the value of option symbol |
|
style* | Mirrors the value of option style |
*: This variable can only be used as a part of a style string
Ejemplo
# ~/.config/starship.toml
[zig]
symbol = "⚡️ "
Comandos personalizados
The custom
modules show the output of some arbitrary commands.
These modules will be shown if any of the following conditions are met:
- The current directory contains a file whose name is in
files
- The current directory contains a directory whose name is in
directories
- The current directory contains a file whose extension is in
extensions
- The
when
command returns 0
::: tip
Multiple custom modules can be defined by using a .
.
:::
::: tip
The order in which custom modules are shown can be individually set by setting custom.foo
in prompt_order
. By default, the custom
module will simply show all custom modules in the order they were defined.
:::
Opciones
Option | Por defecto | Descripción |
---|---|---|
command |
The command whose output should be printed. | |
when |
A shell command used as a condition to show the module. The module will be shown if the command returns a 0 status code. |
|
shell |
See below | |
descripción |
"<custom module>" |
The description of the module that is shown when running starship explain . |
files |
[] |
The files that will be searched in the working directory for a match. |
directories |
[] |
The directories that will be searched in the working directory for a match. |
extensions |
[] |
The extensions that will be searched in the working directory for a match. |
symbol |
"" |
The symbol used before displaying the command output. |
style |
"bold green" |
El estilo del módulo. |
format |
"[$symbol$output]($style) " |
The format for the module. |
disabled |
false |
Disables this custom module. |
Variables
Variable | Descripción |
---|---|
output | The output of shell command in shell |
symbol | Mirrors the value of option symbol |
style* | Mirrors the value of option style |
*: This variable can only be used as a part of a style string
Custom command shell
shell
accepts a non-empty list of strings, where:
- The first string is the path to the shell to use to execute the command.
- Other following arguments are passed to the shell.
If unset, it will fallback to STARSHIP_SHELL and then to "sh" on Linux, and "cmd /C" on Windows.
If shell
is not given or only contains one element and Starship detects PowerShell will be used, the following arguments will automatically be added: -NoProfile -Command -
. This behavior can be avoided by explicitly passing arguments to the shell, e.g.
shell = ["pwsh", "-Command", "-"]
::: warning Make sure your custom shell configuration exits gracefully
If you set a custom command, make sure that the default Shell used by starship will properly execute the command with a graceful exit (via the shell
option).
For example, PowerShell requires the -Command
parameter to execute a one liner. Omitting this parameter might throw starship into a recursive loop where the shell might try to load a full profile environment with starship itself again and hence re-execute the custom command, getting into a never ending loop.
Parameters similar to -NoProfile
in PowerShell are recommended for other shells as well to avoid extra loading time of a custom profile on every starship invocation.
Automatic detection of shells and proper parameters addition are currently implemented, but it's possible that not all shells are covered. Please open an issue with shell details and starship configuration if you hit such scenario.
:::
Ejemplo
# ~/.config/starship.toml
[custom.foo]
command = "echo foo" # shows output of command
files = ["foo"] # can specify filters
when = """ test "$HOME" == "$PWD" """
prefix = " transcending "
[custom.time]
command = "time /T"
files = ["*.pst"]
prefix = "transcending "
shell = ["pwsh.exe", "-NoProfile", "-Command", "-"]
PureScript
The purescript
module shows the currently installed version of PureScript version. El módulo se muestra si algunas de las siguientes condiciones se cumplen:
- El directorio actual contiene un fichero
spago.dhall
- The current directory contains a *.purs files
Opciones
Option | Por defecto | Descripción |
---|---|---|
format |
"via [$symbol$version]($style) " |
The format for the module. |
symbol |
"<=> " |
The symbol used before displaying the version of PureScript. |
style |
"bold white" |
El estilo del módulo. |
disabled |
false |
Disables the purescript module. |
Variables
Variable | Ejemplo | Descripción |
---|---|---|
version | 0.13.5 |
The version of purescript |
symbol | Mirrors the value of option symbol |
|
style* | Mirrors the value of option style |
*: This variable can only be used as a part of a style string
Ejemplo
# ~/.config/starship.toml
[purescript]
format = "via [$symbol$version](bold white)"