2020-01-15 17:23:25 +00:00
# Configuración
2020-09-30 20:26:13 +00:00
Para comenzar a configurar starship, crea el siguiente archivo: `~/.config/starship.toml` .
2020-01-15 17:23:25 +00:00
2020-02-07 21:47:30 +00:00
```sh
2020-06-19 21:05:45 +00:00
mkdir -p ~/.config & & touch ~/.config/starship.toml
2020-01-15 17:23:25 +00:00
```
2020-09-30 20:26:13 +00:00
Toda la configuración de starship se realiza en este archivo [TOML ](https://github.com/toml-lang/toml ):
2020-01-15 17:23:25 +00:00
```toml
2020-09-30 20:26:13 +00:00
# Evita imprimir una nueva linea al inicio del prompt
2020-01-15 17:23:25 +00:00
add_newline = false
2020-09-30 20:26:13 +00:00
# Reemplaza el símbolo "❯ " por "➜" del prompt
[character] # El nombre del módulo que se está configurando es "character"
symbol = "➜" # El segmento "symbol" es reemplazado por "➜"
success_symbol = "[➜](bold green)" # El segmento "success_symbol" es reemplazado por "➜" con el color "bold green"
2020-01-15 17:23:25 +00:00
2020-09-30 20:26:13 +00:00
# Desactiva el gestor de paquetes, ocultándolo por completo del prompt
2020-01-15 17:23:25 +00:00
[package]
disabled = true
```
2020-09-30 20:26:13 +00:00
Puedes cambiar la ubicación predeterminada del archivo `starship.toml` con la variable de entorno `STARSHIP_CONFIG` :
2020-07-23 21:07:10 +00:00
2020-02-07 21:47:30 +00:00
```sh
2020-01-15 17:23:25 +00:00
export STARSHIP_CONFIG=~/.starship
```
docs(i18n): new Crowdin translations (#1262)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (German)
* New translations README.md (French)
* New translations README.md (Japanese)
* New translations README.md (Spanish)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Portuguese)
* New translations README.md (Chinese Traditional)
* New translations README.md (Chinese Simplified)
* New translations README.md (Russian)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (Chinese Simplified)
* New translations README.md (Chinese Traditional)
* New translations README.md (Portuguese)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (French)
* New translations README.md (Spanish)
* New translations README.md (German)
* New translations README.md (Russian)
* New translations README.md (Japanese)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Chinese Simplified)
* New translations README.md (Chinese Traditional)
* New translations README.md (Portuguese)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (French)
* New translations README.md (Spanish)
* New translations README.md (German)
* New translations README.md (Russian)
* New translations README.md (Japanese)
* New translations README.md (French)
* New translations README.md (Japanese)
* New translations README.md (German)
* New translations README.md (Spanish)
* New translations README.md (Chinese Traditional)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Portuguese)
* New translations README.md (Chinese Simplified)
* New translations README.md (Russian)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Chinese Traditional)
* New translations README.md (Chinese Traditional)
* New translations README.md (Portuguese)
* New translations README.md (Portuguese)
* New translations README.md (Chinese Simplified)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (French)
* New translations README.md (French)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (German)
* New translations README.md (German)
* New translations README.md (Chinese Simplified)
* New translations README.md (Japanese)
* New translations README.md (Japanese)
* New translations README.md (Russian)
* New translations README.md (Russian)
* New translations README.md (Japanese)
* New translations README.md (Japanese)
* New translations README.md (Japanese)
* New translations README.md (Japanese)
2020-06-11 01:28:04 +00:00
El equivalente en PowerShell (Windows) es añadir esta línea a tu `$PROFILE` :
2020-07-23 21:07:10 +00:00
2020-05-23 23:10:58 +00:00
```ps1
$ENV:STARSHIP_CONFIG = "$HOME\.starship"
```
2020-09-30 20:26:13 +00:00
### Logging
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` :
```ps1
$ENV:STARSHIP_CACHE = "$HOME\AppData\Local\Temp"
```
### Terminology
2020-01-15 17:23:25 +00:00
2020-09-30 20:26:13 +00:00
**Module**: A component in the prompt giving information based on contextual information from your OS. For example, the "nodejs" module shows the version of NodeJS that is currently installed on your computer, if your current directory is a NodeJS project.
2020-01-15 17:23:25 +00:00
2020-07-23 21:07:10 +00:00
**Variable**: Smaller sub-components that contains information provided by the module. For example, the "version" variable in the "nodejs" module contains the current version of NodeJS.
2020-01-15 17:23:25 +00:00
2020-07-23 21:07:10 +00:00
By convention, most modules have a prefix of default terminal color (e.g. `via` in "nodejs") and an empty space as a suffix.
2020-01-15 17:23:25 +00:00
2020-07-23 21:07:10 +00:00
### Format Strings
Format strings are the format that a module prints all its variables with. Most modules have an entry called `format` that configures the display format of the module. You can use texts, variables and text groups in a format string.
#### Variable
A variable contains a `$` symbol followed by the name of the variable. The name of a variable only contains letters, numbers and `_` .
For example:
2020-09-30 20:26:13 +00:00
- `$version` es un formato de cadena de texto 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.
2020-07-23 21:07:10 +00:00
2020-09-30 20:26:13 +00:00
#### Grupo de texto
2020-07-23 21:07:10 +00:00
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 style the first part.
For example:
2020-01-15 17:23:25 +00:00
2020-09-30 20:26:13 +00:00
- `[on](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` rojo. y `a` y `c` verde.
2020-07-23 21:07:10 +00:00
#### Cadenas de estilo
2020-01-15 17:23:25 +00:00
2020-09-30 20:26:13 +00:00
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/ ).
2020-01-15 17:23:25 +00:00
2020-05-05 17:07:34 +00:00
- `"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
2020-01-15 17:23:25 +00:00
2020-09-30 20:26:13 +00:00
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.
2020-01-15 17:23:25 +00:00
2020-09-30 20:26:13 +00:00
#### Cadenas de formato condicionales
2020-07-23 21:07:10 +00:00
A conditional format string wrapped in `(` and `)` will not render if all variables inside are empty.
For example:
2020-09-30 20:26:13 +00:00
- `(@$region)` no mostrará nada si la variable `region` es `None` , 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 de teclado para `\[$a$b\]` , `($all)` no mostrará nada solo si `$a` y `$b` ambos son `None` . Esto funciona igual que `(\[$a$b\] )` .
2020-07-23 21:07:10 +00:00
2020-09-30 20:26:13 +00:00
#### Carácteres de escape
2020-07-23 21:07:10 +00:00
The following symbols have special usage in a format string. If you want to print the following symbols, you have to escape them with a backslash (`\`).
2020-09-30 20:26:13 +00:00
- \$
2020-07-23 21:07:10 +00:00
- \\
- [
- ]
- (
- )
Note that `toml` has [its own escape syntax ](https://github.com/toml-lang/toml#user-content-string ). It is recommended to use a literal string (`''`) in your config. If you want to use a basic string (`""`), pay attention to escape the backslash `\` .
For example, when you want to print a `$` symbol on a new line, the following configs for `format` are equivalent:
```toml
# with basic string
format = "\n\\$"
# with multiline basic string
format = """
\\$"""
# with literal string
format = '''
\$'''
```
2020-09-30 20:26:13 +00:00
## Prompt
2020-01-15 17:23:25 +00:00
2020-09-30 20:26:13 +00:00
This is the list of prompt-wide configuration options.
2020-01-15 17:23:25 +00:00
2020-05-05 17:07:34 +00:00
### Opciones
2020-01-15 17:23:25 +00:00
2020-09-30 20:26:13 +00:00
| Opción | Por defecto | Descripción |
| -------------- | ------------------------------ | ----------------------------------------------------------------------------- |
| `format` | [link ](#default-prompt-format ) | Configura el formato del prompt. |
| `scan_timeout` | `30` | Tiempo de espera tras el que starship escanea los archivos (en milisegundos). |
| `add_newline` | `true` | Añade una nueva línea antes del prompt. |
2020-01-15 17:23:25 +00:00
2020-05-05 17:07:34 +00:00
### Ejemplo
2020-01-15 17:23:25 +00:00
```toml
# ~/.config/starship.toml
2020-07-23 21:07:10 +00:00
# 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.
2020-01-15 17:23:25 +00:00
scan_timeout = 10
2020-09-30 20:26:13 +00:00
# Disable the newline at the start of the prompt
add_newline = false
2020-01-15 17:23:25 +00:00
```
2020-07-23 21:07:10 +00:00
### Default Prompt Format
2020-01-15 17:23:25 +00:00
2020-09-30 20:26:13 +00:00
The default `format` is used to define the format of the prompt, if empty or no `format` is provided. The default is as shown:
2020-01-15 17:23:25 +00:00
```toml
2020-09-30 20:26:13 +00:00
format = "$all"
2020-07-23 21:07:10 +00:00
# Which is equivalent to
format = """
$username\
$hostname\
2020-09-30 20:26:13 +00:00
$shlvl\
2020-07-23 21:07:10 +00:00
$kubernetes\
$directory\
$git_branch\
$git_commit\
$git_state\
$git_status\
$hg_branch\
$docker_context\
$package\
$cmake\
2020-09-30 20:26:13 +00:00
$dart\
2020-07-23 21:07:10 +00:00
$dotnet\
$elixir\
$elm\
$erlang\
$golang\
$helm\
$java\
$julia\
$nim\
$nodejs\
$ocaml\
2020-09-30 20:26:13 +00:00
$perl\
2020-07-23 21:07:10 +00:00
$php\
$purescript\
$python\
$ruby\
$rust\
2020-09-30 20:26:13 +00:00
$swift\
2020-07-23 21:07:10 +00:00
$terraform\
$zig\
$nix_shell\
$conda\
$memory_usage\
$aws\
2020-09-30 20:26:13 +00:00
$gcloud\
2020-07-23 21:07:10 +00:00
$env_var\
$crystal\
$cmd_duration\
$custom\
$line_break\
$jobs\
$battery\
$time\
2020-09-30 20:26:13 +00:00
$status\
2020-07-23 21:07:10 +00:00
$character"""
2020-01-15 17:23:25 +00:00
```
## AWS
2020-09-30 20:26:13 +00:00
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.
2020-01-15 17:23:25 +00:00
2020-09-30 20:26:13 +00:00
When using [aws-vault ](https://github.com/99designs/aws-vault ) the profile is read from the `AWS_VAULT` env var.
2020-04-06 18:48:26 +00:00
2020-05-05 17:07:34 +00:00
### Opciones
2020-01-15 17:23:25 +00:00
2020-09-30 20:26:13 +00:00
| Opción | Por defecto | Descripción |
2020-07-23 21:07:10 +00:00
| ---------------- | ---------------------------------------------------- | ------------------------------------------------------------ |
2020-09-30 20:26:13 +00:00
| `format` | `"on [$symbol$profile(\\($region\\))]($style) "` | El formato del módulo. |
2020-07-23 21:07:10 +00:00
| `symbol` | `"☁️ "` | El símbolo que se muestra antes del perfil de AWS. |
| `region_aliases` | | Tabla de alias de región para mostrar además del nombre AWS. |
| `style` | `"bold yellow"` | El estilo del módulo. |
| `disabled` | `false` | Desactiva el módulo AWS. |
2020-01-15 17:23:25 +00:00
2020-07-23 21:07:10 +00:00
### Variables
2020-09-30 20:26:13 +00:00
| Variable | Ejemplo | Descripción |
| --------- | ---------------- | -------------------------------------- |
| region | `ap-northeast-1` | La región actual de AWS |
| profile | `astronauts` | El perfil actual de AWS |
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
2020-07-23 21:07:10 +00:00
2020-09-30 20:26:13 +00:00
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
2020-07-23 21:07:10 +00:00
### Examples
2020-09-30 20:26:13 +00:00
#### Mostrar todo
2020-01-15 17:23:25 +00:00
```toml
# ~/.config/starship.toml
[aws]
2020-07-23 21:07:10 +00:00
format = "on [$symbol$profile(\\($region\\)) ]($style ) "
2020-01-15 17:23:25 +00:00
style = "bold blue"
symbol = "🅰 "
[aws.region_aliases]
ap-southeast-2 = "au"
us-east-1 = "va"
```
2020-09-30 20:26:13 +00:00
#### Mostrar región
2020-07-23 21:07:10 +00:00
```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"
```
2020-09-30 20:26:13 +00:00
#### Mostrar perfil
2020-07-23 21:07:10 +00:00
```toml
# ~/.config/starship.toml
[aws]
format = "on [$symbol$profile ]($style ) "
style = "bold blue"
symbol = "🅰 "
```
2020-01-15 17:23:25 +00:00
## Battery
2020-09-30 20:26:13 +00:00
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%.
2020-01-15 17:23:25 +00:00
2020-05-05 17:07:34 +00:00
### Opciones
2020-01-15 17:23:25 +00:00
2020-09-30 20:26:13 +00:00
| Opción | Por defecto | Descripción |
2020-07-23 21:07:10 +00:00
| -------------------- | --------------------------------- | ------------------------------------------------- |
| `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. |
2020-09-30 20:26:13 +00:00
| `format` | `"[$symbol$percentage]($style) "` | El formato del módulo. |
2020-07-23 21:07:10 +00:00
| `display` | [link ](#battery-display ) | Define cuándo mostrar el indicador y el estilo. |
| `disabled` | `false` | Desactiva el módulo `battery` . |
2020-01-15 17:23:25 +00:00
< details >
2020-09-30 20:26:13 +00:00
< summary > There are also options for some uncommon battery states.< / summary >
2020-01-15 17:23:25 +00:00
2020-05-05 17:07:34 +00:00
| Variable | Descripción |
2020-01-15 17:23:25 +00:00
| ---------------- | --------------------------------------------------- |
| `unknown_symbol` | The symbol shown when the battery state is unknown. |
| `empty_symbol` | The symbol shown when the battery state is empty. |
Note: Battery indicator will be hidden if the status is `unknown` or `empty` unless you specify the option in the config.
< / details >
2020-05-05 17:07:34 +00:00
### Ejemplo
2020-01-15 17:23:25 +00:00
```toml
# ~/.config/starship.toml
[battery]
full_symbol = "🔋"
charging_symbol = "⚡️"
discharging_symbol = "💀"
```
2020-09-30 20:26:13 +00:00
### Battery Display
2020-01-15 17:23:25 +00:00
2020-09-30 20:26:13 +00:00
The `display` configuration option is used to define when the battery indicator should be shown (threshold) and what it looks like (style). If no `display` is provided. The default is as shown:
2020-01-15 17:23:25 +00:00
```toml
[[battery.display]]
threshold = 10
style = "bold red"
```
2020-05-05 17:07:34 +00:00
#### Opciones
2020-01-15 17:23:25 +00:00
2020-09-30 20:26:13 +00:00
The `display` option is an array of the following table.
2020-01-15 17:23:25 +00:00
2020-05-05 17:07:34 +00:00
| Variable | Descripción |
| ----------- | --------------------------------------------------------------- |
| `threshold` | El umbral para la opción de visualización. |
| `style` | El estilo usado cuando si la opción < 0 > display</ 0 > está activa. |
2020-01-15 17:23:25 +00:00
2020-05-05 17:07:34 +00:00
#### Ejemplo
2020-01-15 17:23:25 +00:00
```toml
2020-09-30 20:26:13 +00:00
[[battery.display]] # "bold red" style when capacity is between 0% and 10%
2020-01-15 17:23:25 +00:00
threshold = 10
style = "bold red"
2020-09-30 20:26:13 +00:00
[[battery.display]] # "bold yellow" style when capacity is between 10% and 30%
2020-01-15 17:23:25 +00:00
threshold = 30
style = "bold yellow"
2020-09-30 20:26:13 +00:00
# when capacity is over 30%, the battery indicator will not be displayed
2020-01-15 17:23:25 +00:00
```
## Character
2020-09-30 20:26:13 +00:00
The `character` module shows a character (usually an arrow) beside where the text is entered in your terminal.
2020-01-15 17:23:25 +00:00
2020-09-30 20:26:13 +00:00
The character will tell you whether the last command was successful or not. It can do this in two ways:
2020-07-23 21:07:10 +00:00
2020-09-30 20:26:13 +00:00
- cambiando el color (`red`/`green`)
- cambiando la forma (`.`/`✖`)
2020-07-23 21:07:10 +00:00
By default it only changes color. If you also want to change it's shape take a look at [this example ](#with-custom-error-shape ).
2020-01-15 17:23:25 +00:00
2020-05-05 17:07:34 +00:00
### Opciones
2020-01-15 17:23:25 +00:00
2020-09-30 20:26:13 +00:00
| 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 la shell está en modo vim normal. |
| `disabled` | `false` | Desactiva el módulo `character` . |
2020-01-15 17:23:25 +00:00
2020-07-23 21:07:10 +00:00
### Variables
2020-09-30 20:26:13 +00:00
| Variable | Ejemplo | Descripción |
| -------- | ------- | -------------------------------------------------------------- |
| symbol | | Un espejo de `success_symbol` , `error_symbol` o `vicmd_symbol` |
2020-07-23 21:07:10 +00:00
### Examples
2020-09-30 20:26:13 +00:00
#### Con forma de error personalizada
2020-01-15 17:23:25 +00:00
```toml
# ~/.config/starship.toml
[character]
2020-07-23 21:07:10 +00:00
success_symbol = "[➜](bold green) "
error_symbol = "[✗](bold red) "
2020-01-15 17:23:25 +00:00
```
2020-09-30 20:26:13 +00:00
#### Sin forma de error personalizada
2020-07-23 21:07:10 +00:00
```toml
# ~/.config/starship.toml
[character]
success_symbol = "[➜](bold green) "
error_symbol = "[➜](bold red) "
```
2020-09-30 20:26:13 +00:00
#### Con forma vim personalizada
2020-07-23 21:07:10 +00:00
```toml
# ~/.config/starship.toml
[character]
vicmd_symbol = "[V](bold green) "
```
## CMake
The `cmake` module shows the currently installed version of CMake if:
2020-09-30 20:26:13 +00:00
- El directorio actual contiene un archivo `CMakeLists.txt`
2020-07-23 21:07:10 +00:00
### Opciones
2020-09-30 20:26:13 +00:00
| Opción | Por defecto | Descripción |
| ---------- | ---------------------------------- | ---------------------------------------------- |
| `format` | `"via [$symbol$version]($style) "` | El formato del módulo. |
| `symbol` | `"🛆 "` | El símbolo usado antes de la versión de cmake. |
| `style` | `"bold blue"` | El estilo del módulo. |
| `disabled` | `false` | Deshabilita el módulo `cmake` . |
2020-07-23 21:07:10 +00:00
### Variables
2020-09-30 20:26:13 +00:00
| 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` |
2020-07-23 21:07:10 +00:00
2020-09-30 20:26:13 +00:00
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
2020-07-23 21:07:10 +00:00
2020-05-05 17:07:34 +00:00
## Tiempo de ejecución
2020-01-15 17:23:25 +00:00
2020-09-30 20:26:13 +00:00
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.
2020-01-15 17:23:25 +00:00
2020-09-30 20:26:13 +00:00
::: warning Do not hook the DEBUG trap in Bash
2020-01-15 17:23:25 +00:00
2020-09-30 20:26:13 +00:00
If you are running Starship in `bash` , do not hook the `DEBUG` trap after running `eval $(starship init $0)` , or this module **will** break.
2020-01-15 17:23:25 +00:00
:::
2020-09-30 20:26:13 +00:00
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.
2020-01-15 17:23:25 +00:00
2020-05-05 17:07:34 +00:00
### Opciones
2020-01-15 17:23:25 +00:00
2020-09-30 20:26:13 +00:00
| Opción | Por defecto | Descripción |
2020-07-23 21:07:10 +00:00
| ------------------- | ----------------------------- | --------------------------------------------------------------------- |
| `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. |
2020-09-30 20:26:13 +00:00
| `format` | `"took [$duration]($style) "` | El formato del módulo. |
2020-07-23 21:07:10 +00:00
| `style` | `"bold yellow"` | El estilo del módulo. |
| `disabled` | `false` | Desactiva el módulo `cmd_duration` . |
### Variables
2020-09-30 20:26:13 +00:00
| Variable | Ejemplo | Descripción |
| --------- | -------- | ------------------------------------------ |
| duration | `16m40s` | El tiempo que tardó en ejecutar el comando |
| style\* | | Refleja el valor de la opción `style` |
2020-07-23 21:07:10 +00:00
2020-09-30 20:26:13 +00:00
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
2020-01-15 17:23:25 +00:00
2020-05-05 17:07:34 +00:00
### Ejemplo
2020-01-15 17:23:25 +00:00
```toml
# ~/.config/starship.toml
[cmd_duration]
min_time = 500
2020-07-23 21:07:10 +00:00
format = "underwent [$duration ](bold yellow )"
2020-01-15 17:23:25 +00:00
```
## Conda
2020-09-30 20:26:13 +00:00
The `conda` module shows the current conda environment, if `$CONDA_DEFAULT_ENV` is set.
2020-01-15 17:23:25 +00:00
::: tip
2020-09-30 20:26:13 +00:00
This does not suppress conda's own prompt modifier, you may want to run `conda config --set changeps1 False` .
2020-01-15 17:23:25 +00:00
:::
2020-05-05 17:07:34 +00:00
### Opciones
2020-01-15 17:23:25 +00:00
2020-09-30 20:26:13 +00:00
| Opción | Por defecto | Descripción |
2020-07-23 21:07:10 +00:00
| ------------------- | ---------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `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. |
2020-09-30 20:26:13 +00:00
| `format` | `"[$symbol$environment]($style) "` | El formato del módulo. |
| `ignore_base` | `true` | Ignora el entorno `base` cuando se activa. |
| `disabled` | `false` | Deshabilita el módulo `conda` . |
2020-07-23 21:07:10 +00:00
### Variables
2020-09-30 20:26:13 +00:00
| 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` |
2020-07-23 21:07:10 +00:00
2020-09-30 20:26:13 +00:00
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
2020-01-15 17:23:25 +00:00
2020-05-05 17:07:34 +00:00
### Ejemplo
2020-01-15 17:23:25 +00:00
```toml
# ~/.config/starship.toml
[conda]
2020-07-23 21:07:10 +00:00
format = "[$symbol$environment](dimmed green) "
2020-01-15 17:23:25 +00:00
```
2020-04-03 16:35:39 +00:00
## Crystal
2020-09-30 20:26:13 +00:00
The `crystal` module shows the currently installed version of Crystal. El módulo se muestra si algunas de las siguientes condiciones se cumplen:
2020-04-03 16:35:39 +00:00
2020-05-05 17:07:34 +00:00
- El directorio actual contiene un fichero `shard.yml`
- El directorio actual contiene un fichero `.cr`
2020-04-03 16:35:39 +00:00
2020-05-05 17:07:34 +00:00
### Opciones
2020-04-03 16:35:39 +00:00
2020-09-30 20:26:13 +00:00
| Opción | Por defecto | Descripción |
2020-07-23 21:07:10 +00:00
| ---------- | ---------------------------------- | --------------------------------------------- |
| `symbol` | `"🔮 "` | Símbolo usado antes de la versión de Crystal. |
| `style` | `"bold red"` | El estilo del módulo. |
2020-09-30 20:26:13 +00:00
| `format` | `"via [$symbol$version]($style) "` | El formato del módulo. |
2020-07-23 21:07:10 +00:00
| `disabled` | `false` | Desactiva el módulo `crystal` . |
### Variables
2020-09-30 20:26:13 +00:00
| 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` |
2020-07-23 21:07:10 +00:00
2020-09-30 20:26:13 +00:00
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
2020-04-03 16:35:39 +00:00
2020-05-05 17:07:34 +00:00
### Ejemplo
2020-04-03 16:35:39 +00:00
```toml
# ~/.config/starship.toml
[crystal]
2020-07-23 21:07:10 +00:00
format = "via [✨ $version ](bold blue ) "
2020-04-03 16:35:39 +00:00
```
2020-09-30 20:26:13 +00:00
## Dart
The `dart` module shows the currently installed version of Dart. El módulo se muestra si algunas de las siguientes condiciones se cumplen:
- 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` o `pubspec.lock`
### Opciones
| Variable | Por defecto | Descripción |
| ---------- | ---------------------------------- | ------------------------------------------------------- |
| `format` | `"via [$symbol$version]($style) "` | El formato del módulo. |
| `symbol` | `"🎯 "` | Una cadena de formato que representa el símbolo de Dart |
| `style` | `"bold blue"` | El estilo del módulo. |
| `disabled` | `false` | Deshabilita el módulo `dart` . |
### Variables
| Variable | Ejemplo | Descripción |
| --------- | -------- | -------------------------------------- |
| version | `v2.8.4` | La versión de `dart` |
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
### Ejemplo
```toml
# ~/.config/starship.toml
[dart]
format = "via [🔰 $version ](bold red ) "
```
2020-01-15 17:23:25 +00:00
## Directory
2020-09-30 20:26:13 +00:00
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.
2020-01-15 17:23:25 +00:00
2020-09-30 20:26:13 +00:00
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.
2020-01-15 17:23:25 +00:00
2020-09-30 20:26:13 +00:00
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` .
2020-01-15 17:23:25 +00:00
2020-05-05 17:07:34 +00:00
### Opciones
2020-01-15 17:23:25 +00:00
2020-09-30 20:26:13 +00:00
| Variable | Por defecto | Descripción |
| ------------------------ | ----------------------------------------------- | --------------------------------------------------------------------- |
| `truncation_length` | `3` | El número de carpetas a las que se debe truncar el directorio actual. |
| `truncate_to_repo` | `true` | Truncar o no hasta la raíz del repositorio git en el que se esté. |
| `format` | `"[$path]($style)[$lock_symbol]($lock_style) "` | El formato del módulo. |
| `style` | `"bold cyan"` | El estilo del módulo. |
| `disabled` | `false` | Deshabilita el módulo `directory` . |
| `read_only_symbol` | `"🔒"` | El símbolo que indica si el directorio actual es de sólo lectura. |
| `read_only_symbol_style` | `"red"` | El estilo para el símbolo de sólo lectura. |
2020-01-15 17:23:25 +00:00
< details >
2020-09-30 20:26:13 +00:00
< summary > This module has a few advanced configuration options that control how the directory is displayed.< / summary >
2020-01-15 17:23:25 +00:00
2020-07-23 21:07:10 +00:00
| Advanced Option | Por defecto | Descripción |
2020-05-05 17:07:34 +00:00
| --------------------------- | ----------- | ---------------------------------------------------------------------------------------- |
docs(i18n): new Crowdin translations (#1262)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (German)
* New translations README.md (French)
* New translations README.md (Japanese)
* New translations README.md (Spanish)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Portuguese)
* New translations README.md (Chinese Traditional)
* New translations README.md (Chinese Simplified)
* New translations README.md (Russian)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (Chinese Simplified)
* New translations README.md (Chinese Traditional)
* New translations README.md (Portuguese)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (French)
* New translations README.md (Spanish)
* New translations README.md (German)
* New translations README.md (Russian)
* New translations README.md (Japanese)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Chinese Simplified)
* New translations README.md (Chinese Traditional)
* New translations README.md (Portuguese)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (French)
* New translations README.md (Spanish)
* New translations README.md (German)
* New translations README.md (Russian)
* New translations README.md (Japanese)
* New translations README.md (French)
* New translations README.md (Japanese)
* New translations README.md (German)
* New translations README.md (Spanish)
* New translations README.md (Chinese Traditional)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Portuguese)
* New translations README.md (Chinese Simplified)
* New translations README.md (Russian)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Chinese Traditional)
* New translations README.md (Chinese Traditional)
* New translations README.md (Portuguese)
* New translations README.md (Portuguese)
* New translations README.md (Chinese Simplified)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (French)
* New translations README.md (French)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (German)
* New translations README.md (German)
* New translations README.md (Chinese Simplified)
* New translations README.md (Japanese)
* New translations README.md (Japanese)
* New translations README.md (Russian)
* New translations README.md (Russian)
* New translations README.md (Japanese)
* New translations README.md (Japanese)
* New translations README.md (Japanese)
* New translations README.md (Japanese)
2020-06-11 01:28:04 +00:00
| `substitutions` | | A table of substitutions to be made to the path. |
2020-05-05 17:07:34 +00:00
| `fish_style_pwd_dir_length` | `0` | The number of characters to use when applying fish shell pwd path logic. |
| `use_logical_path` | `true` | Displays the logical path provided by the shell (`PWD`) instead of the path from the OS. |
2020-01-15 17:23:25 +00:00
docs(i18n): new Crowdin translations (#1262)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (German)
* New translations README.md (French)
* New translations README.md (Japanese)
* New translations README.md (Spanish)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Portuguese)
* New translations README.md (Chinese Traditional)
* New translations README.md (Chinese Simplified)
* New translations README.md (Russian)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (Chinese Simplified)
* New translations README.md (Chinese Traditional)
* New translations README.md (Portuguese)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (French)
* New translations README.md (Spanish)
* New translations README.md (German)
* New translations README.md (Russian)
* New translations README.md (Japanese)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Chinese Simplified)
* New translations README.md (Chinese Traditional)
* New translations README.md (Portuguese)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (French)
* New translations README.md (Spanish)
* New translations README.md (German)
* New translations README.md (Russian)
* New translations README.md (Japanese)
* New translations README.md (French)
* New translations README.md (Japanese)
* New translations README.md (German)
* New translations README.md (Spanish)
* New translations README.md (Chinese Traditional)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Portuguese)
* New translations README.md (Chinese Simplified)
* New translations README.md (Russian)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Chinese Traditional)
* New translations README.md (Chinese Traditional)
* New translations README.md (Portuguese)
* New translations README.md (Portuguese)
* New translations README.md (Chinese Simplified)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (French)
* New translations README.md (French)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (German)
* New translations README.md (German)
* New translations README.md (Chinese Simplified)
* New translations README.md (Japanese)
* New translations README.md (Japanese)
* New translations README.md (Russian)
* New translations README.md (Russian)
* New translations README.md (Japanese)
* New translations README.md (Japanese)
* New translations README.md (Japanese)
* New translations README.md (Japanese)
2020-06-11 01:28:04 +00:00
`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"
```
2020-04-03 16:35:39 +00:00
`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` .
2020-01-15 17:23:25 +00:00
< / details >
2020-07-23 21:07:10 +00:00
### Variables
2020-09-30 20:26:13 +00:00
| Variable | Ejemplo | Descripción |
| --------- | --------------------- | ------------------------------------- |
| path | `"D:/Projects"` | La ruta de directorio actual |
| style\* | `"black bold dimmed"` | Refleja el valor de la opción `style` |
2020-07-23 21:07:10 +00:00
2020-09-30 20:26:13 +00:00
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
2020-07-23 21:07:10 +00:00
2020-05-05 17:07:34 +00:00
### Ejemplo
2020-01-15 17:23:25 +00:00
```toml
# ~/.config/starship.toml
[directory]
truncation_length = 8
```
2020-09-30 20:26:13 +00:00
## Docker Context
2020-04-06 18:48:26 +00:00
2020-09-30 20:26:13 +00:00
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` .
2020-04-06 18:48:26 +00:00
2020-05-05 17:07:34 +00:00
### Opciones
2020-04-06 18:48:26 +00:00
2020-09-30 20:26:13 +00:00
| 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. |
| `style` | `"blue bold"` | El estilo del módulo. |
| `only_with_files` | `false` | Mostrar solo cuando hay un `docker-compose.yml` o `Dockerfile` en el directorio actual. |
| `disabled` | `true` | Deshabilita el módulo `docker_context` . |
2020-07-23 21:07:10 +00:00
### Variables
2020-09-30 20:26:13 +00:00
| 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` |
2020-07-23 21:07:10 +00:00
2020-09-30 20:26:13 +00:00
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
2020-04-06 18:48:26 +00:00
2020-05-05 17:07:34 +00:00
### Ejemplo
2020-04-06 18:48:26 +00:00
```toml
# ~/.config/starship.toml
[docker_context]
2020-07-23 21:07:10 +00:00
format = "via [🐋 $context ](blue bold )"
2020-04-06 18:48:26 +00:00
```
2020-01-15 17:23:25 +00:00
## Dotnet
2020-09-30 20:26:13 +00:00
The `dotnet` module shows the relevant version of the .NET Core SDK 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.
2020-01-15 17:23:25 +00:00
2020-07-23 21:07:10 +00:00
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`
2020-09-30 20:26:13 +00:00
- `Directoria.Build.props`
- `Directorio.Build.targets`
2020-07-23 21:07:10 +00:00
- `Packages.props`
- `*.sln`
- `*.csproj`
- `*.fsproj`
- `*.xproj`
You'll also need the .NET Core SDK installed in order to use it correctly.
2020-01-15 17:23:25 +00:00
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.
2020-07-23 21:07:10 +00:00
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.
2020-05-05 17:07:34 +00:00
### Opciones
2020-01-15 17:23:25 +00:00
2020-09-30 20:26:13 +00:00
| Opción | Por defecto | Descripción |
| ----------- | ---------------------------------------- | ------------------------------------------------------------------------- |
| `format` | `"v[$symbol$version( 🎯 $tfm)]($style) "` | El formato del módulo. |
| `symbol` | `"•NET "` | El símbolo usado antes de mostrar la version de dotnet. |
| `heuristic` | `true` | Usa una detección de versiones más rápida para mantener a starship veloz. |
| `style` | `"bold blue"` | El estilo del módulo. |
| `disabled` | `false` | Deshabilita el módulo `dotnet` . |
2020-07-23 21:07:10 +00:00
### Variables
2020-09-30 20:26:13 +00:00
| 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` |
2020-07-23 21:07:10 +00:00
2020-09-30 20:26:13 +00:00
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
2020-01-15 17:23:25 +00:00
2020-05-05 17:07:34 +00:00
### Ejemplo
2020-01-15 17:23:25 +00:00
```toml
# ~/.config/starship.toml
[dotnet]
symbol = "🥅 "
style = "green"
heuristic = false
```
2020-04-03 16:35:39 +00:00
## Elixir
2020-05-05 17:07:34 +00:00
The `elixir` module shows the currently installed version of Elixir and Erlang/OTP. El módulo se muestra si algunas de las siguientes condiciones se cumplen:
2020-04-03 16:35:39 +00:00
2020-09-30 20:26:13 +00:00
- El directorio actual contiene un archivo `mix.exs` .
2020-04-03 16:35:39 +00:00
2020-05-05 17:07:34 +00:00
### Opciones
2020-04-03 16:35:39 +00:00
2020-09-30 20:26:13 +00:00
| Opción | Por defecto | Descripción |
| ---------- | ------------------------------------------------------------- | -------------------------------------------------------------- |
| `symbol` | `"💧 "` | El símbolo usado antes de mostrar la version de Elixir/Erlang. |
| `style` | `"bold purple"` | El estilo del módulo. |
| `format` | `"via [$symbol$version \\(OTP $otp_version\\)]($style) "` | El formato para el módulo elixir. |
| `disabled` | `false` | Deshabilita el módulo `elixir` . |
2020-07-23 21:07:10 +00:00
### Variables
2020-09-30 20:26:13 +00:00
| 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` |
2020-07-23 21:07:10 +00:00
2020-09-30 20:26:13 +00:00
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
2020-04-03 16:35:39 +00:00
2020-05-05 17:07:34 +00:00
### Ejemplo
2020-04-03 16:35:39 +00:00
```toml
# ~/.config/starship.toml
[elixir]
symbol = "🔮 "
```
2020-02-07 21:47:30 +00:00
## Elm
2020-05-05 17:07:34 +00:00
The `elm` module shows the currently installed version of Elm. El módulo se muestra si algunas de las siguientes condiciones se cumplen:
2020-02-07 21:47:30 +00:00
2020-09-30 20:26:13 +00:00
- The current directory contains a `elm.json` file
- The current directory contains a `elm-package.json` file
2020-04-06 18:48:26 +00:00
- The current directory contains a `.elm-version` file
2020-02-07 21:47:30 +00:00
- The current directory contains a `elm-stuff` folder
- The current directory contains a `*.elm` files
2020-05-05 17:07:34 +00:00
### Opciones
2020-02-07 21:47:30 +00:00
2020-09-30 20:26:13 +00:00
| Opción | Por defecto | Descripción |
2020-07-23 21:07:10 +00:00
| ---------- | ---------------------------------- | ----------------------------------------------- |
2020-09-30 20:26:13 +00:00
| `format` | `"via [$symbol$version]($style) "` | El formato del módulo. |
2020-07-23 21:07:10 +00:00
| `symbol` | `"🌳 "` | A format string representing the symbol of Elm. |
| `style` | `"cyan bold"` | El estilo del módulo. |
| `disabled` | `false` | Disables the `elm` module. |
2020-02-07 21:47:30 +00:00
2020-07-23 21:07:10 +00:00
### Variables
2020-09-30 20:26:13 +00:00
| Variable | Ejemplo | Descripción |
| --------- | --------- | -------------------------------------- |
| version | `v0.19.1` | The version of `elm` |
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
2020-07-23 21:07:10 +00:00
2020-09-30 20:26:13 +00:00
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
2020-02-07 21:47:30 +00:00
2020-05-05 17:07:34 +00:00
### Ejemplo
2020-02-07 21:47:30 +00:00
```toml
# ~/.config/starship.toml
[elm]
2020-07-23 21:07:10 +00:00
format = "via [ $version ](cyan bold ) "
2020-02-07 21:47:30 +00:00
```
2020-09-30 20:26:13 +00:00
## Environment Variable
2020-05-05 17:07:34 +00:00
2020-05-15 15:55:21 +00:00
The `env_var` module displays the current value of a selected environment variable. The module will be shown only if any of the following conditions are met:
2020-05-05 17:07:34 +00:00
2020-05-15 15:55:21 +00:00
- The `variable` configuration option matches an existing environment variable
- The `variable` configuration option is not defined, but the `default` configuration option is
2020-05-05 17:07:34 +00:00
### Opciones
2020-09-30 20:26:13 +00:00
| Opción | Por defecto | Descripción |
| ---------- | ------------------------------ | ---------------------------------------------------------------------------- |
| `symbol` | | The symbol used before displaying the variable value. |
| `variable` | | The environment variable to be displayed. |
| `default` | | The default value to be displayed when the selected variable is not defined. |
| `format` | `"with [$env_value]($style) "` | El formato del módulo. |
| `disabled` | `false` | Disables the `env_var` module. |
2020-07-23 21:07:10 +00:00
### Variables
| Variable | Ejemplo | Descripción |
| --------- | ------------------------------------------- | ------------------------------------------ |
2020-09-30 20:26:13 +00:00
| env_value | `Windows NT` (if _variable_ would be `$OS` ) | The environment value of option `variable` |
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | `black bold dimmed` | Refleja el valor de la opción `style` |
2020-07-23 21:07:10 +00:00
2020-09-30 20:26:13 +00:00
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
2020-05-05 17:07:34 +00:00
### Ejemplo
```toml
# ~/.config/starship.toml
2020-05-15 15:55:21 +00:00
[env_var]
variable = "SHELL"
default = "unknown shell"
2020-05-05 17:07:34 +00:00
```
2020-01-15 17:23:25 +00:00
2020-05-15 15:55:21 +00:00
## Erlang
2020-01-15 17:23:25 +00:00
2020-05-15 15:55:21 +00:00
The `erlang` module shows the currently installed version of Erlang/OTP. El módulo se muestra si algunas de las siguientes condiciones se cumplen:
2020-09-30 20:26:13 +00:00
- The current directory contains a `rebar.config` file.
- The current directory contains a `erlang.mk` file.
2020-01-15 17:23:25 +00:00
2020-05-05 17:07:34 +00:00
### Opciones
2020-01-15 17:23:25 +00:00
2020-09-30 20:26:13 +00:00
| Opción | Por defecto | Descripción |
2020-07-23 21:07:10 +00:00
| ---------- | ---------------------------------- | -------------------------------------------------------- |
| `symbol` | `"🖧 "` | The symbol used before displaying the version of erlang. |
| `style` | `"bold red"` | El estilo del módulo. |
2020-09-30 20:26:13 +00:00
| `format` | `"via [$symbol$version]($style) "` | El formato del módulo. |
2020-07-23 21:07:10 +00:00
| `disabled` | `false` | Disables the `erlang` module. |
### Variables
2020-09-30 20:26:13 +00:00
| Variable | Ejemplo | Descripción |
| --------- | --------- | -------------------------------------- |
| version | `v22.1.3` | The version of `erlang` |
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
2020-07-23 21:07:10 +00:00
2020-09-30 20:26:13 +00:00
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
2020-01-15 17:23:25 +00:00
2020-05-05 17:07:34 +00:00
### Ejemplo
2020-01-15 17:23:25 +00:00
```toml
# ~/.config/starship.toml
2020-05-15 15:55:21 +00:00
[erlang]
2020-07-23 21:07:10 +00:00
format = "via [e $version ](bold red ) "
2020-01-15 17:23:25 +00:00
```
2020-09-30 20:26:13 +00:00
## 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
| Variable | Por defecto | Descripción |
| ---------------- | ---------------------------------------------------- | --------------------------------------------------------------- |
| `format` | `"on [$symbol$account(\\($region\\))]($style) "` | El formato del módulo. |
| `symbol` | `"☁️ "` | The symbol used before displaying the current GCP profile. |
| `region_aliases` | | Table of region aliases to display in addition to the GCP name. |
| `style` | `"bold blue"` | El estilo del módulo. |
| `disabled` | `false` | Disables the `gcloud` module. |
### Variables
| Variable | Ejemplo | Descripción |
| --------- | ----------------- | ------------------------------------------------------------------ |
| region | `us-central1` | The current GCP region |
| account | `foo@example.com` | The current GCP profile |
| project | | The current GCP project |
| active | `default` | The active config name written in `~/.config/gcloud/active_config` |
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
### Examples
#### Display account and project
```toml
# ~/.config/starship.toml
[gcloud]
format = "on [$symbol$account(\\($project\\)) ]($style ) "
```
#### Display active config name only
```toml
# ~/.config/starship.toml
[gcloud]
format = "[$symbol$active]($style) "
style = "bold yellow"
```
#### Display account and aliased region
```toml
# ~/.config/starship.toml
[gcloud]
symbol = "️🇬️ "
[gcloud.region_aliases]
us-central1 = "uc1"
asia-northeast1 = "an1"
```
2020-01-15 17:23:25 +00:00
## Git Branch
The `git_branch` module shows the active branch of the repo in your current directory.
2020-05-05 17:07:34 +00:00
### Opciones
2020-01-15 17:23:25 +00:00
2020-09-30 20:26:13 +00:00
| Opción | Por defecto | Descripción |
2020-07-23 21:07:10 +00:00
| ------------------- | -------------------------------- | ---------------------------------------------------------------------------------------- |
2020-09-30 20:26:13 +00:00
| `format` | `"on [$symbol$branch]($style) "` | El formato del módulo. Use `"$branch"` to refer to the current branch name. |
2020-07-23 21:07:10 +00:00
| `symbol` | `" "` | A format string representing the symbol of git branch. |
| `style` | `"bold purple"` | El estilo del módulo. |
| `truncation_length` | `2^63 - 1` | Truncates a git branch to X graphemes. |
| `truncation_symbol` | `"…"` | The symbol used to indicate a branch name was truncated. You can use `""` for no symbol. |
| `disabled` | `false` | Disables the `git_branch` module. |
### Variables
| Variable | Ejemplo | Descripción |
| --------- | -------- | ---------------------------------------------------------------------------------------------------- |
| branch | `master` | The current branch name, falls back to `HEAD` if there's no current branch (e.g. git detached HEAD). |
2020-09-30 20:26:13 +00:00
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
2020-07-23 21:07:10 +00:00
2020-09-30 20:26:13 +00:00
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
2020-01-15 17:23:25 +00:00
2020-05-05 17:07:34 +00:00
### Ejemplo
2020-01-15 17:23:25 +00:00
```toml
# ~/.config/starship.toml
[git_branch]
symbol = "🌱 "
truncation_length = 4
truncation_symbol = ""
```
2020-09-30 20:26:13 +00:00
## Git Commit
2020-01-15 17:23:25 +00:00
The `git_commit` module shows the current commit hash of the repo in your current directory.
2020-05-05 17:07:34 +00:00
### Opciones
2020-01-15 17:23:25 +00:00
2020-09-30 20:26:13 +00:00
| Opción | Por defecto | Descripción |
2020-07-23 21:07:10 +00:00
| -------------------- | ------------------------------ | ----------------------------------------------------- |
| `commit_hash_length` | `7` | The length of the displayed git commit hash. |
2020-09-30 20:26:13 +00:00
| `format` | `"[\\($hash\\)]($style) "` | El formato del módulo. |
2020-07-23 21:07:10 +00:00
| `style` | `"bold green"` | El estilo del módulo. |
| `only_detached` | `true` | Only show git commit hash when in detached HEAD state |
| `disabled` | `false` | Disables the `git_commit` module. |
### Variables
2020-09-30 20:26:13 +00:00
| Variable | Ejemplo | Descripción |
| --------- | --------- | ------------------------------------- |
| hash | `b703eb3` | The current git commit hash |
| style\* | | Refleja el valor de la opción `style` |
2020-07-23 21:07:10 +00:00
2020-09-30 20:26:13 +00:00
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
2020-01-15 17:23:25 +00:00
2020-05-05 17:07:34 +00:00
### Ejemplo
2020-01-15 17:23:25 +00:00
```toml
# ~/.config/starship.toml
[git_commit]
commit_hash_length = 4
```
2020-09-30 20:26:13 +00:00
## Git State
2020-01-15 17:23:25 +00:00
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.
2020-05-05 17:07:34 +00:00
### Opciones
2020-01-15 17:23:25 +00:00
2020-09-30 20:26:13 +00:00
| Opción | Por defecto | Descripción |
2020-07-23 21:07:10 +00:00
| -------------- | ------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
| `rebase` | `"REBASING"` | A format string displayed when a `rebase` is in progress. |
| `merge` | `"MERGING"` | A format string displayed when a `merge` is in progress. |
| `revert` | `"REVERTING"` | A format string displayed when a `revert` is in progress. |
| `cherry_pick` | `"CHERRY-PICKING"` | A format string displayed when a `cherry-pick` is in progress. |
| `bisect` | `"BISECTING"` | A format string displayed when a `bisect` is in progress. |
| `am` | `"AM"` | A format string displayed when an `apply-mailbox` (`git am`) is in progress. |
| `am_or_rebase` | `"AM/REBASE"` | A format string displayed when an ambiguous `apply-mailbox` or `rebase` is in progress. |
| `style` | `"bold yellow"` | El estilo del módulo. |
2020-09-30 20:26:13 +00:00
| `format` | `"\\([$state( $progress_current/$progress_total)]($style)\\) "` | El formato del módulo. |
2020-07-23 21:07:10 +00:00
| `disabled` | `false` | Disables the `git_state` module. |
### Variables
2020-09-30 20:26:13 +00:00
| Variable | Ejemplo | Descripción |
| ---------------- | ---------- | ------------------------------------- |
| state | `REBASING` | The current state of the repo |
| progress_current | `1` | The current operation progress |
| progress_total | `2` | The total operation progress |
| style\* | | Refleja el valor de la opción `style` |
2020-07-23 21:07:10 +00:00
2020-09-30 20:26:13 +00:00
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
2020-01-15 17:23:25 +00:00
2020-05-05 17:07:34 +00:00
### Ejemplo
2020-01-15 17:23:25 +00:00
```toml
# ~/.config/starship.toml
[git_state]
2020-07-23 21:07:10 +00:00
format = "[\\($state( $progress_current of $progress_total)\\)]($style) "
cherry_pick = "[🍒 PICKING](bold red)"
2020-01-15 17:23:25 +00:00
```
2020-09-30 20:26:13 +00:00
## Git Status
2020-01-15 17:23:25 +00:00
The `git_status` module shows symbols representing the state of the repo in your current directory.
2020-05-05 17:07:34 +00:00
### Opciones
2020-01-15 17:23:25 +00:00
2020-09-30 20:26:13 +00:00
| Opción | Por defecto | Descripción |
| ------------ | --------------------------------------------- | ----------------------------------- |
| `format` | `"[\[$all_status$ahead_behind\]]($style) "` | The default format for `git_status` |
| `conflicted` | `"="` | This branch has merge conflicts. |
| `ahead` | `"⇡"` | The format of `ahead` |
| `behind` | `"⇣"` | The format of `behind` |
| `diverged` | `"⇕"` | The format of `diverged` |
| `untracked` | `"?"` | The format of `untracked` |
| `stashed` | `"$"` | The format of `stashed` |
| `modified` | `"!"` | The format of `modified` |
| `staged` | `"+"` | The format of `staged` |
| `renamed` | `"»"` | The format of `renamed` |
| `deleted` | `"✘"` | The format of `deleted` |
| `style` | `"bold red"` | El estilo del módulo. |
| `disabled` | `false` | Disables the `git_status` module. |
2020-07-23 21:07:10 +00:00
### Variables
The following variables can be used in `format` :
| Variable | Descripción |
| -------------- | --------------------------------------------------------------------------------------------- |
| `all_status` | Shortcut for`$conflicted$stashed$deleted$renamed$modified$staged$untracked` |
| `ahead_behind` | Displays `diverged` `ahead` or `behind` format string based on the current status of the repo |
| `conflicted` | Displays `conflicted` when this branch has merge conflicts. |
2020-09-30 20:26:13 +00:00
| `untracked` | Displays `untracked` when there are untracked files in the working directory. |
| `stashed` | Displays `stashed` when a stash exists for the local repository. |
| `modified` | Displays `modified` when there are file modifications in the working directory. |
| `staged` | Displays `staged` when a new file has been added to the staging area. |
| `renamed` | Displays `renamed` when a renamed file has been added to the staging area. |
| `deleted` | Displays `deleted` when a file's deletion has been added to the staging area. |
| style\* | Refleja el valor de la opción `style` |
2020-07-23 21:07:10 +00:00
2020-09-30 20:26:13 +00:00
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
2020-07-23 21:07:10 +00:00
The following variables can be used in `diverged` :
| Variable | Descripción |
| -------------- | ---------------------------------------------- |
| `ahead_count` | Number of commits ahead of the tracking branch |
| `behind_count` | Number of commits behind the tracking branch |
The following variables can be used in `conflicted` , `ahead` , `behind` , `untracked` , `stashed` , `modified` , `staged` , `renamed` and `deleted` :
| Variable | Descripción |
| -------- | ------------------------ |
| `count` | Show the number of files |
2020-01-15 17:23:25 +00:00
2020-05-05 17:07:34 +00:00
### Ejemplo
2020-01-15 17:23:25 +00:00
```toml
# ~/.config/starship.toml
[git_status]
conflicted = "🏳"
ahead = "🏎💨"
behind = "😰"
diverged = "😵"
untracked = "🤷"
stashed = "📦"
modified = "📝"
2020-07-23 21:07:10 +00:00
staged = '[++\($count\)](green)'
2020-01-15 17:23:25 +00:00
renamed = "👅"
deleted = "🗑"
```
2020-09-30 20:26:13 +00:00
Show ahead/behind count of the branch being tracked
```toml
# ~/.config/starship.toml
[git_status]
ahead = "⇡${count}"
diverged = "⇕⇡${ahead_count}⇣${behind_count}"
behind = "⇣${count}"
```
2020-01-15 17:23:25 +00:00
## Golang
2020-05-05 17:07:34 +00:00
The `golang` module shows the currently installed version of Golang. El módulo se muestra si algunas de las siguientes condiciones se cumplen:
2020-01-15 17:23:25 +00:00
2020-09-30 20:26:13 +00:00
- The current directory contains a `go.mod` file
- The current directory contains a `go.sum` file
- The current directory contains a `glide.yaml` file
2020-01-15 17:23:25 +00:00
- The current directory contains a `Gopkg.yml` file
- The current directory contains a `Gopkg.lock` file
2020-04-06 18:48:26 +00:00
- The current directory contains a `.go-version` file
2020-01-15 17:23:25 +00:00
- The current directory contains a `Godeps` directory
- The current directory contains a file with the `.go` extension
2020-05-05 17:07:34 +00:00
### Opciones
2020-01-15 17:23:25 +00:00
2020-09-30 20:26:13 +00:00
| Opción | Por defecto | Descripción |
2020-07-23 21:07:10 +00:00
| ---------- | ---------------------------------- | ---------------------------------------------- |
2020-09-30 20:26:13 +00:00
| `format` | `"via [$symbol$version]($style) "` | El formato del módulo. |
2020-07-23 21:07:10 +00:00
| `symbol` | `"🐹 "` | A format string representing the symbol of Go. |
| `style` | `"bold cyan"` | El estilo del módulo. |
| `disabled` | `false` | Disables the `golang` module. |
### Variables
2020-09-30 20:26:13 +00:00
| Variable | Ejemplo | Descripción |
| --------- | --------- | -------------------------------------- |
| version | `v1.12.1` | The version of `go` |
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
2020-07-23 21:07:10 +00:00
2020-09-30 20:26:13 +00:00
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
2020-01-15 17:23:25 +00:00
2020-05-05 17:07:34 +00:00
### Ejemplo
2020-01-15 17:23:25 +00:00
```toml
# ~/.config/starship.toml
[golang]
2020-07-23 21:07:10 +00:00
format = "via [🏎💨 $version ](bold cyan ) "
2020-01-15 17:23:25 +00:00
```
2020-02-04 17:11:36 +00:00
2020-07-23 21:07:10 +00:00
## Helm
2020-02-04 17:11:36 +00:00
2020-07-23 21:07:10 +00:00
The `helm` module shows the currently installed version of Helm. El módulo se muestra si algunas de las siguientes condiciones se cumplen:
2020-09-30 20:26:13 +00:00
- The current directory contains a `helmfile.yaml` file
2020-07-23 21:07:10 +00:00
- The current directory contains a `Chart.yaml` file
2020-02-04 17:11:36 +00:00
2020-05-05 17:07:34 +00:00
### Opciones
2020-02-04 17:11:36 +00:00
2020-09-30 20:26:13 +00:00
| Opción | Por defecto | Descripción |
2020-07-23 21:07:10 +00:00
| ---------- | ---------------------------------- | ------------------------------------------------ |
2020-09-30 20:26:13 +00:00
| `format` | `"via [$symbol$version]($style) "` | El formato del módulo. |
2020-07-23 21:07:10 +00:00
| `symbol` | `"⎈ "` | A format string representing the symbol of Helm. |
| `style` | `"bold white"` | El estilo del módulo. |
| `disabled` | `false` | Disables the `helm` module. |
### Variables
2020-09-30 20:26:13 +00:00
| Variable | Ejemplo | Descripción |
| --------- | -------- | -------------------------------------- |
| version | `v3.1.1` | The version of `helm` |
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
2020-02-04 17:11:36 +00:00
2020-09-30 20:26:13 +00:00
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
2020-02-04 17:11:36 +00:00
2020-05-05 17:07:34 +00:00
### Ejemplo
2020-02-04 17:11:36 +00:00
```toml
# ~/.config/starship.toml
2020-07-23 21:07:10 +00:00
[helm]
format = "via [⎈ $version ](bold white ) "
2020-02-04 17:11:36 +00:00
```
2020-01-15 17:23:25 +00:00
## Hostname
The `hostname` module shows the system hostname.
2020-05-05 17:07:34 +00:00
### Opciones
2020-01-15 17:23:25 +00:00
2020-09-30 20:26:13 +00:00
| Opción | Por defecto | Descripción |
2020-07-23 21:07:10 +00:00
| ---------- | --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ |
| `ssh_only` | `true` | Only show hostname when connected to an SSH session. |
| `trim_at` | `"."` | String that the hostname is cut off at, after the first match. `"."` will stop after the first dot. `""` will disable any truncation |
2020-09-30 20:26:13 +00:00
| `format` | `"[$hostname]($style) in "` | El formato del módulo. |
2020-07-23 21:07:10 +00:00
| `style` | `"bold dimmed green"` | El estilo del módulo. |
| `disabled` | `false` | Disables the `hostname` module. |
### Variables
2020-09-30 20:26:13 +00:00
| Variable | Ejemplo | Descripción |
| --------- | ------- | -------------------------------------- |
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
2020-07-23 21:07:10 +00:00
2020-09-30 20:26:13 +00:00
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
2020-01-15 17:23:25 +00:00
2020-05-05 17:07:34 +00:00
### Ejemplo
2020-01-15 17:23:25 +00:00
```toml
# ~/.config/starship.toml
[hostname]
ssh_only = false
2020-07-23 21:07:10 +00:00
format = "on [$hostname ](bold red ) "
2020-01-15 17:23:25 +00:00
trim_at = ".companyname.com"
disabled = false
```
2020-04-03 16:35:39 +00:00
## Java
2020-05-05 17:07:34 +00:00
The `java` module shows the currently installed version of Java. El módulo se muestra si algunas de las siguientes condiciones se cumplen:
2020-04-03 16:35:39 +00:00
2020-04-06 18:48:26 +00:00
- The current directory contains a `pom.xml` , `build.gradle.kts` , `build.sbt` or `.java-version` file
2020-04-03 16:35:39 +00:00
- The current directory contains a file with the `.java` , `.class` , `.gradle` or `.jar` extension
2020-05-05 17:07:34 +00:00
### Opciones
2020-04-03 16:35:39 +00:00
2020-09-30 20:26:13 +00:00
| Opción | Por defecto | Descripción |
2020-07-23 21:07:10 +00:00
| ---------- | -------------------------------------- | ----------------------------------------------- |
2020-09-30 20:26:13 +00:00
| `format` | `"via [${symbol}${version}]($style) "` | El formato del módulo. |
2020-07-23 21:07:10 +00:00
| `symbol` | `"☕ "` | A format string representing the symbol of Java |
| `style` | `"red dimmed"` | El estilo del módulo. |
| `disabled` | `false` | Disables the `java` module. |
### Variables
2020-09-30 20:26:13 +00:00
| Variable | Ejemplo | Descripción |
| --------- | ------- | -------------------------------------- |
| version | `v14` | The version of `java` |
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
2020-07-23 21:07:10 +00:00
2020-09-30 20:26:13 +00:00
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
2020-04-03 16:35:39 +00:00
2020-05-05 17:07:34 +00:00
### Ejemplo
2020-04-03 16:35:39 +00:00
```toml
# ~/.config/starship.toml
[java]
symbol = "🌟 "
```
2020-01-15 17:23:25 +00:00
## Jobs
The `jobs` module shows the current number of jobs running. The module will be shown only if there are background jobs running. The module will show the number of jobs running if there is more than 1 job, or more than the `threshold` config value, if it exists.
2020-05-05 17:07:34 +00:00
### Opciones
2020-01-15 17:23:25 +00:00
2020-09-30 20:26:13 +00:00
| Opción | Por defecto | Descripción |
2020-07-23 21:07:10 +00:00
| ----------- | ----------------------------- | ------------------------------------------------ |
| `threshold` | `1` | Show number of jobs if exceeded. |
2020-09-30 20:26:13 +00:00
| `format` | `"[$symbol$number]($style) "` | El formato del módulo. |
2020-07-23 21:07:10 +00:00
| `symbol` | `"✦"` | A format string representing the number of jobs. |
| `style` | `"bold blue"` | El estilo del módulo. |
| `disabled` | `false` | Disables the `jobs` module. |
### Variables
2020-09-30 20:26:13 +00:00
| Variable | Ejemplo | Descripción |
| --------- | ------- | -------------------------------------- |
| number | `1` | The number of jobs |
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
2020-07-23 21:07:10 +00:00
2020-09-30 20:26:13 +00:00
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
2020-01-15 17:23:25 +00:00
2020-05-05 17:07:34 +00:00
### Ejemplo
2020-01-15 17:23:25 +00:00
```toml
# ~/.config/starship.toml
[jobs]
symbol = "+ "
threshold = 4
```
2020-04-06 18:48:26 +00:00
## Julia
2020-05-05 17:07:34 +00:00
The `julia` module shows the currently installed version of Julia. El módulo se muestra si algunas de las siguientes condiciones se cumplen:
2020-04-06 18:48:26 +00:00
- The current directory contains a `Project.toml` file
- The current directory contains a `Manifest.toml` file
- The current directory contains a file with the `.jl` extension
2020-05-05 17:07:34 +00:00
### Opciones
2020-04-06 18:48:26 +00:00
2020-09-30 20:26:13 +00:00
| Opción | Por defecto | Descripción |
2020-07-23 21:07:10 +00:00
| ---------- | ---------------------------------- | ------------------------------------------------- |
2020-09-30 20:26:13 +00:00
| `format` | `"via [$symbol$version]($style) "` | El formato del módulo. |
2020-07-23 21:07:10 +00:00
| `symbol` | `"ஃ "` | A format string representing the symbol of Julia. |
| `style` | `"bold purple"` | El estilo del módulo. |
| `disabled` | `false` | Disables the `julia` module. |
### Variables
2020-09-30 20:26:13 +00:00
| Variable | Ejemplo | Descripción |
| --------- | -------- | -------------------------------------- |
| version | `v1.4.0` | The version of `julia` |
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
2020-07-23 21:07:10 +00:00
2020-09-30 20:26:13 +00:00
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
2020-04-06 18:48:26 +00:00
2020-05-05 17:07:34 +00:00
### Ejemplo
2020-04-06 18:48:26 +00:00
```toml
# ~/.config/starship.toml
[julia]
2020-05-05 17:07:34 +00:00
symbol = "∴ "
2020-04-06 18:48:26 +00:00
```
2020-07-23 21:07:10 +00:00
2020-01-15 17:23:25 +00:00
## Kubernetes
Displays the current Kubernetes context name and, if set, the namespace from the kubeconfig file. The namespace needs to be set in the kubeconfig file, this can be done via `kubectl config set-context starship-cluster --namespace astronaut` . If the `$KUBECONFIG` env var is set the module will use that if not it will use the `~/.kube/config` .
::: tip
This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
:::
2020-05-05 17:07:34 +00:00
### Opciones
2020-01-15 17:23:25 +00:00
2020-09-30 20:26:13 +00:00
| Opción | Por defecto | Descripción |
2020-07-23 21:07:10 +00:00
| ----------------------- | -------------------------------------------------------- | --------------------------------------------------------------------- |
| `symbol` | `"☸ "` | A format string representing the symbol displayed before the Cluster. |
2020-09-30 20:26:13 +00:00
| `format` | `"[$symbol$context( \\($namespace\\))]($style) in "` | El formato del módulo. |
2020-07-23 21:07:10 +00:00
| `style` | `"cyan bold"` | El estilo del módulo. |
| `namespace_spaceholder` | `none` | The value to display if no namespace was found. |
| `context_aliases` | | Table of context aliases to display. |
| `disabled` | `true` | Disables the `kubernetes` module. |
### Variables
| Variable | Ejemplo | Descripción |
| --------- | -------------------- | ---------------------------------------- |
| context | `starship-cluster` | The current kubernetes context |
| namespace | `starship-namespace` | If set, the current kubernetes namespace |
2020-09-30 20:26:13 +00:00
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
2020-07-23 21:07:10 +00:00
2020-09-30 20:26:13 +00:00
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
2020-01-15 17:23:25 +00:00
2020-05-05 17:07:34 +00:00
### Ejemplo
2020-01-15 17:23:25 +00:00
```toml
# ~/.config/starship.toml
[kubernetes]
2020-07-23 21:07:10 +00:00
format = "on [⛵ $context \\($namespace\\) ](dimmed green ) "
2020-01-15 17:23:25 +00:00
disabled = false
2020-04-06 18:48:26 +00:00
[kubernetes.context_aliases]
"dev.local.cluster.k8s" = "dev"
2020-01-15 17:23:25 +00:00
```
2020-09-30 20:26:13 +00:00
## Line Break
2020-01-15 17:23:25 +00:00
The `line_break` module separates the prompt into two lines.
2020-05-05 17:07:34 +00:00
### Opciones
2020-01-15 17:23:25 +00:00
2020-09-30 20:26:13 +00:00
| Opción | Por defecto | Descripción |
2020-05-05 17:07:34 +00:00
| ---------- | ----------- | ------------------------------------------------------------------ |
| `disabled` | `false` | Disables the `line_break` module, making the prompt a single line. |
2020-01-15 17:23:25 +00:00
2020-05-05 17:07:34 +00:00
### Ejemplo
2020-01-15 17:23:25 +00:00
```toml
# ~/.config/starship.toml
[line_break]
disabled = true
```
2020-09-30 20:26:13 +00:00
## Memory Usage
2020-01-15 17:23:25 +00:00
The `memory_usage` module shows current system memory and swap usage.
By default the swap usage is displayed if the total system swap is non-zero.
::: tip
This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
:::
2020-05-05 17:07:34 +00:00
### Opciones
2020-01-15 17:23:25 +00:00
2020-09-30 20:26:13 +00:00
| Opción | Por defecto | Descripción |
2020-07-23 21:07:10 +00:00
| ----------- | --------------------------------------------- | -------------------------------------------------------- |
| `threshold` | `75` | Hide the memory usage unless it exceeds this percentage. |
2020-09-30 20:26:13 +00:00
| `format` | `"via $symbol [${ram}( | ${swap})]($style) "` | El formato del módulo. |
2020-07-23 21:07:10 +00:00
| `symbol` | `"🐏"` | The symbol used before displaying the memory usage. |
| `style` | `"bold dimmed white"` | El estilo del módulo. |
| `disabled` | `true` | Disables the `memory_usage` module. |
### Variables
2020-09-30 20:26:13 +00:00
| Variable | Ejemplo | Descripción |
| ---------------- | ------------- | ------------------------------------------------------------------ |
| ram | `31GiB/65GiB` | The usage/total RAM of the current system memory. |
| ram_pct | `48%` | The percentage of the current system memory. |
| swap\*\* | `1GiB/4GiB` | The swap memory size of the current system swap memory file. |
| swap_pct\*\* | `77%` | The swap memory percentage of the current system swap memory file. |
| symbol | `🐏` | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
2020-07-23 21:07:10 +00:00
\*: 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
2020-01-15 17:23:25 +00:00
2020-05-05 17:07:34 +00:00
### Ejemplo
2020-01-15 17:23:25 +00:00
```toml
# ~/.config/starship.toml
[memory_usage]
2020-04-03 16:35:39 +00:00
disabled = false
2020-01-15 17:23:25 +00:00
show_percentage = true
show_swap = true
threshold = -1
symbol = " "
separator = "/"
style = "bold dimmed green"
```
2020-04-03 16:35:39 +00:00
## Mercurial Branch
2020-02-07 21:47:30 +00:00
2020-04-03 16:35:39 +00:00
The `hg_branch` module shows the active branch of the repo in your current directory.
2020-02-07 21:47:30 +00:00
2020-05-05 17:07:34 +00:00
### Opciones
2020-04-03 16:35:39 +00:00
2020-09-30 20:26:13 +00:00
| Opción | Por defecto | Descripción |
2020-07-23 21:07:10 +00:00
| ------------------- | -------------------------------- | -------------------------------------------------------------------------------------------- |
| `symbol` | `" "` | The symbol used before the hg bookmark or branch name of the repo in your current directory. |
| `style` | `"bold purple"` | El estilo del módulo. |
2020-09-30 20:26:13 +00:00
| `format` | `"on [$symbol$branch]($style) "` | El formato del módulo. |
2020-07-23 21:07:10 +00:00
| `truncation_length` | `2^63 - 1` | Truncates the hg branch name to X graphemes |
| `truncation_symbol` | `"…"` | The symbol used to indicate a branch name was truncated. |
| `disabled` | `true` | Disables the `hg_branch` module. |
### Variables
2020-09-30 20:26:13 +00:00
| Variable | Ejemplo | Descripción |
| --------- | -------- | -------------------------------------- |
| branch | `master` | The active mercurial branch |
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
2020-07-23 21:07:10 +00:00
2020-09-30 20:26:13 +00:00
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
2020-04-03 16:35:39 +00:00
2020-05-05 17:07:34 +00:00
### Ejemplo
2020-04-03 16:35:39 +00:00
```toml
# ~/.config/starship.toml
[hg_branch]
2020-07-23 21:07:10 +00:00
format = "on [🌱 $branch ](bold purple )"
2020-04-03 16:35:39 +00:00
truncation_length = 4
truncation_symbol = ""
```
docs(i18n): new Crowdin translations (#1262)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (German)
* New translations README.md (French)
* New translations README.md (Japanese)
* New translations README.md (Spanish)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Portuguese)
* New translations README.md (Chinese Traditional)
* New translations README.md (Chinese Simplified)
* New translations README.md (Russian)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (Chinese Simplified)
* New translations README.md (Chinese Traditional)
* New translations README.md (Portuguese)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (French)
* New translations README.md (Spanish)
* New translations README.md (German)
* New translations README.md (Russian)
* New translations README.md (Japanese)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Chinese Simplified)
* New translations README.md (Chinese Traditional)
* New translations README.md (Portuguese)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (French)
* New translations README.md (Spanish)
* New translations README.md (German)
* New translations README.md (Russian)
* New translations README.md (Japanese)
* New translations README.md (French)
* New translations README.md (Japanese)
* New translations README.md (German)
* New translations README.md (Spanish)
* New translations README.md (Chinese Traditional)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Portuguese)
* New translations README.md (Chinese Simplified)
* New translations README.md (Russian)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Chinese Traditional)
* New translations README.md (Chinese Traditional)
* New translations README.md (Portuguese)
* New translations README.md (Portuguese)
* New translations README.md (Chinese Simplified)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (French)
* New translations README.md (French)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (German)
* New translations README.md (German)
* New translations README.md (Chinese Simplified)
* New translations README.md (Japanese)
* New translations README.md (Japanese)
* New translations README.md (Russian)
* New translations README.md (Russian)
* New translations README.md (Japanese)
* New translations README.md (Japanese)
* New translations README.md (Japanese)
* New translations README.md (Japanese)
2020-06-11 01:28:04 +00:00
## Nim
The `nim` module shows the currently installed version of Nim. El módulo se muestra si algunas de las siguientes condiciones se cumplen:
2020-07-23 21:07:10 +00:00
2020-09-30 20:26:13 +00:00
- The current directory contains a `nim.cfg` file
docs(i18n): new Crowdin translations (#1262)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (German)
* New translations README.md (French)
* New translations README.md (Japanese)
* New translations README.md (Spanish)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Portuguese)
* New translations README.md (Chinese Traditional)
* New translations README.md (Chinese Simplified)
* New translations README.md (Russian)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (Chinese Simplified)
* New translations README.md (Chinese Traditional)
* New translations README.md (Portuguese)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (French)
* New translations README.md (Spanish)
* New translations README.md (German)
* New translations README.md (Russian)
* New translations README.md (Japanese)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Chinese Simplified)
* New translations README.md (Chinese Traditional)
* New translations README.md (Portuguese)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (French)
* New translations README.md (Spanish)
* New translations README.md (German)
* New translations README.md (Russian)
* New translations README.md (Japanese)
* New translations README.md (French)
* New translations README.md (Japanese)
* New translations README.md (German)
* New translations README.md (Spanish)
* New translations README.md (Chinese Traditional)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Portuguese)
* New translations README.md (Chinese Simplified)
* New translations README.md (Russian)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Chinese Traditional)
* New translations README.md (Chinese Traditional)
* New translations README.md (Portuguese)
* New translations README.md (Portuguese)
* New translations README.md (Chinese Simplified)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (French)
* New translations README.md (French)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (German)
* New translations README.md (German)
* New translations README.md (Chinese Simplified)
* New translations README.md (Japanese)
* New translations README.md (Japanese)
* New translations README.md (Russian)
* New translations README.md (Russian)
* New translations README.md (Japanese)
* New translations README.md (Japanese)
* New translations README.md (Japanese)
* New translations README.md (Japanese)
2020-06-11 01:28:04 +00:00
- The current directory contains a file with the `.nim` extension
- The current directory contains a file with the `.nims` extension
- The current directory contains a file with the `.nimble` extension
### Opciones
2020-09-30 20:26:13 +00:00
| Opción | Por defecto | Descripción |
2020-07-23 21:07:10 +00:00
| ---------- | ---------------------------------- | ----------------------------------------------------- |
| `format` | `"via [$symbol$version]($style) "` | The format for the module |
| `symbol` | `"👑 "` | The symbol used before displaying the version of Nim. |
| `style` | `"bold yellow"` | El estilo del módulo. |
| `disabled` | `false` | Disables the `nim` module. |
### Variables
2020-09-30 20:26:13 +00:00
| Variable | Ejemplo | Descripción |
| --------- | -------- | -------------------------------------- |
| version | `v1.2.0` | The version of `nimc` |
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
2020-07-23 21:07:10 +00:00
2020-09-30 20:26:13 +00:00
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
docs(i18n): new Crowdin translations (#1262)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (German)
* New translations README.md (French)
* New translations README.md (Japanese)
* New translations README.md (Spanish)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Portuguese)
* New translations README.md (Chinese Traditional)
* New translations README.md (Chinese Simplified)
* New translations README.md (Russian)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (Chinese Simplified)
* New translations README.md (Chinese Traditional)
* New translations README.md (Portuguese)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (French)
* New translations README.md (Spanish)
* New translations README.md (German)
* New translations README.md (Russian)
* New translations README.md (Japanese)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Chinese Simplified)
* New translations README.md (Chinese Traditional)
* New translations README.md (Portuguese)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (French)
* New translations README.md (Spanish)
* New translations README.md (German)
* New translations README.md (Russian)
* New translations README.md (Japanese)
* New translations README.md (French)
* New translations README.md (Japanese)
* New translations README.md (German)
* New translations README.md (Spanish)
* New translations README.md (Chinese Traditional)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Portuguese)
* New translations README.md (Chinese Simplified)
* New translations README.md (Russian)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Chinese Traditional)
* New translations README.md (Chinese Traditional)
* New translations README.md (Portuguese)
* New translations README.md (Portuguese)
* New translations README.md (Chinese Simplified)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (French)
* New translations README.md (French)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (German)
* New translations README.md (German)
* New translations README.md (Chinese Simplified)
* New translations README.md (Japanese)
* New translations README.md (Japanese)
* New translations README.md (Russian)
* New translations README.md (Russian)
* New translations README.md (Japanese)
* New translations README.md (Japanese)
* New translations README.md (Japanese)
* New translations README.md (Japanese)
2020-06-11 01:28:04 +00:00
### Ejemplo
```toml
# ~/.config/starship.toml
[nim]
style = "yellow"
symbol = "🎣 "
```
2020-04-03 16:35:39 +00:00
## Nix-shell
The `nix_shell` module shows the nix-shell environment. The module will be shown when inside a nix-shell environment.
2020-02-07 21:47:30 +00:00
2020-05-05 17:07:34 +00:00
### Opciones
2020-02-07 21:47:30 +00:00
2020-09-30 20:26:13 +00:00
| Opción | Por defecto | Descripción |
2020-07-23 21:07:10 +00:00
| ------------ | -------------------------------------------------- | ----------------------------------------------------- |
2020-09-30 20:26:13 +00:00
| `format` | `"via [$symbol$state( \\($name\\))]($style) "` | El formato del módulo. |
| `symbol` | `"❄️ "` | A format string representing the symbol of nix-shell. |
2020-07-23 21:07:10 +00:00
| `style` | `"bold blue"` | El estilo del módulo. |
| `impure_msg` | `"impure"` | A format string shown when the shell is impure. |
| `pure_msg` | `"pure"` | A format string shown when the shell is pure. |
| `disabled` | `false` | Disables the `nix_shell` module. |
### Variables
2020-09-30 20:26:13 +00:00
| Variable | Ejemplo | Descripción |
| --------- | ------- | -------------------------------------- |
| state | `pure` | The state of the nix-shell |
| name | `lorri` | The name of the nix-shell |
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
2020-07-23 21:07:10 +00:00
2020-09-30 20:26:13 +00:00
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
2020-02-07 21:47:30 +00:00
2020-05-05 17:07:34 +00:00
### Ejemplo
2020-02-07 21:47:30 +00:00
```toml
# ~/.config/starship.toml
2020-04-03 16:35:39 +00:00
[nix_shell]
disabled = true
2020-07-23 21:07:10 +00:00
impure_msg = "[impure shell](bold red)"
pure_msg = "[pure shell](bold green)"
format = "via [☃️ $state( \\($name\\)) ](bold blue ) "
2020-02-07 21:47:30 +00:00
```
2020-01-15 17:23:25 +00:00
## NodeJS
2020-05-05 17:07:34 +00:00
The `nodejs` module shows the currently installed version of NodeJS. El módulo se muestra si algunas de las siguientes condiciones se cumplen:
2020-01-15 17:23:25 +00:00
2020-09-30 20:26:13 +00:00
- The current directory contains a `package.json` file
2020-04-06 18:48:26 +00:00
- The current directory contains a `.node-version` file
2020-01-15 17:23:25 +00:00
- The current directory contains a `node_modules` directory
2020-07-23 21:07:10 +00:00
- The current directory contains a file with the `.js` , `.mjs` or `.cjs` extension
- The current directory contains a file with the `.ts` extension
2020-01-15 17:23:25 +00:00
2020-05-05 17:07:34 +00:00
### Opciones
2020-01-15 17:23:25 +00:00
2020-09-30 20:26:13 +00:00
| Opción | Por defecto | Descripción |
2020-07-23 21:07:10 +00:00
| ---------- | ---------------------------------- | -------------------------------------------------- |
2020-09-30 20:26:13 +00:00
| `format` | `"via [$symbol$version]($style) "` | El formato del módulo. |
2020-07-23 21:07:10 +00:00
| `symbol` | `"⬢ "` | A format string representing the symbol of NodeJS. |
| `style` | `"bold green"` | El estilo del módulo. |
| `disabled` | `false` | Disables the `nodejs` module. |
### Variables
2020-09-30 20:26:13 +00:00
| Variable | Ejemplo | Descripción |
| --------- | ---------- | -------------------------------------- |
| version | `v13.12.0` | The version of `node` |
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
2020-07-23 21:07:10 +00:00
2020-09-30 20:26:13 +00:00
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
2020-01-15 17:23:25 +00:00
2020-05-05 17:07:34 +00:00
### Ejemplo
2020-01-15 17:23:25 +00:00
```toml
# ~/.config/starship.toml
[nodejs]
2020-07-23 21:07:10 +00:00
format = "via [🤖 $version ](bold green ) "
2020-01-15 17:23:25 +00:00
```
2020-09-30 20:26:13 +00:00
## Package Version
2020-01-15 17:23:25 +00:00
2020-09-30 20:26:13 +00:00
The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm` , `cargo` , `poetry` , `composer` , `gradle` , `julia` , `mix` and `helm` packages.
2020-01-15 17:23:25 +00:00
- **npm** – The `npm` package version is extracted from the `package.json` present in the current directory
- **cargo** – The `cargo` package version is extracted from the `Cargo.toml` present in the current directory
- **poetry** – The `poetry` package version is extracted from the `pyproject.toml` present in the current directory
- **composer** – The `composer` package version is extracted from the `composer.json` present in the current directory
2020-04-03 16:35:39 +00:00
- **gradle** – The `gradle` package version is extracted from the `build.gradle` present
2020-04-06 18:48:26 +00:00
- **julia** - The package version is extracted from the `Project.toml` present
2020-05-05 17:07:34 +00:00
- **mix** - The `mix` package version is extracted from the `mix.exs` present
2020-09-30 20:26:13 +00:00
- **helm** - The `helm` chart version is extracted from the `Chart.yaml` present
- **maven** - The `maven` package version is extracted from the `pom.xml` present
2020-01-15 17:23:25 +00:00
> ⚠️ The version being shown is that of the package whose source code is in your current directory, not your package manager.
2020-05-05 17:07:34 +00:00
### Opciones
2020-01-15 17:23:25 +00:00
2020-09-30 20:26:13 +00:00
| Opción | Por defecto | Descripción |
2020-07-23 21:07:10 +00:00
| ----------------- | ---------------------------------- | ---------------------------------------------------------- |
2020-09-30 20:26:13 +00:00
| `format` | `"via [$symbol$version]($style) "` | El formato del módulo. |
2020-07-23 21:07:10 +00:00
| `symbol` | `"📦 "` | The symbol used before displaying the version the package. |
| `style` | `"bold 208"` | El estilo del módulo. |
| `display_private` | `false` | Enable displaying version for packages marked as private. |
| `disabled` | `false` | Disables the `package` module. |
### Variables
2020-09-30 20:26:13 +00:00
| Variable | Ejemplo | Descripción |
| --------- | -------- | -------------------------------------- |
| version | `v1.0.0` | The version of your package |
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
2020-07-23 21:07:10 +00:00
2020-09-30 20:26:13 +00:00
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
2020-01-15 17:23:25 +00:00
2020-05-05 17:07:34 +00:00
### Ejemplo
2020-01-15 17:23:25 +00:00
```toml
# ~/.config/starship.toml
[package]
2020-07-23 21:07:10 +00:00
format = "via [🎁 $version ](208 bold ) "
2020-01-15 17:23:25 +00:00
```
2020-05-23 23:10:58 +00:00
## OCaml
The `ocaml` module shows the currently installed version of OCaml. El módulo se muestra si algunas de las siguientes condiciones se cumplen:
- The current directory contains a file with `.opam` extension or `_opam` directory
- The current directory contains a `esy.lock` directory
- The current directory contains a `dune` or `dune-project` file
- The current directory contains a `jbuild` or `jbuild-ignore` file
- The current directory contains a `.merlin` file
- The current directory contains a file with `.ml` , `.mli` , `.re` or `.rei` extension
### Opciones
2020-09-30 20:26:13 +00:00
| Opción | Por defecto | Descripción |
2020-07-23 21:07:10 +00:00
| ---------- | ---------------------------------- | ------------------------------------------------------- |
| `format` | `"via [$symbol$version]($style) "` | The format string for the module. |
| `symbol` | `"🐫 "` | The symbol used before displaying the version of OCaml. |
| `style` | `"bold yellow"` | El estilo del módulo. |
| `disabled` | `false` | Disables the `ocaml` module. |
### Variables
2020-09-30 20:26:13 +00:00
| Variable | Ejemplo | Descripción |
| --------- | --------- | -------------------------------------- |
| version | `v4.10.0` | The version of `ocaml` |
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
2020-07-23 21:07:10 +00:00
2020-09-30 20:26:13 +00:00
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
2020-05-23 23:10:58 +00:00
### Ejemplo
```toml
# ~/.config/starship.toml
[ocaml]
2020-07-23 21:07:10 +00:00
format = "via [🐪 $version ]($style ) "
2020-05-23 23:10:58 +00:00
```
2020-09-30 20:26:13 +00:00
## Perl
The `perl` module shows the currently installed version of Perl. El módulo se muestra si algunas de las siguientes condiciones se cumplen:
- The current directory contains a `Makefile.PL` or `Build.PL` file
- The current directory contains a `cpanfile` or `cpanfile.snapshot` file
- The current directory contains a `META.json` file or `META.yml` file
- The current directory contains a `.perl-version` file
- The current directory contains a `.pl` , `.pm` or `.pod`
### Opciones
| Variable | Por defecto | Descripción |
| ---------- | ---------------------------------- | ----------------------------------------------------- |
| `format` | `"via [$symbol$version]($style) "` | The format string for the module. |
| `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl |
| `style` | `"bold 149"` | El estilo del módulo. |
| `disabled` | `false` | Disables the `perl` module. |
### Variables
| Variable | Ejemplo | Descripción |
| --------- | --------- | -------------------------------------- |
| version | `v5.26.1` | The version of `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 ) "
```
2020-01-15 17:23:25 +00:00
## PHP
2020-05-05 17:07:34 +00:00
The `php` module shows the currently installed version of PHP. El módulo se muestra si algunas de las siguientes condiciones se cumplen:
2020-01-15 17:23:25 +00:00
2020-09-30 20:26:13 +00:00
- The current directory contains a `composer.json` file
2020-04-06 18:48:26 +00:00
- The current directory contains a `.php-version` file
2020-01-15 17:23:25 +00:00
- The current directory contains a `.php` file
2020-05-05 17:07:34 +00:00
### Opciones
2020-01-15 17:23:25 +00:00
2020-09-30 20:26:13 +00:00
| Opción | Por defecto | Descripción |
2020-07-23 21:07:10 +00:00
| ---------- | ---------------------------------- | ----------------------------------------------------- |
2020-09-30 20:26:13 +00:00
| `format` | `"via [$symbol$version]($style) "` | El formato del módulo. |
2020-07-23 21:07:10 +00:00
| `symbol` | `"🐘 "` | The symbol used before displaying the version of PHP. |
| `style` | `"147 bold"` | El estilo del módulo. |
| `disabled` | `false` | Disables the `php` module. |
### Variables
2020-09-30 20:26:13 +00:00
| Variable | Ejemplo | Descripción |
| --------- | -------- | -------------------------------------- |
| version | `v7.3.8` | The version of `php` |
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
2020-07-23 21:07:10 +00:00
2020-09-30 20:26:13 +00:00
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
2020-01-15 17:23:25 +00:00
2020-05-05 17:07:34 +00:00
### Ejemplo
2020-01-15 17:23:25 +00:00
```toml
# ~/.config/starship.toml
[php]
2020-07-23 21:07:10 +00:00
format = "via [🔹 $version ](147 bold ) "
2020-01-15 17:23:25 +00:00
```
## Python
2020-05-15 15:55:21 +00:00
The `python` module shows the currently installed version of Python and the current Python virtual environment if one is activated.
2020-01-15 17:23:25 +00:00
2020-05-15 15:55:21 +00:00
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` .
2020-01-15 17:23:25 +00:00
2020-05-05 17:07:34 +00:00
El módulo se muestra si algunas de las siguientes condiciones se cumplen:
2020-01-15 17:23:25 +00:00
- The current directory contains a `.python-version` file
2020-09-30 20:26:13 +00:00
- The current directory contains a `requirements.txt` file
- The current directory contains a `pyproject.toml` file
2020-05-05 17:07:34 +00:00
- The current directory contains a file with the `.py` extension (and `scan_for_pyfiles` is true)
2020-01-15 17:23:25 +00:00
- The current directory contains a `Pipfile` file
2020-09-30 20:26:13 +00:00
- The current directory contains a `tox.ini` file
- The current directory contains a `setup.py` file
2020-05-05 17:07:34 +00:00
- The current directory contains a `__init__.py` file
2020-01-15 17:23:25 +00:00
- A virtual environment is currently activated
2020-05-05 17:07:34 +00:00
### Opciones
2020-01-15 17:23:25 +00:00
2020-09-30 20:26:13 +00:00
| Opción | Por defecto | Descripción |
| -------------------- | ----------------------------------------------------------------------------- | -------------------------------------------------------------------------- |
| `format` | `"via [${symbol}${pyenv_prefix}${version}( \\($virtualenv\\))]($style) "` | El formato del módulo. |
| `symbol` | `"🐍 "` | A format string representing the symbol of Python |
| `style` | `"yellow bold"` | El estilo del módulo. |
| `pyenv_version_name` | `false` | Use pyenv to get Python version |
| `pyenv_prefix` | `pyenv` | Prefix before pyenv version display, only used if pyenv is used |
| `scan_for_pyfiles` | `true` | If false, Python files in the current directory will not show this module. |
| `disabled` | `false` | Disables the `python` module. |
2020-07-23 21:07:10 +00:00
### Variables
2020-09-30 20:26:13 +00:00
| Variable | Ejemplo | Descripción |
| ------------ | --------------- | ------------------------------------------ |
| version | `"v3.8.1"` | The version of `python` |
| symbol | `"🐍 "` | Refleja el valor de la opción `symbol` |
| style | `"yellow bold"` | Refleja el valor de la opción `style` |
| pyenv_prefix | `"pyenv "` | Mirrors the value of option `pyenv_prefix` |
| virtualenv | `"venv"` | The current `virtualenv` name |
2020-01-15 17:23:25 +00:00
2020-06-19 21:05:45 +00:00
< details >
< summary > This module has some advanced configuration options.< / summary >
| Variable | Por defecto | Descripción |
| --------------- | ----------- | ----------------------------------------------------------------------------- |
| `python_binary` | `python` | Configures the python binary that Starship executes when getting the version. |
The `python_binary` variable changes the binary that Starship executes to get the version of Python, it doesn't change the arguments that are used.
```toml
# ~/.config/starship.toml
[python]
python_binary = "python3"
```
< / details >
2020-05-05 17:07:34 +00:00
### Ejemplo
2020-01-15 17:23:25 +00:00
```toml
# ~/.config/starship.toml
[python]
symbol = "👾 "
pyenv_version_name = true
```
## Ruby
2020-05-05 17:07:34 +00:00
The `ruby` module shows the currently installed version of Ruby. El módulo se muestra si algunas de las siguientes condiciones se cumplen:
2020-01-15 17:23:25 +00:00
- The current directory contains a `Gemfile` file
2020-04-06 18:48:26 +00:00
- The current directory contains a `.ruby-version` file
2020-01-15 17:23:25 +00:00
- The current directory contains a `.rb` file
2020-05-05 17:07:34 +00:00
### Opciones
2020-01-15 17:23:25 +00:00
2020-09-30 20:26:13 +00:00
| Opción | Por defecto | Descripción |
2020-07-23 21:07:10 +00:00
| ---------- | ---------------------------------- | ------------------------------------------------ |
2020-09-30 20:26:13 +00:00
| `format` | `"via [$symbol$version]($style) "` | El formato del módulo. |
2020-07-23 21:07:10 +00:00
| `symbol` | `"💎 "` | A format string representing the symbol of Ruby. |
| `style` | `"bold red"` | El estilo del módulo. |
| `disabled` | `false` | Disables the `ruby` module. |
### Variables
2020-09-30 20:26:13 +00:00
| Variable | Ejemplo | Descripción |
| --------- | -------- | -------------------------------------- |
| version | `v2.5.1` | The version of `ruby` |
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
2020-07-23 21:07:10 +00:00
2020-09-30 20:26:13 +00:00
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
2020-01-15 17:23:25 +00:00
2020-05-05 17:07:34 +00:00
### Ejemplo
2020-01-15 17:23:25 +00:00
```toml
# ~/.config/starship.toml
[ruby]
symbol = "🔺 "
```
## Rust
2020-05-05 17:07:34 +00:00
The `rust` module shows the currently installed version of Rust. El módulo se muestra si algunas de las siguientes condiciones se cumplen:
2020-01-15 17:23:25 +00:00
- The current directory contains a `Cargo.toml` file
- The current directory contains a file with the `.rs` extension
2020-05-05 17:07:34 +00:00
### Opciones
2020-01-15 17:23:25 +00:00
2020-09-30 20:26:13 +00:00
| Opción | Por defecto | Descripción |
2020-07-23 21:07:10 +00:00
| ---------- | ---------------------------------- | ----------------------------------------------- |
2020-09-30 20:26:13 +00:00
| `format` | `"via [$symbol$version]($style) "` | El formato del módulo. |
2020-07-23 21:07:10 +00:00
| `symbol` | `"🦀 "` | A format string representing the symbol of Rust |
| `style` | `"bold red"` | El estilo del módulo. |
| `disabled` | `false` | Disables the `rust` module. |
### Variables
2020-09-30 20:26:13 +00:00
| Variable | Ejemplo | Descripción |
| --------- | ----------------- | -------------------------------------- |
| version | `v1.43.0-nightly` | The version of `rustc` |
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
2020-07-23 21:07:10 +00:00
2020-09-30 20:26:13 +00:00
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
2020-01-15 17:23:25 +00:00
2020-05-05 17:07:34 +00:00
### Ejemplo
2020-01-15 17:23:25 +00:00
```toml
# ~/.config/starship.toml
[rust]
2020-07-23 21:07:10 +00:00
format = "via [⚙️ $version ](red bold )"
2020-01-15 17:23:25 +00:00
```
2020-09-30 20:26:13 +00:00
## SHLVL
The `shlvl` module shows the current SHLVL ("shell level") environment variable, if it is set to a number and meets or exceeds the specified threshold.
### Opciones
| Variable | Por defecto | Descripción |
| ----------- | ---------------------------- | --------------------------------------- |
| `threshold` | `2` | Display threshold. |
| `format` | `"[$symbol$shlvl]($style) "` | El formato del módulo. |
| `symbol` | `"↕️ "` | The symbol used to represent the SHLVL. |
| `style` | `"bold yellow"` | El estilo del módulo. |
| `disabled` | `true` | Disables the `shlvl` module. |
### Variables
| Variable | Ejemplo | Descripción |
| --------- | ------- | -------------------------------------- |
| shlvl | `3` | The current value of SHLVL |
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
### Ejemplo
```toml
# ~/.config/starship.toml
[shlvl]
disabled = false
format = "$shlvl level(s) down"
threshold = 3
```
2020-04-03 16:35:39 +00:00
## Singularity
The `singularity` module shows the current singularity image, if inside a container and `$SINGULARITY_NAME` is set.
2020-05-05 17:07:34 +00:00
### Opciones
2020-04-03 16:35:39 +00:00
2020-09-30 20:26:13 +00:00
| Opción | Por defecto | Descripción |
2020-07-23 21:07:10 +00:00
| ---------- | ------------------------------------ | ------------------------------------------------ |
2020-09-30 20:26:13 +00:00
| `format` | `"[$symbol\\[$env\\]]($style) "` | El formato del módulo. |
2020-07-23 21:07:10 +00:00
| `symbol` | `""` | A format string displayed before the image name. |
| `style` | `"bold dimmed blue"` | El estilo del módulo. |
| `disabled` | `false` | Disables the `singularity` module. |
### Variables
2020-09-30 20:26:13 +00:00
| Variable | Ejemplo | Descripción |
| --------- | ------------ | -------------------------------------- |
| env | `centos.img` | The current singularity image |
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
2020-07-23 21:07:10 +00:00
2020-09-30 20:26:13 +00:00
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
2020-04-03 16:35:39 +00:00
2020-05-05 17:07:34 +00:00
### Ejemplo
2020-04-03 16:35:39 +00:00
```toml
# ~/.config/starship.toml
[singularity]
2020-07-23 21:07:10 +00:00
format = "[📦 \\[$env\\]]($style) "
2020-04-03 16:35:39 +00:00
```
2020-09-30 20:26:13 +00:00
## Swift
The `swift` module shows the currently installed version of Swift. El módulo se muestra si algunas de las siguientes condiciones se cumplen:
- The current directory contains a `Package.swift` file
- The current directory contains a file with the `.swift` extension
### Opciones
| Opción | Por defecto | Descripción |
| ---------- | ---------------------------------- | ------------------------------------------------ |
| `format` | `"via [$symbol$version]($style) "` | El formato del módulo. |
| `symbol` | `"🐦 "` | A format string representing the symbol of Swift |
| `style` | `"bold 202"` | El estilo del módulo. |
| `disabled` | `false` | Disables the `swift` module. |
### Variables
| Variable | Ejemplo | Descripción |
| --------- | -------- | -------------------------------------- |
| version | `v5.2.4` | The version of `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 )"
```
## 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. :::
### Opciones
| Variable | Por defecto | Descripción |
| ---------- | -------------------------- | ------------------------------------------------------ |
| `format` | `[$symbol$status]($style)` | The format of the module |
| `symbol` | `"✖"` | A format string representing the symbol for the status |
| `style` | `"bold red"` | El estilo del módulo. |
| `disabled` | `true` | Disables the `status` module. |
### Variables
| Variable | Ejemplo | Descripción |
| --------- | ------- | -------------------------------------- |
| status | `127` | The exit code of the last command |
| 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$status\\]]($style) "
disabled = false
```
2020-01-15 17:23:25 +00:00
## Terraform
2020-07-23 21:07:10 +00:00
The `terraform` module shows the currently selected terraform workspace and version. By default the terraform version is not shown, since this is slow on current versions of terraform when a lot of plugins are in use. If you still want to enable it, [follow the example shown below ](#with-version ). El módulo se muestra si algunas de las siguientes condiciones se cumplen:
2020-01-15 17:23:25 +00:00
- The current directory contains a `.terraform` folder
- Current directory contains a file with the `.tf` extension
2020-05-05 17:07:34 +00:00
### Opciones
2020-01-15 17:23:25 +00:00
2020-09-30 20:26:13 +00:00
| Opción | Por defecto | Descripción |
2020-07-23 21:07:10 +00:00
| ---------- | ------------------------------------ | ----------------------------------------------------- |
| `format` | `"via [$symbol$workspace]($style) "` | The format string for the module. |
| `symbol` | `"💠 "` | A format string shown before the terraform workspace. |
| `style` | `"bold 105"` | El estilo del módulo. |
| `disabled` | `false` | Disables the `terraform` module. |
### Variables
2020-09-30 20:26:13 +00:00
| Variable | Ejemplo | Descripción |
| --------- | ---------- | -------------------------------------- |
| version | `v0.12.24` | The version of `terraform` |
| workspace | `default` | The current terraform workspace |
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
2020-07-23 21:07:10 +00:00
2020-09-30 20:26:13 +00:00
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
2020-01-15 17:23:25 +00:00
2020-05-05 17:07:34 +00:00
### Ejemplo
2020-01-15 17:23:25 +00:00
2020-07-23 21:07:10 +00:00
#### With Version
2020-01-15 17:23:25 +00:00
```toml
# ~/.config/starship.toml
[terraform]
2020-07-23 21:07:10 +00:00
format = "[🏎💨 $version$workspace]($style) "
```
#### Without version
```toml
# ~/.config/starship.toml
[terraform]
format = "[🏎💨 $workspace]($style) "
2020-01-15 17:23:25 +00:00
```
2020-09-30 20:26:13 +00:00
## Time
2020-01-15 17:23:25 +00:00
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.
:::
2020-05-05 17:07:34 +00:00
### Opciones
2020-01-15 17:23:25 +00:00
2020-09-30 20:26:13 +00:00
| Opción | Por defecto | Descripción |
2020-07-23 21:07:10 +00:00
| ----------------- | ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
| `format` | `"at [$time]($style) "` | The format string for the module. |
2020-09-30 20:26:13 +00:00
| `use_12hr` | `false` | Enables 12 hour formatting |
2020-07-23 21:07:10 +00:00
| `time_format` | see below | The [chrono format string ](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html ) used to format the time. |
2020-09-30 20:26:13 +00:00
| `style` | `"bold yellow"` | The style for the module time |
2020-07-23 21:07:10 +00:00
| `utc_time_offset` | `"local"` | Sets the UTC offset to use. Range from -24 < x < 24. Allows floats to accommodate 30/45 minute timezone offsets. |
| `disabled` | `true` | Disables the `time` module. |
2020-09-30 20:26:13 +00:00
| `time_range` | `"-"` | Sets the time range during which the module will be shown. Times must be specified in 24-hours format |
2020-07-23 21:07:10 +00:00
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
2020-09-30 20:26:13 +00:00
| Variable | Ejemplo | Descripción |
| --------- | ---------- | ------------------------------------- |
| time | `13:08:10` | The current time. |
| style\* | | Refleja el valor de la opción `style` |
2020-01-15 17:23:25 +00:00
2020-09-30 20:26:13 +00:00
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
2020-01-15 17:23:25 +00:00
2020-05-05 17:07:34 +00:00
### Ejemplo
2020-01-15 17:23:25 +00:00
```toml
# ~/.config/starship.toml
[time]
disabled = false
2020-07-23 21:07:10 +00:00
format = "🕙[\\[ $time \\]]($style) "
time_format = "%T"
2020-04-03 16:35:39 +00:00
utc_time_offset = "-5"
docs(i18n): new Crowdin translations (#1262)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (German)
* New translations README.md (French)
* New translations README.md (Japanese)
* New translations README.md (Spanish)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Portuguese)
* New translations README.md (Chinese Traditional)
* New translations README.md (Chinese Simplified)
* New translations README.md (Russian)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (Chinese Simplified)
* New translations README.md (Chinese Traditional)
* New translations README.md (Portuguese)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (French)
* New translations README.md (Spanish)
* New translations README.md (German)
* New translations README.md (Russian)
* New translations README.md (Japanese)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Chinese Simplified)
* New translations README.md (Chinese Traditional)
* New translations README.md (Portuguese)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (French)
* New translations README.md (Spanish)
* New translations README.md (German)
* New translations README.md (Russian)
* New translations README.md (Japanese)
* New translations README.md (French)
* New translations README.md (Japanese)
* New translations README.md (German)
* New translations README.md (Spanish)
* New translations README.md (Chinese Traditional)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Portuguese)
* New translations README.md (Chinese Simplified)
* New translations README.md (Russian)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Chinese Traditional)
* New translations README.md (Chinese Traditional)
* New translations README.md (Portuguese)
* New translations README.md (Portuguese)
* New translations README.md (Chinese Simplified)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (French)
* New translations README.md (French)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (German)
* New translations README.md (German)
* New translations README.md (Chinese Simplified)
* New translations README.md (Japanese)
* New translations README.md (Japanese)
* New translations README.md (Russian)
* New translations README.md (Russian)
* New translations README.md (Japanese)
* New translations README.md (Japanese)
* New translations README.md (Japanese)
* New translations README.md (Japanese)
2020-06-11 01:28:04 +00:00
time_range = "10:00:00-14:00:00"
2020-01-15 17:23:25 +00:00
```
2020-09-30 20:26:13 +00:00
## Username
2020-01-15 17:23:25 +00:00
2020-05-05 17:07:34 +00:00
The `username` module shows active user's username. El módulo se muestra si algunas de las siguientes condiciones se cumplen:
2020-01-15 17:23:25 +00:00
- The current user is root
- The current user isn't the same as the one that is logged in
- The user is currently connected as an SSH session
- The variable `show_always` is set to true
2020-05-05 17:07:34 +00:00
### Opciones
2020-01-15 17:23:25 +00:00
2020-09-30 20:26:13 +00:00
| Opción | Por defecto | Descripción |
| ------------- | ----------------------- | ------------------------------------- |
| `style_root` | `"bold red"` | The style used when the user is root. |
| `style_user` | `"bold yellow"` | The style used for non-root users. |
| `format` | `"[$user]($style) in "` | El formato del módulo. |
| `show_always` | `false` | Always shows the `username` module. |
| `disabled` | `false` | Disables the `username` module. |
2020-07-23 21:07:10 +00:00
### Variables
| Variable | Ejemplo | Descripción |
| -------- | ------------ | ------------------------------------------------------------------------------------------- |
| `style` | `"red bold"` | Mirrors the value of option `style_root` when root is logged in and `style_user` otherwise. |
| `user` | `"matchai"` | The currently logged-in user ID. |
2020-01-15 17:23:25 +00:00
2020-05-05 17:07:34 +00:00
### Ejemplo
2020-01-15 17:23:25 +00:00
```toml
# ~/.config/starship.toml
[username]
2020-07-23 21:07:10 +00:00
style_user = "white bold"
style_root = "black bold"
format = "user: [$user ]($style ) "
disabled = false
show_always = true
2020-01-15 17:23:25 +00:00
```
2020-05-05 17:07:34 +00:00
2020-05-23 23:10:58 +00:00
## Zig
The `zig` module shows the currently installed version of Zig. El módulo se muestra si algunas de las siguientes condiciones se cumplen:
- The current directory contains a `.zig` file
### Opciones
2020-09-30 20:26:13 +00:00
| Opción | Por defecto | Descripción |
2020-07-23 21:07:10 +00:00
| ---------- | ---------------------------------- | ----------------------------------------------------- |
| `symbol` | `"↯ "` | The symbol used before displaying the version of Zig. |
| `style` | `"bold yellow"` | El estilo del módulo. |
2020-09-30 20:26:13 +00:00
| `format` | `"via [$symbol$version]($style) "` | El formato del módulo. |
2020-07-23 21:07:10 +00:00
| `disabled` | `false` | Disables the `zig` module. |
### Variables
2020-09-30 20:26:13 +00:00
| Variable | Ejemplo | Descripción |
| --------- | -------- | -------------------------------------- |
| version | `v0.6.0` | The version of `zig` |
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
2020-07-23 21:07:10 +00:00
2020-09-30 20:26:13 +00:00
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
2020-05-23 23:10:58 +00:00
### Ejemplo
```toml
# ~/.config/starship.toml
[zig]
symbol = "⚡️ "
```
2020-09-30 20:26:13 +00:00
## Custom commands
2020-05-05 17:07:34 +00:00
The `custom` modules show the output of some arbitrary commands.
These modules will be shown if any of the following conditions are met:
2020-07-23 21:07:10 +00:00
2020-05-05 17:07:34 +00:00
- The current directory contains a file whose name is in `files`
- The current directory contains a directory whose name is in `directories`
- The current directory contains a file whose extension is in `extensions`
- The `when` command returns 0
::: tip
Multiple custom modules can be defined by using a `.` .
:::
::: tip
2020-09-30 20:26:13 +00:00
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!
2020-05-05 17:07:34 +00:00
:::
### Opciones
2020-09-30 20:26:13 +00:00
| Opción | Por defecto | Descripción |
2020-07-23 21:07:10 +00:00
| ------------- | ----------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
2020-09-30 20:26:13 +00:00
| `command` | | The command whose output should be printed. The command will be passed on stdin to the shell. |
2020-07-23 21:07:10 +00:00
| `when` | | A shell command used as a condition to show the module. The module will be shown if the command returns a `0` status code. |
| `shell` | | [See below ](#custom-command-shell ) |
2020-09-30 20:26:13 +00:00
| `description` | `"<custom module>"` | The description of the module that is shown when running `starship explain` . |
2020-07-23 21:07:10 +00:00
| `files` | `[]` | The files that will be searched in the working directory for a match. |
| `directories` | `[]` | The directories that will be searched in the working directory for a match. |
| `extensions` | `[]` | The extensions that will be searched in the working directory for a match. |
| `symbol` | `""` | The symbol used before displaying the command output. |
| `style` | `"bold green"` | El estilo del módulo. |
2020-09-30 20:26:13 +00:00
| `format` | `"[$symbol$output]($style) "` | El formato del módulo. |
2020-07-23 21:07:10 +00:00
| `disabled` | `false` | Disables this `custom` module. |
### Variables
| Variable | Descripción |
| --------- | -------------------------------------- |
| output | The output of shell command in `shell` |
2020-09-30 20:26:13 +00:00
| symbol | Refleja el valor de la opción `symbol` |
| style\* | Refleja el valor de la opción `style` |
2020-07-23 21:07:10 +00:00
2020-09-30 20:26:13 +00:00
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
2020-05-05 17:07:34 +00:00
2020-09-30 20:26:13 +00:00
#### Comando personalizado de shell
docs(i18n): new Crowdin translations (#1262)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (German)
* New translations README.md (French)
* New translations README.md (Japanese)
* New translations README.md (Spanish)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Portuguese)
* New translations README.md (Chinese Traditional)
* New translations README.md (Chinese Simplified)
* New translations README.md (Russian)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (Chinese Simplified)
* New translations README.md (Chinese Traditional)
* New translations README.md (Portuguese)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (French)
* New translations README.md (Spanish)
* New translations README.md (German)
* New translations README.md (Russian)
* New translations README.md (Japanese)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Chinese Simplified)
* New translations README.md (Chinese Traditional)
* New translations README.md (Portuguese)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (French)
* New translations README.md (Spanish)
* New translations README.md (German)
* New translations README.md (Russian)
* New translations README.md (Japanese)
* New translations README.md (French)
* New translations README.md (Japanese)
* New translations README.md (German)
* New translations README.md (Spanish)
* New translations README.md (Chinese Traditional)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Portuguese)
* New translations README.md (Chinese Simplified)
* New translations README.md (Russian)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Chinese Traditional)
* New translations README.md (Chinese Traditional)
* New translations README.md (Portuguese)
* New translations README.md (Portuguese)
* New translations README.md (Chinese Simplified)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (French)
* New translations README.md (French)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (German)
* New translations README.md (German)
* New translations README.md (Chinese Simplified)
* New translations README.md (Japanese)
* New translations README.md (Japanese)
* New translations README.md (Russian)
* New translations README.md (Russian)
* New translations README.md (Japanese)
* New translations README.md (Japanese)
* New translations README.md (Japanese)
* New translations README.md (Japanese)
2020-06-11 01:28:04 +00:00
`shell` accepts a non-empty list of strings, where:
2020-07-23 21:07:10 +00:00
2020-09-30 20:26:13 +00:00
- La primera cadena es la ruta al intérprete de comandos a usar para ejecutar el comando.
- Otros argumentos siguientes son pasados al shell.
docs(i18n): new Crowdin translations (#1262)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (German)
* New translations README.md (French)
* New translations README.md (Japanese)
* New translations README.md (Spanish)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Portuguese)
* New translations README.md (Chinese Traditional)
* New translations README.md (Chinese Simplified)
* New translations README.md (Russian)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (Chinese Simplified)
* New translations README.md (Chinese Traditional)
* New translations README.md (Portuguese)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (French)
* New translations README.md (Spanish)
* New translations README.md (German)
* New translations README.md (Russian)
* New translations README.md (Japanese)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Chinese Simplified)
* New translations README.md (Chinese Traditional)
* New translations README.md (Portuguese)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (French)
* New translations README.md (Spanish)
* New translations README.md (German)
* New translations README.md (Russian)
* New translations README.md (Japanese)
* New translations README.md (French)
* New translations README.md (Japanese)
* New translations README.md (German)
* New translations README.md (Spanish)
* New translations README.md (Chinese Traditional)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Portuguese)
* New translations README.md (Chinese Simplified)
* New translations README.md (Russian)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Chinese Traditional)
* New translations README.md (Chinese Traditional)
* New translations README.md (Portuguese)
* New translations README.md (Portuguese)
* New translations README.md (Chinese Simplified)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (French)
* New translations README.md (French)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (German)
* New translations README.md (German)
* New translations README.md (Chinese Simplified)
* New translations README.md (Japanese)
* New translations README.md (Japanese)
* New translations README.md (Russian)
* New translations README.md (Russian)
* New translations README.md (Japanese)
* New translations README.md (Japanese)
* New translations README.md (Japanese)
* New translations README.md (Japanese)
2020-06-11 01:28:04 +00:00
If unset, it will fallback to STARSHIP_SHELL and then to "sh" on Linux, and "cmd /C" on Windows.
2020-09-30 20:26:13 +00:00
The `command` will be passed in on stdin.
docs(i18n): new Crowdin translations (#1262)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (German)
* New translations README.md (French)
* New translations README.md (Japanese)
* New translations README.md (Spanish)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Portuguese)
* New translations README.md (Chinese Traditional)
* New translations README.md (Chinese Simplified)
* New translations README.md (Russian)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (Chinese Simplified)
* New translations README.md (Chinese Traditional)
* New translations README.md (Portuguese)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (French)
* New translations README.md (Spanish)
* New translations README.md (German)
* New translations README.md (Russian)
* New translations README.md (Japanese)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Chinese Simplified)
* New translations README.md (Chinese Traditional)
* New translations README.md (Portuguese)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (French)
* New translations README.md (Spanish)
* New translations README.md (German)
* New translations README.md (Russian)
* New translations README.md (Japanese)
* New translations README.md (French)
* New translations README.md (Japanese)
* New translations README.md (German)
* New translations README.md (Spanish)
* New translations README.md (Chinese Traditional)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Portuguese)
* New translations README.md (Chinese Simplified)
* New translations README.md (Russian)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Chinese Traditional)
* New translations README.md (Chinese Traditional)
* New translations README.md (Portuguese)
* New translations README.md (Portuguese)
* New translations README.md (Chinese Simplified)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (French)
* New translations README.md (French)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (German)
* New translations README.md (German)
* New translations README.md (Chinese Simplified)
* New translations README.md (Japanese)
* New translations README.md (Japanese)
* New translations README.md (Russian)
* New translations README.md (Russian)
* New translations README.md (Japanese)
* New translations README.md (Japanese)
* New translations README.md (Japanese)
* New translations README.md (Japanese)
2020-06-11 01:28:04 +00:00
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.
:::
2020-05-05 17:07:34 +00:00
### Ejemplo
```toml
# ~/.config/starship.toml
[custom.foo]
command = "echo foo" # shows output of command
files = ["foo"] # can specify filters
when = """ test "$HOME" == "$PWD" """
2020-09-30 20:26:13 +00:00
format = " transcending [$output ]($style )"
docs(i18n): new Crowdin translations (#1262)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (German)
* New translations README.md (French)
* New translations README.md (Japanese)
* New translations README.md (Spanish)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Portuguese)
* New translations README.md (Chinese Traditional)
* New translations README.md (Chinese Simplified)
* New translations README.md (Russian)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (Chinese Simplified)
* New translations README.md (Chinese Traditional)
* New translations README.md (Portuguese)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (French)
* New translations README.md (Spanish)
* New translations README.md (German)
* New translations README.md (Russian)
* New translations README.md (Japanese)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Chinese Simplified)
* New translations README.md (Chinese Traditional)
* New translations README.md (Portuguese)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (French)
* New translations README.md (Spanish)
* New translations README.md (German)
* New translations README.md (Russian)
* New translations README.md (Japanese)
* New translations README.md (French)
* New translations README.md (Japanese)
* New translations README.md (German)
* New translations README.md (Spanish)
* New translations README.md (Chinese Traditional)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Portuguese)
* New translations README.md (Chinese Simplified)
* New translations README.md (Russian)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Chinese Traditional)
* New translations README.md (Chinese Traditional)
* New translations README.md (Portuguese)
* New translations README.md (Portuguese)
* New translations README.md (Chinese Simplified)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (French)
* New translations README.md (French)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (German)
* New translations README.md (German)
* New translations README.md (Chinese Simplified)
* New translations README.md (Japanese)
* New translations README.md (Japanese)
* New translations README.md (Russian)
* New translations README.md (Russian)
* New translations README.md (Japanese)
* New translations README.md (Japanese)
* New translations README.md (Japanese)
* New translations README.md (Japanese)
2020-06-11 01:28:04 +00:00
[custom.time]
command = "time /T"
files = ["*.pst"]
shell = ["pwsh.exe", "-NoProfile", "-Command", "-"]
2020-05-05 17:07:34 +00:00
```
2020-05-23 23:10:58 +00:00
## PureScript
The `purescript` module shows the currently installed version of PureScript version. El módulo se muestra si algunas de las siguientes condiciones se cumplen:
2020-09-30 20:26:13 +00:00
- El directorio actual contiene un archivo `spago.dhall`
- El directorio actual contiene un archivo \*.purs
2020-05-23 23:10:58 +00:00
### Opciones
2020-09-30 20:26:13 +00:00
| Opción | Por defecto | Descripción |
2020-07-23 21:07:10 +00:00
| ---------- | ---------------------------------- | ------------------------------------------------------------ |
2020-09-30 20:26:13 +00:00
| `format` | `"via [$symbol$version]($style) "` | El formato del módulo. |
2020-07-23 21:07:10 +00:00
| `symbol` | `"<=> "` | The symbol used before displaying the version of PureScript. |
| `style` | `"bold white"` | El estilo del módulo. |
| `disabled` | `false` | Disables the `purescript` module. |
### Variables
2020-09-30 20:26:13 +00:00
| Variable | Ejemplo | Descripción |
| --------- | -------- | -------------------------------------- |
| version | `0.13.5` | The version of `purescript` |
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
2020-07-23 21:07:10 +00:00
2020-09-30 20:26:13 +00:00
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
2020-05-23 23:10:58 +00:00
### Ejemplo
```toml
# ~/.config/starship.toml
[purescript]
2020-07-23 21:07:10 +00:00
format = "via [$symbol$version ](bold white )"
2020-05-23 23:10:58 +00:00
```