mirror of
https://github.com/Llewellynvdm/starship.git
synced 2024-12-04 10:58:36 +00:00
6aa2bab97e
* New translations README.md (Portuguese) * New translations README.md (Spanish) * New translations README.md (Polish) * New translations README.md (Dutch) * New translations README.md (Korean) * New translations README.md (Japanese) * New translations README.md (Italian) * New translations README.md (German) * New translations README.md (Arabic) * New translations README.md (Sorani (Kurdish)) * New translations README.md (French) * New translations README.md (Russian) * New translations README.md (Indonesian) * New translations README.md (Portuguese, Brazilian) * New translations README.md (Vietnamese) * New translations README.md (Chinese Traditional) * New translations README.md (Chinese Simplified) * New translations README.md (Turkish) * New translations README.md (Portuguese) * New translations README.md (Spanish) * New translations README.md (Polish) * New translations README.md (Dutch) * New translations README.md (Korean) * New translations README.md (Japanese) * New translations README.md (Italian) * New translations README.md (German) * New translations README.md (Arabic) * New translations README.md (Sorani (Kurdish)) * New translations README.md (French) * New translations README.md (French) * New translations README.md (French) * New translations README.md (Portuguese, Brazilian) * New translations README.md (Portuguese, Brazilian) * New translations README.md (Portuguese, Brazilian) * New translations README.md (Portuguese, Brazilian) * New translations README.md (Portuguese, Brazilian) * New translations README.md (Portuguese, Brazilian) * New translations README.md (Portuguese, Brazilian) * New translations README.md (Portuguese, Brazilian) * New translations README.md (Portuguese, Brazilian) * New translations README.md (Portuguese, Brazilian) * New translations README.md (Portuguese, Brazilian) * New translations README.md (Portuguese, Brazilian) * New translations README.md (Portuguese, Brazilian) * New translations README.md (Portuguese, Brazilian) * New translations README.md (Portuguese, Brazilian) * New translations README.md (Portuguese, Brazilian) * New translations README.md (Portuguese, Brazilian) * New translations README.md (Portuguese, Brazilian) * New translations README.md (Portuguese, Brazilian) * New translations README.md (Portuguese, Brazilian) * New translations README.md (Portuguese, Brazilian) * New translations README.md (Portuguese, Brazilian) * New translations README.md (French) * New translations README.md (Russian) * New translations README.md (Indonesian) * New translations README.md (Portuguese, Brazilian) * New translations README.md (Vietnamese) * New translations README.md (Chinese Traditional) * New translations README.md (Chinese Simplified) * New translations README.md (Turkish) * New translations README.md (Portuguese) * New translations README.md (Spanish) * New translations README.md (Polish) * New translations README.md (Dutch) * New translations README.md (Korean) * New translations README.md (Japanese) * New translations README.md (Italian) * New translations README.md (German) * New translations README.md (Arabic) * New translations README.md (Sorani (Kurdish)) * New translations README.md (Portuguese, Brazilian) * New translations README.md (Portuguese, Brazilian) * New translations README.md (Portuguese, Brazilian) * New translations README.md (Portuguese, Brazilian) * New translations README.md (Portuguese, Brazilian) * New translations README.md (French) * New translations README.md (French) * New translations README.md (Portuguese, Brazilian) * New translations README.md (French) * New translations README.md (Portuguese, Brazilian) * New translations README.md (French) * New translations README.md (Portuguese, Brazilian) * New translations README.md (French) * New translations README.md (Portuguese, Brazilian) * New translations README.md (Portuguese, Brazilian) * New translations README.md (Portuguese, Brazilian) * New translations README.md (Portuguese, Brazilian) * New translations README.md (Portuguese, Brazilian) * New translations README.md (Portuguese, Brazilian) * New translations README.md (Portuguese, Brazilian) * New translations README.md (French) * New translations README.md (Russian) * New translations README.md (Indonesian) * New translations README.md (Portuguese, Brazilian) * New translations README.md (Vietnamese) * New translations README.md (Chinese Traditional) * New translations README.md (Chinese Simplified) * New translations README.md (Turkish) * New translations README.md (Portuguese) * New translations README.md (Spanish) * New translations README.md (Polish) * New translations README.md (Dutch) * New translations README.md (Korean) * New translations README.md (Japanese) * New translations README.md (Italian) * New translations README.md (German) * New translations README.md (Arabic) * New translations README.md (Sorani (Kurdish)) * New translations README.md (Portuguese, Brazilian) * New translations README.md (French) * New translations README.md (Russian) * New translations README.md (Indonesian) * New translations README.md (Portuguese, Brazilian) * New translations README.md (Vietnamese) * New translations README.md (Chinese Traditional) * New translations README.md (Chinese Simplified) * New translations README.md (Turkish) * New translations README.md (Portuguese) * New translations README.md (Spanish) * New translations README.md (Polish) * New translations README.md (Dutch) * New translations README.md (Korean) * New translations README.md (Japanese) * New translations README.md (Italian) * New translations README.md (German) * New translations README.md (Arabic) * New translations README.md (Sorani (Kurdish)) * New translations README.md (French) * New translations README.md (Korean) * New translations README.md (German) * New translations README.md (Italian) * New translations README.md (Italian) * New translations README.md (Japanese) * New translations README.md (Japanese) * New translations README.md (Korean) * New translations README.md (Dutch) * New translations README.md (Dutch) * New translations README.md (Polish) * New translations README.md (Polish) * New translations README.md (Portuguese) * New translations README.md (Portuguese) * New translations README.md (Russian) * New translations README.md (German) * New translations README.md (Arabic) * New translations README.md (Spanish) * New translations README.md (Chinese Simplified) * New translations README.md (Arabic) * New translations README.md (German) * New translations README.md (Italian) * New translations README.md (Japanese) * New translations README.md (Korean) * New translations README.md (Dutch) * New translations README.md (Polish) * New translations README.md (Portuguese) * New translations README.md (Russian) * New translations README.md (Turkish) * New translations README.md (Chinese Traditional) * New translations README.md (Arabic) * New translations README.md (Vietnamese) * New translations README.md (Portuguese, Brazilian) * New translations README.md (Indonesian) * New translations README.md (Sorani (Kurdish)) * New translations README.md (French) * New translations README.md (French) * New translations README.md (Spanish) * New translations README.md (Spanish) * New translations README.md (Russian) * New translations README.md (French) * New translations README.md (Dutch) * New translations README.md (Spanish) * New translations README.md (Arabic) * New translations README.md (German) * New translations README.md (Italian) * New translations README.md (Japanese) * New translations README.md (Korean) * New translations README.md (Polish) * New translations README.md (Portuguese) * New translations README.md (Russian) * New translations README.md (Turkish) * New translations README.md (Chinese Traditional) * New translations README.md (Vietnamese) * New translations README.md (Portuguese, Brazilian) * New translations README.md (Indonesian) * New translations README.md (Chinese Simplified) * New translations README.md (Sorani (Kurdish)) * New translations README.md (Turkish) * New translations README.md (Turkish) * New translations README.md (Chinese Simplified) * New translations README.md (Chinese Simplified) * New translations README.md (Chinese Traditional) * New translations README.md (Chinese Traditional) * New translations README.md (Vietnamese) * New translations README.md (Sorani (Kurdish)) * New translations README.md (Vietnamese) * New translations README.md (Portuguese, Brazilian) * New translations README.md (Portuguese, Brazilian) * New translations README.md (Indonesian) * New translations README.md (Indonesian) * New translations README.md (Sorani (Kurdish)) * New translations README.md (Spanish) * New translations README.md (Spanish) * New translations README.md (Spanish) * New translations README.md (Russian) * New translations README.md (Russian) * New translations README.md (French) * New translations README.md (Russian) * New translations README.md (Indonesian) * New translations README.md (Portuguese, Brazilian) * New translations README.md (Vietnamese) * New translations README.md (Chinese Traditional) * New translations README.md (Chinese Simplified) * New translations README.md (Turkish) * New translations README.md (Portuguese) * New translations README.md (Spanish) * New translations README.md (Polish) * New translations README.md (Dutch) * New translations README.md (Korean) * New translations README.md (Japanese) * New translations README.md (Italian) * New translations README.md (German) * New translations README.md (Arabic) * New translations README.md (Sorani (Kurdish)) * New translations README.md (Chinese Simplified) * New translations README.md (Chinese Simplified) * New translations README.md (Chinese Simplified) * New translations README.md (Chinese Simplified) * New translations README.md (Chinese Simplified) * New translations README.md (Chinese Simplified) * New translations README.md (Chinese Simplified) * New translations README.md (Chinese Simplified) * New translations README.md (Chinese Simplified) * New translations README.md (French) * New translations README.md (Russian) * New translations README.md (Indonesian) * New translations README.md (Portuguese, Brazilian) * New translations README.md (Vietnamese) * New translations README.md (Chinese Traditional) * New translations README.md (Chinese Simplified) * New translations README.md (Turkish) * New translations README.md (Portuguese) * New translations README.md (Spanish) * New translations README.md (Polish) * New translations README.md (Dutch) * New translations README.md (Korean) * New translations README.md (Japanese) * New translations README.md (Italian) * New translations README.md (German) * New translations README.md (Arabic) * New translations README.md (Sorani (Kurdish))
3343 lines
193 KiB
Markdown
3343 lines
193 KiB
Markdown
# Configuración
|
||
|
||
Para comenzar a configurar Starship, crea el siguiente archivo: `~/.config/starship.toml`.
|
||
|
||
```sh
|
||
mkdir -p ~/.config && touch ~/.config/starship.toml
|
||
```
|
||
|
||
Toda la configuración de Starship se realiza en este archivo [TOML](https://github.com/toml-lang/toml):
|
||
|
||
```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`:
|
||
|
||
```sh
|
||
export STARSHIP_CONFIG=~/example/non/default/path/starship.toml
|
||
```
|
||
|
||
El equivalente en PowerShell (Windows) es añadir esta línea a tu `$PROFILE`:
|
||
|
||
```powershell
|
||
$ENV:STARSHIP_CONFIG = "$HOME\example\non\default\path\starship.toml"
|
||
```
|
||
|
||
Or for Cmd (Windows) would be adding this line to your `starship.lua`:
|
||
|
||
```lua
|
||
os.setenv('STARSHIP_CONFIG', 'C:\\Users\\user\\example\\non\\default\\path\\starship.toml')
|
||
```
|
||
|
||
### Registros
|
||
|
||
By default starship logs warnings and errors into a file named `~/.cache/starship/session_${STARSHIP_SESSION_KEY}.log`, where the session key is corresponding to a instance of your terminal. This, however can be changed using the `STARSHIP_CACHE` environment variable:
|
||
|
||
```sh
|
||
export STARSHIP_CACHE=~/.starship/cache
|
||
```
|
||
|
||
El equivalente en PowerShell (Windows) es añadir esta línea a tu `$PROFILE`:
|
||
|
||
```powershell
|
||
$ENV:STARSHIP_CACHE = "$HOME\AppData\Local\Temp"
|
||
```
|
||
|
||
Or for Cmd (Windows) would be adding this line to your `starship.lua`:
|
||
|
||
```lua
|
||
os.setenv('STARSHIP_CACHE', 'C:\\Users\\user\\AppData\\Local\\Temp')
|
||
```
|
||
|
||
### Terminología
|
||
|
||
**Module**: A component in the prompt giving information based on contextual information from your OS. For example, the "nodejs" module shows the version of Node.js that is currently installed on your computer, if your current directory is a Node.js project.
|
||
|
||
**Variable**: Smaller sub-components that contain information provided by the module. For example, the "version" variable in the "nodejs" module contains the current version of Node.js.
|
||
|
||
By convention, most modules have a prefix of default terminal color (e.g. `via` in "nodejs") and an empty space as a suffix.
|
||
|
||
### Cadenas de Formato
|
||
|
||
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 can only contain letters, numbers and `_`.
|
||
|
||
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
|
||
|
||
A text group is made up of two different parts.
|
||
|
||
The first part, which is enclosed in a `[]`, is a [format string](#format-strings). 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](#style-strings). This can be used to style the first part.
|
||
|
||
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
|
||
|
||
Most modules in starship allow you to configure their display styles. This is done with an entry (usually called `style`) which is a string specifying the configuration. Here are some examples of style strings along with what they do. For details on the full syntax, consult the [advanced config guide](/advanced-config/).
|
||
|
||
- `"fg:green bg:blue"` pone texto verde sobre un fondo azul
|
||
- `"bg:blue fg:bright-green"` pone texto verde claro sobre un fondo azul
|
||
- `"bold fg:27"` pone texto en negrita con [color ANSI](https://i.stack.imgur.com/KTSQa.png) 27
|
||
- `"underline bg:#bf5700"` subraya el texto sobre un fondo naranja oscuro
|
||
- `"bold italic fg:purple"` pone texto color morado, en negrita y cursiva
|
||
- `""` desactiva explícitamente cualquier estilo
|
||
|
||
Note that what styling looks like will be controlled by your terminal emulator. For example, some terminal emulators will brighten the colors instead of bolding text, and some color themes use the same values for the normal and bright colors. Also, to get italic text, your terminal must support italics.
|
||
|
||
#### Cadenas de Formato Condicional
|
||
|
||
A conditional format string wrapped in `(` and `)` will not render if all variables inside are empty.
|
||
|
||
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\] )`.
|
||
|
||
#### Special characters
|
||
|
||
The following symbols have special usage in a format string and must be escaped: `$ \ [ ] ( )`.
|
||
|
||
Note that TOML has [both basic strings and literal strings](https://toml.io/en/v1.0.0#string). It is recommended to use a literal string (surrounded by single quotes) in your config. If you want to use a basic string (surrounded by double quotes), you must escape the backslash itself (i.e. use `\\`).
|
||
|
||
For example, when you want to print a `$` symbol on a new line, the following configs for `format` are equivalent:
|
||
|
||
```toml
|
||
# with basic string
|
||
format = "\n\\$"
|
||
|
||
# with multiline basic string
|
||
format = """
|
||
|
||
\\$"""
|
||
|
||
# with literal string
|
||
format = '''
|
||
|
||
\$'''
|
||
```
|
||
|
||
## Prompt
|
||
|
||
This is the list of prompt-wide configuration options.
|
||
|
||
### Opciones
|
||
|
||
| Opción | Por defecto | Descripción |
|
||
| ----------------- | ---------------------------------- | ------------------------------------------------------------------------------ |
|
||
| `format` | [ver aquí](#default-prompt-format) | Configura el formato del prompt. |
|
||
| `right_format` | `""` | Ver [Habilitar prompt derecho](/advanced-config/#enable-right-prompt) |
|
||
| `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
|
||
|
||
```toml
|
||
# ~/.config/starship.toml
|
||
|
||
# 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
|
||
|
||
# Disable the blank line at the start of the prompt
|
||
add_newline = false
|
||
```
|
||
|
||
### Formato por Defecto del Prompt
|
||
|
||
The default `format` is used to define the format of the prompt, if empty or no `format` is provided. The default is as shown:
|
||
|
||
```toml
|
||
format = "$all"
|
||
|
||
# Which is equivalent to
|
||
format = """
|
||
$username\
|
||
$hostname\
|
||
$shlvl\
|
||
$singularity\
|
||
$kubernetes\
|
||
$directory\
|
||
$vcsh\
|
||
$git_branch\
|
||
$git_commit\
|
||
$git_state\
|
||
$git_metrics\
|
||
$git_status\
|
||
$hg_branch\
|
||
$docker_context\
|
||
$package\
|
||
$cmake\
|
||
$cobol\
|
||
$dart\
|
||
$deno\
|
||
$dotnet\
|
||
$elixir\
|
||
$elm\
|
||
$erlang\
|
||
$golang\
|
||
$helm\
|
||
$java\
|
||
$julia\
|
||
$kotlin\
|
||
$lua\
|
||
$nim\
|
||
$nodejs\
|
||
$ocaml\
|
||
$perl\
|
||
$php\
|
||
$pulumi\
|
||
$purescript\
|
||
$python\
|
||
$rlang\
|
||
$red\
|
||
$ruby\
|
||
$rust\
|
||
$scala\
|
||
$swift\
|
||
$terraform\
|
||
$vlang\
|
||
$vagrant\
|
||
$zig\
|
||
$nix_shell\
|
||
$conda\
|
||
$memory_usage\
|
||
$aws\
|
||
$gcloud\
|
||
$openstack\
|
||
$azure\
|
||
$env_var\
|
||
$crystal\
|
||
$custom\
|
||
$sudo\
|
||
$cmd_duration\
|
||
$line_break\
|
||
$jobs\
|
||
$battery\
|
||
$time\
|
||
$status\
|
||
$shell\
|
||
$character"""
|
||
```
|
||
|
||
If you just want to extend the default format, you can use `$all`; modules you explicitly add to the format will not be duplicated. Ej.
|
||
|
||
```toml
|
||
# Move the directory to the second line
|
||
format="$all$directory$character"
|
||
```
|
||
|
||
## AWS
|
||
|
||
The `aws` module shows the current AWS region and profile. This is based on `AWS_REGION`, `AWS_DEFAULT_REGION`, and `AWS_PROFILE` env var with `~/.aws/config` file. This module also shows an expiration timer when using temporary credentials.
|
||
|
||
When using [aws-vault](https://github.com/99designs/aws-vault) the profile is read from the `AWS_VAULT` env var and the credentials expiration date is read from the `AWS_SESSION_EXPIRATION` env var.
|
||
|
||
When using [awsu](https://github.com/kreuzwerker/awsu) the profile is read from the `AWSU_PROFILE` env var.
|
||
|
||
When using [AWSume](https://awsu.me) the profile is read from the `AWSUME_PROFILE` env var and the credentials expiration date is read from the `AWSUME_EXPIRATION` env var.
|
||
|
||
### 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
|
||
|
||
```toml
|
||
# ~/.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
|
||
|
||
```toml
|
||
# ~/.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
|
||
|
||
```toml
|
||
# ~/.config/starship.toml
|
||
|
||
[aws]
|
||
format = "on [$symbol$profile]($style) "
|
||
style = "bold blue"
|
||
symbol = "🅰 "
|
||
```
|
||
|
||
## Azure
|
||
|
||
The `azure` module shows the current Azure Subscription. This is based on showing the name of the default subscription, as defined in the `~/.azure/azureProfile.json` file.
|
||
|
||
### Opciones
|
||
|
||
| Variable | Por defecto | Descripción |
|
||
| ---------- | ---------------------------------------- | ------------------------------------------ |
|
||
| `format` | `"on [$symbol($subscription)]($style) "` | The format for the Azure module to render. |
|
||
| `symbol` | `"ﴃ "` | The symbol used in the format. |
|
||
| `style` | `"blue bold"` | The style used in the format. |
|
||
| `disabled` | `true` | Disables the `azure` module. |
|
||
|
||
### Ejemplo
|
||
|
||
```toml
|
||
# ~/.config/starship.toml
|
||
|
||
[azure]
|
||
disabled = false
|
||
format = "on [$symbol($subscription)]($style) "
|
||
symbol = "ﴃ "
|
||
style = "blue bold"
|
||
```
|
||
|
||
## Battery
|
||
|
||
The `battery` module shows how charged the device's battery is and its current charging status. The module is only visible when the device's battery is below 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 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í](#battery-display) | Define cuándo mostrar el indicador y el estilo. |
|
||
| `disabled` | `false` | Desactiva el módulo `battery`. |
|
||
|
||
### Ejemplo
|
||
|
||
```toml
|
||
# ~/.config/starship.toml
|
||
|
||
[battery]
|
||
full_symbol = "🔋 "
|
||
charging_symbol = "⚡️ "
|
||
discharging_symbol = "💀 "
|
||
```
|
||
|
||
### Indicador de batería
|
||
|
||
The `display` configuration option is used to define when the battery indicator should be shown (threshold), which symbol would be used (symbol), and what it would like (style). If no `display` is provided. The default is as shown:
|
||
|
||
```toml
|
||
[[battery.display]]
|
||
threshold = 10
|
||
style = "bold red"
|
||
```
|
||
|
||
The default value for the `charging_symbol` and `discharging_symbol` option is respectively the value of `battery`'s `charging_symbol` and `discharging_symbol` option.
|
||
|
||
#### Opciones
|
||
|
||
The `display` option is an array of the following table.
|
||
|
||
| 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
|
||
|
||
```toml
|
||
[[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
|
||
|
||
The `character` module shows a character (usually an arrow) beside where the text is entered in your terminal.
|
||
|
||
The character will tell you whether the last command was successful or not. It can do this in two ways:
|
||
|
||
- Cambiando el color (`red`/`green`)
|
||
- Cambiando la forma (`.`/`✖`)
|
||
|
||
By default it only changes color. If you also want to change its shape take a look at [this example](#with-custom-error-shape).
|
||
|
||
::: aviso
|
||
|
||
`error_symbol` is not supported on nu shell.
|
||
|
||
:::
|
||
|
||
::: aviso
|
||
|
||
`vicmd_symbol` is only supported in cmd, fish and 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
|
||
|
||
```toml
|
||
# ~/.config/starship.toml
|
||
|
||
[character]
|
||
success_symbol = "[➜](bold green) "
|
||
error_symbol = "[✗](bold red) "
|
||
```
|
||
|
||
#### Sin formato de error personalizado
|
||
|
||
```toml
|
||
# ~/.config/starship.toml
|
||
|
||
[character]
|
||
success_symbol = "[➜](bold green) "
|
||
error_symbol = "[➜](bold red) "
|
||
```
|
||
|
||
#### Con formato de vim personalizado
|
||
|
||
```toml
|
||
# ~/.config/starship.toml
|
||
|
||
[character]
|
||
vicmd_symbol = "[V](bold green) "
|
||
```
|
||
|
||
## CMake
|
||
|
||
The `cmake` module shows the currently installed version of [CMake](https://cmake.org/). By default the module will be activated if any of the following conditions are met:
|
||
|
||
- El directorio actual contiene un archivo `CMakeLists.txt`
|
||
- The current directory contains a `CMakeCache.txt` file
|
||
|
||
### Opciones
|
||
|
||
| Opción | Por defecto | Descripción |
|
||
| ------------------- | -------------------------------------- | --------------------------------------------------------------------------------------- |
|
||
| `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. |
|
||
| `version_format` | `"v${raw}"` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
|
||
| `symbol` | `"△ "` | 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
|
||
|
||
The `cobol` module shows the currently installed version of COBOL. By default, the module will be shown if any of the following conditions are met:
|
||
|
||
- 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
|
||
|
||
The `cmd_duration` module shows how long the last command took to execute. The module will be shown only if the command took longer than two seconds, or the `min_time` config value, if it exists.
|
||
|
||
::: warning Do not hook the DEBUG trap in Bash
|
||
|
||
If you are running Starship in `bash`, do not hook the `DEBUG` trap after running `eval $(starship init $0)`, or this module **will** break.
|
||
|
||
:::
|
||
|
||
Bash users who need preexec-like functionality can use [rcaloras's bash_preexec framework](https://github.com/rcaloras/bash-preexec). Simply define the arrays `preexec_functions` and `precmd_functions` before running `eval $(starship init $0)`, and then proceed as normal.
|
||
|
||
### Opciones
|
||
|
||
| Opción | Por defecto | Descripción |
|
||
| -------------------- | ----------------------------- | ---------------------------------------------------------------------- |
|
||
| `min_time` | `2_000` | Duración mínima para mostrar el tiempo de ejecución (en milisegundos) |
|
||
| `show_milliseconds` | `false` | Muestra la duración con precisión en milisegundos. |
|
||
| `format` | `"took [$duration]($style) "` | El formato del módulo. |
|
||
| `style` | `"bold yellow"` | El estilo del módulo. |
|
||
| `disabled` | `false` | Desactiva el módulo `cmd_duration`. |
|
||
| `show_notifications` | `false` | Muestra notificaciones de escritorio cuando se complete el comando. |
|
||
| `min_time_to_notify` | `45_000` | Duración mínima para mostrar el tiempo de ejecución (en milisegundos). |
|
||
|
||
::: tip
|
||
|
||
Showing desktop notifications requires starship to be built with `notify-rust` support. You check if your starship supports notifications by running `STARSHIP_LOG=debug starship module cmd_duration -d 60000` when `show_notifications` is set to `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
|
||
|
||
```toml
|
||
# ~/.config/starship.toml
|
||
|
||
[cmd_duration]
|
||
min_time = 500
|
||
format = "underwent [$duration](bold yellow)"
|
||
```
|
||
|
||
## Conda
|
||
|
||
The `conda` module shows the current [Conda](https://docs.conda.io/en/latest/) environment, if `$CONDA_DEFAULT_ENV` is set.
|
||
|
||
::: consejo
|
||
|
||
This does not suppress conda's own prompt modifier, you may want to run `conda config --set changeps1 False`.
|
||
|
||
:::
|
||
|
||
### Opciones
|
||
|
||
| Opción | Por defecto | Descripción |
|
||
| ------------------- | -------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||
| `truncation_length` | `1` | El número de directorios a los que se debe truncar la variable de entorno, si el entorno fue creado usando `conda create -p [path]`. `0` significa sin truncamiento. Mirar también el módulo [`directory`](#directory). |
|
||
| `symbol` | `"🅒 "` | El símbolo usado antes del nombre del entorno. |
|
||
| `style` | `"bold green"` | El estilo del módulo. |
|
||
| `format` | `"via [$symbol$environment]($style) "` | El formato del módulo. |
|
||
| `ignore_base` | `true` | Ignora el entorno `base` cuando se activa. |
|
||
| `disabled` | `false` | Desactiva el módulo `conda`. |
|
||
|
||
### Variables
|
||
|
||
| Variable | Ejemplo | Descripción |
|
||
| ----------- | ------------ | -------------------------------------- |
|
||
| environment | `astronauts` | El entorno conda actual |
|
||
| symbol | | Refleja el valor de la opción `symbol` |
|
||
| style\* | | Refleja el valor de la opción `style` |
|
||
|
||
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
|
||
|
||
### Ejemplo
|
||
|
||
```toml
|
||
# ~/.config/starship.toml
|
||
|
||
[conda]
|
||
format = "[$symbol$environment](dimmed green) "
|
||
```
|
||
|
||
## Crystal
|
||
|
||
The `crystal` module shows the currently installed version of [Crystal](https://crystal-lang.org/). Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones:
|
||
|
||
- El directorio actual contiene un fichero `shard.yml`
|
||
- El directorio actual contiene un fichero `.cr`
|
||
|
||
### Opciones
|
||
|
||
| Opción | Por defecto | Descripción |
|
||
| ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------- |
|
||
| `symbol` | `"🔮 "` | Símbolo usado antes de la versión de Crystal. |
|
||
| `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. |
|
||
| `version_format` | `"v${raw}"` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
|
||
| `style` | `"bold red"` | El estilo del módulo. |
|
||
| `detect_extensions` | `["cr"]` | Qué extensiones deberían activar este módulo. |
|
||
| `detect_files` | `["shard.yml"]` | Qué nombres de archivo deberían activar este módulo. |
|
||
| `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. |
|
||
| `disabled` | `false` | Desactiva el módulo `crystal`. |
|
||
|
||
### Variables
|
||
|
||
| Variable | Ejemplo | Descripción |
|
||
| --------- | --------- | -------------------------------------- |
|
||
| version | `v0.32.1` | La versión de `crystal` |
|
||
| symbol | | Refleja el valor de la opción `symbol` |
|
||
| style\* | | Refleja el valor de la opción `style` |
|
||
|
||
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
|
||
|
||
### Ejemplo
|
||
|
||
```toml
|
||
# ~/.config/starship.toml
|
||
|
||
[crystal]
|
||
format = "via [✨ $version](bold blue) "
|
||
```
|
||
|
||
## Dart
|
||
|
||
The `dart` module shows the currently installed version of [Dart](https://dart.dev/). Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones:
|
||
|
||
- El directorio actual contiene un archivo con la extensión `.dart`
|
||
- El directorio actual contiene un directorio `.dart_tool`
|
||
- El directorio actual contiene un archivo `pubspec.yaml`, `pubspec.yml` o `pubspec.lock`
|
||
|
||
### Opciones
|
||
|
||
| Opción | Por defecto | Descripción |
|
||
| ------------------- | ------------------------------------------------- | --------------------------------------------------------------------------------------- |
|
||
| `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. |
|
||
| `version_format` | `"v${raw}"` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
|
||
| `symbol` | `"🎯 "` | Una cadena de formato que representa el símbolo de Dart |
|
||
| `detect_extensions` | `["dart"]` | Qué extensiones deberían activar este módulo. |
|
||
| `detect_files` | `["pubspec.yaml", "pubspec.yml", "pubspec.lock"]` | Qué nombres de archivo deberían activar este módulo. |
|
||
| `detect_folders` | `[".dart_tool"]` | Qué carpetas deberían activar este módulo. |
|
||
| `style` | `"bold blue"` | El estilo del módulo. |
|
||
| `disabled` | `false` | Desactiva el módulo `dart`. |
|
||
|
||
### Variables
|
||
|
||
| Variable | Ejemplo | Descripción |
|
||
| --------- | -------- | -------------------------------------- |
|
||
| version | `v2.8.4` | La versión de `dart` |
|
||
| symbol | | Refleja el valor de la opción `symbol` |
|
||
| style\* | | Refleja el valor de la opción `style` |
|
||
|
||
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
|
||
|
||
### Ejemplo
|
||
|
||
```toml
|
||
# ~/.config/starship.toml
|
||
|
||
[dart]
|
||
format = "via [🔰 $version](bold red) "
|
||
```
|
||
|
||
## Deno
|
||
|
||
The `deno` module shows you your currently installed version of [Deno](https://deno.land/). Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones:
|
||
- The current directory contains a `deno.json`, `deno.jsonc`, `mod.ts`, `mod.js`, `deps.ts` or `deps.js` file
|
||
|
||
### Opciones
|
||
|
||
| Opción | Por defecto | Descripción |
|
||
| ------------------- | ----------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
|
||
| `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. |
|
||
| `version_format` | `"v${raw}"` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
|
||
| `symbol` | `"🦕 "` | Una cadena de formato que representa el símbolo de Deno |
|
||
| `detect_extensions` | `[]` | Qué extensiones deberían activar este módulo. |
|
||
| `detect_files` | `["deno.json", "deno.jsonc", "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
|
||
|
||
```toml
|
||
# ~/.config/starship.toml
|
||
|
||
[deno]
|
||
format = "via [🦕 $version](green bold) "
|
||
```
|
||
|
||
## Directory
|
||
|
||
The `directory` module shows the path to your current directory, truncated to three parent folders. Your directory will also be truncated to the root of the git repo that you're currently in.
|
||
|
||
When using the fish style pwd option, instead of hiding the path that is truncated, you will see a shortened name of each directory based on the number you enable for the option.
|
||
|
||
For example, given `~/Dev/Nix/nixpkgs/pkgs` where `nixpkgs` is the repo root, and the option set to `1`. You will now see `~/D/N/nixpkgs/pkgs`, whereas before it would have been `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` | Desactiva el módulo `directory`. |
|
||
| `read_only` | `"🔒"` | El símbolo que indica si el directorio actual es de sólo lectura. |
|
||
| `read_only_style` | `"red"` | El estilo para el símbolo de sólo lectura. |
|
||
| `truncation_symbol` | `""` | El símbolo a prefijar a las rutas truncadas. ej: "…/" |
|
||
| `repo_root_style` | `None` | The style for the root of the git repo when `truncate_to_repo` option is set to false. |
|
||
| `home_symbol` | `"~"` | El símbolo que indica el directorio personal. |
|
||
| `use_os_path_sep` | `true` | Use the OS specific path seperator instead of always using `/` (e.g. `\` on Windows) |
|
||
|
||
<details>
|
||
<summary>This module has a few advanced configuration options that control how the directory is displayed.</summary>
|
||
|
||
| Opciones avanzadas | Por defecto | Descripción |
|
||
| --------------------------- | ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||
| `substitutions` | | Una tabla de sustituciones que se deben hacer a la ruta. |
|
||
| `fish_style_pwd_dir_length` | `0` | El número de caracteres a usar al aplicar la lógica de ruta pwd 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` 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.
|
||
|
||
```toml
|
||
[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`.
|
||
|
||
</details>
|
||
|
||
### 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
|
||
|
||
```toml
|
||
# ~/.config/starship.toml
|
||
|
||
[directory]
|
||
truncation_length = 8
|
||
truncation_symbol = "…/"
|
||
```
|
||
|
||
## Docker context
|
||
|
||
The `docker_context` module shows the currently active [Docker context](https://docs.docker.com/engine/context/working-with-contexts/) 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 deberían activar este módulo (necesita que `solly_with_files` sea verdadero, con un valor "true"). |
|
||
| `detect_files` | `["docker-compose.yml", "docker-compose.yaml", "Dockerfile"]` | Qué nombres de archivo deberían activar este módulo (necesita que `solly_with_files` sea verdadero, con un valor "true"). |
|
||
| `detect_folders` | `[]` | Qué carpetas deberían activar este módulo (necesita que `solly_with_files` sea verdadero, con un valor "true"). |
|
||
| `style` | `"blue bold"` | El estilo del módulo. |
|
||
| `disabled` | `false` | Desactiva 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
|
||
|
||
```toml
|
||
# ~/.config/starship.toml
|
||
|
||
[docker_context]
|
||
format = "via [🐋 $context](blue bold)"
|
||
```
|
||
|
||
## Dotnet
|
||
|
||
The `dotnet` module shows the relevant version of the [.NET Core SDK](https://dotnet.microsoft.com/) for the current directory. If the SDK has been pinned in the current directory, the pinned version is shown. Otherwise the module shows the latest installed version of the SDK.
|
||
|
||
By default this module will only be shown in your prompt when one or more of the following files are present in the current directory:
|
||
|
||
- `global.json`
|
||
- `project.json`
|
||
- `Directory.Build.props`
|
||
- `Directory.Build.targets`
|
||
- `Packages.props`
|
||
- `*.csproj`
|
||
- `*.fsproj`
|
||
- `*.xproj`
|
||
|
||
You'll also need the .NET Core SDK installed in order to use it correctly.
|
||
|
||
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
|
||
|
||
| 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
|
||
|
||
```toml
|
||
# ~/.config/starship.toml
|
||
|
||
[dotnet]
|
||
symbol = "🥅 "
|
||
style = "green"
|
||
heuristic = false
|
||
```
|
||
|
||
## Elixir
|
||
|
||
The `elixir` module shows the currently installed version of [Elixir](https://elixir-lang.org/) and [Erlang/OTP](https://erlang.org/doc/). 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
|
||
|
||
```toml
|
||
# ~/.config/starship.toml
|
||
|
||
[elixir]
|
||
symbol = "🔮 "
|
||
```
|
||
|
||
## Elm
|
||
|
||
The `elm` module shows the currently installed version of [Elm](https://elm-lang.org/). 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
|
||
|
||
```toml
|
||
# ~/.config/starship.toml
|
||
|
||
[elm]
|
||
format = "via [ $version](cyan bold) "
|
||
```
|
||
|
||
## Variable de entorno
|
||
|
||
The `env_var` module displays the current value of a selected environment variables. The module will be shown only if any of the following conditions are met:
|
||
|
||
- La opción de configuración de `variable` coincide con una variable de entorno existente
|
||
- La opción de configuración de `variable` no está definida, pero la opción de configuración se encuentra `por defecto`
|
||
|
||
|
||
::: tip Multiple environmental variables can be displayed by using a `.`. (see example) If the `variable` configuration option is not set, the module will display value of variable under the name of text after the `.` character.
|
||
|
||
Example: following configuration will display value of USER environment variable
|
||
```toml
|
||
# ~/.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` (si _variable_ es `$OS`) | El valor de entorno de la opción `variable` |
|
||
| symbol | | Refleja el valor de la opción `symbol` |
|
||
| style\* | `black bold dimmed` | Refleja el valor de la opción `style` |
|
||
|
||
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
|
||
|
||
### Ejemplo
|
||
|
||
```toml
|
||
# ~/.config/starship.toml
|
||
|
||
[env_var]
|
||
variable = "SHELL"
|
||
default = "unknown shell"
|
||
```
|
||
|
||
Displaying multiple environmental variables:
|
||
```toml
|
||
# ~/.config/starship.toml
|
||
|
||
[env_var.SHELL]
|
||
variable = "SHELL"
|
||
default = "unknown shell"
|
||
[env_var.USER]
|
||
default = "unknown user"
|
||
```
|
||
|
||
## Erlang
|
||
|
||
The `erlang` module shows the currently installed version of [Erlang/OTP](https://erlang.org/doc/). 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
|
||
|
||
```toml
|
||
# ~/.config/starship.toml
|
||
|
||
[erlang]
|
||
format = "via [e $version](bold red) "
|
||
```
|
||
|
||
## Llenar
|
||
|
||
The `fill` module fills any extra space on the line with a symbol. If multiple `fill` modules are present in a line they will split the space evenly between them. This is useful for aligning other modules.
|
||
|
||
### 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
|
||
|
||
```toml
|
||
# ~/.config/starship.toml
|
||
format="AA $fill BB $fill CC"
|
||
|
||
[fill]
|
||
symbol = "-"
|
||
style = "bold green"
|
||
```
|
||
|
||
Produces a prompt that looks like:
|
||
|
||
```
|
||
AA -------------------------------------------- BB -------------------------------------------- CC
|
||
|
||
```
|
||
|
||
## Google Cloud (`gcloud`)
|
||
|
||
The `gcloud` module shows the current configuration for [`gcloud`](https://cloud.google.com/sdk/gcloud) CLI. This is based on the `~/.config/gcloud/active_config` file and the `~/.config/gcloud/configurations/config_{CONFIG NAME}` file and the `CLOUDSDK_CONFIG` env var.
|
||
|
||
### Opciones
|
||
|
||
| Opción | Por defecto | Descripción |
|
||
| ---------------- | ---------------------------------------------------------- | ---------------------------------------------------------- |
|
||
| `format` | `'on [$symbol$account(@$domain)(\($region\))]($style) '` | El formato del módulo. |
|
||
| `symbol` | `"☁️ "` | El símbolo usado antes de mostrar el perfil actual de GCP. |
|
||
| `region_aliases` | | Tabla de alias de región a mostrar además del nombre GCP. |
|
||
| `style` | `"bold blue"` | El estilo del módulo. |
|
||
| `disabled` | `false` | Desactiva el módulo `gcloud`. |
|
||
|
||
### Variables
|
||
|
||
| Variable | Ejemplo | Descripción |
|
||
| --------- | ------------- | ----------------------------------------------------------------------------- |
|
||
| region | `us-central1` | La región GCP actual |
|
||
| account | `foo` | El perfil actual de GCP |
|
||
| domain | `example.com` | El dominio actual del perfil GCP |
|
||
| project | | El proyecto GCP actual |
|
||
| active | `default` | El nombre de configuración activo escrito en `~/.config/gcloud/active_config` |
|
||
| symbol | | Refleja el valor de la opción `symbol` |
|
||
| style\* | | Refleja el valor de la opción `style` |
|
||
|
||
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
|
||
|
||
### Ejemplos
|
||
|
||
#### Mostrar cuenta y proyecto
|
||
|
||
```toml
|
||
# ~/.config/starship.toml
|
||
|
||
[gcloud]
|
||
format = 'on [$symbol$account(@$domain)(\($project\))]($style) '
|
||
```
|
||
|
||
#### Mostrar solo el nombre de la configuración activa
|
||
|
||
```toml
|
||
# ~/.config/starship.toml
|
||
|
||
[gcloud]
|
||
format = "[$symbol$active]($style) "
|
||
style = "bold yellow"
|
||
```
|
||
|
||
#### Mostrar los alias de cuenta y región
|
||
|
||
```toml
|
||
# ~/.config/starship.toml
|
||
|
||
[gcloud]
|
||
symbol = "️🇬️ "
|
||
[gcloud.region_aliases]
|
||
us-central1 = "uc1"
|
||
asia-northeast1 = "an1"
|
||
```
|
||
|
||
## Git Branch
|
||
|
||
The `git_branch` module shows the active branch of the repo in your current directory.
|
||
|
||
### Opciones
|
||
|
||
| Opción | Por defecto | Descripción |
|
||
| -------------------- | -------------------------------- | ------------------------------------------------------------------------------------------------------- |
|
||
| `always_show_remote` | `false` | Muestra el nombre de la rama de seguimiento remoto, incluso si es igual al nombre de la rama local. |
|
||
| `format` | `"on [$symbol$branch]($style) "` | El formato del módulo. 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 |
|
||
| ------------- | -------- | -------------------------------------------------------------------------------------------------------------- |
|
||
| branch | `master` | El nombre de la rama actual, vuelve a `HEAD` si no hay ninguna rama actual (por ejemplo, git detached `HEAD`). |
|
||
| remote_name | `origin` | El nombre remoto. |
|
||
| remote_branch | `master` | El nombre de la rama rastreada en `remote_name`. |
|
||
| symbol | | Refleja el valor de la opción `symbol` |
|
||
| style\* | | Refleja el valor de la opción `style` |
|
||
|
||
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
|
||
|
||
### Ejemplo
|
||
|
||
```toml
|
||
# ~/.config/starship.toml
|
||
|
||
[git_branch]
|
||
symbol = "🌱 "
|
||
truncation_length = 4
|
||
truncation_symbol = ""
|
||
```
|
||
|
||
## Git commit
|
||
|
||
The `git_commit` module shows the current commit hash and also the tag (if any) of the repo in your current directory.
|
||
|
||
### Opciones
|
||
|
||
| Opción | Por defecto | Descripción |
|
||
| -------------------- | ---------------------------------- | -------------------------------------------------------------------------------------- |
|
||
| `commit_hash_length` | `7` | La longitud del hash 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
|
||
|
||
```toml
|
||
# ~/.config/starship.toml
|
||
|
||
[git_commit]
|
||
commit_hash_length = 4
|
||
tag_symbol = "🔖 "
|
||
```
|
||
|
||
## Git state
|
||
|
||
The `git_state` module will show in directories which are part of a git repository, and where there is an operation in progress, such as: _REBASING_, _BISECTING_, etc. If there is progress information (e.g., REBASING 3/10), that information will be shown too.
|
||
|
||
### Opciones
|
||
|
||
| Opción | Por defecto | Descripción |
|
||
| -------------- | --------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
|
||
| `rebase` | `"REBASING"` | Una cadena de formato que se muestra cuando un `rebase` está en progreso. |
|
||
| `merge` | `"MERGING"` | Una cadena de formato que se muestra cuando un `merge` está en progreso. |
|
||
| `revert` | `"REVERTING"` | Una cadena de formato mostrada cuando un `revert` está en progreso. |
|
||
| `cherry_pick` | `"CHERRY-PICKING"` | Una cadena de formato que se muestra cuando un `cherry-pick` está en progreso. |
|
||
| `bisect` | `"BISECTING"` | Una cadena de formato que se muestra cuando un `bisect` está en progreso. |
|
||
| `am` | `"AM"` | Una cadena de formato que se muestra cuando un `apply-mailbox` (`git am`) está en progeso. |
|
||
| `am_or_rebase` | `"AM/REBASE"` | Una cadena de formato que se muestra cuando un ambiguo `apply-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
|
||
|
||
```toml
|
||
# ~/.config/starship.toml
|
||
|
||
[git_state]
|
||
format = '[\($state( $progress_current of $progress_total)\)]($style) '
|
||
cherry_pick = "[🍒 PICKING](bold red)"
|
||
```
|
||
|
||
## Métricas de Git
|
||
|
||
The `git_metrics` module will show the number of added and deleted lines in the current git repository.
|
||
|
||
::: consejo
|
||
|
||
This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||
|
||
:::
|
||
|
||
### Opciones
|
||
|
||
| Opción | Por defecto | Descripción |
|
||
| -------------------- | ------------------------------------------------------------ | -------------------------------------------------- |
|
||
| `added_style` | `"bold green"` | 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
|
||
|
||
```toml
|
||
# ~/.config/starship.toml
|
||
|
||
[git_metrics]
|
||
added_style = "bold blue"
|
||
format = '[+$added]($added_style)/[-$deleted]($deleted_style) '
|
||
```
|
||
|
||
## Git status
|
||
|
||
The `git_status` module shows symbols representing the state of the repo in your current directory.
|
||
|
||
### Opciones
|
||
|
||
| Opción | Por defecto | Descripción |
|
||
| ------------------- | ----------------------------------------------- | ---------------------------------------- |
|
||
| `format` | `'([\[$all_status$ahead_behind\]]($style) )'` | El formato por defecto para `git_status` |
|
||
| `conflicted` | `"="` | Esta rama tiene conflictos de fusión. |
|
||
| `ahead` | `"⇡"` | El formato de `ahead` |
|
||
| `behind` | `"⇣"` | El formato de `behind` |
|
||
| `diverged` | `"⇕"` | El formato de `diverged` |
|
||
| `up_to_date` | `""` | El formato de `up_to_date` |
|
||
| `untracked` | `"?"` | El formato de `untracked` |
|
||
| `stashed` | `"$"` | El formato de `stashed` |
|
||
| `modified` | `"!"` | El formato de `modified` |
|
||
| `staged` | `"+"` | El formato de `staged` |
|
||
| `renamed` | `"»"` | El formato de `renamed` |
|
||
| `deleted` | `"✘"` | El formato de `deleted` |
|
||
| `style` | `"bold red"` | El estilo del módulo. |
|
||
| `ignore_submodules` | `false` | Ignore changes to submodules. |
|
||
| `disabled` | `false` | Disables the `git_status` module. |
|
||
|
||
### Variables
|
||
|
||
The following variables can be used in `format`:
|
||
|
||
| Variable | Descripción |
|
||
| -------------- | ------------------------------------------------------------------------------------------------------------------------ |
|
||
| `all_status` | Atajo para `$conflicted$stashed$deleted$renamed$modified$staged$untracked` |
|
||
| `ahead_behind` | 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. |
|
||
| `modified` | Muestra `modified` cuando hay modificaciones de archivo en el directorio de trabajo. |
|
||
| `staged` | Muestra `staged` cuando se ha añadido un nuevo archivo al área de "stash". |
|
||
| `renamed` | Muestra `renamed` cuando un archivo renombrado ha sido añadido al área de "stash". |
|
||
| `deleted` | Muestra `deleted` cuando un archivo ha sido añadido al área de "stash". |
|
||
| style\* | Refleja el valor de la opción `style` |
|
||
|
||
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
|
||
|
||
The following variables can be used in `diverged`:
|
||
|
||
| Variable | Descripción |
|
||
| -------------- | ------------------------------------------------------- |
|
||
| `ahead_count` | Número de commits por delante de la rama de seguimiento |
|
||
| `behind_count` | Número de commits detrás de la rama de seguimiento |
|
||
|
||
The following variables can be used in `conflicted`, `ahead`, `behind`, `untracked`, `stashed`, `modified`, `staged`, `renamed` and `deleted`:
|
||
|
||
| Variable | Descripción |
|
||
| -------- | ----------------------------- |
|
||
| `count` | Muestra el número de archivos |
|
||
|
||
### Ejemplo
|
||
|
||
```toml
|
||
# ~/.config/starship.toml
|
||
|
||
[git_status]
|
||
conflicted = "🏳"
|
||
ahead = "🏎💨"
|
||
behind = "😰"
|
||
diverged = "😵"
|
||
up_to_date = "✓"
|
||
untracked = "🤷"
|
||
stashed = "📦"
|
||
modified = "📝"
|
||
staged = '[++\($count\)](green)'
|
||
renamed = "👅"
|
||
deleted = "🗑"
|
||
```
|
||
|
||
Show ahead/behind count of the branch being tracked
|
||
|
||
```toml
|
||
# ~/.config/starship.toml
|
||
|
||
[git_status]
|
||
ahead = "⇡${count}"
|
||
diverged = "⇕⇡${ahead_count}⇣${behind_count}"
|
||
behind = "⇣${count}"
|
||
```
|
||
|
||
## Go
|
||
|
||
The `golang` module shows the currently installed version of [Go](https://golang.org/). Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones:
|
||
|
||
- El directorio actual contiene un archivo `go.mod`
|
||
- El directorio actual contiene un archivo `go.sum`
|
||
- El directorio actual contiene un archivo `glide.yaml`
|
||
- El directorio actual contiene un archivo `Gopkg.yml`
|
||
- El directorio actual contiene un archivo `Gopkg.lock`
|
||
- El directorio actual contiene un archivo `.go-version`
|
||
- El directorio actual contiene un directorio `Godeps`
|
||
- El directorio actual contiene un archivo con la extensión `.go`
|
||
|
||
### Opciones
|
||
|
||
| Opción | Por defecto | Descripción |
|
||
| ------------------- | ------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------- |
|
||
| `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. |
|
||
| `version_format` | `"v${raw}"` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
|
||
| `symbol` | `"🐹 "` | Una cadena de formato que representa el símbolo de Go. |
|
||
| `detect_extensions` | `["go"]` | Qué extensiones deberían activar este módulo. |
|
||
| `detect_files` | `["go.mod", "go.sum", "glide.yaml", "Gopkg.yml", "Gopkg.lock", ".go-version"]` | Qué nombres de archivo deberían activar este módulo. |
|
||
| `detect_folders` | `["Godeps"]` | Qué carpetas deberían activar este módulo. |
|
||
| `style` | `"bold cyan"` | El estilo del módulo. |
|
||
| `disabled` | `false` | Desactiva el módulo de `golang`. |
|
||
|
||
### Variables
|
||
|
||
| Variable | Ejemplo | Descripción |
|
||
| --------- | --------- | -------------------------------------- |
|
||
| version | `v1.12.1` | La versión de `go` |
|
||
| symbol | | Refleja el valor de la opción `symbol` |
|
||
| style\* | | Refleja el valor de la opción `style` |
|
||
|
||
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
|
||
|
||
### Ejemplo
|
||
|
||
```toml
|
||
# ~/.config/starship.toml
|
||
|
||
[golang]
|
||
format = "via [🏎💨 $version](bold cyan) "
|
||
```
|
||
|
||
## Helm
|
||
|
||
The `helm` module shows the currently installed version of [Helm](https://helm.sh/). 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
|
||
|
||
```toml
|
||
# ~/.config/starship.toml
|
||
|
||
[helm]
|
||
format = "via [⎈ $version](bold white) "
|
||
```
|
||
|
||
## Hostname
|
||
|
||
The `hostname` module shows the system hostname.
|
||
|
||
### Opciones
|
||
|
||
| Opción | Por defecto | Descripción |
|
||
| ---------- | --------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||
| `ssh_only` | `true` | Mostrar sólo el nombre de host cuando esté conectado a una sesión SSH. |
|
||
| `trim_at` | `"."` | Cadena en la que el nombre de host se corta, después de la primera partida. `"."` se detendrá después del primer punto. `""` deshabilitará cualquier truncamiento |
|
||
| `format` | `"[$hostname]($style) in "` | El formato del módulo. |
|
||
| `style` | `"bold dimmed green"` | El estilo del módulo. |
|
||
| `disabled` | `false` | Desactiva el módulo `hostname`. |
|
||
|
||
### Variables
|
||
|
||
| Variable | Ejemplo | Descripción |
|
||
| --------- | ---------- | ------------------------------------- |
|
||
| hostname | `computer` | The hostname of the computer |
|
||
| style\* | | Refleja el valor de la opción `style` |
|
||
|
||
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
|
||
|
||
### Ejemplo
|
||
|
||
```toml
|
||
# ~/.config/starship.toml
|
||
|
||
[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](https://www.oracle.com/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
|
||
|
||
```toml
|
||
# ~/.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 are at least 2 jobs, or more than the `number_threshold` config value, if it exists. The module will show a symbol if there is at least 1 job, or more than the `symbol_threshold` config value, if it exists. You can set both values to 0 in order to *always* show the symbol and number of jobs, even if there are 0 jobs running.
|
||
|
||
The default functionality is:
|
||
|
||
- 0 tareas -> Nada se muestra.
|
||
- 1 tarea -> `symbol` se muestra.
|
||
- 2 tareas o más -> `symbol` + `number` son mostrados.
|
||
|
||
::: aviso
|
||
|
||
This module is not supported on tcsh and nu.
|
||
|
||
:::
|
||
|
||
::: aviso
|
||
|
||
The `threshold` option is deprecated, but if you want to use it, the module will show the number of jobs running if there is more than 1 job, or more than the `threshold` config value, if it exists. If `threshold` is set to 0, then the module will also show when there are 0 jobs running.
|
||
|
||
:::
|
||
|
||
### Opciones
|
||
|
||
| Opción | Por defecto | Descripción |
|
||
| ------------------ | ----------------------------- | ---------------------------------------------------------------------------------- |
|
||
| `threshold`\* | `1` | 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`. |
|
||
\*: This option is deprecated, please use the
|
||
|
||
`number_threshold` and `symbol_threshold` options instead.
|
||
|
||
### Variables
|
||
|
||
| Variable | Ejemplo | Descripción |
|
||
| --------- | ------- | -------------------------------------- |
|
||
| number | `1` | El número de tareas |
|
||
| symbol | | Refleja el valor de la opción `symbol` |
|
||
| style\* | | Refleja el valor de la opción `style` |
|
||
|
||
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
|
||
|
||
### Ejemplo
|
||
|
||
```toml
|
||
# ~/.config/starship.toml
|
||
|
||
[jobs]
|
||
symbol = "+ "
|
||
number_threshold = 4
|
||
symbol_threshold = 0
|
||
```
|
||
|
||
## Julia
|
||
|
||
The `julia` module shows the currently installed version of [Julia](https://julialang.org/). 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
|
||
|
||
```toml
|
||
# ~/.config/starship.toml
|
||
|
||
[julia]
|
||
symbol = "∴ "
|
||
```
|
||
|
||
## Kotlin
|
||
|
||
The `kotlin` module shows the currently installed version of [Kotlin](https://kotlinlang.org/). Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones:
|
||
|
||
- El directorio actual contiene un archivo `.kt` o `.kts`
|
||
|
||
### Opciones
|
||
|
||
| Opción | Por defecto | Descripción |
|
||
| ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------- |
|
||
| `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. |
|
||
| `version_format` | `"v${raw}"` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
|
||
| `detect_extensions` | `["kt", "kts"]` | Qué extensiones deberían activar este módulo. |
|
||
| `detect_files` | `[]` | Qué nombres de archivo deberían activar este módulo. |
|
||
| `detect_folders` | `[]` | Qué carpetas deberían activar estos módulos. |
|
||
| `symbol` | `"🅺 "` | Una cadena de formato que representa el símbolo de Kotlin. |
|
||
| `style` | `"bold blue"` | El estilo del módulo. |
|
||
| `kotlin_binary` | `"kotlin"` | Configura el binario kotlin que Starship ejecuta al obtener la versión. |
|
||
| `disabled` | `false` | Deshabilita el módulo `kotlin`. |
|
||
|
||
### Variables
|
||
|
||
| Variable | Ejemplo | Descripción |
|
||
| --------- | --------- | -------------------------------------- |
|
||
| version | `v1.4.21` | La versión de `kotlin` |
|
||
| symbol | | Refleja el valor de la opción `symbol` |
|
||
| style\* | | Refleja el valor de la opción `style` |
|
||
|
||
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
|
||
|
||
### Ejemplo
|
||
|
||
```toml
|
||
# ~/.config/starship.toml
|
||
|
||
[kotlin]
|
||
symbol = "🅺 "
|
||
```
|
||
|
||
```toml
|
||
# ~/.config/starship.toml
|
||
|
||
[kotlin]
|
||
# Uses the Kotlin Compiler binary to get the installed version
|
||
kotlin_binary = "kotlinc"
|
||
```
|
||
|
||
## Kubernetes
|
||
|
||
Displays the current [Kubernetes context](https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/#context) name and, if set, the namespace from the kubeconfig file. The namespace needs to be set in the kubeconfig file, this can be done via `kubectl config set-context starship-cluster --namespace astronaut`. If the `$KUBECONFIG` env var is set the module will use that if not it will use the `~/.kube/config`.
|
||
|
||
::: consejo
|
||
|
||
This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||
|
||
:::
|
||
|
||
### Opciones
|
||
|
||
| Opción | Por defecto | Descripción |
|
||
| ----------------- | ---------------------------------------------------- | --------------------------------------------------------------------------- |
|
||
| `symbol` | `"☸ "` | Una cadena de formato que representa el símbolo mostrado antes del Cluster. |
|
||
| `format` | `'[$symbol$context( \($namespace\))]($style) in '` | El formato del módulo. |
|
||
| `style` | `"cyan bold"` | El estilo del módulo. |
|
||
| `context_aliases` | | Tabla de alias de contexto a mostrar. |
|
||
| `disabled` | `true` | Desactiva el módulo `kubernetes`. |
|
||
|
||
### Variables
|
||
|
||
| Variable | Ejemplo | Descripción |
|
||
| --------- | -------------------- | ----------------------------------------------------------- |
|
||
| context | `starship-cluster` | El contexto actual de kubernetes |
|
||
| namespace | `starship-namespace` | Si se establece, el espacio de nombres actual de kubernetes |
|
||
| symbol | | Refleja el valor de la opción `symbol` |
|
||
| style\* | | Refleja el valor de la opción `style` |
|
||
|
||
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
|
||
|
||
### Ejemplo
|
||
|
||
```toml
|
||
# ~/.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
|
||
|
||
Additional to simple aliasing, `context_aliases` also supports extended matching and renaming using regular expressions.
|
||
|
||
The regular expression must match on the entire kube context, capture groups can be referenced using `$name` and `$N` in the replacement. This is more explained in the [regex crate](https://docs.rs/regex/1.5.4/regex/struct.Regex.html#method.replace) documentation.
|
||
|
||
Long and automatically generated cluster names can be identified and shortened using regular expressions:
|
||
|
||
```toml
|
||
[kubernetes.context_aliases]
|
||
# OpenShift contexts carry the namespace and user in the kube context: `namespace/name/user`:
|
||
".*/openshift-cluster/.*" = "openshift"
|
||
# Or better, to rename every OpenShift cluster at once:
|
||
".*/(?P<cluster>[\\w-]+)/.*" = "$cluster"
|
||
|
||
# Contexts from GKE, AWS and other cloud providers usually carry additional information, like the region/zone.
|
||
# The following entry matches on the GKE format (`gke_projectname_zone_cluster-name`)
|
||
# and renames every matching kube context into a more readable format (`gke-cluster-name`):
|
||
"gke_.*_(?P<cluster>[\\w-]+)" = "gke-$cluster"
|
||
```
|
||
|
||
## Salto de línea
|
||
|
||
The `line_break` module separates the prompt into two lines.
|
||
|
||
### Opciones
|
||
|
||
| Opción | Por defecto | Descripción |
|
||
| ---------- | ----------- | ------------------------------------------------------------------------------- |
|
||
| `disabled` | `false` | Deshabilita el módulo `line_break`, haciendo que el mensaje sea una sola línea. |
|
||
|
||
### Ejemplo
|
||
|
||
```toml
|
||
# ~/.config/starship.toml
|
||
|
||
[line_break]
|
||
disabled = true
|
||
```
|
||
|
||
## Lua
|
||
|
||
The `lua` module shows the currently installed version of [Lua](http://www.lua.org/). 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
|
||
|
||
```toml
|
||
# ~/.config/starship.toml
|
||
|
||
[lua]
|
||
format = "via [🌕 $version](bold blue) "
|
||
```
|
||
|
||
## Memoria utilizada
|
||
|
||
The `memory_usage` module shows current system memory and swap usage.
|
||
|
||
By default the swap usage is displayed if the total system swap is non-zero.
|
||
|
||
::: consejo
|
||
|
||
This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||
|
||
:::
|
||
|
||
### Opciones
|
||
|
||
| Opción | Por defecto | Descripción |
|
||
| ----------- | ----------------------------------------------- | ------------------------------------------------------------- |
|
||
| `threshold` | `75` | Ocultar el uso de memoria a menos que supere este porcentaje. |
|
||
| `format` | `"via $symbol [${ram}( \| ${swap})]($style) "` | El formato del módulo. |
|
||
| `symbol` | `"🐏"` | El símbolo usado antes de mostrar el uso de memoria. |
|
||
| `style` | `"bold dimmed white"` | El estilo del módulo. |
|
||
| `disabled` | `true` | Desactiva el módulo `memory_usage`. |
|
||
|
||
### Variables
|
||
|
||
| Variable | Ejemplo | Descripción |
|
||
| ---------------- | ------------- | ---------------------------------------------------------------------------------- |
|
||
| ram | `31GiB/65GiB` | La memoria RAM usada/total del sistema actual. |
|
||
| ram_pct | `48%` | El porcentaje de la memoria actual del sistema. |
|
||
| swap\*\* | `1GiB/4GiB` | El tamaño de la memoria de intercambio del archivo de memoria del sistema actual. |
|
||
| swap_pct\*\* | `77%` | El porcentaje de memoria de intercambio del archivo de memoria del sistema actual. |
|
||
| symbol | `🐏` | Refleja el valor de la opción `symbol` |
|
||
| style\* | | Refleja el valor de la opción `style` |
|
||
|
||
\*: This variable can only be used as a part of a style string \*\*: The SWAP file information is only displayed if detected on the current system
|
||
|
||
### Ejemplo
|
||
|
||
```toml
|
||
# ~/.config/starship.toml
|
||
|
||
[memory_usage]
|
||
disabled = false
|
||
threshold = -1
|
||
symbol = " "
|
||
style = "bold dimmed green"
|
||
```
|
||
|
||
## Mercurial Branch
|
||
|
||
The `hg_branch` module shows the active branch of the repo in your current directory.
|
||
|
||
### Opciones
|
||
|
||
| Opción | Por defecto | Descripción |
|
||
| ------------------- | -------------------------------- | --------------------------------------------------------------------------------------------------- |
|
||
| `symbol` | `" "` | El símbolo usado antes del marcador hg o nombre de la rama del repositorio en su directorio actual. |
|
||
| `style` | `"bold purple"` | El estilo del módulo. |
|
||
| `format` | `"on [$symbol$branch]($style) "` | El formato del módulo. |
|
||
| `truncation_length` | `2^63 - 1` | Trunca el nombre de la rama hg a `N` grafemas |
|
||
| `truncation_symbol` | `"…"` | El símbolo usado para indicar que un nombre de rama fue truncado. |
|
||
| `disabled` | `true` | Desactiva el módulo `hg_branch`. |
|
||
|
||
### Variables
|
||
|
||
| Variable | Ejemplo | Descripción |
|
||
| --------- | -------- | -------------------------------------- |
|
||
| branch | `master` | La rama de mercurial activa |
|
||
| symbol | | Refleja el valor de la opción `symbol` |
|
||
| style\* | | Refleja el valor de la opción `style` |
|
||
|
||
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
|
||
|
||
### Ejemplo
|
||
|
||
```toml
|
||
# ~/.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](https://nim-lang.org/). 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
|
||
|
||
```toml
|
||
# ~/.config/starship.toml
|
||
|
||
[nim]
|
||
style = "yellow"
|
||
symbol = "🎣 "
|
||
```
|
||
|
||
## Nix-shell
|
||
|
||
The `nix_shell` module shows the [nix-shell](https://nixos.org/guides/nix-pills/developing-with-nix-shell.html) environment. The module will be shown when inside a nix-shell environment.
|
||
|
||
### Opciones
|
||
|
||
| Opción | Por defecto | Descripción |
|
||
| ------------ | ---------------------------------------------- | -------------------------------------------------------------------------------- |
|
||
| `format` | `'via [$symbol$state( \($name\))]($style) '` | El formato del módulo. |
|
||
| `symbol` | `"❄️ "` | Una cadena de formato que representa el símbolo de nix-shell. |
|
||
| `style` | `"bold blue"` | El estilo del módulo. |
|
||
| `impure_msg` | `"impure"` | Una cadena de formato que se muestra cuando el intérprete de comandos es impuro. |
|
||
| `pure_msg` | `"pure"` | Una cadena de formato que se muestra cuando el intérprete de comandos es puro. |
|
||
| `disabled` | `false` | Desactiva el módulo `nix_shell`. |
|
||
|
||
### Variables
|
||
|
||
| Variable | Ejemplo | Descripción |
|
||
| --------- | ------- | -------------------------------------- |
|
||
| state | `pure` | El estado de nix-shell |
|
||
| name | `lorri` | El nombre de nix-shell |
|
||
| symbol | | Refleja el valor de la opción `symbol` |
|
||
| style\* | | Refleja el valor de la opción `style` |
|
||
|
||
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
|
||
|
||
### Ejemplo
|
||
|
||
```toml
|
||
# ~/.config/starship.toml
|
||
|
||
[nix_shell]
|
||
disabled = true
|
||
impure_msg = "[impure shell](bold red)"
|
||
pure_msg = "[pure shell](bold green)"
|
||
format = 'via [☃️ $state( \($name\))](bold blue) '
|
||
```
|
||
|
||
## Node.js
|
||
|
||
The `nodejs` module shows the currently installed version of [Node.js](https://nodejs.org/). 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
|
||
|
||
```toml
|
||
# ~/.config/starship.toml
|
||
|
||
[nodejs]
|
||
format = "via [🤖 $version](bold green) "
|
||
```
|
||
|
||
## OCaml
|
||
|
||
The `ocaml` module shows the currently installed version of [OCaml](https://ocaml.org/). 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
|
||
|
||
```toml
|
||
# ~/.config/starship.toml
|
||
|
||
[ocaml]
|
||
format = "via [🐪 $version]($style) "
|
||
```
|
||
|
||
## OpenStack
|
||
|
||
The `openstack` module shows the current OpenStack cloud and project. The module only active when the `OS_CLOUD` env var is set, in which case it will read `clouds.yaml` file from any of the [default locations](https://docs.openstack.org/python-openstackclient/latest/configuration/index.html#configuration-files). to fetch the current project in use.
|
||
|
||
### Opciones
|
||
|
||
| Opción | Por defecto | Descripción |
|
||
| ---------- | --------------------------------------------------- | ----------------------------------------------------------- |
|
||
| `format` | `"on [$symbol$cloud(\\($project\\))]($style) "` | El formato del módulo. |
|
||
| `symbol` | `"☁️ "` | El símbolo usado antes de mostrar la nube OpenStack actual. |
|
||
| `style` | `"bold yellow"` | El estilo del módulo. |
|
||
| `disabled` | `false` | Deshabilita el módulo `openstack`. |
|
||
|
||
### Variables
|
||
|
||
| Variable | Ejemplo | Descripción |
|
||
| --------- | ------- | -------------------------------------- |
|
||
| cloud | `corp` | La nube OpenStack actual |
|
||
| project | `dev` | El proyecto OpenStack actual |
|
||
| symbol | | Refleja el valor de la opción `symbol` |
|
||
| style\* | | Refleja el valor de la opción `style` |
|
||
|
||
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
|
||
|
||
### Ejemplo
|
||
|
||
```toml
|
||
# ~/.config/starship.toml
|
||
|
||
[openstack]
|
||
format = "on [$symbol$cloud(\\($project\\))]($style) "
|
||
style = "bold yellow"
|
||
symbol = "☁️ "
|
||
```
|
||
|
||
## Versión del paquete
|
||
|
||
The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards` and `dart` packages.
|
||
|
||
- [**npm**](https://docs.npmjs.com/cli/commands/npm) – La versión del paquete `npm` se extrae del `package.json` presente en el directorio actual
|
||
- [**Cargo**](https://doc.rust-lang.org/cargo/) – La versión del paquete `cargo` se extrae del `Cargo.toml` presente en el directorio actual
|
||
- [**Nimble**](https://github.com/nim-lang/nimble) - La versión del paquete `nimble` se extrae del archivo `*.nimble` presente en el directorio actual con el comando `nimble dump`
|
||
- [**Poetry**](https://python-poetry.org/) – La versión del paquete `poetry` se extrae del `pyproject.toml` presente en el directorio actual
|
||
- [**Python**](https://www.python.org) – La versión del paquete `python` se extrae del `setup.cfg` presente en el directorio actual
|
||
- [**Composer**](https://getcomposer.org/) – La versión del paquete `composer` se extrae del `composer.json` presente en el directorio actual
|
||
- [**Gradle**](https://gradle.org/) – La versión del paquete `gradle` se extrae del `build.gradle` presente en directorio actual
|
||
- [**Julia**](https://docs.julialang.org/en/v1/stdlib/Pkg/) - La versión del paquete se extrae del `Project.toml` presente en el directorio actual
|
||
- [**Mix**](https://hexdocs.pm/mix/) - La versión del paquete `mix` se extrae del `mix.exs` presente en el directorio actual
|
||
- [**Help**](https://helm.sh/docs/helm/helm_package/) - La versión del paquete `helm` se extrae del `Chart.yaml` presente en el directorio actual
|
||
- [**Maven**](https://maven.apache.org/) - La versión de paquete `maven` se extrae del `pom.xml` presente en el directorio actual
|
||
- [**Meson**](https://mesonbuild.com/) - La versión del paquete `meson` se extrae del `meson.build` presente en el directorio actual
|
||
- [**Shards**](https://crystal-lang.org/reference/the_shards_command/index.html) - The `shards` package version is extracted from the `shard.yml` present
|
||
- [**V**](https://vlang.io) - La versión del paquete `vlang` se extrae del `v.mod` presente en el directorio actual
|
||
- [**SBT**](https://scala-sbt.org) - The `sbt` package version is extracted from the `build.sbt` present in the current directory
|
||
- [**Dart**](https://pub.dev/) - The `dart` package version is extracted from the `pubspec.yaml` present in the current directory
|
||
|
||
> ⚠️ 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
|
||
|
||
```toml
|
||
# ~/.config/starship.toml
|
||
|
||
[package]
|
||
format = "via [🎁 $version](208 bold) "
|
||
```
|
||
|
||
## Perl
|
||
|
||
The `perl` module shows the currently installed version of [Perl](https://www.perl.org/). Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones:
|
||
|
||
- El directorio actual contiene un archivo `Makefile.PL` o `Build.PL`
|
||
- El directorio actual contiene un archivo `cpanfile` o `cpanfile.snapshot`
|
||
- El directorio actual contiene un archivo `META.json` o `META.yml`
|
||
- El directorio actual contiene un archivo `.perl-version`
|
||
- El directorio actual contiene un `.pl`, `.pm` o `.pod`
|
||
|
||
### Opciones
|
||
|
||
| Opción | Por defecto | Descripción |
|
||
| ------------------- | -------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
|
||
| `format` | `"via [$symbol($version )]($style)"` | La cadena de formato para el módulo. |
|
||
| `version_format` | `"v${raw}"` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
|
||
| `symbol` | `"🐪 "` | El símbolo usado antes de mostrar la versión de Perl |
|
||
| `detect_extensions` | `["pl", "pm", "pod"]` | Qué extensiones deberían activar este módulo. |
|
||
| `detect_files` | `["Makefile.PL", "Build.PL", "cpanfile", "cpanfile.snapshot", "META.json", "META.yml", ".perl-version"]` | Qué nombres de archivo deberían activar este módulo. |
|
||
| `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. |
|
||
| `style` | `"bold 149"` | El estilo del módulo. |
|
||
| `disabled` | `false` | Desactiva el módulo `perl`. |
|
||
|
||
### Variables
|
||
|
||
| Variable | Ejemplo | Descripción |
|
||
| --------- | --------- | -------------------------------------- |
|
||
| version | `v5.26.1` | La versión de `perl` |
|
||
| symbol | | Refleja el valor de la opción `symbol` |
|
||
| style\* | | Refleja el valor de la opción `style` |
|
||
|
||
### Ejemplo
|
||
|
||
```toml
|
||
# ~/.config/starship.toml
|
||
|
||
[perl]
|
||
format = "via [🦪 $version]($style) "
|
||
```
|
||
|
||
## PHP
|
||
|
||
The `php` module shows the currently installed version of [PHP](https://www.php.net/). 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
|
||
|
||
```toml
|
||
# ~/.config/starship.toml
|
||
|
||
[php]
|
||
format = "via [🔹 $version](147 bold) "
|
||
```
|
||
|
||
## Pulumi
|
||
|
||
The `pulumi` module shows the currently selected [Pulumi Stack](https://www.pulumi.com/docs/intro/concepts/stack/) and version.
|
||
|
||
::: tip
|
||
|
||
By default the Pulumi version is not shown, since it takes an order of magnitude longer to load then most plugins (~70ms). If you still want to enable it, [follow the example shown below](#with-pulumi-version).
|
||
|
||
:::
|
||
|
||
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
|
||
|
||
```toml
|
||
# ~/.config/starship.toml
|
||
|
||
[pulumi]
|
||
format = "[🛥 ($version )$stack]($style) "
|
||
```
|
||
|
||
#### Sin versión de Pulumi
|
||
|
||
```toml
|
||
# ~/.config/starship.toml
|
||
[pulumi]
|
||
symbol = "🛥 "
|
||
format = "[$symbol$stack]($style) "
|
||
|
||
```
|
||
|
||
## PureScript
|
||
|
||
The `purescript` module shows the currently installed version of [PureScript](https://www.purescript.org/) version. Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones:
|
||
|
||
- El directorio actual contiene un archivo `spago.dhall`
|
||
- El directorio actual contiene un archivo con la extensión `.purs`
|
||
|
||
### Opciones
|
||
|
||
| Opción | Por defecto | Descripción |
|
||
| ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------- |
|
||
| `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. |
|
||
| `version_format` | `"v${raw}"` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
|
||
| `symbol` | `"<=> "` | El símbolo usado antes de mostrar la versión de PureScript. |
|
||
| `detect_extensions` | `["purs"]` | Qué extensiones deberían activar este módulo. |
|
||
| `detect_files` | `["spago.dhall"]` | Qué nombres de archivo deberían activar este módulo. |
|
||
| `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. |
|
||
| `style` | `"bold white"` | El estilo del módulo. |
|
||
| `disabled` | `false` | Deshabilita el módulo `purescript`. |
|
||
|
||
### Variables
|
||
|
||
| Variable | Ejemplo | Descripción |
|
||
| --------- | -------- | -------------------------------------- |
|
||
| version | `0.13.5` | La versión de `purescript` |
|
||
| symbol | | Refleja el valor de la opción `symbol` |
|
||
| style\* | | Refleja el valor de la opción `style` |
|
||
|
||
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
|
||
|
||
### Ejemplo
|
||
|
||
```toml
|
||
# ~/.config/starship.toml
|
||
|
||
[purescript]
|
||
format = "via [$symbol$version](bold white)"
|
||
```
|
||
|
||
## Python
|
||
|
||
The `python` module shows the currently installed version of [Python](https://www.python.org/) and the current [Python virtual environment](https://docs.python.org/tutorial/venv.html) if one is activated.
|
||
|
||
If `pyenv_version_name` is set to `true`, it will display the pyenv version name. Otherwise, it will display the version number from `python --version`.
|
||
|
||
Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones:
|
||
|
||
- El directorio actual contiene un archivo `.python-version`
|
||
- El directorio actual contiene un archivo `Pipfile`
|
||
- El directorio actual contiene un archivo `__init__.py`
|
||
- El directorio actual contiene un archivo `pyproject.toml`
|
||
- El directorio actual contiene un archivo `requirements.txt`
|
||
- El directorio actual contiene un archivo `setup.py`
|
||
- El directorio actual contiene un archivo `tox.ini`
|
||
- El directorio actual contiene un archivo con la extensión `.py`.
|
||
- Un entorno virtual está activado actualmente
|
||
|
||
### Opciones
|
||
|
||
| Opción | Por defecto | Descripción |
|
||
| -------------------- | ------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------- |
|
||
| `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\) )]($style)'` | El formato del módulo. |
|
||
| `version_format` | `"v${raw}"` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
|
||
| `symbol` | `"🐍 "` | Una cadena de formato que representa el símbolo de Python |
|
||
| `style` | `"yellow bold"` | El estilo del módulo. |
|
||
| `pyenv_version_name` | `false` | Usar pyenv para obtener la versión de Python |
|
||
| `pyenv_prefix` | `pyenv` | Prefijo antes de mostrar la versión de pyenv sólo se utiliza si se utiliza pyenv |
|
||
| `python_binary` | `["python", "python3", "python2"]` | Configura los binarios de python que Starship debería ejecutar al obtener la versión. |
|
||
| `detect_extensions` | `["py"]` | Qué extensiones deben activar este módulo |
|
||
| `detect_files` | `[".python-version", "Pipfile", "__init__.py", "pyproject.toml", "requirements.txt", "setup.py", "tox.ini"]` | Qué nombres de archivo deben activar este módulo |
|
||
| `detect_folders` | `[]` | Qué carpetas deben activar este módulo |
|
||
| `disabled` | `false` | Desactiva el módulo `python`. |
|
||
|
||
::: tip
|
||
|
||
The `python_binary` variable accepts either a string or a list of strings. Starship will try executing each binary until it gets a result. Note you can only change the binary that Starship executes to get the version of Python not the arguments that are used.
|
||
|
||
The default values and order for `python_binary` was chosen to first identify the Python version in a virtualenv/conda environments (which currently still add a `python`, no matter if it points to `python3` or `python2`). This has the side effect that if you still have a system Python 2 installed, it may be picked up before any Python 3 (at least on Linux Distros that always symlink `/usr/bin/python` to Python 2). If you do not work with Python 2 anymore but cannot remove the system Python 2, changing this to `"python3"` will hide any Python version 2, see example below.
|
||
|
||
:::
|
||
|
||
### Variables
|
||
|
||
| Variable | Ejemplo | Descripción |
|
||
| ------------ | --------------- | ------------------------------------------- |
|
||
| version | `"v3.8.1"` | La versión de `python` |
|
||
| symbol | `"🐍 "` | Refleja el valor de la opción `symbol` |
|
||
| style | `"yellow bold"` | Refleja el valor de la opción `style` |
|
||
| pyenv_prefix | `"pyenv "` | Ordena el valor de la opción `pyenv_prefix` |
|
||
| virtualenv | `"venv"` | El nombre actual del `virtualenv` |
|
||
|
||
### Ejemplo
|
||
|
||
```toml
|
||
# ~/.config/starship.toml
|
||
|
||
[python]
|
||
symbol = "👾 "
|
||
pyenv_version_name = true
|
||
```
|
||
|
||
```toml
|
||
# ~/.config/starship.toml
|
||
|
||
[python]
|
||
# Only use the `python3` binary to get the version.
|
||
python_binary = "python3"
|
||
```
|
||
|
||
```toml
|
||
# ~/.config/starship.toml
|
||
|
||
[python]
|
||
# Don't trigger for files with the py extension
|
||
detect_extensions = []
|
||
```
|
||
|
||
```toml
|
||
# ~/.config/starship.toml
|
||
|
||
[python]
|
||
# Display the version of python from inside a local venv.
|
||
#
|
||
# Note this will only work when the venv is inside the project and it will only
|
||
# work in the directory that contains the venv dir but maybe this is ok?
|
||
python_binary = ["./venv/bin/python", "python", "python3", "python2"]
|
||
```
|
||
|
||
## R
|
||
|
||
The `rlang` module shows the currently installed version of [R](https://www.r-project.org/). The module will be shown if any of the following conditions are met:
|
||
|
||
- 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
|
||
|
||
```toml
|
||
# ~/.config/starship.toml
|
||
|
||
[rlang]
|
||
format = "with [📐 $version](blue bold) "
|
||
```
|
||
|
||
## Red
|
||
|
||
By default the `red` module shows the currently installed version of [Red](https://www.red-lang.org/). El módulo se muestra si algunas de las siguientes condiciones se cumplen:
|
||
|
||
- 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
|
||
|
||
```toml
|
||
# ~/.config/starship.toml
|
||
|
||
[red]
|
||
symbol = "🔴 "
|
||
```
|
||
|
||
## Ruby
|
||
|
||
By default the `ruby` module shows the currently installed version of [Ruby](https://www.ruby-lang.org/). El módulo se muestra si algunas de las siguientes condiciones se cumplen:
|
||
|
||
- 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` | Desactiva el módulo `ruby`. |
|
||
|
||
### Variables
|
||
|
||
| Variable | Ejemplo | Descripción |
|
||
| --------- | -------- | -------------------------------------- |
|
||
| version | `v2.5.1` | La versión de `ruby` |
|
||
| symbol | | Refleja el valor de la opción `symbol` |
|
||
| style\* | | Refleja el valor de la opción `style` |
|
||
|
||
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
|
||
|
||
### Ejemplo
|
||
|
||
```toml
|
||
# ~/.config/starship.toml
|
||
|
||
[ruby]
|
||
symbol = "🔺 "
|
||
```
|
||
|
||
## Rust
|
||
|
||
By default the `rust` module shows the currently installed version of [Rust](https://www.rust-lang.org/). El módulo se muestra si algunas de las siguientes condiciones se cumplen:
|
||
|
||
- El directorio actual contiene un archivo `Cargo.toml`
|
||
- El directorio actual contiene un archivo con la extensión `.rs`
|
||
|
||
### Opciones
|
||
|
||
| Opción | Por defecto | Descripción |
|
||
| ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------- |
|
||
| `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. |
|
||
| `version_format` | `"v${raw}"` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
|
||
| `symbol` | `"🦀 "` | Una cadena de formato que representa el símbolo de Rust |
|
||
| `detect_extensions` | `["rs"]` | Qué extensiones deberían activar este módulo. |
|
||
| `detect_files` | `["Cargo.toml"]` | Qué nombres de archivo deberían activar este módulo. |
|
||
| `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. |
|
||
| `style` | `"bold red"` | El estilo del módulo. |
|
||
| `disabled` | `false` | Desactiva el módulo `rust`. |
|
||
|
||
### Variables
|
||
|
||
| Variable | Ejemplo | Descripción |
|
||
| --------- | ----------------- | -------------------------------------- |
|
||
| version | `v1.43.0-nightly` | La versión de `rustc` |
|
||
| symbol | | Refleja el valor de la opción `symbol` |
|
||
| style\* | | Refleja el valor de la opción `style` |
|
||
|
||
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
|
||
|
||
### Ejemplo
|
||
|
||
```toml
|
||
# ~/.config/starship.toml
|
||
|
||
[rust]
|
||
format = "via [⚙️ $version](red bold)"
|
||
```
|
||
|
||
## Scala
|
||
|
||
The `scala` module shows the currently installed version of [Scala](https://www.scala-lang.org/). 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
|
||
|
||
```toml
|
||
# ~/.config/starship.toml
|
||
|
||
[scala]
|
||
symbol = "🌟 "
|
||
```
|
||
|
||
## Shell
|
||
|
||
The `shell` module shows an indicator for currently used shell.
|
||
|
||
::: tip
|
||
|
||
This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||
|
||
:::
|
||
|
||
### Opciones
|
||
|
||
| Opción | Por defecto | Descripción |
|
||
| ---------------------- | ------------------------- | ------------------------------------------------------------ |
|
||
| `bash_indicator` | `bsh` | Una cadena de formato usada para representar Bash. |
|
||
| `fish_indicator` | `fsh` | Una cadena de formato usada para representar Fish. |
|
||
| `zsh_indicator` | `zsh` | Una cadena de formato usada para representar Zsh. |
|
||
| `powershell_indicator` | `psh` | Una cadena de formato usada para representar Powershell. |
|
||
| `ion_indicator` | `ion` | Una cadena de formato usada para representar Ion. |
|
||
| `elvish_indicator` | `esh` | Una cadena de formato usada para representar Elvish. |
|
||
| `tcsh_indicator` | `tsh` | Una cadena de formato usada para representar tcsh. |
|
||
| `xonsh_indicator` | `xsh` | Una cadena de formato usada para representar xonsh. |
|
||
| `cmd_indicator` | `cmd` | A format string used to represent cmd. |
|
||
| `nu_indicator` | `nu` | A format string used to represent nu. |
|
||
| `unknown_indicator` | | The default value to be displayed when the shell is unknown. |
|
||
| `format` | `"[$indicator]($style) "` | El formato del módulo. |
|
||
| `style` | `"white bold"` | El estilo del módulo. |
|
||
| `disabled` | `true` | Disables the `shell` module. |
|
||
|
||
### Variables
|
||
|
||
| Variable | Por defecto | Descripción |
|
||
| --------- | ----------- | ------------------------------------------------------------------------------------ |
|
||
| indicator | | Ordena el valor de `indicator` para el intérprete de comandos actualmente utilizado. |
|
||
| style\* | | Refleja el valor de la opción `style`. |
|
||
|
||
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
|
||
|
||
### Ejemplos
|
||
|
||
```toml
|
||
# ~/.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`](https://tldp.org/LDP/abs/html/internalvariables.html#SHLVLREF) ("shell level") environment variable, if it is set to a number and meets or exceeds the specified threshold.
|
||
|
||
### Opciones
|
||
|
||
| Opción | Por defecto | Descripción |
|
||
| ----------- | ---------------------------- | ----------------------------------------------------------------- |
|
||
| `threshold` | `2` | Mostrar umbral. |
|
||
| `format` | `"[$symbol$shlvl]($style) "` | El formato del módulo. |
|
||
| `symbol` | `"↕️ "` | El símbolo utilizado para representar el `SHLVL`. |
|
||
| `repeat` | `false` | Hace que el `symbol` se repita con la cantidad actual de `SHLVL`. |
|
||
| `style` | `"bold yellow"` | El estilo del módulo. |
|
||
| `disabled` | `true` | Desactiva el módulo `shlvl`. |
|
||
|
||
### Variables
|
||
|
||
| Variable | Ejemplo | Descripción |
|
||
| --------- | ------- | -------------------------------------- |
|
||
| shlvl | `3` | El valor actual de `SHLVL` |
|
||
| symbol | | Refleja el valor de la opción `symbol` |
|
||
| style\* | | Refleja el valor de la opción `style` |
|
||
|
||
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
|
||
|
||
### Ejemplo
|
||
|
||
```toml
|
||
# ~/.config/starship.toml
|
||
|
||
[shlvl]
|
||
disabled = false
|
||
format = "$shlvl level(s) down"
|
||
threshold = 3
|
||
```
|
||
|
||
## Singularity
|
||
|
||
The `singularity` module shows the current [Singularity](https://sylabs.io/singularity/) image, if inside a container and `$SINGULARITY_NAME` is set.
|
||
|
||
### Opciones
|
||
|
||
| Opción | Por defecto | Descripción |
|
||
| ---------- | -------------------------------- | ------------------------------------------------------------------- |
|
||
| `format` | `'[$symbol\[$env\]]($style) '` | El formato del módulo. |
|
||
| `symbol` | `""` | Una cadena de formato que se muestra antes del nombre de la imagen. |
|
||
| `style` | `"bold dimmed blue"` | El estilo del módulo. |
|
||
| `disabled` | `false` | Desactiva el módulo `singularity`. |
|
||
|
||
### Variables
|
||
|
||
| Variable | Ejemplo | Descripción |
|
||
| --------- | ------------ | -------------------------------------- |
|
||
| env | `centos.img` | 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
|
||
|
||
```toml
|
||
# ~/.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`.
|
||
|
||
::: tip
|
||
|
||
This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||
|
||
:::
|
||
|
||
::: warning This module is not supported on nu shell. :::
|
||
|
||
### Opciones
|
||
|
||
| Opción | Por defecto | Descripción |
|
||
| ----------------------- | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------- |
|
||
| `format` | `"[$symbol$status]($style) "` | El formato del módulo |
|
||
| `symbol` | `"✖"` | El símbolo mostrado en error del programa |
|
||
| `success_symbol` | `"✔️"` | 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` | Activar mapeo de señales desde el código de salida |
|
||
| `map_symbol` | `false` | Activar mapeo de símbolos desde el código de salida |
|
||
| `pipestatus` | `false` | Habilita el reporte de pipstatus |
|
||
| `pipestatus_separator` | `|` | El símbolo que se separa en los códigos de salida del programa de tubería |
|
||
| `pipestatus_format` | `\\[$pipestatus\\] => [$symbol$common_meaning$signal_name$maybe_int]($style)` | El formato del módulo cuando el comando es un pipeline |
|
||
| `disabled` | `true` | Desactiva el módulo `status`. |
|
||
|
||
### Variables
|
||
|
||
| Variable | Ejemplo | Descripción |
|
||
| -------------- | ------- | ------------------------------------------------------------------------------------------- |
|
||
| status | `127` | El código de salida del último comando |
|
||
| hex_status | `0x7F` | The exit code of the last command in hex |
|
||
| int | `127` | El código de salida del último comando |
|
||
| common_meaning | `ERROR` | Meaning of the code if not a signal |
|
||
| signal_number | `9` | Signal number corresponding to the exit code, only if signalled |
|
||
| signal_name | `KILL` | Name of the signal corresponding to the exit code, only if signalled |
|
||
| maybe_int | `7` | Contains the exit code number when no meaning has been found |
|
||
| pipestatus | | Rendering of in pipeline programs's exit codes, this is only available in pipestatus_format |
|
||
| symbol | | Refleja el valor de la opción `symbol` |
|
||
| style\* | | Refleja el valor de la opción `style` |
|
||
|
||
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
|
||
|
||
### Ejemplo
|
||
|
||
```toml
|
||
|
||
# ~/.config/starship.toml
|
||
|
||
[status]
|
||
style = "bg:blue"
|
||
symbol = "🔴"
|
||
format = '[\[$symbol $common_meaning$signal_name$maybe_int\]]($style) '
|
||
map_symbol = true
|
||
disabled = false
|
||
|
||
```
|
||
|
||
## Sudo
|
||
|
||
The `sudo` module displays if sudo credentials are currently cached. The module will only be shown if credentials are cached.
|
||
|
||
::: tip
|
||
|
||
This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||
|
||
:::
|
||
|
||
### Opciones
|
||
|
||
| Opción | Por defecto | Descripción |
|
||
| --------------- | ----------------------- | ------------------------------------------------------- |
|
||
| `format` | `[as $symbol]($style)"` | El formato del módulo |
|
||
| `symbol` | `"🧙 "` | The symbol displayed when credentials are cached |
|
||
| `style` | `"bold blue"` | El estilo del módulo. |
|
||
| `allow_windows` | `false` | Since windows has no default sudo, default is disabled. |
|
||
| `disabled` | `true` | Disables the `sudo` module. |
|
||
|
||
### Variables
|
||
|
||
| Variable | Ejemplo | Descripción |
|
||
| --------- | ------- | -------------------------------------- |
|
||
| symbol | | Refleja el valor de la opción `symbol` |
|
||
| style\* | | Refleja el valor de la opción `style` |
|
||
|
||
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
|
||
|
||
### Ejemplo
|
||
|
||
```toml
|
||
|
||
# ~/.config/starship.toml
|
||
|
||
[sudo]
|
||
style = "bold green"
|
||
symbol = "👩💻 "
|
||
disabled = false
|
||
```
|
||
|
||
```toml
|
||
# On windows
|
||
# $HOME\.starship\config.toml
|
||
|
||
[sudo]
|
||
allow_windows = true
|
||
disabled = false
|
||
```
|
||
|
||
## Swift
|
||
|
||
By default the `swift` module shows the currently installed version of [Swift](https://swift.org/). El módulo se muestra si algunas de las siguientes condiciones se cumplen:
|
||
|
||
- El directorio actual contiene un archivo `Package.swift`
|
||
- El directorio actual contiene un archivo con la extensión `.swift`
|
||
|
||
### Opciones
|
||
|
||
| Opción | Por defecto | Descripción |
|
||
| ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------- |
|
||
| `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. |
|
||
| `version_format` | `"v${raw}"` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
|
||
| `symbol` | `"🐦 "` | Una cadena de formato que representa el símbolo de Swift |
|
||
| `detect_extensions` | `["swift"]` | Qué extensiones deberían activar este módulo. |
|
||
| `detect_files` | `["Package.swift"]` | Qué nombres de archivo deberían activar este módulo. |
|
||
| `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. |
|
||
| `style` | `"bold 202"` | El estilo del módulo. |
|
||
| `disabled` | `false` | Desactiva el módulo `swift`. |
|
||
|
||
### Variables
|
||
|
||
| Variable | Ejemplo | Descripción |
|
||
| --------- | -------- | -------------------------------------- |
|
||
| version | `v5.2.4` | La versión de `swift` |
|
||
| symbol | | Refleja el valor de la opción `symbol` |
|
||
| style\* | | Refleja el valor de la opción `style` |
|
||
|
||
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
|
||
|
||
### Ejemplo
|
||
|
||
```toml
|
||
# ~/.config/starship.toml
|
||
|
||
[swift]
|
||
format = "via [🏎 $version](red bold)"
|
||
```
|
||
|
||
## Terraform
|
||
|
||
The `terraform` module shows the currently selected [Terraform workspace](https://www.terraform.io/docs/language/state/workspaces.html) and version.
|
||
|
||
::: tip
|
||
|
||
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](#with-terraform-version).
|
||
|
||
:::
|
||
|
||
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` | Desactiva 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
|
||
|
||
```toml
|
||
# ~/.config/starship.toml
|
||
|
||
[terraform]
|
||
format = "[🏎💨 $version$workspace]($style) "
|
||
```
|
||
|
||
#### Sin la versión de Terraform
|
||
|
||
```toml
|
||
# ~/.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`](https://crates.io/crates/chrono) crate to control how the time is displayed. Take a look [at the chrono strftime docs](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) 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
|
||
|
||
| Opción | Por defecto | Descripción |
|
||
| ----------------- | ----------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||
| `format` | `"at [$time]($style) "` | La cadena de formato para el módulo. |
|
||
| `use_12hr` | `false` | Habilita el formato de 12 horas |
|
||
| `time_format` | see below | La [cadena de formato de chrono](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) utilizada para formatear la hora. |
|
||
| `style` | `"bold yellow"` | El estilo para la hora del módulo |
|
||
| `utc_time_offset` | `"local"` | Establece el desplazamiento UTC a utilizar. Rango de -24 < x < 24. Permite a los flotantes acomodar los desplazamientos de zona horaria de 30/45 minutos. |
|
||
| `disabled` | `true` | Desactiva el módulo `time`. |
|
||
| `time_range` | `"-"` | Establece el intervalo de tiempo durante el cual el módulo se mostrará. La hora debe ser especificada en formato de 24 horas |
|
||
|
||
If `use_12hr` is `true`, then `time_format` defaults to `"%r"`. Otherwise, it defaults to `"%T"`. Manually setting `time_format` will override the `use_12hr` setting.
|
||
|
||
### Variables
|
||
|
||
| Variable | Ejemplo | Descripción |
|
||
| --------- | ---------- | ------------------------------------- |
|
||
| tiempo | `13:08:10` | La hora actual. |
|
||
| style\* | | Refleja el valor de la opción `style` |
|
||
|
||
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
|
||
|
||
### Ejemplo
|
||
|
||
```toml
|
||
# ~/.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:
|
||
|
||
- 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
|
||
|
||
::: tip
|
||
|
||
SSH connection is detected by checking environment variables `SSH_CONNECTION`, `SSH_CLIENT`, and `SSH_TTY`. If your SSH host does not set up these variables, one workaround is to set one of them with a dummy value.
|
||
|
||
:::
|
||
|
||
### Opciones
|
||
|
||
| Opción | Por defecto | Descripción |
|
||
| ------------- | ----------------------- | ------------------------------------------ |
|
||
| `style_root` | `"bold red"` | El estilo usado cuando el usuario es root. |
|
||
| `style_user` | `"bold yellow"` | El estilo usado para usuarios no root. |
|
||
| `format` | `"[$user]($style) in "` | El formato del módulo. |
|
||
| `show_always` | `false` | Siempre muestra el módulo `username`. |
|
||
| `disabled` | `false` | Desactiva el módulo `username`. |
|
||
|
||
### Variables
|
||
|
||
| Variable | Ejemplo | Descripción |
|
||
| -------- | ------------ | --------------------------------------------------------------------------------------------------- |
|
||
| `style` | `"red bold"` | Refleja el valor de la opción `style_root` cuando root inició sesión y `style_user` por otra parte. |
|
||
| `user` | `"matchai"` | El ID de usuario conectado actualmente. |
|
||
|
||
### Ejemplo
|
||
|
||
```toml
|
||
# ~/.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](https://www.vagrantup.com/). 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
|
||
|
||
```toml
|
||
# ~/.config/starship.toml
|
||
|
||
[vagrant]
|
||
format = "via [⍱ $version](bold white) "
|
||
```
|
||
|
||
## V
|
||
|
||
The `vlang` module shows you your currently installed version of [V](https://vlang.io/). 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
|
||
|
||
```toml
|
||
# ~/.config/starship.toml
|
||
[vlang]
|
||
format = "via [V $version](blue bold) "
|
||
```
|
||
|
||
## VCSH
|
||
|
||
The `vcsh` module displays the current active [VCSH](https://github.com/RichiH/vcsh) repository. The module will be shown only if a repository is currently in use.
|
||
|
||
### Opciones
|
||
|
||
| Opción | Por defecto | Descripción |
|
||
| ---------- | -------------------------------- | ------------------------------------------------------------ |
|
||
| `symbol` | | El símbolo usado antes de mostrar el nombre del repositorio. |
|
||
| `style` | `"bold yellow"` | El estilo del módulo. |
|
||
| `format` | `"vcsh [$symbol$repo]($style) "` | El formato del módulo. |
|
||
| `disabled` | `false` | Deshabilita el módulo `vcsh`. |
|
||
|
||
### Variables
|
||
|
||
| Variable | Ejemplo | Descripción |
|
||
| ----------- | ----------------------------------------------------------- | -------------------------------------- |
|
||
| repositorio | `dotfiles` si está en un repositorio VCSH nombrado dotfiles | El nombre del repositorio activo |
|
||
| symbol | | Refleja el valor de la opción `symbol` |
|
||
| style\* | `black bold dimmed` | Refleja el valor de la opción `style` |
|
||
|
||
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
|
||
|
||
### Ejemplo
|
||
|
||
```toml
|
||
# ~/.config/starship.toml
|
||
|
||
[vcsh]
|
||
format = "[🆅 $repo](bold blue) "
|
||
```
|
||
|
||
## Zig
|
||
|
||
By default the the `zig` module shows the currently installed version of [Zig](https://ziglang.org/). El módulo se muestra si algunas de las siguientes condiciones se cumplen:
|
||
|
||
- El directorio actual contiene un archivo `.zig`
|
||
|
||
### Opciones
|
||
|
||
| Opción | Por defecto | Descripción |
|
||
| ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------- |
|
||
| `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. |
|
||
| `version_format` | `"v${raw}"` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
|
||
| `symbol` | `"↯ "` | El símbolo usado antes de mostrar la versión de Zig. |
|
||
| `style` | `"bold yellow"` | El estilo del módulo. |
|
||
| `disabled` | `false` | Desactiva el módulo `zig`. |
|
||
| `detect_extensions` | `["zig"]` | Qué extensiones deberían activar este módulo. |
|
||
| `detect_files` | `[]` | Qué nombres de archivo deberían activar este módulo. |
|
||
| `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. |
|
||
|
||
### Variables
|
||
|
||
| Variable | Ejemplo | Descripción |
|
||
| --------- | -------- | -------------------------------------- |
|
||
| version | `v0.6.0` | La versión de `zig` |
|
||
| symbol | | Refleja el valor de la opción `symbol` |
|
||
| style\* | | Refleja el valor de la opción `style` |
|
||
|
||
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
|
||
|
||
### Ejemplo
|
||
|
||
```toml
|
||
# ~/.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.
|
||
|
||
::: tip
|
||
|
||
Multiple custom modules can be defined by using a `.`.
|
||
|
||
:::
|
||
|
||
::: tip
|
||
|
||
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.
|
||
|
||
:::
|
||
|
||
::: tip
|
||
|
||
[Issue #1252](https://github.com/starship/starship/discussions/1252) contains examples of custom modules. If you have an interesting example not covered there, feel free to share it there!
|
||
|
||
:::
|
||
|
||
::: 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](https://www.gnu.org/software/bash/manual/html_node/Controlling-the-Prompt.html), [Zsh](https://zsh.sourceforge.io/Doc/Release/Prompt-Expansion.html).
|
||
|
||
:::
|
||
|
||
### Opciones
|
||
|
||
| Opción | Por defecto | Descripción |
|
||
| ------------- | ------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||
| `command` | `""` | El comando cuya salida debe ser impresa. El comando se pasará en stdin al shell. |
|
||
| `when` | | Comando de shell usado como condición para mostrar el módulo. El módulo se mostrará si el comando devuelve un código de estado `0`. |
|
||
| `shell` | | [Ver abajo](#custom-command-shell) |
|
||
| `description` | `"<custom module>"` | La descripción del módulo que se muestra al ejecutar `starship explain`. |
|
||
| `files` | `[]` | Los archivos que se buscarán en el directorio de trabajo para obtener una coincidencia. |
|
||
| `directories` | `[]` | Los directorios que se buscarán en el directorio de trabajo para una coincidencia. |
|
||
| `extensions` | `[]` | Las extensiones que se buscarán en el directorio de trabajo para obtener una coincidencia. |
|
||
| `symbol` | `""` | El símbolo usado antes de mostrar la salida del comando. |
|
||
| `style` | `"bold green"` | El estilo del módulo. |
|
||
| `format` | `"[$symbol($output )]($style)"` | El formato del módulo. |
|
||
| `disabled` | `false` | Desactiva este módulo `custom`. |
|
||
| `os` | | Nombre del sistema operativo en el que se mostrará el módulo (unix, linux, macos, windows, ... ) [Ver valores posibles](https://doc.rust-lang.org/std/env/consts/constant.OS.html). |
|
||
|
||
### Variables
|
||
|
||
| Variable | Descripción |
|
||
| --------- | ----------------------------------------- |
|
||
| output | La salida del comando de shell en `shell` |
|
||
| symbol | Refleja el valor de la opción `symbol` |
|
||
| style\* | Refleja el valor de la opción `style` |
|
||
|
||
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
|
||
|
||
#### 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 shell.
|
||
|
||
If unset, it will fallback to STARSHIP_SHELL and then to "sh" on Linux, and "cmd /C" on Windows.
|
||
|
||
The `command` will be passed in on stdin.
|
||
|
||
If `shell` is not given or only contains one element and Starship detects PowerShell will be used, the following arguments will automatically be added: `-NoProfile -Command -`. This behavior can be avoided by explicitly passing arguments to the shell, e.g.
|
||
|
||
```toml
|
||
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](https://github.com/starship/starship/issues/new/choose) with shell details and starship configuration if you hit such scenario.
|
||
|
||
:::
|
||
|
||
### Ejemplo
|
||
|
||
```toml
|
||
# ~/.config/starship.toml
|
||
|
||
[custom.foo]
|
||
command = "echo foo" # shows output of command
|
||
files = ["foo"] # can specify filters but wildcards are not supported
|
||
when = """ test "$HOME" == "$PWD" """
|
||
format = " transcending [$output]($style)"
|
||
|
||
[custom.time]
|
||
command = "time /T"
|
||
extensions = ["pst"] # filters *.pst files
|
||
shell = ["pwsh.exe", "-NoProfile", "-Command", "-"]
|
||
```
|