* New translations README.md (Portuguese) * New translations README.md (Spanish) * New translations README.md (Polish) * New translations README.md (Dutch) * New translations README.md (Korean) * New translations README.md (Japanese) * New translations README.md (Italian) * New translations README.md (German) * New translations README.md (Arabic) * New translations README.md (Sorani (Kurdish)) * New translations README.md (French) * New translations README.md (Russian) * New translations README.md (Indonesian) * New translations README.md (Portuguese, Brazilian) * New translations README.md (Vietnamese) * New translations README.md (Chinese Traditional) * New translations README.md (Chinese Simplified) * New translations README.md (Turkish) * New translations README.md (Portuguese) * New translations README.md (Spanish) * New translations README.md (Polish) * New translations README.md (Dutch) * New translations README.md (Korean) * New translations README.md (Japanese) * New translations README.md (Italian) * New translations README.md (German) * New translations README.md (Arabic) * New translations README.md (Sorani (Kurdish)) * New translations README.md (French) * New translations README.md (French) * New translations README.md (French) * New translations README.md (Portuguese, Brazilian) * New translations README.md (Portuguese, Brazilian) * New translations README.md (Portuguese, Brazilian) * New translations README.md (Portuguese, Brazilian) * New translations README.md (Portuguese, Brazilian) * New translations README.md (Portuguese, Brazilian) * New translations README.md (Portuguese, Brazilian) * New translations README.md (Portuguese, Brazilian) * New translations README.md (Portuguese, Brazilian) * New translations README.md (Portuguese, Brazilian) * New translations README.md (Portuguese, Brazilian) * New translations README.md (Portuguese, Brazilian) * New translations README.md (Portuguese, Brazilian) * New translations README.md (Portuguese, Brazilian) * New translations README.md (Portuguese, Brazilian) * New translations README.md (Portuguese, Brazilian) * New translations README.md (Portuguese, Brazilian) * New translations README.md (Portuguese, Brazilian) * New translations README.md (Portuguese, Brazilian) * New translations README.md (Portuguese, Brazilian) * New translations README.md (Portuguese, Brazilian) * New translations README.md (Portuguese, Brazilian) * New translations README.md (French) * New translations README.md (Russian) * New translations README.md (Indonesian) * New translations README.md (Portuguese, Brazilian) * New translations README.md (Vietnamese) * New translations README.md (Chinese Traditional) * New translations README.md (Chinese Simplified) * New translations README.md (Turkish) * New translations README.md (Portuguese) * New translations README.md (Spanish) * New translations README.md (Polish) * New translations README.md (Dutch) * New translations README.md (Korean) * New translations README.md (Japanese) * New translations README.md (Italian) * New translations README.md (German) * New translations README.md (Arabic) * New translations README.md (Sorani (Kurdish)) * New translations README.md (Portuguese, Brazilian) * New translations README.md (Portuguese, Brazilian) * New translations README.md (Portuguese, Brazilian) * New translations README.md (Portuguese, Brazilian) * New translations README.md (Portuguese, Brazilian) * New translations README.md (French) * New translations README.md (French) * New translations README.md (Portuguese, Brazilian) * New translations README.md (French) * New translations README.md (Portuguese, Brazilian) * New translations README.md (French) * New translations README.md (Portuguese, Brazilian) * New translations README.md (French) * New translations README.md (Portuguese, Brazilian) * New translations README.md (Portuguese, Brazilian) * New translations README.md (Portuguese, Brazilian) * New translations README.md (Portuguese, Brazilian) * New translations README.md (Portuguese, Brazilian) * New translations README.md (Portuguese, Brazilian) * New translations README.md (Portuguese, Brazilian) * New translations README.md (French) * New translations README.md (Russian) * New translations README.md (Indonesian) * New translations README.md (Portuguese, Brazilian) * New translations README.md (Vietnamese) * New translations README.md (Chinese Traditional) * New translations README.md (Chinese Simplified) * New translations README.md (Turkish) * New translations README.md (Portuguese) * New translations README.md (Spanish) * New translations README.md (Polish) * New translations README.md (Dutch) * New translations README.md (Korean) * New translations README.md (Japanese) * New translations README.md (Italian) * New translations README.md (German) * New translations README.md (Arabic) * New translations README.md (Sorani (Kurdish)) * New translations README.md (Portuguese, Brazilian) * New translations README.md (French) * New translations README.md (Russian) * New translations README.md (Indonesian) * New translations README.md (Portuguese, Brazilian) * New translations README.md (Vietnamese) * New translations README.md (Chinese Traditional) * New translations README.md (Chinese Simplified) * New translations README.md (Turkish) * New translations README.md (Portuguese) * New translations README.md (Spanish) * New translations README.md (Polish) * New translations README.md (Dutch) * New translations README.md (Korean) * New translations README.md (Japanese) * New translations README.md (Italian) * New translations README.md (German) * New translations README.md (Arabic) * New translations README.md (Sorani (Kurdish)) * New translations README.md (French) * New translations README.md (Korean) * New translations README.md (German) * New translations README.md (Italian) * New translations README.md (Italian) * New translations README.md (Japanese) * New translations README.md (Japanese) * New translations README.md (Korean) * New translations README.md (Dutch) * New translations README.md (Dutch) * New translations README.md (Polish) * New translations README.md (Polish) * New translations README.md (Portuguese) * New translations README.md (Portuguese) * New translations README.md (Russian) * New translations README.md (German) * New translations README.md (Arabic) * New translations README.md (Spanish) * New translations README.md (Chinese Simplified) * New translations README.md (Arabic) * New translations README.md (German) * New translations README.md (Italian) * New translations README.md (Japanese) * New translations README.md (Korean) * New translations README.md (Dutch) * New translations README.md (Polish) * New translations README.md (Portuguese) * New translations README.md (Russian) * New translations README.md (Turkish) * New translations README.md (Chinese Traditional) * New translations README.md (Arabic) * New translations README.md (Vietnamese) * New translations README.md (Portuguese, Brazilian) * New translations README.md (Indonesian) * New translations README.md (Sorani (Kurdish)) * New translations README.md (French) * New translations README.md (French) * New translations README.md (Spanish) * New translations README.md (Spanish) * New translations README.md (Russian) * New translations README.md (French) * New translations README.md (Dutch) * New translations README.md (Spanish) * New translations README.md (Arabic) * New translations README.md (German) * New translations README.md (Italian) * New translations README.md (Japanese) * New translations README.md (Korean) * New translations README.md (Polish) * New translations README.md (Portuguese) * New translations README.md (Russian) * New translations README.md (Turkish) * New translations README.md (Chinese Traditional) * New translations README.md (Vietnamese) * New translations README.md (Portuguese, Brazilian) * New translations README.md (Indonesian) * New translations README.md (Chinese Simplified) * New translations README.md (Sorani (Kurdish)) * New translations README.md (Turkish) * New translations README.md (Turkish) * New translations README.md (Chinese Simplified) * New translations README.md (Chinese Simplified) * New translations README.md (Chinese Traditional) * New translations README.md (Chinese Traditional) * New translations README.md (Vietnamese) * New translations README.md (Sorani (Kurdish)) * New translations README.md (Vietnamese) * New translations README.md (Portuguese, Brazilian) * New translations README.md (Portuguese, Brazilian) * New translations README.md (Indonesian) * New translations README.md (Indonesian) * New translations README.md (Sorani (Kurdish)) * New translations README.md (Spanish) * New translations README.md (Spanish) * New translations README.md (Spanish) * New translations README.md (Russian) * New translations README.md (Russian) * New translations README.md (French) * New translations README.md (Russian) * New translations README.md (Indonesian) * New translations README.md (Portuguese, Brazilian) * New translations README.md (Vietnamese) * New translations README.md (Chinese Traditional) * New translations README.md (Chinese Simplified) * New translations README.md (Turkish) * New translations README.md (Portuguese) * New translations README.md (Spanish) * New translations README.md (Polish) * New translations README.md (Dutch) * New translations README.md (Korean) * New translations README.md (Japanese) * New translations README.md (Italian) * New translations README.md (German) * New translations README.md (Arabic) * New translations README.md (Sorani (Kurdish)) * New translations README.md (Chinese Simplified) * New translations README.md (Chinese Simplified) * New translations README.md (Chinese Simplified) * New translations README.md (Chinese Simplified) * New translations README.md (Chinese Simplified) * New translations README.md (Chinese Simplified) * New translations README.md (Chinese Simplified) * New translations README.md (Chinese Simplified) * New translations README.md (Chinese Simplified) * New translations README.md (French) * New translations README.md (Russian) * New translations README.md (Indonesian) * New translations README.md (Portuguese, Brazilian) * New translations README.md (Vietnamese) * New translations README.md (Chinese Traditional) * New translations README.md (Chinese Simplified) * New translations README.md (Turkish) * New translations README.md (Portuguese) * New translations README.md (Spanish) * New translations README.md (Polish) * New translations README.md (Dutch) * New translations README.md (Korean) * New translations README.md (Japanese) * New translations README.md (Italian) * New translations README.md (German) * New translations README.md (Arabic) * New translations README.md (Sorani (Kurdish))
192 KiB
Configuration
Pour commencer à configurer starship, créez le fichier suivant : ~/.config/starship.toml
.
mkdir -p ~/.config && touch ~/.config/starship.toml
Toute la configuration de starship est faite dans ce fichier TOML:
# Insérer une ligne vide entre deux invites
add_newline = true
# Remplacer le "❯" dans l'invite par "➜"
[character] # On configure le module appelé "character"
success_symbol = "[➜](bold green)" # Le segment "success_symbol" est configuré sur la valeur "➜" avec la couleur "bold green" (vert, gras)
# Désactiver le module "package", pour le supprimer totalement de l'invite
[package]
disabled = true
Vous pouvez changer l'emplacement par défaut du fichier avec la variable d'environnement STARSHIP_CONFIG
:
export STARSHIP_CONFIG=~/example/non/default/path/starship.toml
De manière équivalente, pour Powershell (Windows), ajoutez la ligne suivante à votre $PROFILE
:
$ENV:STARSHIP_CONFIG = "$HOME\example\non\default\path\starship.toml"
Or for Cmd (Windows) would be adding this line to your starship.lua
:
os.setenv('STARSHIP_CONFIG', 'C:\\Users\\user\\example\\non\\default\\path\\starship.toml')
Journalisation
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:
export STARSHIP_CACHE=~/.starship/cache
De manière équivalente, pour Powershell (Windows), ajoutez la ligne suivante à votre $PROFILE
:
$ENV:STARSHIP_CACHE = "$HOME\AppData\Local\Temp"
Or for Cmd (Windows) would be adding this line to your starship.lua
:
os.setenv('STARSHIP_CACHE', 'C:\\Users\\user\\AppData\\Local\\Temp')
Terminologie
Module: A component in the prompt giving information based on contextual information from your OS. For example, the "nodejs" module shows the version of Node.js that is currently installed on your computer, if your current directory is a Node.js project.
Variable: Smaller sub-components that contain information provided by the module. For example, the "version" variable in the "nodejs" module contains the current version of Node.js.
By convention, most modules have a prefix of default terminal color (e.g. via
in "nodejs") and an empty space as a suffix.
Chaîne de formatage
Format strings are the format that a module prints all its variables with. Most modules have an entry called format
that configures the display format of the module. You can use texts, variables and text groups in a format string.
Variable
A variable contains a $
symbol followed by the name of the variable. The name of a variable can only contain letters, numbers and _
.
For example:
$version
est une chaîne de formatage avec une variable nomméeversion
.$git_branch$git_commit
est une chaîne de formatage avec deux variables appeléesgit_branch
etgit_commit
.$git_branch $git_commit
a les deux variables séparées par un espace.
Groupe de texte
A text group is made up of two different parts.
The first part, which is enclosed in a []
, is a format string. You can add texts, variables, or even nested text groups in it.
In the second part, which is enclosed in a ()
, is a style string. This can be used to style the first part.
For example:
[on](red bold)
affichera une chaîne de caractèreson
avec un texte gras de couleur rouge.[⌘ $version](bold green)
affichera le symbole⌘
suivi par le contenu de la variableversion
, en texte gras de couleur verte.[a [b](red) c](green)
afficheraa b c
avecb
rouge, eta
etc
vert.
Chaînes de style
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.
"fg:green bg:blue"
définit un texte vert sur un fond bleu"bg:blue fg:bright-green"
définit un texte vert clair sur un fond bleu"bold fg:27"
définit le texte en gras avec la couleur ANSI 27"underline bg:#bf5700"
définit le texte en souligné sur un fond orange foncé"bold italic fg:purple"
définit le texte en italique et gras sur un fond violet""
désactive explicitement tous les styles
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.
Chaînes de formatage conditionnel
A conditional format string wrapped in (
and )
will not render if all variables inside are empty.
For example:
(@$region)
n’affichera rien si la variableregion
estNone
or une chaine vide, sinon@
suivi par la valeur de region.(some text)
ne montrera toujours rien puisqu'il n'y a pas de variables enveloppées dans les accolades.- Lorsque
$all
est un raccourci pour\[$a$b\]
,($all)
ne montrera rien que si$a
et$b
sont tous les deuxNone
. Cela fonctionne comme(\[$a$b\] )
.
Caractères spéciaux
The following symbols have special usage in a format string and must be escaped: $ \ [ ] ( )
.
Note that TOML has both basic strings and literal strings. It is recommended to use a literal string (surrounded by single quotes) in your config. If you want to use a basic string (surrounded by double quotes), you must escape the backslash itself (i.e. use \\
).
For example, when you want to print a $
symbol on a new line, the following configs for format
are equivalent:
# with basic string
format = "\n\\$"
# with multiline basic string
format = """
\\$"""
# with literal string
format = '''
\$'''
Invite
This is the list of prompt-wide configuration options.
Options
Option | Défaut | Description |
---|---|---|
format |
lien | Configure le format de l'invite. |
right_format |
"" |
See Enable Right Prompt |
scan_timeout |
30 |
Délai d'attente pour que starship scanne les fichiers (en millisecondes). |
command_timeout |
500 |
Délai maximal pour les commandes exécutées par starship (en millisecondes). |
add_newline |
true |
Insère une ligne vide entre les invites du shell. |
Exemple
# ~/.config/starship.toml
# Use custom format
format = """
[┌───────────────────>](bold green)
[│](bold green)$directory$rust$package
[└─>](bold green) """
# Wait 10 milliseconds for starship to check files under the current directory.
scan_timeout = 10
# Disable the blank line at the start of the prompt
add_newline = false
Format par Défaut
The default format
is used to define the format of the prompt, if empty or no format
is provided. The default is as shown:
format = "$all"
# Which is equivalent to
format = """
$username\
$hostname\
$shlvl\
$singularity\
$kubernetes\
$directory\
$vcsh\
$git_branch\
$git_commit\
$git_state\
$git_metrics\
$git_status\
$hg_branch\
$docker_context\
$package\
$cmake\
$cobol\
$dart\
$deno\
$dotnet\
$elixir\
$elm\
$erlang\
$golang\
$helm\
$java\
$julia\
$kotlin\
$lua\
$nim\
$nodejs\
$ocaml\
$perl\
$php\
$pulumi\
$purescript\
$python\
$rlang\
$red\
$ruby\
$rust\
$scala\
$swift\
$terraform\
$vlang\
$vagrant\
$zig\
$nix_shell\
$conda\
$memory_usage\
$aws\
$gcloud\
$openstack\
$azure\
$env_var\
$crystal\
$custom\
$sudo\
$cmd_duration\
$line_break\
$jobs\
$battery\
$time\
$status\
$shell\
$character"""
If you just want to extend the default format, you can use $all
; modules you explicitly add to the format will not be duplicated. Eg.
# Move the directory to the second line
format="$all$directory$character"
AWS
The aws
module shows the current AWS region and profile. This is based on AWS_REGION
, AWS_DEFAULT_REGION
, and AWS_PROFILE
env var with ~/.aws/config
file. This module also shows an expiration timer when using temporary credentials.
When using aws-vault the profile is read from the AWS_VAULT
env var and the credentials expiration date is read from the AWS_SESSION_EXPIRATION
env var.
When using awsu the profile is read from the AWSU_PROFILE
env var.
When using AWSume the profile is read from the AWSUME_PROFILE
env var and the credentials expiration date is read from the AWSUME_EXPIRATION
env var.
Options
Option | Default | Description |
---|---|---|
format |
'on [$symbol($profile )(\($region\) )(\[$duration\])]($style)' |
Format du module. |
symbol |
"☁️ " |
Le symbole affiché avant le profil AWS actuel. |
region_aliases |
Table des alias de région à afficher en plus du nom AWS. | |
style |
"bold yellow" |
Le style du module. |
expiration_symbol |
X |
Le symbole affiché lorsque les identifiants temporaires ont expiré. |
disabled |
false |
Désactive le module AWS . |
Variables
Variable | Exemple | Description |
---|---|---|
region | ap-northeast-1 |
La région AWS actuelle |
profile | astronauts |
Le profil AWS actuel |
duration | 2h27m20s |
Durée de validité des identifiants temporaires |
symbol | Reflète la valeur de l'option symbol |
|
style* | Reflète la valeur de l'option style |
* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
Exemples
Tout afficher
# ~/.config/starship.toml
[aws]
format = 'on [$symbol($profile )(\($region\) )]($style)'
style = "bold blue"
symbol = "🅰 "
[aws.region_aliases]
ap-southeast-2 = "au"
us-east-1 = "va"
Afficher la région
# ~/.config/starship.toml
[aws]
format = "on [$symbol$region]($style) "
style = "bold blue"
symbol = "🅰 "
[aws.region_aliases]
ap-southeast-2 = "au"
us-east-1 = "va"
Afficher le profil
# ~/.config/starship.toml
[aws]
format = "on [$symbol$profile]($style) "
style = "bold blue"
symbol = "🅰 "
Azure
The azure
module shows the current Azure Subscription. This is based on showing the name of the default subscription, as defined in the ~/.azure/azureProfile.json
file.
Options
Variable | Default | Description |
---|---|---|
format |
"on [$symbol($subscription)]($style) " |
Le format utilisé pour faire le rendu du module Azure. |
symbol |
"ﴃ " |
Le symbole utilisé dans le format. |
style |
"blue bold" |
Le style utilisé dans le format. |
disabled |
true |
Désactive le module azure . |
Exemple
# ~/.config/starship.toml
[azure]
disabled = false
format = "on [$symbol($subscription)]($style) "
symbol = "ﴃ "
style = "blue bold"
Battery
The battery
module shows how charged the device's battery is and its current charging status. The module is only visible when the device's battery is below 10%.
Options
Option | Défaut | Description |
---|---|---|
full_symbol |
" " |
Le symbole affiché lorsque la batterie est pleine. |
charging_symbol |
" " |
Le symbole affiché lorsque la batterie se charge. |
discharging_symbol |
" " |
Le symbole affiché lorsque la batterie se décharge. |
unknown_symbol |
" " |
Le symbole affiché lorsque l'état de la batterie est inconnu. |
empty_symbol |
" " |
Le symbole affiché lorsque la batterie est vide. |
format |
"[$symbol$percentage]($style) " |
Format du module. |
display |
lien | Affiche le seuil et le style du module. |
disabled |
false |
Désactive le module battery . |
Exemple
# ~/.config/starship.toml
[battery]
full_symbol = "🔋 "
charging_symbol = "⚡️ "
discharging_symbol = "💀 "
Indicateur de batterie
The display
configuration option is used to define when the battery indicator should be shown (threshold), which symbol would be used (symbol), and what it would like (style). If no display
is provided. The default is as shown:
[[battery.display]]
threshold = 10
style = "bold red"
The default value for the charging_symbol
and discharging_symbol
option is respectively the value of battery
's charging_symbol
and discharging_symbol
option.
Options
The display
option is an array of the following table.
Option | Défaut | Description |
---|---|---|
threshold |
10 |
La limite supérieure pour l'option d'affichage. |
style |
bold red |
Le style de l'option display si elle est utilisée. |
charging_symbol |
- |
Symbole optionnel affiché si l'option display est utilisée, la valeur par défaut est l'option charging_symbol du module "battery". |
discharging_symbol |
- |
Symbole optionnel affiché si l'option display est utilisée, la valeur par défaut est l'option discharging_symbol du module "battery". |
Exemple
[[battery.display]] # "bold red" style and discharging_symbol when capacity is between 0% and 10%
threshold = 10
style = "bold red"
[[battery.display]] # "bold yellow" style and 💦 symbol when capacity is between 10% and 30%
threshold = 30
style = "bold yellow"
discharging_symbol = "💦"
# when capacity is over 30%, the battery indicator will not be displayed
Character
The character
module shows a character (usually an arrow) beside where the text is entered in your terminal.
The character will tell you whether the last command was successful or not. It can do this in two ways:
- changement de couleur (
red
/green
) - changement de forme (
❯
/✖
)
By default it only changes color. If you also want to change its shape take a look at this example.
::: warning
error_symbol
is not supported on nu shell.
:::
::: warning
vicmd_symbol
is only supported in cmd, fish and zsh.
:::
Options
Option | Défaut | Description |
---|---|---|
format |
"$symbol " |
Le format utilisée avant l'entrée de texte. |
success_symbol |
"[❯](bold green)" |
Le format utilisé avant l'entrée de texte si la commande précédente a réussi. |
error_symbol |
"[❯](bold red)" |
Le format utilisé avant l'entrée de texte si la commande précédente a échoué. |
vicmd_symbol |
"[❮](bold green)" |
Le format utilisé avant l'entrée de texte si le shell est en mode vim normal. |
disabled |
false |
Désactive le module character . |
Variables
Variable | Exemple | Description |
---|---|---|
symbol | Reflète sois success_symbol , error_symbol ou vicmd_symbol |
Exemples
Avec une forme d'erreur personnalisée
# ~/.config/starship.toml
[character]
success_symbol = "[➜](bold green) "
error_symbol = "[✗](bold red) "
Sans forme d'erreur personnalisée
# ~/.config/starship.toml
[character]
success_symbol = "[➜](bold green) "
error_symbol = "[➜](bold red) "
Avec une forme vim personnalisée
# ~/.config/starship.toml
[character]
vicmd_symbol = "[V](bold green) "
CMake
The cmake
module shows the currently installed version of CMake. By default the module will be activated if any of the following conditions are met:
- Le répertoire actuel contient un fichier
CMakeLists.txt
- Le répertoire actuel contient un fichier
CMakeCache.txt
Options
Option | Défaut | Description |
---|---|---|
format |
"via [$symbol($version )]($style)" |
Format du module. |
version_format |
"v${raw}" |
Le format de la version. Les variables disponibles sont raw , major , minor , & patch |
symbol |
"△ " |
Le symbole utilisé avant la version de cmake. |
detect_extensions |
[] |
Quelles extensions devraient activer ce module |
detect_files |
["CMakeLists.txt", "CMakeCache.txt"] |
Quels fichiers devraient activer ce module |
detect_folders |
[] |
Quels dossiers devraient activer ce module |
style |
"bold blue" |
Le style du module. |
disabled |
false |
Désactive le module cmake . |
Variables
Variable | Exemple | Description |
---|---|---|
version | v3.17.3 |
La version de cmake |
symbol | Reflète la valeur de l'option symbol |
|
style* | Reflète la valeur de l'option style |
* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
COBOL / GNUCOBOL
The cobol
module shows the currently installed version of COBOL. By default, the module will be shown if any of the following conditions are met:
- Le répertoire courant contient un fichier finissant par
.cob
ou.COB
- Le répertoire courant contiens un fichier finissant par
.cbl
ou.CBL
Options
Option | Défaut | Description |
---|---|---|
symbol |
"⚙️ " |
Le symbole utilisé avant d’afficher la version de COBOL. |
format |
"via [$symbol($version )]($style)" |
Format du module. |
version_format |
"v${raw}" |
Le format de la version. Les variables disponibles sont raw , major , minor , & patch |
style |
"bold blue" |
Le style du module. |
detect_extensions |
["cbl", "cob", "CBL", "COB"] |
Quelles extensions devraient activer ce module. |
detect_files |
[] |
Quels fichiers devraient activer ce module. |
detect_folders |
[] |
Quels dossiers devraient activer ce module. |
disabled |
false |
Désactive le module cobol . |
Variables
Variable | Exemple | Description |
---|---|---|
version | v3.1.2.0 |
La version de cobol |
symbol | Reflète la valeur de l'option symbol |
|
style* | Reflète la valeur de l'option style |
* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
Temps d'exécution
The cmd_duration
module shows how long the last command took to execute. The module will be shown only if the command took longer than two seconds, or the min_time
config value, if it exists.
::: warning Do not hook the DEBUG trap in Bash
If you are running Starship in bash
, do not hook the DEBUG
trap after running eval $(starship init $0)
, or this module will break.
:::
Bash users who need preexec-like functionality can use rcaloras's bash_preexec framework. Simply define the arrays preexec_functions
and precmd_functions
before running eval $(starship init $0)
, and then proceed as normal.
Options
Option | Défaut | Description |
---|---|---|
min_time |
2_000 |
Durée la plus courte quand afficher le temps (en millisecondes). |
show_milliseconds |
false |
Afficher les millisecondes en plus des secondes pendant la durée. |
format |
"took [$duration]($style) " |
Format du module. |
style |
"bold yellow" |
Le style du module. |
disabled |
false |
Désactive le module cmd_duration . |
show_notifications |
false |
Afficher les notifications du bureau lorsque la commande est terminée. |
min_time_to_notify |
45_000 |
Durée minimale après laquelle activer la notification (en millisecondes). |
::: tip
Showing desktop notifications requires starship to be built with notify-rust
support. You check if your starship supports notifications by running STARSHIP_LOG=debug starship module cmd_duration -d 60000
when show_notifications
is set to true
.
:::
Variables
Variable | Exemple | Description |
---|---|---|
duration | 16m40s |
Le temps nécessaire pour exécuter la commande |
style* | Reflète la valeur de l'option style |
* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
Exemple
# ~/.config/starship.toml
[cmd_duration]
min_time = 500
format = "underwent [$duration](bold yellow)"
Conda
The conda
module shows the current Conda environment, if $CONDA_DEFAULT_ENV
is set.
::: tip
This does not suppress conda's own prompt modifier, you may want to run conda config --set changeps1 False
.
:::
Options
Option | Défaut | Description |
---|---|---|
truncation_length |
1 |
Le nombre de répertoires dans lesquels le chemin d'environnement (Path) doit être tronqué, si l'environnement a été créé via conda create -p [path] . 0 ne signifie pas de troncature. Regardez aussi le module directory . |
symbol |
"🅒 " |
Le symbole utilisé avant le nom d'environnement. |
style |
"bold green" |
Le style du module. |
format |
"via [$symbol$environment]($style) " |
Format du module. |
ignore_base |
true |
Ignore l'environnement base lorsqu'il est activé. |
disabled |
false |
Désactive le module conda . |
Variables
Variable | Exemple | Description |
---|---|---|
environnement | astronauts |
La version courante de conda |
symbol | Reflète la valeur de l'option symbol |
|
style* | Reflète la valeur de l'option style |
* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
Exemple
# ~/.config/starship.toml
[conda]
format = "[$symbol$environment](dimmed green) "
Crystal
The crystal
module shows the currently installed version of Crystal. Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie:
- Le répertoire courant contient un fichier
shard.yml
- Le répertoire courant contient un fichier
.cr
Options
Option | Défaut | Description |
---|---|---|
symbol |
"🔮 " |
Le symbole utilisé avant d'afficher la version de crystal. |
format |
"via [$symbol($version )]($style)" |
Format du module. |
version_format |
"v${raw}" |
Le format de la version. Les variables disponibles sont raw , major , minor , & patch |
style |
"bold green" |
Le style du module. |
detect_extensions |
["cr"] |
Quelles extensions devraient activer ce module. |
detect_files |
["shard.yml"] |
Quels fichiers devraient activer ce module. |
detect_folders |
[] |
Quels dossiers devraient activer ce module. |
disabled |
false |
Désactive le module crystal . |
Variables
Variable | Exemple | Description |
---|---|---|
version | v0.32.1 |
La version de cristal |
symbol | Reflète la valeur de l'option symbol |
|
style* | Reflète la valeur de l'option style |
* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
Exemple
# ~/.config/starship.toml
[crystal]
format = "via [✨ $version](bold blue) "
Dart
The dart
module shows the currently installed version of Dart. Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie:
- Le répertoire courant contient un fichier
.dart
- Le répertoire courant contient un répertoire
.dart_tool
- Le répertoire courant contient un fichier
pubspec.yaml
,pubspec.yml
oupubspec.lock
Options
Option | Défaut | Description |
---|---|---|
format |
"via [$symbol($version )]($style)" |
Format du module. |
version_format |
"v${raw}" |
Le format de la version. Les variables disponibles sont raw , major , minor , & patch |
symbol |
"🎯 " |
Une chaîne de caractères représentant le symbole de Dart |
detect_extensions |
["dart"] |
Quelles extensions devraient activer ce module. |
detect_files |
["pubspec.yaml", "pubspec.yml", "pubspec.lock"] |
Quels fichiers devraient activer ce module. |
detect_folders |
[".dart_tool"] |
Quels dossiers devraient activer ce module. |
style |
"bold blue" |
Le style du module. |
disabled |
false |
Désactive le module dart . |
Variables
Variable | Exemple | Description |
---|---|---|
version | v2.8.4 |
La version de dart |
symbol | Reflète la valeur de l'option symbol |
|
style* | Reflète la valeur de l'option style |
* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
Exemple
# ~/.config/starship.toml
[dart]
format = "via [🔰 $version](bold red) "
Deno
The deno
module shows you your currently installed version of Deno. Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie:
- The current directory contains a
deno.json
,deno.jsonc
,mod.ts
,mod.js
,deps.ts
ordeps.js
file
Options
Option | Défaut | Description |
---|---|---|
format |
"via [$symbol($version )]($style)" |
Format du module. |
version_format |
"v${raw}" |
Le format de la version. Les variables disponibles sont raw , major , minor , & patch |
symbol |
"🦕 " |
Une chaîne de caractères représentant le symbole de Deno |
detect_extensions |
[] |
Quelles extensions devraient activer ce module. |
detect_files |
["deno.json", "deno.jsonc", "mod.ts", "mod.js", "deps.ts", "deps.js"] |
Quels fichiers devraient activer ce module. |
detect_folders |
[] |
Quels dossiers devraient activer ce module. |
style |
"green bold" |
Le style du module. |
disabled |
false |
Désactive le module deno . |
Variables
Variable | Exemple | Description |
---|---|---|
version | v1.8.3 |
La version de deno |
symbol | Reflète la valeur de l'option symbol |
|
style* | Reflète la valeur de l'option style |
Exemple
# ~/.config/starship.toml
[deno]
format = "via [🦕 $version](green bold) "
Dossier
The directory
module shows the path to your current directory, truncated to three parent folders. Your directory will also be truncated to the root of the git repo that you're currently in.
When using the fish style pwd option, instead of hiding the path that is truncated, you will see a shortened name of each directory based on the number you enable for the option.
For example, given ~/Dev/Nix/nixpkgs/pkgs
where nixpkgs
is the repo root, and the option set to 1
. You will now see ~/D/N/nixpkgs/pkgs
, whereas before it would have been nixpkgs/pkgs
.
Options
Option | Défaut | Description |
---|---|---|
truncation_length |
3 |
Le nombre de dossiers parents selon lesquels le répertoire courant doit être tronqué. |
truncate_to_repo |
true |
Si oui ou non tronquer à la racine du repo git dans lequel vous vous trouvez. |
format |
"[$path]($style)[$read_only]($read_only_style) " |
Format du module. |
style |
"bold cyan" |
Le style du module. |
disabled |
false |
Désactive le module directory . |
read_only |
"🔒" |
Le symbole indiquant que le répertoire courant est en lecture seule. |
read_only_style |
"red" |
Le style du symbole en lecture seule. |
truncation_symbol |
"" |
Le symbole en préfixe aux chemins tronqués. eg: "…/" |
repo_root_style |
None |
Le style pour la racine du dépôt git quand l’option truncate_to_repo est à false. |
home_symbol |
"~" |
Le symbole indiquant le répertoire personnel. |
use_os_path_sep |
true |
Use the OS specific path seperator instead of always using / (e.g. \ on Windows) |
This module has a few advanced configuration options that control how the directory is displayed.
Options avancées | Défaut | Description |
---|---|---|
substitutions |
Table de substitutions à faire au chemin. | |
fish_style_pwd_dir_length |
0 |
Le nombre de caractères à utiliser lors de l'application de la logique de troncature du pwd de fish. |
use_logical_path |
true |
Si true affiche le chemin logique issu du shell via PWD ou --logical-path . Si false renvoie plutôt le chemin du système de fichiers physique avec les liens symboliques résolus. |
substitutions
allows you to define arbitrary replacements for literal strings that occur in the path, for example long network prefixes or development directories (i.e. Java). Note that this will disable the fish style PWD.
[directory.substitutions]
"/Volumes/network/path" = "/net"
"src/com/long/java/path" = "mypath"
fish_style_pwd_dir_length
interacts with the standard truncation options in a way that can be surprising at first: if it's non-zero, the components of the path that would normally be truncated are instead displayed with that many characters. For example, the path /built/this/city/on/rock/and/roll
, which would normally be displayed as as rock/and/roll
, would be displayed as /b/t/c/o/rock/and/roll
with fish_style_pwd_dir_length = 1
--the path components that would normally be removed are displayed with a single character. For fish_style_pwd_dir_length = 2
, it would be /bu/th/ci/on/rock/and/roll
.
Variables
Variable | Exemple | Description |
---|---|---|
path | "D:/Projects" |
Le chemin du répertoire courant |
style* | "black bold dimmed" |
Reflète la valeur de l'option style |
* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
Exemple
# ~/.config/starship.toml
[directory]
truncation_length = 8
truncation_symbol = "…/"
Contexte Docker
The docker_context
module shows the currently active Docker context if it's not set to default
or if the DOCKER_MACHINE_NAME
, DOCKER_HOST
or DOCKER_CONTEXT
environment variables are set (as they are meant to override the context in use).
Options
Option | Défaut | Description |
---|---|---|
format |
"via [$symbol$context]($style) " |
Format du module. |
symbol |
"🐳 " |
Le symbole utilisé avant d'afficher le contexte Docker. |
only_with_files |
true |
Afficher uniquement quand il y a une correspondance |
detect_extensions |
[] |
Quelles extensions devraient activer ce module (il faut que only_with_files soit réglé sur true). |
detect_files |
["docker-compose.yml", "docker-compose.yaml", "Dockerfile"] |
Quels noms de fichier devraient activer ce module (il faut que only_with_files soit réglé sur true). |
detect_folders |
[] |
Quels dossiers devraient activer ce module (il faut que only_with_files soit réglé sur true). |
style |
"blue bold" |
Le style du module. |
disabled |
false |
Désactive le module docker_context . |
Variables
Variable | Exemple | Description |
---|---|---|
context | test_context |
Le contexte actuel de Docker |
symbol | Reflète la valeur de l'option symbol |
|
style* | Reflète la valeur de l'option style |
* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
Exemple
# ~/.config/starship.toml
[docker_context]
format = "via [🐋 $context](blue bold)"
Dotnet
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.
By default this module will only be shown in your prompt when one or more of the following files are present in the current directory:
global.json
project.json
Directory.Build.props
Directory.Build.targets
Packages.props
*.csproj
*.fsproj
*.xproj
You'll also need the .NET Core SDK installed in order to use it correctly.
Internally, this module uses its own mechanism for version detection. Typically it is twice as fast as running dotnet --version
, but it may show an incorrect version if your .NET project has an unusual directory layout. If accuracy is more important than speed, you can disable the mechanism by setting heuristic = false
in the module options.
The module will also show the Target Framework Moniker (https://docs.microsoft.com/en-us/dotnet/standard/frameworks#supported-target-framework-versions) when there is a csproj file in the current directory.
Options
Option | Défaut | Description |
---|---|---|
format |
"via [$symbol($version )(🎯 $tfm )]($style)" |
Format du module. |
version_format |
"v${raw}" |
Le format de la version. Les variables disponibles sont raw , major , minor , & patch |
symbol |
".NET " |
Le symbole utilisé avant d'afficher la version de dotnet. |
heuristic |
true |
Utilisez la détection de versions plus rapide pour garder starship instantané. |
detect_extensions |
["csproj", "fsproj", "xproj"] |
Quelles extensions devraient activer ce module. |
detect_files |
["global.json", "project.json", "Directory.Build.props", "Directory.Build.targets", "Packages.props"] |
Quels fichiers devraient activer ce module. |
detect_folders |
[] |
Quels dossiers devraient activer ce module. |
style |
"bold blue" |
Le style du module. |
disabled |
false |
Désactive le module dotnet . |
Variables
Variable | Exemple | Description |
---|---|---|
version | v3.1.201 |
La version du sdk dotnet |
tfm | netstandard2.0 |
The Target Framework Moniker that the current project is targeting |
symbol | Reflète la valeur de l'option symbol |
|
style* | Reflète la valeur de l'option style |
* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
Exemple
# ~/.config/starship.toml
[dotnet]
symbol = "🥅 "
style = "green"
heuristic = false
Elixir
The elixir
module shows the currently installed version of Elixir and Erlang/OTP. Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie:
- Le répertoire courant contient un fichier
mix.exs
.
Options
Option | Défaut | Description |
---|---|---|
format |
'via [$symbol($version \(OTP $otp_version\) )]($style)' |
Format du module elixir. |
version_format |
"v${raw}" |
Le format de la version. Les variables disponibles sont raw , major , minor , & patch |
symbol |
"💧 " |
Le symbole utilisé avant d'afficher la version d'Elixir/Erlang. |
detect_extensions |
[] |
Quelles extensions devraient activer ce module. |
detect_files |
["mix.exs"] |
Quels fichiers devraient activer ce module. |
detect_folders |
[] |
Quels dossiers devraient activer ce module. |
style |
"bold purple" |
Le style du module. |
disabled |
false |
Désactive le module elixir . |
Variables
Variable | Exemple | Description |
---|---|---|
version | v1.10 |
La version d' elixir |
otp_version | La version otp d' elixir |
|
symbol | Reflète la valeur de l'option symbol |
|
style* | Reflète la valeur de l'option style |
* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
Exemple
# ~/.config/starship.toml
[elixir]
symbol = "🔮 "
Elm
The elm
module shows the currently installed version of Elm. Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie:
- Le répertoire courant contient un fichier
elm.json
- Le répertoire courant contient un fichier
elm-package.json
- Le répertoire courant contient un fichier
elm-version
- Le répertoire courant contient un dossier
elm-stuff
- Le répertoire courant contient des fichiers
*.elm
Options
Option | Défaut | Description |
---|---|---|
format |
"via [$symbol($version )]($style)" |
Format du module. |
version_format |
"v${raw}" |
Le format de la version. Les variables disponibles sont raw , major , minor , & patch |
symbol |
"🌳 " |
Une chaîne de format représentant le symbole d'Elm. |
detect_extensions |
["elm"] |
Quelles extensions devraient activer ce module. |
detect_files |
["elm.json", "elm-package.json", ".elm-version"] |
Quels fichiers devraient activer ce module. |
detect_folders |
["elm-stuff"] |
Quels dossiers devraient activer ce module. |
style |
"cyan bold" |
Le style du module. |
disabled |
false |
Désactive le module elm . |
Variables
Variable | Exemple | Description |
---|---|---|
version | v0.19.1 |
La version de elm |
symbol | Reflète la valeur de l'option symbol |
|
style* | Reflète la valeur de l'option style |
* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
Exemple
# ~/.config/starship.toml
[elm]
format = "via [ $version](cyan bold) "
Variable d'environnement
The env_var
module displays the current value of a selected environment variables. The module will be shown only if any of the following conditions are met:
- L'option
variable
correspond à une variable d'environnement existante - L'option
variable
n'est pas définie, mais l'optiondefault
l'est
::: tip Multiple environmental variables can be displayed by using a .
. (see example) If the variable
configuration option is not set, the module will display value of variable under the name of text after the .
character.
Example: following configuration will display value of USER environment variable
# ~/.config/starship.toml
[env_var.USER]
default = "unknown user"
:::
Options
Option | Défaut | Description |
---|---|---|
symbol |
"" |
Le symbole utilisé avant d'afficher la valeur de la variable. |
variable |
La variable d'environnement à afficher. | |
default |
La valeur par défaut à afficher lorsque la variable sélectionnée n'est pas définie. | |
format |
"with [$env_value]($style) " |
Format du module. |
disabled |
false |
Désactive le module env_var . |
Variables
Variable | Exemple | Description |
---|---|---|
env_value | Windows NT (si variable était $OS ) |
La valeur d'environnement de l'option variable |
symbol | Reflète la valeur de l'option symbol |
|
style* | black bold dimmed |
Reflète la valeur de l'option style |
* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
Exemple
# ~/.config/starship.toml
[env_var]
variable = "SHELL"
default = "unknown shell"
Displaying multiple environmental variables:
# ~/.config/starship.toml
[env_var.SHELL]
variable = "SHELL"
default = "unknown shell"
[env_var.USER]
default = "unknown user"
Erlang
The erlang
module shows the currently installed version of Erlang/OTP. Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie:
- Le répertoire courant contient un fichier
rebar.config
. - Le répertoire courant contient un fichier
erlang.mk
.
Options
Option | Défaut | Description |
---|---|---|
format |
"via [$symbol($version )]($style)" |
Format du module. |
version_format |
"v${raw}" |
Le format de la version. Les variables disponibles sont raw , major , minor , & patch |
symbol |
" " |
Le symbole utilisé avant d'afficher la version d'erlang. |
style |
"bold green" |
Le style du module. |
detect_extensions |
[] |
Quelles extensions devraient activer ce module. |
detect_files |
["rebar.config", "elang.mk"] |
Quels fichiers devraient activer ce module. |
detect_folders |
[] |
Quels dossiers devraient activer ce module. |
disabled |
false |
Désactive le module erlang . |
Variables
Variable | Exemple | Description |
---|---|---|
version | v22.1.3 |
La version d'erlang |
symbol | Reflète la valeur de l'option symbol |
|
style* | Reflète la valeur de l'option style |
* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
Exemple
# ~/.config/starship.toml
[erlang]
format = "via [e $version](bold red) "
Remplissage
The fill
module fills any extra space on the line with a symbol. If multiple fill
modules are present in a line they will split the space evenly between them. This is useful for aligning other modules.
Options
Option | Défaut | Description |
---|---|---|
symbol |
"." |
Le symbole utilisé pour remplir la ligne. |
style |
"bold black" |
Le style du module. |
disabled |
false |
Désactive le module fill |
Exemple
# ~/.config/starship.toml
format="AA $fill BB $fill CC"
[fill]
symbol = "-"
style = "bold green"
Produces a prompt that looks like:
AA -------------------------------------------- BB -------------------------------------------- CC
Google Cloud (gcloud
)
The gcloud
module shows the current configuration for gcloud
CLI. This is based on the ~/.config/gcloud/active_config
file and the ~/.config/gcloud/configurations/config_{CONFIG NAME}
file and the CLOUDSDK_CONFIG
env var.
Options
Option | Défaut | Description |
---|---|---|
format |
'on [$symbol$account(@$domain)(\($region\))]($style) ' |
Format du module. |
symbol |
"☁️ " |
Le symbole affiché avant le profil GCP actuel. |
region_aliases |
Table des alias de région à afficher en plus du nom du GCP. | |
style |
"bold blue" |
Le style du module. |
disabled |
false |
Désactive le module gcloud . |
Variables
Variable | Exemple | Description |
---|---|---|
region | us-central1 |
La région GCP actuelle |
account | foo |
Le profil GCP actuel |
domain | exemple.com |
Le domaine du profil GCP actuel |
project | Le projet GCP actuel | |
active | default |
Le nom de la configuration active écrit dans ~/.config/gcloud/active_config |
symbol | Reflète la valeur de l'option symbol |
|
style* | Reflète la valeur de l'option style |
* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
Exemples
Afficher le compte et le projet
# ~/.config/starship.toml
[gcloud]
format = 'on [$symbol$account(@$domain)(\($project\))]($style) '
Afficher uniquement le nom de la configuration active
# ~/.config/starship.toml
[gcloud]
format = "[$symbol$active]($style) "
style = "bold yellow"
Afficher le compte et la région aliasée
# ~/.config/starship.toml
[gcloud]
symbol = "️🇬️ "
[gcloud.region_aliases]
us-central1 = "uc1"
asia-northeast1 = "an1"
Branche Git
The git_branch
module shows the active branch of the repo in your current directory.
Options
Option | Défaut | Description |
---|---|---|
always_show_remote |
false |
Affiche le nom de la branche suivie distante, même si elle est égale au nom de la branche locale. |
format |
"on [$symbol$branch]($style) " |
Format du module. Utilisez "$branch" pour vous référer au nom de la branche courante. |
symbol |
" " |
Une chaîne de format représentant le symbole de la branche git. |
style |
"bold purple" |
Le style du module. |
truncation_length |
2^63 - 1 |
Tronque une branche git à N graphèmes. |
truncation_symbol |
"…" |
Le symbole utilisé pour indiquer qu'un nom de branche a été tronqué. Vous pouvez utiliser "" pour ne pas afficher de symbole. |
only_attached |
false |
Ne montrer le nom de la branche que si elle n'est pas dans un état HEAD détachée. |
disabled |
false |
Désactive le module git_branch . |
Variables
Variable | Exemple | Description |
---|---|---|
branch | master |
Le nom de la branche actuelle, par défaut à HEAD s'il n'y a pas de branche actuelle (par exemple HEAD détachée). |
remote_name | origin |
Le nom du dépôt distant. |
remote_branch | master |
Le nom de la branche suivie sur remote_name . |
symbol | Reflète la valeur de l'option symbol |
|
style* | Reflète la valeur de l'option style |
* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
Exemple
# ~/.config/starship.toml
[git_branch]
symbol = "🌱 "
truncation_length = 4
truncation_symbol = ""
Commit Git
The git_commit
module shows the current commit hash and also the tag (if any) of the repo in your current directory.
Options
Option | Défaut | Description |
---|---|---|
commit_hash_length |
7 |
La longueur du hash affiché du commit git. |
format |
"[\\($hash$tag\\)]($style) " |
Format du module. |
style |
"bold green" |
Le style du module. |
only_detached |
true |
Ne montrer le hash du commit qu'en mode HEAD détachée. |
tag_disabled |
true |
Désactive l'affichage des informations du tag dans le module git_commit . |
tag_symbol |
" 🏷 " |
Symbole préfixant les informations affichées concernant le tag |
disabled |
false |
Désactive le module git_commit . |
Variables
Variable | Exemple | Description |
---|---|---|
hash | b703eb3 |
Le hash du commit git actuel |
style* | Reflète la valeur de l'option style |
* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
Exemple
# ~/.config/starship.toml
[git_commit]
commit_hash_length = 4
tag_symbol = "🔖 "
État Git
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.
Options
Option | Défaut | Description |
---|---|---|
rebase |
"REBASING" |
Une chaîne de format affichée lorsqu'un rebase est en cours. |
merge |
"MERGING" |
Une chaîne de format affichée quand un merge est en cours. |
revert |
"REVERTING" |
Une chaîne de format affichée quand un revert est en cours. |
cherry_pick |
"CHERRY-PICKING" |
Une chaîne de format affichée quand un cherry-pick est en cours. |
bisect |
"BISECTING" |
Une chaîne de format affichée quand un bisect est en cours. |
am |
"AM" |
Une chaîne de format affichée lorsqu'un apply-mailbox (git am ) est en cours. |
am_or_rebase |
"AM/REBASE" |
Une chaîne de format affichée lorsqu'une apply-mailbox ou un rebase est en cours sans pouvoir les différencier. |
style |
"bold yellow" |
Le style du module. |
format |
'\([$state( $progress_current/$progress_total)]($style)\) ' |
Format du module. |
disabled |
false |
Désactive le module git_state . |
Variables
Variable | Exemple | Description |
---|---|---|
state | REBASING |
L'état actuel du dépôt |
progress_current | 1 |
Progression de l'opération en cours |
progress_total | 2 |
Progression maximale de l'opération |
style* | Reflète la valeur de l'option style |
* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
Exemple
# ~/.config/starship.toml
[git_state]
format = '[\($state( $progress_current of $progress_total)\)]($style) '
cherry_pick = "[🍒 PICKING](bold red)"
Git Metrics
The git_metrics
module will show the number of added and deleted lines in the current git repository.
::: tip
This module is disabled by default. To enable it, set disabled
to false
in your configuration file.
:::
Options
Option | Défaut | Description |
---|---|---|
added_style |
"bold green" |
The style for the added count. |
deleted_style |
"bold green" |
The style for the deleted count. |
only_nonzero_diffs |
true |
Render status only for changed items. |
format |
'([+$added]($added_style) )([-$deleted]($deleted_style) )' |
Format du module. |
disabled |
true |
Disables the git_metrics module. |
Variables
Variable | Exemple | Description |
---|---|---|
added | 1 |
The current number of added lines |
deleted | 2 |
The current number of deleted lines |
added_style* | Mirrors the value of option added_style |
|
deleted_style* | Mirrors the value of option deleted_style |
* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
Exemple
# ~/.config/starship.toml
[git_metrics]
added_style = "bold blue"
format = '[+$added]($added_style)/[-$deleted]($deleted_style) '
Statut Git
The git_status
module shows symbols representing the state of the repo in your current directory.
Options
Option | Défaut | Description |
---|---|---|
format |
'([\[$all_status$ahead_behind\]]($style) )' |
Le format par défaut du module git_status |
conflicted |
"=" |
Cette branche a des conflits de fusion. |
ahead |
"⇡" |
Le format de ahead |
behind |
"⇣" |
Le format de behind |
diverged |
"⇕" |
Le format de diverged |
up_to_date |
"" |
The format of up_to_date |
untracked |
"?" |
Le format de untracked |
stashed |
"$" |
Le format de stashed |
modified |
"!" |
Le format de modified |
staged |
"+" |
Le format de staged |
renamed |
"»" |
Le format de renamed |
deleted |
"✘" |
Le format de deleted |
style |
"bold green" |
Le style du module. |
ignore_submodules |
false |
Ignore changes to submodules. |
disabled |
false |
Disables the git_status module. |
Variables
The following variables can be used in format
:
Variable | Description |
---|---|
all_status |
Raccourci pour $conflicted$stashed$deleted$renamed$modified$staged$untracked |
ahead_behind |
Displays diverged , ahead , behind or up_to_date format string based on the current status of the repo. |
conflicted |
Affiche conflicted lorsque la branche courante a des conflits de fusion. |
untracked |
Affiche untracked lorsqu'il y a des fichiers non suivis dans le répertoire de travail. |
stashed |
Affiche stashed lorsqu'une remise existe pour le dépôt local. |
modified |
Affiche modified lorsqu'il y a des fichiers modifiés dans le répertoire de travail. |
staged |
Affiche staged lorsqu'un nouveau fichier a été ajouté à la zone de validation. |
renamed |
Affiche renamed lorsqu'un fichier renommé a été ajouté à la zone de validation. |
deleted |
Affiche deleted lorsque la suppression d'un fichier a été ajoutée à la zone de validation. |
style* | Reflète la valeur de l'option style |
* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
The following variables can be used in diverged
:
Variable | Description |
---|---|
ahead_count |
Nombre de commits en avance sur la branche suivie |
behind_count |
Nombre de commits en retard sur la branche suivie |
The following variables can be used in conflicted
, ahead
, behind
, untracked
, stashed
, modified
, staged
, renamed
and deleted
:
Variable | Description |
---|---|
count |
Affiche le nombre de fichiers concernés |
Exemple
# ~/.config/starship.toml
[git_status]
conflicted = "🏳"
ahead = "🏎💨"
behind = "😰"
diverged = "😵"
up_to_date = "✓"
untracked = "🤷"
stashed = "📦"
modified = "📝"
staged = '[++\($count\)](green)'
renamed = "👅"
deleted = "🗑"
Show ahead/behind count of the branch being tracked
# ~/.config/starship.toml
[git_status]
ahead = "⇡${count}"
diverged = "⇕⇡${ahead_count}⇣${behind_count}"
behind = "⇣${count}"
Go
The golang
module shows the currently installed version of Go. Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie:
- Le répertoire courant contient un fichier
go.mod
- Le répertoire courant contient un fichier
go.sum
- Le répertoire courant contient un fichier
glide.yaml
- Le répertoire courant contient un fichier
Gopkg.yml
- Le répertoire courant contient un fichier
Gopkg.lock
- Le répertoire courant contient un fichier
.go-version
- Le répertoire courant contient un répertoire
Godeps
- Le répertoire actuel contient un fichier avec l'extension
.go
Options
Option | Défaut | Description |
---|---|---|
format |
"via [$symbol($version )]($style)" |
Format du module. |
version_format |
"v${raw}" |
Le format de la version. Les variables disponibles sont raw , major , minor , & patch |
symbol |
"🐹 " |
Une chaîne de caractères représentant le symbole de Go. |
detect_extensions |
["go"] |
Quelles extensions devraient activer ce module. |
detect_files |
["go.mod", "go.sum", "glide.yaml", "Gopkg.yml", "Gopkg.lock", ".go-version"] |
Quels fichiers devraient activer ce module. |
detect_folders |
["Godeps"] |
Quels dossiers devraient activer ce module. |
style |
"bold cyan" |
Le style du module. |
disabled |
false |
Désactive le module golang . |
Variables
Variable | Exemple | Description |
---|---|---|
version | v1.12.1 |
La version de go |
symbol | Reflète la valeur de l'option symbol |
|
style* | Reflète la valeur de l'option style |
* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
Exemple
# ~/.config/starship.toml
[golang]
format = "via [🏎💨 $version](bold cyan) "
Helm
The helm
module shows the currently installed version of Helm. Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie:
- Le répertoire courant contient un fichier
helmfile.yaml
- Le répertoire courant contient un fichier
Chart.yml
Options
Option | Défaut | Description |
---|---|---|
format |
"via [$symbol($version )]($style)" |
Format du module. |
version_format |
"v${raw}" |
Le format de la version. Les variables disponibles sont raw , major , minor , & patch |
detect_extensions |
[] |
Quelles extensions devraient activer ce module. |
detect_files |
["helmfile.yaml", "Chart.yaml"] |
Quels fichiers devraient activer ce module. |
detect_folders |
[] |
Quels dossiers devraient activer ce module. |
symbol |
"⎈ " |
Une chaîne de format représentant le symbole de Helm. |
style |
"bold white" |
Le style du module. |
disabled |
false |
Désactive le module helm . |
Variables
Variable | Exemple | Description |
---|---|---|
version | v3.1.1 |
La version de helm |
symbol | Reflète la valeur de l'option symbol |
|
style* | Reflète la valeur de l'option style |
* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
Exemple
# ~/.config/starship.toml
[helm]
format = "via [⎈ $version](bold white) "
Nom d'hôte
The hostname
module shows the system hostname.
Options
Option | Défaut | Description |
---|---|---|
ssh_only |
true |
Afficher uniquement le nom d'hôte lorsque vous êtes connecté à une session SSH. |
trim_at |
"." |
Chaîne à laquelle le nom d'hôte est coupé, après la première correspondance. "." s'arrêtera après le premier point. "" désactivera toute troncature |
format |
"[$hostname]($style) in " |
Format du module. |
style |
"bold dimmed green" |
Le style du module. |
disabled |
false |
Désactive le module hostname . |
Variables
Variable | Exemple | Description |
---|---|---|
hostname | computer |
The hostname of the computer |
style* | Reflète la valeur de l'option style |
* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
Exemple
# ~/.config/starship.toml
[hostname]
ssh_only = false
format = "on [$hostname](bold red) "
trim_at = ".companyname.com"
disabled = false
Java
The java
module shows the currently installed version of Java. Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie:
- Le répertoire actuel contient un fichier
pom.xml
,build.gradle.kts
,build.sbt
,.java-version
,.deps.edn
,project.clj
, oubuild.boot
- Le répertoire actuel contient un fichier avec l'extension
.java
,.class
,. gradle
,.jar
,.clj
, ou.cljc
Options
Option | Défaut | Description |
---|---|---|
format |
"via [${symbol}(${version} )]($style)" |
Format du module. |
version_format |
"v${raw}" |
Le format de la version. Les variables disponibles sont raw , major , minor , & patch |
detect_extensions |
["java", "class", "gradle", "jar", "cljs", "cljc"] |
Quelles extensions devraient activer ce module. |
detect_files |
["pom.xml", "build.gradle.kts", "build.sbt", ".java-version", ".deps.edn", "project.clj", "build.boot"] |
Quels fichiers devraient activer ce module. |
detect_folders |
[] |
Quels dossiers devraient activer ce module. |
symbol |
"☕ " |
Une chaîne de caractères représentant le symbole de Java |
style |
"red dimmed" |
Le style du module. |
disabled |
false |
Désactive le module java . |
Variables
Variable | Exemple | Description |
---|---|---|
version | v14 |
La version de java |
symbol | Reflète la valeur de l'option symbol |
|
style* | Reflète la valeur de l'option style |
* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
Exemple
# ~/.config/starship.toml
[java]
symbol = "🌟 "
Jobs
The jobs
module shows the current number of jobs running. The module will be shown only if there are background jobs running. The module will show the number of jobs running if there are at least 2 jobs, or more than the number_threshold
config value, if it exists. The module will show a symbol if there is at least 1 job, or more than the symbol_threshold
config value, if it exists. You can set both values to 0 in order to always show the symbol and number of jobs, even if there are 0 jobs running.
The default functionality is:
- 0 jobs -> Nothing is shown.
- 1 job ->
symbol
is shown. - 2 jobs or more ->
symbol
+number
are shown.
::: warning
This module is not supported on tcsh and nu.
:::
::: warning
The threshold
option is deprecated, but if you want to use it, the module will show the number of jobs running if there is more than 1 job, or more than the threshold
config value, if it exists. If threshold
is set to 0, then the module will also show when there are 0 jobs running.
:::
Options
Option | Défaut | Description |
---|---|---|
threshold * |
1 |
Afficher le nombre de jobs si dépassé. |
symbol_threshold |
1 |
Show symbol if the job count is at least symbol_threshold . |
number_threshold |
2 |
Show the number of jobs if the job count is at least number_threshold . |
format |
"[$symbol$number]($style) " |
Format du module. |
symbol |
"✦" |
The string used to represent the symbol variable. |
style |
"bold blue" |
Le style du module. |
disabled |
false |
Désactive le module jobs . |
*: This option is deprecated, please use the |
number_threshold
and symbol_threshold
options instead.
Variables
Variable | Exemple | Description |
---|---|---|
number | 1 |
Le nombre de tâches |
symbol | Reflète la valeur de l'option symbol |
|
style* | Reflète la valeur de l'option style |
* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
Exemple
# ~/.config/starship.toml
[jobs]
symbol = "+ "
number_threshold = 4
symbol_threshold = 0
Julia
The julia
module shows the currently installed version of Julia. Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie:
- Le répertoire courant contient un fichier
Project.toml
- Le répertoire courant contient un fichier
Manifest.toml
- Le répertoire actuel contient un fichier avec l'extension
.jl
Options
Option | Défaut | Description |
---|---|---|
format |
"via [$symbol($version )]($style)" |
Format du module. |
version_format |
"v${raw}" |
Le format de la version. Les variables disponibles sont raw , major , minor , & patch |
detect_extensions |
["jl"] |
Quelles extensions devraient activer ce module. |
detect_files |
["Project.toml", "Manifest.toml"] |
Quels fichiers devraient activer ce module. |
detect_folders |
[] |
Quels dossiers devraient activer ce module. |
symbol |
"ஃ " |
Une chaîne de caractères représentant le symbole de Julia. |
style |
"bold purple" |
Le style du module. |
disabled |
false |
Désactive le module Julia . |
Variables
Variable | Exemple | Description |
---|---|---|
version | v1.4.0 |
La version de julia |
symbol | Reflète la valeur de l'option symbol |
|
style* | Reflète la valeur de l'option style |
* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
Exemple
# ~/.config/starship.toml
[julia]
symbol = "∴ "
Kotlin
The kotlin
module shows the currently installed version of Kotlin. Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie:
- Le répertoire courant contient un fichier
.kt
ou.kts
Options
Option | Défaut | Description |
---|---|---|
format |
"via [$symbol($version )]($style)" |
Format du module. |
version_format |
"v${raw}" |
Le format de la version. Les variables disponibles sont raw , major , minor , & patch |
detect_extensions |
["kt", "kts"] |
Quelles extensions devraient activer ce module. |
detect_files |
[] |
Quels fichiers devraient activer ce module. |
detect_folders |
[] |
Quels dossiers devraient activer ce module. |
symbol |
"🅺 " |
Une chaîne de caractères représentant le symbole de Kotlin. |
style |
"bold blue" |
Le style du module. |
kotlin_binary |
"kotlin" |
Configure le binaire kotlin que Starship exécute lors de l'obtention de la version. |
disabled |
false |
Désactive le module kotlin . |
Variables
Variable | Exemple | Description |
---|---|---|
version | v1.4.21 |
La version de kotlin |
symbol | Reflète la valeur de l'option symbol |
|
style* | Reflète la valeur de l'option style |
* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
Exemple
# ~/.config/starship.toml
[kotlin]
symbol = "🅺 "
# ~/.config/starship.toml
[kotlin]
# Uses the Kotlin Compiler binary to get the installed version
kotlin_binary = "kotlinc"
Kubernetes
Displays the current Kubernetes context name and, if set, the namespace from the kubeconfig file. The namespace needs to be set in the kubeconfig file, this can be done via kubectl config set-context starship-cluster --namespace astronaut
. If the $KUBECONFIG
env var is set the module will use that if not it will use the ~/.kube/config
.
::: tip
This module is disabled by default. To enable it, set disabled
to false
in your configuration file.
:::
Options
Option | Défaut | Description |
---|---|---|
symbol |
"☸ " |
Une chaîne de format représentant le symbole affiché avant le Cluster. |
format |
'[$symbol$context( \($namespace\))]($style) in ' |
Format du module. |
style |
"cyan bold" |
Le style du module. |
context_aliases |
Tableau des alias de contexte à afficher. | |
disabled |
true |
Désactiver le module kubernetes . |
Variables
Variable | Exemple | Description |
---|---|---|
context | starship-cluster |
Le contexte kubernetes actuel |
namespace | starship-namespace |
Si défini, l'espace de noms actuel de kubernetes |
symbol | Reflète la valeur de l'option symbol |
|
style* | Reflète la valeur de l'option style |
* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
Exemple
# ~/.config/starship.toml
[kubernetes]
format = 'on [⛵ $context \($namespace\)](dimmed green) '
disabled = false
[kubernetes.context_aliases]
"dev.local.cluster.k8s" = "dev"
".*/openshift-cluster/.*" = "openshift"
"gke_.*_(?P<cluster>[\\w-]+)" = "gke-$cluster"
Regex Matching
Additional to simple aliasing, context_aliases
also supports extended matching and renaming using regular expressions.
The regular expression must match on the entire kube context, capture groups can be referenced using $name
and $N
in the replacement. This is more explained in the regex crate documentation.
Long and automatically generated cluster names can be identified and shortened using regular expressions:
[kubernetes.context_aliases]
# OpenShift contexts carry the namespace and user in the kube context: `namespace/name/user`:
".*/openshift-cluster/.*" = "openshift"
# Or better, to rename every OpenShift cluster at once:
".*/(?P<cluster>[\\w-]+)/.*" = "$cluster"
# Contexts from GKE, AWS and other cloud providers usually carry additional information, like the region/zone.
# The following entry matches on the GKE format (`gke_projectname_zone_cluster-name`)
# and renames every matching kube context into a more readable format (`gke-cluster-name`):
"gke_.*_(?P<cluster>[\\w-]+)" = "gke-$cluster"
Saut de ligne
The line_break
module separates the prompt into two lines.
Options
Option | Défaut | Description |
---|---|---|
disabled |
false |
Désactive le module line_break , faisant de l'invite une seule ligne. |
Exemple
# ~/.config/starship.toml
[line_break]
disabled = true
Lua
The lua
module shows the currently installed version of Lua. Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie:
- Le répertoire courant contient un fichier
.lua-version
- Le répertoire courant contient un répertoire
lua
- Le répertoire actuel contient un fichier avec l'extension
.lua
Options
Option | Défaut | Description |
---|---|---|
format |
"via [$symbol($version )]($style)" |
Format du module. |
version_format |
"v${raw}" |
Le format de la version. Les variables disponibles sont raw , major , minor , & patch |
symbol |
"🌙 " |
Une chaîne de caractères représentant le symbole de Lua. |
detect_extensions |
["lua"] |
Quelles extensions devraient activer ce module. |
detect_files |
[".lua-version"] |
Quels fichiers devraient activer ce module. |
detect_folders |
["lua"] |
Quels dossiers devraient activer ce module. |
style |
"bold blue" |
Le style du module. |
lua_binary |
"lua" |
Configure le binaire lua que Starship exécute lors de l'obtention de la version. |
disabled |
false |
Désactive le module lua . |
Variables
Variable | Exemple | Description |
---|---|---|
version | v5.4.0 |
La version de lua |
symbol | Reflète la valeur de l'option symbol |
|
style* | Reflète la valeur de l'option style |
* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
Exemple
# ~/.config/starship.toml
[lua]
format = "via [🌕 $version](bold blue) "
Utilisation mémoire
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.
:::
Options
Option | Défaut | Description |
---|---|---|
threshold |
75 |
Masquer l'utilisation de la mémoire à moins qu'elle ne dépasse ce pourcentage. |
format |
"via $symbol [${ram}( | ${swap})]($style) " |
Format du module. |
symbol |
"🐏" |
Le symbole utilisé avant d'afficher l'utilisation de la mémoire. |
style |
"bold dimmed white" |
Le style du module. |
disabled |
true |
Désactiver le module memory_usage . |
Variables
Variable | Exemple | Description |
---|---|---|
ram | 31GiB/65GiB |
La mémoire système utilisée/totale . |
ram_pct | 48% |
Le pourcentage de la mémoire du système actuel. |
swap** | 1GiB/4GiB |
La taille de la mémoire swap du fichier de mémoire swap du système courant. |
swap_pct** | 77% |
Le poucentage de la mémoire swap du fichier de mémoire swap du système courant. |
symbol | 🐏 |
Reflète la valeur de l'option symbol |
style* | Reflète la valeur de l'option style |
*: This variable can only be used as a part of a style string **: The SWAP file information is only displayed if detected on the current system
Exemple
# ~/.config/starship.toml
[memory_usage]
disabled = false
threshold = -1
symbol = " "
style = "bold dimmed green"
Branche Mercurial
The hg_branch
module shows the active branch of the repo in your current directory.
Options
Option | Défaut | Description |
---|---|---|
symbol |
" " |
Le symbole utilisé avant le marque-page hg ou le nom de la branche du dépôt dans votre répertoire courant. |
style |
"bold purple" |
Le style du module. |
format |
"on [$symbol$branch]($style) " |
Format du module. |
truncation_length |
2^63 - 1 |
Tronque le nom de la branche hg à N graphèmes |
truncation_symbol |
"…" |
Le symbole utilisé pour indiquer qu'un nom de branche a été tronqué. |
disabled |
true |
Désactive le module hg_branch . |
Variables
Variable | Exemple | Description |
---|---|---|
branch | master |
La branche mercuriale active |
symbol | Reflète la valeur de l'option symbol |
|
style* | Reflète la valeur de l'option style |
* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
Exemple
# ~/.config/starship.toml
[hg_branch]
format = "on [🌱 $branch](bold purple)"
truncation_length = 4
truncation_symbol = ""
Nim
The nim
module shows the currently installed version of Nim. Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie:
- Le répertoire courant contient un fichier
nim.cfg
- Le répertoire actuel contient un fichier avec l'extension
.nim
- Le répertoire actuel contient un fichier avec l'extension
.nims
- Le répertoire actuel contient un fichier avec l'extension
.nimble
Options
Option | Défaut | Description |
---|---|---|
format |
"via [$symbol($version )]($style)" |
Format du module |
version_format |
"v${raw}" |
Le format de la version. Les variables disponibles sont raw , major , minor , & patch |
symbol |
"👑 " |
Le symbole utilisé avant d'afficher la version de Nim. |
detect_extensions |
["nim", "nims", "nimble"] |
Quelles extensions devraient activer ce module. |
detect_files |
["nim.cfg"] |
Quels fichiers devraient activer ce module. |
detect_folders |
[] |
Quels dossiers devraient activer ce module. |
style |
"bold yellow" |
Le style du module. |
disabled |
false |
Désactive le module nim . |
Variables
Variable | Exemple | Description |
---|---|---|
version | v1.2.0 |
La version de nim |
symbol | Reflète la valeur de l'option symbol |
|
style* | Reflète la valeur de l'option style |
* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
Exemple
# ~/.config/starship.toml
[nim]
style = "yellow"
symbol = "🎣 "
Nix-shell
The nix_shell
module shows the nix-shell environment. The module will be shown when inside a nix-shell environment.
Options
Option | Défaut | Description |
---|---|---|
format |
'via [$symbol$state( \($name\))]($style) ' |
Format du module. |
symbol |
"❄️ " |
Une chaîne de format représentant le symbole de nix-shell. |
style |
"bold blue" |
Le style du module. |
impure_msg |
"impure" |
Une chaîne de format affichée lorsque le shell est impur. |
pure_msg |
"pure" |
Une chaîne de format affichée lorsque le shell est pur. |
disabled |
false |
Désactive le module nix_shell . |
Variables
Variable | Exemple | Description |
---|---|---|
state | pure |
The state of the nix-shell |
name | lorri |
The name of the nix-shell |
symbol | Reflète la valeur de l'option symbol |
|
style* | Reflète la valeur de l'option style |
* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
Exemple
# ~/.config/starship.toml
[nix_shell]
disabled = true
impure_msg = "[impure shell](bold red)"
pure_msg = "[pure shell](bold green)"
format = 'via [☃️ $state( \($name\))](bold blue) '
Node.js
The nodejs
module shows the currently installed version of Node.js. Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie:
- Le répertoire courant contient un fichier
package.json
- Le répertoire courant contient un fichier
.node-version
- Le répertoire courant contient un fichier
.nvmrc
- Le répertoire courant contient un répertoire
node_modules
- Le répertoire actuel contient un fichier avec l'extension
.js
,.mjs
ou.cjs
- Le répertoire actuel contient un fichier avec l'extension
.ts
Options
Option | Défaut | Description |
---|---|---|
format |
"via [$symbol($version )]($style)" |
Format du module. |
version_format |
"v${raw}" |
Le format de la version. Les variables disponibles sont raw , major , minor , & patch |
symbol |
" " |
Une chaîne de caractères représentant le symbole de Node.js. |
detect_extensions |
["js", "mjs", "cjs", "ts"] |
Quelles extensions devraient activer ce module. |
detect_files |
["package.json", ".node-version"] |
Quels fichiers devraient activer ce module. |
detect_folders |
["node_modules"] |
Quels dossiers devraient activer ce module. |
style |
"bold green" |
Le style du module. |
disabled |
false |
Désactive le module nodejs . |
not_capable_style |
bold red |
The style for the module when an engines property in package.json does not match the Node.js version. |
Variables
Variable | Exemple | Description |
---|---|---|
version | v13.12.0 |
La version de node |
symbol | Reflète la valeur de l'option symbol |
|
style* | Reflète la valeur de l'option style |
* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
Exemple
# ~/.config/starship.toml
[nodejs]
format = "via [🤖 $version](bold green) "
OCaml
The ocaml
module shows the currently installed version of OCaml. Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie:
- Le répertoire courant contient un fichier avec l'extension
.opam
ou le répertoire_opam
- Le répertoire courant contient un répertoire
esy.lock
- Le répertoire courant contient un fichier
dune
oudune-project
- Le répertoire courant contient un fichier
jbuild
oujbuild-ignore
- Le répertoire courant contient un fichier
.merlin
- Le répertoire actuel contient un fichier avec l'extension
.ml
,.mli
,.re
ou.rei
Options
Option | Défaut | Description |
---|---|---|
format |
"via [$symbol($version )(\($switch_indicator$switch_name\) )]($style)" |
La chaîne de format pour le module. |
version_format |
"v${raw}" |
Le format de la version. Les variables disponibles sont raw , major , minor , & patch |
symbol |
"🐫 " |
Le symbole utilisé avant d'afficher la version de OCaml. |
global_switch_indicator |
"" |
La chaîne de caractères utilisée pour représenter le commutateur OPAM global. |
local_switch_indicator |
"*" |
La chaîne de caractères utilisée pour représenter le commutateur OPAM local. |
detect_extensions |
["opam", "ml", "mli", "re", "rei"] |
Quelles extensions devraient activer ce module. |
detect_files |
["dune", "dune-project", "jbuild", "jbuild-ignore", ".merlin"] |
Quels fichiers devraient activer ce module. |
detect_folders |
["_opam", "esy.lock"] |
Quels dossiers devraient activer ce module. |
style |
"bold yellow" |
Le style du module. |
disabled |
false |
Désactive le module ocaml . |
Variables
Variable | Exemple | Description |
---|---|---|
version | v4.10.0 |
La version de ocaml |
switch_name | my-project |
The active OPAM switch |
switch_indicator | Mirrors the value of indicator for currently active OPAM switch |
|
symbol | Reflète la valeur de l'option symbol |
|
style* | Reflète la valeur de l'option style |
* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
Exemple
# ~/.config/starship.toml
[ocaml]
format = "via [🐪 $version]($style) "
OpenStack
The openstack
module shows the current OpenStack cloud and project. The module only active when the OS_CLOUD
env var is set, in which case it will read clouds.yaml
file from any of the default locations. to fetch the current project in use.
Options
Option | Défaut | Description |
---|---|---|
format |
"on [$symbol$cloud(\\($project\\))]($style) " |
Format du module. |
symbol |
"☁️ " |
Le symbole utilisé avant d'afficher le cloud OpenStack actuel. |
style |
"bold yellow" |
Le style du module. |
disabled |
false |
Désactive le module openstack . |
Variables
Variable | Exemple | Description |
---|---|---|
cloud | corp |
The current OpenStack cloud |
project | dev |
The current OpenStack project |
symbol | Reflète la valeur de l'option symbol |
|
style* | Reflète la valeur de l'option style |
* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
Exemple
# ~/.config/starship.toml
[openstack]
format = "on [$symbol$cloud(\\($project\\))]($style) "
style = "bold yellow"
symbol = "☁️ "
Version du paquet
The package
module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports npm
, nimble
, cargo
, poetry
, composer
, gradle
, julia
, mix
, helm
, shards
and dart
packages.
- npm – La version du paquet
npm
est extraite dupackage.json
présent dans le répertoire courant - Cargo – La version du paquet
cargo
est extraite duCargo.toml
présent dans le répertoire courant - Nimble - La version du paquet
nimble
est extraite du fichier*.nimble
dans le répertoire courant avec la commandenimble dump
- Poetry – La version du paquet
poetry
est extraite dupyproject.toml
présent dans le répertoire courant - Python - La version du paquet
python
est extraite dusetup.cfg
présent dans le répertoire courant - Composer – La version du paquet
composer
est extraite ducomposer.json
présent dans le répertoire courant - Gradle – The
gradle
package version is extracted from thebuild.gradle
present - Julia - The package version is extracted from the
Project.toml
present - Mix - The
mix
package version is extracted from themix.exs
present - Helm - The
helm
chart version is extracted from theChart.yaml
present - Maven - The
maven
package version is extracted from thepom.xml
present - Meson - The
meson
package version is extracted from themeson.build
present - Shards - The
shards
package version is extracted from theshard.yml
present - V - The
vlang
package version is extracted from thev.mod
present - SBT - The
sbt
package version is extracted from thebuild.sbt
present in the current directory - Dart – La version du paquet
dart
est extrait dupubspec.yaml
présent dans le répertoire courant
⚠️ La version montrée est celle du paquet dont le code source est dans votre répertoire courant, pas votre gestionnaire de paquet.
Options
Option | Défaut | Description |
---|---|---|
format |
"is [$symbol$version]($style) " |
Format du module. |
symbol |
"📦 " |
Le symbole utilisé avant d'afficher la version du paquet. |
version_format |
"v${raw}" |
Le format de la version. Les variables disponibles sont raw , major , minor , & patch |
style |
"bold 208" |
Le style du module. |
display_private |
false |
Enable displaying version for packages marked as private. |
disabled |
false |
Désactive le module package . |
Variables
Variable | Exemple | Description |
---|---|---|
version | v1.0.0 |
La version de votre package |
symbol | Reflète la valeur de l'option symbol |
|
style* | Reflète la valeur de l'option style |
* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
Exemple
# ~/.config/starship.toml
[package]
format = "via [🎁 $version](208 bold) "
Perl
The perl
module shows the currently installed version of Perl. Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie:
- Le répertoire courant contient un fichier
Makefile.PL
ouBuild.PL
- Le répertoire courant contient un fichier
cpanfile
oucpanfile.snapshot
- Le répertoire courant contient un fichier
META.json
ouMETA.yml
- Le répertoire courant contient un fichier
.perl-version
- Le répertoire courant contient un fichier
.pl
,.pm
ou.pod
Options
Option | Défaut | Description |
---|---|---|
format |
"via [$symbol($version )]($style)" |
La chaîne de format pour le module. |
version_format |
"v${raw}" |
Le format de la version. Les variables disponibles sont raw , major , minor , & patch |
symbol |
"🐪 " |
Le symbole utilisé avant d'afficher la version de Perl |
detect_extensions |
["pl", "pm", "pod"] |
Quelles extensions devraient activer ce module. |
detect_files |
["Makefile.PL", "Build.PL", "cpanfile", "cpanfile.snapshot", "META.json", "META.yml", ".perl-version"] |
Quels fichiers devraient activer ce module. |
detect_folders |
[] |
Quels dossiers devraient activer ce module. |
style |
"bold 149" |
Le style du module. |
disabled |
false |
Désactive le module perl . |
Variables
Variable | Exemple | Description |
---|---|---|
version | v5.26.1 |
La version de perl |
symbol | Reflète la valeur de l'option symbol |
|
style* | Reflète la valeur de l'option style |
Exemple
# ~/.config/starship.toml
[perl]
format = "via [🦪 $version]($style) "
PHP
The php
module shows the currently installed version of PHP. Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie:
- Le répertoire courant contient un fichier
composer.json
- Le répertoire courant contient un fichier
.php-version
- Le répertoire courant contient un fichier avec l'extension
.php
Options
Option | Défaut | Description |
---|---|---|
format |
"via [$symbol($version )]($style)" |
Format du module. |
version_format |
"v${raw}" |
Le format de la version. Les variables disponibles sont raw , major , minor , & patch |
symbol |
"🐘 " |
Le symbole utilisé avant d'afficher la version de PHP. |
detect_extensions |
["php"] |
Quelles extensions devraient activer ce module. |
detect_files |
["composer.json", ".php-version"] |
Quels fichiers devraient activer ce module. |
detect_folders |
[] |
Quels dossiers devraient activer ce module. |
style |
"147 bold" |
Le style du module. |
disabled |
false |
Désactive le module php . |
Variables
Variable | Exemple | Description |
---|---|---|
version | v7.3.8 |
La version de php |
symbol | Reflète la valeur de l'option symbol |
|
style* | Reflète la valeur de l'option style |
* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
Exemple
# ~/.config/starship.toml
[php]
format = "via [🔹 $version](147 bold) "
Pulumi
The pulumi
module shows the currently selected Pulumi Stack and version.
::: tip
By default the Pulumi version is not shown, since it takes an order of magnitude longer to load then most plugins (~70ms). If you still want to enable it, follow the example shown below.
:::
Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie:
- The current directory contains either
Pulumi.yaml
orPulumi.yml
- A parent directory contains either
Pulumi.yaml
orPulumi.yml
Options
Option | Défaut | Description |
---|---|---|
format |
"via [$symbol$stack]($style) " |
La chaîne de format pour le module. |
version_format |
"v${raw}" |
Le format de la version. Les variables disponibles sont raw , major , minor , & patch |
symbol |
" " |
A format string shown before the Pulumi stack. |
style |
"bold 5" |
Le style du module. |
disabled |
false |
Disables the pulumi module. |
Variables
Variable | Exemple | Description |
---|---|---|
version | v0.12.24 |
The version of pulumi |
stack | dev |
The current Pulumi stack |
symbol | Reflète la valeur de l'option symbol |
|
style* | Reflète la valeur de l'option style |
* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
Exemple
With Pulumi Version
# ~/.config/starship.toml
[pulumi]
format = "[🛥 ($version )$stack]($style) "
Without Pulumi version
# ~/.config/starship.toml
[pulumi]
symbol = "🛥 "
format = "[$symbol$stack]($style) "
PureScript
The purescript
module shows the currently installed version of PureScript version. Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie:
- Le répertoire courant contient un fichier
spago.dhall
- Le répertoire actuel contient un fichier avec l'extension
.purs
Options
Option | Défaut | Description |
---|---|---|
format |
"via [$symbol($version )]($style)" |
Format du module. |
version_format |
"v${raw}" |
Le format de la version. Les variables disponibles sont raw , major , minor , & patch |
symbol |
"<=> " |
Le symbole utilisé avant d'afficher la version de PureScript. |
detect_extensions |
["purs"] |
Quelles extensions devraient activer ce module. |
detect_files |
["spago.dhall"] |
Quels fichiers devraient activer ce module. |
detect_folders |
[] |
Quels dossiers devraient activer ce module. |
style |
"bold white" |
Le style du module. |
disabled |
false |
Désactive le module purescript . |
Variables
Variable | Exemple | Description |
---|---|---|
version | 0.13.5 |
La version de purescript |
symbol | Reflète la valeur de l'option symbol |
|
style* | Reflète la valeur de l'option style |
* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
Exemple
# ~/.config/starship.toml
[purescript]
format = "via [$symbol$version](bold white)"
Python
The python
module shows the currently installed version of Python and the current Python virtual environment if one is activated.
If pyenv_version_name
is set to true
, it will display the pyenv version name. Otherwise, it will display the version number from python --version
.
Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie:
- Le répertoire courant contient un fichier
.python-version
- Le répertoire courant contient un fichier
Pipfile
- Le répertoire courant contient un fichier
__init__.py
- Le répertoire courant contient un fichier
pyproject.toml
- Le répertoire courant contient un fichier
requirements.txt
- Le répertoire courant contient un fichier
setup.py
- Le répertoire courant contient un fichier
tox.ini
- Le répertoire actuel contient un fichier avec l'extension
.py
. - Un environnement virtuel est actuellement activé
Options
Option | Défaut | Description |
---|---|---|
format |
'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\) )]($style)' |
Format du module. |
version_format |
"v${raw}" |
Le format de la version. Les variables disponibles sont raw , major , minor , & patch |
symbol |
"🐍 " |
Une chaîne de caractères représentant le symbole de Python |
style |
"yellow bold" |
Le style du module. |
pyenv_version_name |
false |
Use pyenv to get Python version |
pyenv_prefix |
pyenv |
Prefix before pyenv version display, only used if pyenv is used |
python_binary |
["python", "python3", "python2"] |
Configures the python binaries that Starship should executes when getting the version. |
detect_extensions |
["py"] |
Quelles extensions devraient activer ce module |
detect_files |
[".python-version", "Pipfile", "__init__.py", "pyproject.toml", "requirements.txt", "setup.py", "tox.ini"] |
Quels fichiers devraient activer ce module |
detect_folders |
[] |
Quels dossiers devraient activer ce module |
disabled |
false |
Désactive le module python . |
::: tip
The python_binary
variable accepts either a string or a list of strings. Starship will try executing each binary until it gets a result. Note you can only change the binary that Starship executes to get the version of Python not the arguments that are used.
The default values and order for python_binary
was chosen to first identify the Python version in a virtualenv/conda environments (which currently still add a python
, no matter if it points to python3
or python2
). This has the side effect that if you still have a system Python 2 installed, it may be picked up before any Python 3 (at least on Linux Distros that always symlink /usr/bin/python
to Python 2). If you do not work with Python 2 anymore but cannot remove the system Python 2, changing this to "python3"
will hide any Python version 2, see example below.
:::
Variables
Variable | Exemple | Description |
---|---|---|
version | "v3.8.1" |
La version de python |
symbol | "🐍 " |
Reflète la valeur de l'option symbol |
style | "yellow bold" |
Reflète la valeur de l'option style |
pyenv_prefix | "pyenv " |
Mirrors the value of option pyenv_prefix |
virtualenv | "venv" |
The current virtualenv name |
Exemple
# ~/.config/starship.toml
[python]
symbol = "👾 "
pyenv_version_name = true
# ~/.config/starship.toml
[python]
# Only use the `python3` binary to get the version.
python_binary = "python3"
# ~/.config/starship.toml
[python]
# Don't trigger for files with the py extension
detect_extensions = []
# ~/.config/starship.toml
[python]
# Display the version of python from inside a local venv.
#
# Note this will only work when the venv is inside the project and it will only
# work in the directory that contains the venv dir but maybe this is ok?
python_binary = ["./venv/bin/python", "python", "python3", "python2"]
R
The rlang
module shows the currently installed version of R. The module will be shown if any of the following conditions are met:
- Le répertoire actuel contient un fichier avec l'extension
.R
. - Le répertoire actuel contient un fichier avec l'extension
.Rd
. - Le répertoire actuel contient un fichier avec l'extension
.Rmd
. - Le répertoire actuel contient un fichier avec l'extension
.Rproj
. - Le répertoire actuel contient un fichier avec l'extension
.Rsx
. - Le répertoire courant contient un fichier
.Rprofile
- Le répertoire courant contient un dossier
.Rproj.user
Options
Option | Défaut | Description |
---|---|---|
format |
"via [$symbol($version )]($style)" |
Format du module. |
version_format |
"v${raw}" |
Le format de la version. Les variables disponibles sont raw , major , minor , & patch |
symbol |
"📐" |
Une chaîne de caractères représentant le symbole de R. |
style |
"blue bold" |
Le style du module. |
detect_extensions |
["R", "Rd", "Rmd", "Rproj", "Rsx"] |
Quelles extensions devraient activer ce module |
detect_files |
[".Rprofile"] |
Quels fichiers devraient activer ce module |
detect_folders |
[".Rproj.user"] |
Quels dossiers devraient activer ce module |
disabled |
false |
Désactive le module r . |
Variables
Variable | Exemple | Description |
---|---|---|
version | v4.0.5 |
La version de R |
symbol | Reflète la valeur de l'option symbol |
|
style | "blue bold" |
Reflète la valeur de l'option style |
Exemple
# ~/.config/starship.toml
[rlang]
format = "with [📐 $version](blue bold) "
Red
By default the red
module shows the currently installed version of Red. Le module est affiché si l'une de ces conditions est remplie :
- Le répertoire actuel contient un fichier avec l'extension
.red
ou.reds
Options
Option | Défaut | Description |
---|---|---|
format |
"via [$symbol($version )]($style)" |
Format du module. |
version_format |
"v${raw}" |
Le format de la version. Les variables disponibles sont raw , major , minor , & patch |
symbol |
"🔺 " |
Une chaîne de caractères représentant le symbole de Red. |
detect_extensions |
["red"] |
Quelles extensions devraient activer ce module. |
detect_files |
[] |
Quels fichiers devraient activer ce module. |
detect_folders |
[] |
Quels dossiers devraient activer ce module. |
style |
"red bold" |
Le style du module. |
disabled |
false |
Désactive le module red . |
Variables
Variable | Exemple | Description |
---|---|---|
version | v2.5.1 |
La version de red |
symbol | Reflète la valeur de l'option symbol |
|
style* | Reflète la valeur de l'option style |
* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
Exemple
# ~/.config/starship.toml
[red]
symbol = "🔴 "
Ruby
By default the ruby
module shows the currently installed version of Ruby. Le module est affiché si l'une de ces conditions est remplie :
- Le répertoire courant contient un fichier
Gemfile
- Le répertoire courant contient un fichier
.ruby-version
- Le répertoire courant contient un fichier
.rb
- La variable d’environnement
RUBY_VERSION
ouRBENV_VERSION
est définie
Starship gets the current Ruby version by running ruby -v
.
Options
Option | Défaut | Description |
---|---|---|
format |
"via [$symbol($version )]($style)" |
Format du module. |
version_format |
"v${raw}" |
Le format de la version. Les variables disponibles sont raw , major , minor , & patch |
symbol |
"💎 " |
Une chaîne de caractères représentant le symbole de Ruby. |
detect_extensions |
["rb"] |
Les extensions qui activent ce module. |
detect_files |
["Gemfile", ".ruby-version"] |
Les fichiers qui activent ce module. |
detect_folders |
[] |
Les dossiers qui activent ce module. |
detect_variables |
["RUBY_VERSION", "RBENV_VERSION"] |
Les variables d’environnement qui activent ce module. |
style |
"bold green" |
Le style du module. |
disabled |
false |
Désactive le module ruby . |
Variables
Variable | Exemple | Description |
---|---|---|
version | v2.5.1 |
La version de ruby |
symbol | Reflète la valeur de l'option symbol |
|
style* | Reflète la valeur de l'option style |
* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
Exemple
# ~/.config/starship.toml
[ruby]
symbol = "🔺 "
Rust
By default the rust
module shows the currently installed version of Rust. Le module est affiché si l'une de ces conditions est remplie :
- Le répertoire courant contient un fichier
Cargo.toml
- Le répertoire actuel contient un fichier avec l'extension
.rs
Options
Option | Défaut | Description |
---|---|---|
format |
"via [$symbol($version )]($style)" |
Format du module. |
version_format |
"v${raw}" |
Le format de la version. Les variables disponibles sont raw , major , minor , & patch |
symbol |
"🦀 " |
Une chaîne de caractères représentant le symbole de Rust |
detect_extensions |
["rs"] |
Quelles extensions devraient activer ce module. |
detect_files |
["Cargo.toml"] |
Quels fichiers devraient activer ce module. |
detect_folders |
[] |
Quels dossiers devraient activer ce module. |
style |
"bold green" |
Le style du module. |
disabled |
false |
Désactive le module rust . |
Variables
Variable | Exemple | Description |
---|---|---|
version | v1.43.0-nightly |
La version de rustc |
symbol | Reflète la valeur de l'option symbol |
|
style* | Reflète la valeur de l'option style |
* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
Exemple
# ~/.config/starship.toml
[rust]
format = "via [⚙️ $version](red bold)"
Scala
The scala
module shows the currently installed version of Scala. Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie:
- Le répertoire courant contient un fichier
build.sbt
,.scalaenv
ou.sbtenv
- Le répertoire actuel contient un fichier avec l'extension
.scala
ou.sbt
- Le répertoire courant contient un répertoire nommé
.metals
Options
Option | Défaut | Description |
---|---|---|
format |
"via [${symbol}(${version} )]($style)" |
Format du module. |
version_format |
"v${raw}" |
Le format de la version. Les variables disponibles sont raw , major , minor , & patch |
detect_extensions |
["sbt", "scala"] |
Quelles extensions devraient activer ce module. |
detect_files |
[".scalaenv", ".sbtenv", "build.sbt"] |
Quels fichiers devraient activer ce module. |
detect_folders |
[".metals"] |
Quels dossiers devraient activer ce module. |
symbol |
"🆂 " |
Une chaîne de caractères représentant le symbole de Scala. |
style |
"red dimmed" |
Le style du module. |
disabled |
false |
Désactive le module scala . |
Variables
Variable | Exemple | Description |
---|---|---|
version | 2.13.5 |
La version de scala |
symbol | Reflète la valeur de l'option symbol |
|
style* | Reflète la valeur de l'option style |
* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
Exemple
# ~/.config/starship.toml
[scala]
symbol = "🌟 "
Shell
The shell
module shows an indicator for currently used shell.
::: tip
This module is disabled by default. To enable it, set disabled
to false
in your configuration file.
:::
Options
Option | Défaut | Description |
---|---|---|
bash_indicator |
bsh |
Une chaîne de format utilisée pour représenter bash. |
fish_indicator |
fsh |
Une chaîne de format utilisée pour représenter fish. |
zsh_indicator |
zsh |
Une chaîne de format utilisée pour représenter zsh. |
powershell_indicator |
psh |
Une chaîne de format utilisée pour représenter powershell. |
ion_indicator |
ion |
Une chaîne de format utilisée pour représenter ion. |
elvish_indicator |
esh |
Une chaîne de format utilisée pour représenter elvish. |
tcsh_indicator |
tsh |
Une chaîne de format utilisée pour représenter tcsh. |
xonsh_indicator |
xsh |
A format string used to represent xonsh. |
cmd_indicator |
cmd |
A format string used to represent cmd. |
nu_indicator |
nu |
A format string used to represent nu. |
unknown_indicator |
The default value to be displayed when the shell is unknown. | |
format |
"[$indicator]($style) " |
Format du module. |
style |
"white bold" |
Le style du module. |
disabled |
true |
Disables the shell module. |
Variables
Variable | Défaut | Description |
---|---|---|
indicator | Mirrors the value of indicator for currently used shell. |
|
style* | Reflète la valeur de l'option style . |
* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
Exemples
# ~/.config/starship.toml
[shell]
fish_indicator = ""
powershell_indicator = "_"
unknown_indicator = "mystery shell"
style = "cyan bold"
disabled = false
SHLVL
The shlvl
module shows the current SHLVL
("shell level") environment variable, if it is set to a number and meets or exceeds the specified threshold.
Options
Option | Défaut | Description |
---|---|---|
threshold |
2 |
Display threshold. |
format |
"[$symbol$shlvl]($style) " |
Format du module. |
symbol |
"↕️ " |
The symbol used to represent the SHLVL . |
repeat |
false |
Causes symbol to be repeated by the current SHLVL amount. |
style |
"bold yellow" |
Le style du module. |
disabled |
true |
Désactive le module shlvl . |
Variables
Variable | Exemple | Description |
---|---|---|
shlvl | 3 |
The current value of SHLVL |
symbol | Reflète la valeur de l'option symbol |
|
style* | Reflète la valeur de l'option style |
* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
Exemple
# ~/.config/starship.toml
[shlvl]
disabled = false
format = "$shlvl level(s) down"
threshold = 3
Singularity
The singularity
module shows the current Singularity image, if inside a container and $SINGULARITY_NAME
is set.
Options
Option | Défaut | Description |
---|---|---|
format |
'[$symbol\[$env\]]($style) ' |
Format du module. |
symbol |
"" |
Une chaîne de format affichée avant le nom de l'image. |
style |
"bold dimmed blue" |
Le style du module. |
disabled |
false |
Désactive le module singularity . |
Variables
Variable | Exemple | Description |
---|---|---|
env | centos.img |
The current Singularity image |
symbol | Reflète la valeur de l'option symbol |
|
style* | Reflète la valeur de l'option style |
* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
Exemple
# ~/.config/starship.toml
[singularity]
format = '[📦 \[$env\]]($style) '
Status
The status
module displays the exit code of the previous command. The module will be shown only if the exit code is not 0
.
::: tip
This module is disabled by default. To enable it, set disabled
to false
in your configuration file.
:::
::: warning This module is not supported on nu shell. :::
Options
Option | Défaut | Description |
---|---|---|
format |
"[$symbol$status]($style) " |
The format of the module |
symbol |
"✖" |
The symbol displayed on program error |
success_symbol |
"✔️" |
The symbol displayed on program success |
not_executable_symbol |
"🚫" |
The symbol displayed when file isn't executable |
not_found_symbol |
"🔍" |
The symbol displayed when the command can't be found |
sigint_symbol |
"🧱" |
The symbol displayed on SIGINT (Ctrl + c) |
signal_symbol |
"⚡" |
The symbol displayed on any signal |
style |
"bold green" |
Le style du module. |
recognize_signal_code |
true |
Enable signal mapping from exit code |
map_symbol |
false |
Enable symbols mapping from exit code |
pipestatus |
false |
Enable pipestatus reporting |
pipestatus_separator |
` | ` |
pipestatus_format |
\\[$pipestatus\\] => [$symbol$common_meaning$signal_name$maybe_int]($style) |
The format of the module when the command is a pipeline |
disabled |
true |
Désactiver le module status . |
Variables
Variable | Exemple | Description |
---|---|---|
status | 127 |
Le code de sortie de la dernière commande |
hex_status | 0x7F |
Le code de sortie de la dernière commande en hexa |
int | 127 |
Le code de sortie de la dernière commande |
common_meaning | ERROR |
Signification du code si n’est pas un signal |
signal_number | 9 |
Signal number corresponding to the exit code, only if signalled |
signal_name | KILL |
Name of the signal corresponding to the exit code, only if signalled |
maybe_int | 7 |
Contains the exit code number when no meaning has been found |
pipestatus | Rendering of in pipeline programs's exit codes, this is only available in pipestatus_format | |
symbol | Reflète la valeur de l'option symbol |
|
style* | Reflète la valeur de l'option style |
* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
Exemple
# ~/.config/starship.toml
[status]
style = "bg:blue"
symbol = "🔴"
format = '[\[$symbol $common_meaning$signal_name$maybe_int\]]($style) '
map_symbol = true
disabled = false
Sudo
The sudo
module displays if sudo credentials are currently cached. The module will only be shown if credentials are cached.
::: tip
This module is disabled by default. To enable it, set disabled
to false
in your configuration file.
:::
Options
Option | Défaut | Description |
---|---|---|
format |
[as $symbol]($style)" |
The format of the module |
symbol |
"🧙 " |
The symbol displayed when credentials are cached |
style |
"bold blue" |
Le style du module. |
allow_windows |
false |
Since windows has no default sudo, default is disabled. |
disabled |
true |
Disables the sudo module. |
Variables
Variable | Exemple | Description |
---|---|---|
symbol | Reflète la valeur de l'option symbol |
|
style* | Reflète la valeur de l'option style |
* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
Exemple
# ~/.config/starship.toml
[sudo]
style = "bold green"
symbol = "👩💻 "
disabled = false
# On windows
# $HOME\.starship\config.toml
[sudo]
allow_windows = true
disabled = false
Swift
By default the swift
module shows the currently installed version of Swift. Le module est affiché si l'une de ces conditions est remplie :
- Le répertoire courant contient un fichier
Package.swift
- Le répertoire actuel contient un fichier avec l'extension
.swift
Options
Option | Défaut | Description |
---|---|---|
format |
"via [$symbol($version )]($style)" |
Format du module. |
version_format |
"v${raw}" |
Le format de la version. Les variables disponibles sont raw , major , minor , & patch |
symbol |
"🐦 " |
Une chaîne de caractères représentant le symbole de Swift |
detect_extensions |
["swift"] |
Quelles extensions devraient activer ce module. |
detect_files |
["Package.swift"] |
Quels fichiers devraient activer ce module. |
detect_folders |
[] |
Quels dossiers devraient activer ce module. |
style |
"bold 202" |
Le style du module. |
disabled |
false |
Désactiver le module swift . |
Variables
Variable | Exemple | Description |
---|---|---|
version | v5.2.4 |
La version de swift |
symbol | Reflète la valeur de l'option symbol |
|
style* | Reflète la valeur de l'option style |
* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
Exemple
# ~/.config/starship.toml
[swift]
format = "via [🏎 $version](red bold)"
Terraform
The terraform
module shows the currently selected Terraform workspace and version.
::: tip
By default the Terraform version is not shown, since this is slow for current versions of Terraform when a lot of plugins are in use. If you still want to enable it, follow the example shown below.
:::
Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie:
- Le répertoire courant contient un dossier
.terraform
- Le répertoire courant contient un fichier avec l’extension
.tf
,.tfplan
ou.tfstate
Options
Option | Défaut | Description |
---|---|---|
format |
"via [$symbol$workspace]($style) " |
La chaîne de format pour le module. |
version_format |
"v${raw}" |
Le format de la version. Les variables disponibles sont raw , major , minor , & patch |
symbol |
"💠" |
Une chaîne de format montrée avant l'espace de travail terraform. |
detect_extensions |
["tf", "tfplan", "tfstate"] |
Quelles extensions devraient activer ce module. |
detect_files |
[] |
Quels fichiers devraient activer ce module. |
detect_folders |
[".terraform"] |
Quels dossiers devraient activer ce module. |
style |
"bold 105" |
Le style du module. |
disabled |
false |
Désactive le module terraform . |
Variables
Variable | Exemple | Description |
---|---|---|
version | v0.12.24 |
La version de terraform |
workspace | default |
The current Terraform workspace |
symbol | Reflète la valeur de l'option symbol |
|
style* | Reflète la valeur de l'option style |
* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
Exemple
Avec la version de Terraform
# ~/.config/starship.toml
[terraform]
format = "[🏎💨 $version$workspace]($style) "
Sans la version de Terraform
# ~/.config/starship.toml
[terraform]
format = "[🏎💨 $workspace]($style) "
Date et Heure
The time
module shows the current local time. The format
configuration value is used by the chrono
crate to control how the time is displayed. Take a look at the chrono strftime docs to see what options are available.
::: tip
This module is disabled by default. To enable it, set disabled
to false
in your configuration file.
:::
Options
Option | Défaut | Description |
---|---|---|
format |
"at [$time]($style) " |
La chaîne de format pour le module. |
use_12hr |
false |
Activer le format 12h |
time_format |
voir plus bas | Le format chrono utilisé pour formater l'heure. |
style |
"bold yellow" |
Le style utilisé par le module |
utc_time_offset |
"local" |
Définir le décalage horaire UTC à utiliser. Intervalle de -24 < x < 24. Accepte des nombres décimaux pour s'adapter aux décalages de 30/45 minutes. |
disabled |
true |
Désactiver le module time . |
time_range |
"-" |
Sets the time range during which the module will be shown. Times must be specified in 24-hours format |
If use_12hr
is true
, then time_format
defaults to "%r"
. Otherwise, it defaults to "%T"
. Manually setting time_format
will override the use_12hr
setting.
Variables
Variable | Exemple | Description |
---|---|---|
time | 13:08:10 |
The current time. |
style* | Reflète la valeur de l'option style |
* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
Exemple
# ~/.config/starship.toml
[time]
disabled = false
format = '🕙[\[ $time \]]($style) '
time_format = "%T"
utc_time_offset = "-5"
time_range = "10:00:00-14:00:00"
Nom d'utilisateur
The username
module shows active user's username. Le module est affiché si l'une de ces conditions est remplie :
- L'utilisateur courant est root
- L'utilisateur courant est différent de celui connecté
- L'utilisateur est actuellement connecté à une session SSH
- La variable
show_always
a comme valeur true
::: tip
SSH connection is detected by checking environment variables SSH_CONNECTION
, SSH_CLIENT
, and SSH_TTY
. If your SSH host does not set up these variables, one workaround is to set one of them with a dummy value.
:::
Options
Option | Défaut | Description |
---|---|---|
style_root |
"bold green" |
Le style utilisé quand l'utilisateur est root. |
style_user |
"bold yellow" |
Le style utilisé pour les utilisateurs non-root. |
format |
"[$user]($style) in " |
Format du module. |
show_always |
false |
Toujours afficher le module username . |
disabled |
false |
Désactiver le module username . |
Variables
Variable | Exemple | Description |
---|---|---|
style |
"red bold" |
Mirrors the value of option style_root when root is logged in and style_user otherwise. |
user |
"matchai" |
L’identifiant de l’utilisateur courant. |
Exemple
# ~/.config/starship.toml
[username]
style_user = "white bold"
style_root = "black bold"
format = "user: [$user]($style) "
disabled = false
show_always = true
Vagrant
The vagrant
module shows the currently installed version of Vagrant. Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie:
- Le répertoire courant contient un fichier
Vagrantfile
Options
Option | Défaut | Description |
---|---|---|
format |
"via [$symbol($version )]($style)" |
Format du module. |
version_format |
"v${raw}" |
Le format de la version. Les variables disponibles sont raw , major , minor , & patch |
symbol |
"⍱ " |
Une chaîne de caractères représentant le symbole de Vagrant. |
detect_extensions |
[] |
Quelles extensions devraient activer ce module. |
detect_files |
["Vagrantfile"] |
Quels fichiers devraient activer ce module. |
detect_folders |
[] |
Quels dossiers devraient activer ce module. |
style |
"cyan bold" |
Le style du module. |
disabled |
false |
Désactive le module vagrant . |
Variables
Variable | Exemple | Description |
---|---|---|
version | Vagrant 2.2.10 |
La version de Vagrant |
symbol | Reflète la valeur de l'option symbol |
|
style* | Reflète la valeur de l'option style |
* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
Exemple
# ~/.config/starship.toml
[vagrant]
format = "via [⍱ $version](bold white) "
V
The vlang
module shows you your currently installed version of V. Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie:
- Le répertoire courant contient un fichier avec l'extension
.v
- Le répertoire courant contient un fichier
v.mod
,vpkg.json
ou.vpkg-lock.json
Options
Option | Défaut | Description |
---|---|---|
format |
"via [$symbol($version )]($style)" |
Format du module. |
version_format |
"v${raw}" |
Le format de la version. Les variables disponibles sont raw , major , minor , & patch |
symbol |
"V " |
Une chaîne de caractères représentant le symbole de V |
detect_extensions |
["v"] |
Quelles extensions devraient activer ce module. |
detect_files |
["v.mod", "vpkg.json", ".vpkg-lock.json" ] |
Quels fichiers devraient activer ce module. |
detect_folders |
[] |
Quels dossiers devraient activer ce module. |
style |
"blue bold" |
Le style du module. |
disabled |
false |
Désactive le module vlang . |
Variables
Variable | Exemple | Description |
---|---|---|
version | v0.2 |
La version de v |
symbol | Reflète la valeur de l'option symbol |
|
style* | Reflète la valeur de l'option style |
Exemple
# ~/.config/starship.toml
[vlang]
format = "via [V $version](blue bold) "
VCSH
The vcsh
module displays the current active VCSH repository. The module will be shown only if a repository is currently in use.
Options
Option | Défaut | Description |
---|---|---|
symbol |
Le symbole utilisé avant d'afficher le nom du dépôt. | |
style |
"bold yellow" |
Le style du module. |
format |
"vcsh [$symbol$repo]($style) " |
Format du module. |
disabled |
false |
Désactive le module vcsh . |
Variables
Variable | Exemple | Description |
---|---|---|
repo | dotfiles si dans un dépôt VCSH nommé dotfiles |
The active repository name |
symbol | Reflète la valeur de l'option symbol |
|
style* | black bold dimmed |
Reflète la valeur de l'option style |
* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
Exemple
# ~/.config/starship.toml
[vcsh]
format = "[🆅 $repo](bold blue) "
Zig
By default the the zig
module shows the currently installed version of Zig. Le module est affiché si l'une de ces conditions est remplie :
- Le répertoire courant contient un fichier
.zig
Options
Option | Défaut | Description |
---|---|---|
format |
"via [$symbol($version )]($style)" |
Format du module. |
version_format |
"v${raw}" |
Le format de la version. Les variables disponibles sont raw , major , minor , & patch |
symbol |
"↯ " |
Le symbole utilisé avant d'afficher la version de Zig. |
style |
"bold yellow" |
Le style du module. |
disabled |
false |
Désactive le module zig . |
detect_extensions |
["zig"] |
Quelles extensions devraient activer ce module. |
detect_files |
[] |
Quels fichiers devraient activer ce module. |
detect_folders |
[] |
Quels dossiers devraient activer ce module. |
Variables
Variable | Exemple | Description |
---|---|---|
version | v0.6.0 |
La version de zig |
symbol | Reflète la valeur de l'option symbol |
|
style* | Reflète la valeur de l'option style |
* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
Exemple
# ~/.config/starship.toml
[zig]
symbol = "⚡️ "
Commandes personnalisées
The custom
modules show the output of some arbitrary commands.
These modules will be shown if any of the following conditions are met:
- The current directory contains a file whose name is in
files
- The current directory contains a directory whose name is in
directories
- The current directory contains a file whose extension is in
extensions
- The
when
command returns 0 - The current Operating System (std::env::consts::OS) matchs with
os
field if defined.
::: tip
Multiple custom modules can be defined by using a .
.
:::
::: tip
The order in which custom modules are shown can be individually set by including ${custom.foo}
in the top level format
(as it includes a dot, you need to use ${...}
). By default, the custom
module will simply show all custom modules in the order they were defined.
:::
::: tip
Issue #1252 contains examples of custom modules. If you have an interesting example not covered there, feel free to share it there!
:::
::: warning Command output is printed unescaped to the prompt
Whatever output the command generates is printed unmodified in the prompt. This means if the output contains special sequences that are interpreted by your shell they will be expanded when displayed. These special sequences are shell specific, e.g. you can write a command module that writes bash sequences, e.g. \h
, but this module will not work in a fish or zsh shell.
Format strings can also contain shell specific prompt sequences, e.g. Bash, Zsh.
:::
Options
Option | Défaut | Description |
---|---|---|
command |
"" |
The command whose output should be printed. The command will be passed on stdin to the shell. |
when |
A shell command used as a condition to show the module. The module will be shown if the command returns a 0 status code. |
|
shell |
See below | |
description |
"<custom module>" |
The description of the module that is shown when running starship explain . |
files |
[] |
The files that will be searched in the working directory for a match. |
directories |
[] |
The directories that will be searched in the working directory for a match. |
extensions |
[] |
The extensions that will be searched in the working directory for a match. |
symbol |
"" |
Le symbole utilisé avant d'afficher la sortie de la commande. |
style |
"bold green" |
Le style du module. |
format |
"[$symbol($output )]($style)" |
Format du module. |
disabled |
false |
Désactive le module custom . |
os |
Operating System name on which the module will be shown (unix, linux, macos, windows, ... ) See possible values. |
Variables
Variable | Description |
---|---|
output | The output of shell command in shell |
symbol | Reflète la valeur de l'option symbol |
style* | Reflète la valeur de l'option style |
* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
Commandes shell personnalisées
shell
accepts a non-empty list of strings, where:
- La première chaîne est le chemin vers le shell à utiliser pour exécuter la commande.
- Other following arguments are passed to the shell.
If unset, it will fallback to STARSHIP_SHELL and then to "sh" on Linux, and "cmd /C" on Windows.
The command
will be passed in on stdin.
If shell
is not given or only contains one element and Starship detects PowerShell will be used, the following arguments will automatically be added: -NoProfile -Command -
. This behavior can be avoided by explicitly passing arguments to the shell, e.g.
shell = ["pwsh", "-Command", "-"]
::: warning Make sure your custom shell configuration exits gracefully
If you set a custom command, make sure that the default Shell used by starship will properly execute the command with a graceful exit (via the shell
option).
For example, PowerShell requires the -Command
parameter to execute a one liner. Omitting this parameter might throw starship into a recursive loop where the shell might try to load a full profile environment with starship itself again and hence re-execute the custom command, getting into a never ending loop.
Parameters similar to -NoProfile
in PowerShell are recommended for other shells as well to avoid extra loading time of a custom profile on every starship invocation.
Automatic detection of shells and proper parameters addition are currently implemented, but it's possible that not all shells are covered. Please open an issue with shell details and starship configuration if you hit such scenario.
:::
Exemple
# ~/.config/starship.toml
[custom.foo]
command = "echo foo" # shows output of command
files = ["foo"] # can specify filters but wildcards are not supported
when = """ test "$HOME" == "$PWD" """
format = " transcending [$output]($style)"
[custom.time]
command = "time /T"
extensions = ["pst"] # filters *.pst files
shell = ["pwsh.exe", "-NoProfile", "-Command", "-"]