starship/docs/fr-FR/config

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 effectuée dans ce fichier TOML :

# Get editor completions based on the config schema
"$schema" = 'https://starship.rs/config-schema.json'

# Inserts a blank line between shell prompts
add_newline = true

# Replace the '❯' symbol in the prompt with '➜'
[character] # The name of the module we are configuring is 'character'
success_symbol = '[➜](bold green)' # The 'success_symbol' segment is being set to '➜' with the color 'bold green'

# Disable the package module, hiding it from the prompt completely
[package]
disabled = true

Config File Location

Vous pouvez choisir l'emplacement 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"

Ou pour Cmd (Windows) ajouter cette ligne à votre 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 an instance of your terminal. Ceci peut cependant être modifié en utilisant la variable d'environnement STARSHIP_CACHE:

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"

Ou pour Cmd (Windows) ajouter cette ligne à votre starship.lua:

os.setenv('STARSHIP_CACHE', 'C:\\Users\\user\\AppData\\Local\\Temp')

Terminologie

Module: Un composant dans l'invite de commande donnant des informations basées sur des données contextuelles de votre OS. Par exemple, le module "nodejs" montre la version de Node.js qui installée sur votre ordinateur, si votre dossier actuel est un projet Node.js.

Variable: Petits sous-composants qui contiennent des informations fournies par le module. Par exemple, la variable "version" dans le module "nodejs" contient la version actuelle de Node.js.

Par convention, la plupart des modules ont un préfixe de la couleur par défaut du terminal (par exemple via dans "nodejs") et un espace vide comme suffixe.

Strings

In TOML syntax, text values are declared with ', ", ''', or """.

The following Starship syntax symbols have special usage in a format string and must be escaped to display as that character: $ [ ] ( ).

Symbol	Type	Notes
'	literal string	less escaping
"	string	more escaping
'''	multi-line literal string	less escaping
"""	multi-line string	more escaping, newlines in declarations can be ignored

Par exemple :

# literal string
format = '☺\☻ '

# regular string
format = "☺\\☻ "

# escaping Starship symbols
format = '\[\$\] '

When using line breaks, multi-line declarations can be used. For example, if you want to print a $ symbol on a new line, the following values for format are equivalent:

# with literal string
format = '''

\$'''

# with multiline basic string
format = """

\\$"""

# with basic string
format = "\n\\$"

In multiline basic strings, newlines can be used for formatting without being present in the value by escaping them.

format = """
line1\
line1\
line1
line2\
line2\
line2
"""

Chaîne de formatage

Les chaînes de formatage sont le format avec lequel un module affiche toutes ses variables. La plupart des modules ont une entrée appelée format qui configure le format d'affichage du module. Vous pouvez utiliser des textes, des variables et des groupes de texte dans une chaîne de format.

Variable

Une variable contient un symbole $ suivi du nom de la variable. Le nom d’une variable peut seulement container des lettres, des nombres et _.

Par exemple :

• '$version' is a format string with a variable named version.
• '$git_branch$git_commit' is a format string with two variables named git_branch and git_commit.
• '$git_branch $git_commit' has the two variables separated with a space.

Groupe de texte

Un groupe de texte se compose de deux parties différentes.

La première partie, qui est entourée dans un [], est une chaîne de formatage. Vous pouvez y ajouter des textes, des variables, ou même des groupes de texte imbriqués.

La deuxième partie, qui est entourée par (), est une chaîne de style. Elle peut être utilisée pour styliser la première partie.

Par exemple :

• '[on](red bold)' will print a string on with bold text colored red.
• '[⌘ $version](bold green)' will print a symbol ⌘ followed by the content of variable version, with bold text colored green.
• '[a [b](red) c](green)' will print a b c with b red, and a and c green.

Chaînes de style

La plupart des modules de Starship vous permettent de configurer leurs styles d'affichage. Cela se fait avec une entrée (généralement appelée style) qui est une chaîne de caractères spécifiant la configuration. Voici quelques exemples de chaînes de style avec ce qu'elles font. Pour plus de détails sur la syntaxe complète, consultez le guide de configuration avancé.

• 'fg:green bg:blue' sets green text on a blue background
• 'bg:blue fg:bright-green' sets bright green text on a blue background
• 'bold fg:27' sets bold text with ANSI color 27
• 'underline bg:#bf5700' sets underlined text on a burnt orange background
• 'bold italic fg:purple' sets bold italic purple text
• '' explicitly disables all styling

Notez que ce style sera contrôlé par votre émulateur de terminal. Par exemple, certains émulateurs de terminal éclairciront les couleurs au lieu de mettre le texte en gras, et certains thèmes de couleurs utilisent les mêmes valeurs pour les couleurs normales et claires. De plus, pour obtenir du texte italique, votre terminal doit prendre en charge l'italique.

Chaînes de formatage conditionnel

Une chaîne de formatage conditionnel enveloppée dans ( et ) ne sera pas rendue si toutes les variables à l'intérieur sont vides.

Par exemple :

• '(@$region)' will show nothing if the variable region is None or empty string, otherwise @ followed by the value of region.
• '(some text)' will always show nothing since there are no variables wrapped in the braces.
• When $combined is a shortcut for \[$a$b\], '($combined)' will show nothing only if $a and $b are both None. This works the same as '(\[$a$b\] )'.

Negative matching

Many modules have detect_extensions, detect_files, and detect_folders variables. These take lists of strings to match or not match. "Negative" options, those which should not be matched, are indicated with a leading '!' character. The presence of any negative indicator in the directory will result in the module not being matched.

Extensions are matched against both the characters after the last dot in a filename, and the characters after the first dot in a filename. For example, foo.bar.tar.gz will be matched against bar.tar.gz and gz in the detect_extensions variable. Files whose name begins with a dot are not considered to have extensions at all.

To see how this works in practice, you could match TypeScript but not MPEG Transport Stream files thus:

detect_extensions = ['ts', '!video.ts', '!audio.ts']

Invite

Voici la liste des options de configuration globales de l'invite de commandes.

Options

Option	Défaut	Description
format	lien	Configure le format de l'invite.
right_format	''	Voir Activer le prompt à droite
scan_timeout	30	Délai maximal pour le scan des fichiers par starship (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.
palette	''	Sets which color palette from palettes to use.
palettes	{}	Collection of color palettes that assign colors to user-defined names. Note that color palettes cannot reference their own color definitions.

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

# Set 'foo' as custom color palette
palette = 'foo'

# Define custom colors
[palettes.foo]
# Overwrite existing color
blue = '21'
# Define new color
mustard = '#af8700'

Format par Défaut

Le format par défaut est utilisé pour définir le format de l'invite, si il est vide ou mal formaté. La valeur par défaut est la suivante :

format = '$all'

# Which is equivalent to
format = """
$username\
$hostname\
$localip\
$shlvl\
$singularity\
$kubernetes\
$directory\
$vcsh\
$fossil_branch\
$fossil_metrics\
$git_branch\
$git_commit\
$git_state\
$git_metrics\
$git_status\
$hg_branch\
$pijul_channel\
$docker_context\
$package\
$c\
$cmake\
$cobol\
$daml\
$dart\
$deno\
$dotnet\
$elixir\
$elm\
$erlang\
$fennel\
$golang\
$guix_shell\
$haskell\
$haxe\
$helm\
$java\
$julia\
$kotlin\
$gradle\
$lua\
$nim\
$nodejs\
$ocaml\
$opa\
$perl\
$php\
$pulumi\
$purescript\
$python\
$raku\
$rlang\
$red\
$ruby\
$rust\
$scala\
$solidity\
$swift\
$terraform\
$vlang\
$vagrant\
$zig\
$buf\
$nix_shell\
$conda\
$meson\
$spack\
$memory_usage\
$aws\
$gcloud\
$openstack\
$azure\
$env_var\
$crystal\
$custom\
$sudo\
$cmd_duration\
$line_break\
$jobs\
$battery\
$time\
$status\
$os\
$container\
$shell\
$character"""

Si vous voulez étendre le format par défaut, pour pouvoir utiliser $all ; les modules que vous ajouter explicitement au format ne seront pas dupliqués. Par ex.

# Move the directory to the second line
format = '$all$directory$character'

AWS

The aws module shows the current AWS region and profile and an expiration timer when using temporary credentials. The output of the module uses the AWS_REGION, AWS_DEFAULT_REGION, and AWS_PROFILE env vars and the ~/.aws/config and ~/.aws/credentials files as required.

The module will display a profile only if its credentials are present in ~/.aws/credentials or if a credential_process, sso_start_url, or sso_session are defined in ~/.aws/config. Alternatively, having any of the AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY, or AWS_SESSION_TOKEN env vars defined will also suffice. If the option force_display is set to true, all available information will be displayed even if no credentials per the conditions above are detected.

Lorsque vous utilisez aws-vault le profil est lu à partir de la variable d'environnement AWS_VAULT et la date d'expiration des identifiants est lue à partir de la variable d'environnement AWS_SESSION_EXPIRATION.

Lorsque vous utilisez awsu le profil est lu depuis la variable d'environnement AWSU_PROFILE.

Lorsque vous utilisez AWSume le profil est lu à partir de la variable d'environnement AWSUME_PROFILE et la date d'expiration des identifiants est lue à partir de la variable d'environnement AWSUME_EXPIRATION.

When using saml2aws the expiration information obtained from ~/.aws/credentials falls back to the x_security_token_expires key.

Options

Option	Défaut	Description
format	'on [$symbol($profile )(\($region\) )(\[$duration\] )]($style)'	Format du module.
symbole	'☁️ '	Le symbole est affiché avant le profil AWS actuel.
region_aliases	{}	Tableau des alias de région à afficher en plus du nom AWS.
profile_aliases	{}	Tableau des alias de profil à afficher en plus du nom AWS.
style	'bold yellow'	Le style pour le module.
expiration_symbol	X	Le symbole est affiché lorsque les identifiants temporaires ont expiré.
disabled	false	Désactive le module AWS.
force_display	false	Si true, affiche les informations même si credentials, credential_process ou sso_start_url n'ont pas été configurées.

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
symbole		Reflète la valeur de l'option symbol
style*		Reflète la valeur de l'option style

*: Cette variable peut uniquement être utilisée dans une chaine 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'
[aws.profile_aliases]
CompanyGroupFrobozzOnCallAccess = 'Frobozz'

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 = '🅰 '
[aws.profile_aliases]
Enterprise_Naming_Scheme-voidstars = 'void**'

Azure

Le module azure affiche l'abonnement Azure actuel. This is based on showing the name of the default subscription or the username, as defined in the ~/.azure/azureProfile.json file.

Options

Variable	Défaut	Description
format	'on [$symbol($subscription)]($style) '	Le format pour le rendu du module Azure.
symbole	'󰠅 '	Le symbole utilisé dans le format.
style	'blue bold'	Le style utilisé dans le format.
disabled	true	Désactive le module azure.
subscription_aliases	{}	Table of subscription name aliases to display in addition to Azure subscription name.

Exemples

Display Subscription Name

# ~/.config/starship.toml

[azure]
disabled = false
format = 'on [$symbol($subscription)]($style) '
symbol = '󰠅 '
style = 'blue bold'

Display Username

# ~/.config/starship.toml

[azure]
disabled = false
format = "on [$symbol($username)]($style) "
symbol = "󰠅 "
style = "blue bold"

Display Subscription Name Alias

# ~/.config/starship.toml

[azure.subscription_aliases]
very-long-subscription-name = 'vlsn'

Battery

Le module battery montre à quel point la batterie de l'appareil est chargée et son état de charge actuel. Ce module n'est visible que lorsque la batterie de l'appareil est inférieure à 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

L'option de configuration display est utilisée pour définir quand l'indicateur de batterie doit être affiché (threshold), quel symbole doit être utilisé (symbol) et à quoi il ressemble (style). Si aucun display n'est fourni. La valeur par défaut est la suivante :

[[battery.display]]
threshold = 10
style = 'bold red'

La valeur par défaut pour les options charging_symbol et discharging_symbol est respectivement la valeur des options charging_symbol et discharging_symbol du module battery.

Options

L'option display est un tableau des propriétés suivantes.

Option	Défaut	Description
threshold	10	La limite supérieure pour l'option display.
style	'red bold'	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

Buf

Le module buf affiche la version de Buf installée. Par défaut, le module sera affiché si l’une de ces conditions est remplie:

• La commande buf est installée.
• Le dossier actuel contient un fichier de configuration buf.yaml, buf.gen.yaml ou buf.work.yaml.

Options

Option	Défaut	Description
format	'with [$symbol($version )]($style)'	Le format du module buf.
version_format	'v${raw}'	Le format de la version.
symbole	'🐃 '	Le symbole utilisé avant d’afficher la version de Buf.
detect_extensionsdetect_extensions	[]	Les extensions qui déclenchent ce module.
detect_files	['buf.yaml', 'buf.gen.yaml', 'buf.work.yaml']	Les fichiers qui activent ce module.
detect_folders	[]	Quels dossiers devraient activer ce module.
style	'bold blue'	Le style pour le module.
disabled	false	Désactive le module elixir.

Variables

Variable	Exemple	Description
version	v1.0.0	La version de buf
symbole		Reflète la valeur de l'option symbol
style*		Reflète la valeur de l'option style

*: Cette variable peut uniquement être utilisée dans une chaine de style

Exemple

# ~/.config/starship.toml

[buf]
symbol = '🦬 '

Bun

The bun module shows the currently installed version of the bun JavaScript runtime. Par défaut, le module sera affiché si l’une de ces conditions est remplie:

• Le dossier courant contient un fichier bun.lockb
• Le dossier courant contient un fichier bunfig.toml

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
symbole	'🍞 '	A format string representing the symbol of Bun.
detect_extensionsdetect_extensions	[]	Les extensions qui déclenchent ce module.
detect_files	['bun.lockb', 'bunfig.toml']	Les fichiers qui activent ce module.
detect_folders	[]	Les dossiers qui activent ce module.
style	'bold red'	Le style pour le module.
disabled	false	Disables the bun module.

Variables

Variable	Exemple	Description
version	v0.1.4	The version of bun
symbole		Reflète la valeur de l'option symbol
style*		Reflète la valeur de l'option style

*: Cette variable peut uniquement être utilisée dans une chaine de style

Exemple

# ~/.config/starship.toml

[bun]
format = 'via [🍔 $version](bold green) '

C

Le module c affiche des informations à propos de votre compilateur C. Par défaut, ce module sera affiché si le dossier courant contient un fichier .c ou .h.

Options

Option	Défaut	Description
format	'via [$symbol($version(-$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
symbole	'C '	Le symbole utilisé avant d’afficher les détails du compilateur
detect_extensionsdetect_extensions	['c', 'h']	Les extensions qui déclenchent ce module.
detect_files	[]	Les fichiers qui activent ce module.
detect_folders	[]	Les dossiers qui activent ce module.
commands	[ [ 'cc', '--version' ], [ 'gcc', '--version' ], [ 'clang', '--version' ] ]	Comment détecter quel est le compilateur
style	'bold 149'	Le style pour le module.
disabled	false	Désactive le module c.

Variables

Variable	Exemple	Description
name	clang	Le nom du compilateur
version	13.0.0	La version du compilateur
symbole		Reflète la valeur de l'option symbol
style		Reflète la valeur de l'option style

Notez que version n’est pas dans le format par défaut.

Commandes

L’option commands accepte une liste de commandes pour déterminer la version du compilateur et son nom.

Each command is represented as a list of the executable name, followed by its arguments, usually something like ['mycc', '--version']. Starship essayera d'exécuter chaque commande jusqu'à obtenir un résultat sur STDOUT.

Si un compilateur C n’est pas supporté par ce module, vous pouvez demander son ajout en créant un ticket sur GitHub.

Exemple

# ~/.config/starship.toml

[c]
format = 'via [$name $version]($style)'

Caractère

Le module character affiche un caractère (en général une flèche) à côté de là où vous entrez le texte dans votre terminal.

Le caractère vous dira si la dernière commande a été réussie ou pas. Il peut faire ça de deux façons:

• en changeant de couleur(red/green)
• en changeant de forme (❯/✖)

Par défaut, il ne change que de couleur. Si vous désirez également changer sa forme, jetez un à cet exemple.

::: warning

vimcmd_symbol is only supported in cmd, fish and zsh. vimcmd_replace_one_symbol, vimcmd_replace_symbol, and vimcmd_visual_symbol are only supported in fish due to upstream issues with mode detection in zsh.

:::

Options

Option	Défaut	Description
format	'$symbol '	Le format utilisé 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é.
vimcmd_symbol	'[❮](bold green)'	Le format utilisé avant l'entrée de texte si le shell est en mode vim normal.
vimcmd_replace_one_symbol	'[❮](bold purple)'	The format string used before the text input if the shell is in vim replace_one mode.
vimcmd_replace_symbol	'[❮](bold purple)'	The format string used before the text input if the shell is in vim replace mode.
vimcmd_visual_symbol	'[❮](bold yellow)'	The format string used before the text input if the shell is in vim visual mode.
disabled	false	Désactive le module character.

Variables

Variable	Exemple	Description
symbole		A mirror of either success_symbol, error_symbol, vimcmd_symbol or vimcmd_replace_one_symbol etc.

Exemples

Avec un caractère d'erreur personnalisé

# ~/.config/starship.toml

[character]
success_symbol = '[➜](bold green) '
error_symbol = '[✗](bold red) '

Sans caractère d'erreur personnalisé

# ~/.config/starship.toml

[character]
success_symbol = '[➜](bold green) '
error_symbol = '[➜](bold red) '

Avec une forme vim personnalisée

# ~/.config/starship.toml

[character]
vimcmd_symbol = '[V](bold green) '

CMake

Le module cmake affiche la version de CMake installée. Par défaut, le module s’activera si l’une de ces conditions est remplie:

• Le dossier courant contient un fichier CMakeLists.txt
• Le dossier courant 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
symbole	'△ '	Le symbole utilisé avant la version de cmake.
detect_extensionsdetect_extensions	[]	Les extensions qui déclenchent 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 pour le module.
disabled	false	Désactive le module cmake.

Variables

Variable	Exemple	Description
version	v3.17.3	La version de cmake
symbole		Reflète la valeur de l'option symbol
style*		Reflète la valeur de l'option style

*: Cette variable peut uniquement être utilisée dans une chaine de style

COBOL / GNUCOBOL

Le module cobol affiche la version de COBOL installée. Par défaut, le module sera affiché si l’une de ces conditions est remplie:

• Le dossier courant contient un fichier finissant par .cob ou .COB
• Le dossier courant contiens un fichier finissant par .cbl ou .CBL

Options

Option	Défaut	Description
symbole	'⚙️ '	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 pour le module.
detect_extensionsdetect_extensions	['cbl', 'cob', 'CBL', 'COB']	Les extensions qui déclenchent ce module.
detect_files	[]	Les fichiers qui activent ce module.
detect_folders	[]	Les dossiers qui activent ce module.
disabled	false	Désactive le module cobol.

Variables

Variable	Exemple	Description
version	v3.1.2.0	La version de cobol
symbole		Reflète la valeur de l'option symbol
style*		Reflète la valeur de l'option style

*: Cette variable peut uniquement être utilisée dans une chaine de style

Temps d'exécution

Le module cmd_duration montre le temps qu'a pris la dernière commande pour s'exécuter. Le module ne sera affiché que si la commande a pris plus de deux secondes, ou plus que la valeur min_time, si elle existe.

::: warning N'accrochez pas la trappe DEBUG en Bash

Si vous utilisez starship avec bash, n'interceptez pas DEBUG après avoir exécuté eval $(starship init $0), ou ce module ne fonctionnera pas.

:::

Les utilisateurs de Bash qui ont besoin de fonctionnalité pré-exec peuvent utiliser rcaloras's bash_preexec framework. Définissez simplement les tableaux preexec_functions et precmd_functions avant d'exécuter eval $(starship init $0), puis procédez comme d'habitude.

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 pour le 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).
notification_timeout		Durée d’affichage des notifications (en milisecondes). Si non défini, la durée sera déterminée par le démon. Tous les démons de notification ne respectent pas cette option.

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 peut uniquement être utilisée dans une chaine de style

Exemple

# ~/.config/starship.toml

[cmd_duration]
min_time = 500
format = 'underwent [$duration](bold yellow)'

Conda

Le module conda affiche l’environnement Conda courant, si $CONDA_DEFAULT_ENV est définie.

::: tip

Cela ne supprime pas le modificateur d'invite de conda, vous pourriez vouloir exécuter conda config --set changeps1 False pour le désactiver.

:::

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.
symbole	'🅒 '	Le symbole utilisé avant le nom d'environnement.
style	'bold green'	Le style pour le 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
environment	astronauts	La version courante de conda
symbole		Reflète la valeur de l'option symbol
style*		Reflète la valeur de l'option style

*: Cette variable peut uniquement être utilisée dans une chaine de style

Exemple

# ~/.config/starship.toml

[conda]
format = '[$symbol$environment](dimmed green) '

Conteneur

Le module container affiche un symbole et le nom du conteneur, si vous êtes dans un conteneur.

Options

Option	Défaut	Description
symbole	'⬢'	Le symbole affiché quand vous êtes dans un conteneur
style	'bold red dimmed'	Le style pour le module.
format	'[$symbol \[$name\]]($style) '	Format du module.
disabled	false	Désactive le module container.

Variables

Variable	Exemple	Description
name	fedora-toolbox:35	Le nom du conteneur
symbole		Reflète la valeur de l'option symbol
style*		Reflète la valeur de l'option style

*: Cette variable peut uniquement être utilisée dans une chaine de style

Exemple

# ~/.config/starship.toml

[container]
format = '[$symbol \[$name\]]($style) '

Crystal

Le module crystal affiche la version de Crystal installée. Par défaut, le module sera affiché si l’une de ces conditions est remplie:

• Le dossier courant contient un fichier shard.yml
• Le dossier courant contient un fichier .cr

Options

Option	Défaut	Description
symbole	'🔮 '	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 red'	Le style pour le module.
detect_extensionsdetect_extensions	['cr']	Les extensions qui déclenchent ce module.
detect_files	['shard.yml']	Les fichiers qui activent ce module.
detect_folders	[]	Les dossiers qui activent ce module.
disabled	false	Désactive le module crystal.

Variables

Variable	Exemple	Description
version	v0.32.1	La version de crystal
symbole		Reflète la valeur de l'option symbol
style*		Reflète la valeur de l'option style

*: Cette variable peut uniquement être utilisée dans une chaine de style

Exemple

# ~/.config/starship.toml

[crystal]
format = 'via [✨ $version](bold blue) '

Daml

The daml module shows the currently used Daml SDK version when you are in the root directory of your Daml project. The sdk-version in the daml.yaml file will be used, unless it's overridden by the DAML_SDK_VERSION environment variable. Par défaut, le module sera affiché si l’une de ces conditions est remplie:

• Le dossier courant contient un fichier daml.yaml

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
symbole	'Λ '	A format string representing the symbol of Daml
style	'bold cyan'	Le style pour le module.
detect_extensionsdetect_extensions	[]	Les extensions qui déclenchent ce module.
detect_files	['daml.yaml']	Les fichiers qui activent ce module.
detect_folders	[]	Les dossiers qui activent ce module.
disabled	false	Disables the daml module.

Variables

Variable	Exemple	Description
version	v2.2.0	The version of daml
symbole		Reflète la valeur de l'option symbol
style*		Reflète la valeur de l'option style

*: Cette variable peut uniquement être utilisée dans une chaine de style

Exemple

# ~/.config/starship.toml

[daml]
format = 'via [D $version](bold bright-green) '

Dart

Le module dart affiche la version de Dart installée. Par défaut, le module sera affiché si l’une de ces conditions est remplie:

• Le dossier courant contient un fichier avec l’extension .dart
• Le dossier courant contient un fichier .dart_tool
• Le dossier courant contient un fichier pubsepc.yaml, pubspec.yml ou pubspec.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
symbole	'🎯 '	Une chaîne de caractères représentant le symbole de Dart
detect_extensionsdetect_extensions	['dart']	Les extensions qui déclenchent ce module.
detect_files	['pubspec.yaml', 'pubspec.yml', 'pubspec.lock']	Les fichiers qui activent ce module.
detect_folders	['.dart_tool']	Les dossiers qui activent ce module.
style	'bold blue'	Le style pour le module.
disabled	false	Désactive le module dart.

Variables

Variable	Exemple	Description
version	v2.8.4	La version de dart
symbole		Reflète la valeur de l'option symbol
style*		Reflète la valeur de l'option style

*: Cette variable peut uniquement être utilisée dans une chaine de style

Exemple

# ~/.config/starship.toml

[dart]
format = 'via [🔰 $version](bold red) '

Deno

Le module deno affiche la version de Deno installée. Par défaut, le module sera affiché si l’une de ces conditions est remplie:

• Le dossier courant contient un fichier deno.json, deno.jsonc, mod.ts, mod.js, deps.ts ou deps.js

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
symbole	'🦕 '	Une chaîne de caractères représentant le symbole de Deno
detect_extensionsdetect_extensions	[]	Les extensions qui déclenchent ce module.
detect_files	['deno.json', 'deno.jsonc', 'mod.ts', 'mod.js', 'deps.ts', 'deps.js']	Les fichiers qui activent ce module.
detect_folders	[]	Les dossiers qui activent ce module.
style	'green bold'	Le style pour le module.
disabled	false	Désactive le module deno.

Variables

Variable	Exemple	Description
version	v1.8.3	La version de deno
symbole		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

Le module directory affiche le chemin du dossier courant, tronqué à 3 dossiers parents. Votre dossier sera également tronqué à la racine du repo git dans lequel vous vous trouvez actuellement.

When using the fish_style_pwd_dir_length 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.

Par exemple, ~/Dev/Nix/nixpkgs/pkgs où nixpkgs est la racine du repo, et l'option définie à 1. Vous verrez maintenant ~/D/N/nixpkgs/pkgs, alors que vous auriez vu nixpkgs/pkgs avant.

Options

Option	Défaut	Description
truncation_length	3	Le nombre de dossiers parents auquel tronquer le chemin du répertoire courant.
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 pour le 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 de lecture seule.
truncation_symbol	''	Le symbole pour préfixer les chemins tronqués. eg: '…/'
before_repo_root_style		The style for the path segment above the root of the git repo. La valeur par défaut est équivalent à style.
repo_root_style		Le style pour la racine du dépôt Git. La valeur par défaut est équivalent à style.
repo_root_format	'[$before_root_path]($before_repo_root_style)[$repo_root]($repo_root_style)[$path]($style)[$read_only]($read_only_style) '	The format of a git repo when before_repo_root_style and repo_root_style is defined.
home_symbol	'~'	Le symbole indiquant le répertoire personnel.
use_os_path_sep	true	Utiliser le séparateur de chemin du système d’exploitation au lieu de toujours utiliser / (par ex. \ sous Windows)

Ce module possède quelques options de configuration avancées qui contrôlent l'affichage du répertoire.

Options avancées	Défaut	Description
substitutions		Une table de substitutions à appliquer aux chemins.
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 vous permet de définir des remplacements arbitraires pour les chaînes littérales qui apparaissent dans le chemin, par exemple pour de longs préfixes de réseau ou des répertoires de développement (ex. Java). Notez que cela désactivera la PWD de style fish.

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

fish_style_pwd_dir_leng interagit avec les options de troncature d'une manière qui peut être surprenante au début : si elle n'est pas nulle, les composantes du chemin qui seraient normalement tronquées sont affichées à la place avec autant de caractères. For example, the path /built/this/city/on/rock/and/roll, which would normally be displayed 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. Pour fish_style_pwd_dir_length = 2, ce serait /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 peut uniquement être utilisée dans une chaine de style

Les dépôts Git peuvent avoir des variables additionnelles.

Considérons le chemin /path/to/home/git_repo/src/lib

Variable	Exemple	Description
before_root_path	'/path/to/home/'	Le chemin avant le dossier racine Git
repo_root	'git_repo'	Le nom du dossier racine Git
path	'/src/lib'	Le reste du chemin
style	'black bold dimmed'	Reflète la valeur de l'option style
repo_root_style	'underline white'	Style pour le nom du dossier racine Git

Exemple

# ~/.config/starship.toml

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

Contexte Docker

Le module docker_context affiche le context Docker actif, si sa valeur est différente de default ou si les variables d’environnement DOCKER_MACHINE_NAME, DOCKER_HOST ou DOCKER_CONTEXT sont définies (puisqu’elles sont utilisées pour changer le contexte utilisé).

Options

Option	Défaut	Description
format	'via [$symbol$context]($style) '	Format du module.
symbole	'🐳 '	Le symbole utilisé avant d'afficher le contexte Docker.
only_with_files	true	Afficher uniquement quand il y a une correspondance
detect_extensionsdetect_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 pour le module.
disabled	false	Désactive le module docker_context.

Variables

Variable	Exemple	Description
context	test_context	Le contexte docker courant
symbole		Reflète la valeur de l'option symbol
style*		Reflète la valeur de l'option style

*: Cette variable peut uniquement être utilisée dans une chaine de style

Exemple

# ~/.config/starship.toml

[docker_context]
format = 'via [🐋 $context](blue bold)'

Dotnet

Le module dotnet montre la version pertinente du SDK .NET Core pour le répertoire courant. Si le SDK a été épinglé dans le répertoire courant, la version épinglée est affichée. Sinon, le module affiche la dernière version installée du SDK.

Par défaut, ce module ne sera affiché dans votre invite que lorsqu'un ou plusieurs des fichiers suivants sont présents dans le répertoire courant :

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

Vous aurez également besoin du SDK .NET Core pour pouvoir l'utiliser correctement.

En interne, ce module utilise son propre mécanisme de détection de version. Généralement, il est deux fois plus rapide que d'exécuter dotnet --version, mais il peut afficher une version incorrecte si votre projet .NET a une arborescence inhabituelle. Si la précision est plus importante que la vitesse, vous pouvez désactiver le mécanisme en définissant heuristic = false dans les options du module.

Le module affichera aussi le Moniker de Framework Cible (https://docs.microsoft.com/en-us/dotnet/standard/frameworks#supported-target-frameworks) quand il y a un fichier .csproj dans le dossier courant.

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
symbole	'.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_extensionsdetect_extensions	['csproj', 'fsproj', 'xproj']	Les extensions qui déclenchent ce module.
detect_files	['global.json', 'project.json', 'Directory.Build.props', 'Directory.Build.targets', 'Packages.props']	Les fichiers qui activent ce module.
detect_folders	[]	Quels dossiers devraient activer ce module.
style	'bold blue'	Le style pour le module.
disabled	false	Désactive le module dotnet.

Variables

Variable	Exemple	Description
version	v3.1.201	La version du sdk dotnet
tfm	netstandard2.0	Le Moniker de Framework Cible du projet actuel
symbole		Reflète la valeur de l'option symbol
style*		Reflète la valeur de l'option style

*: Cette variable peut uniquement être utilisée dans une chaine de style

Exemple

# ~/.config/starship.toml

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

Elixir

Le module elixir affiche la version de Elixir et Erlang/OTP installée. Par défaut, le module sera affiché si l’une de ces conditions est remplie:

• Le dossier 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
symbole	'💧 '	Le symbole utilisé avant d'afficher la version d'Elixir/Erlang.
detect_extensionsdetect_extensions	[]	Les extensions qui déclenchent ce module.
detect_files	['mix.exs']	Les fichiers qui activent ce module.
detect_folders	[]	Quels dossiers devraient activer ce module.
style	'bold purple'	Le style pour le 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
symbole		Reflète la valeur de l'option symbol
style*		Reflète la valeur de l'option style

*: Cette variable peut uniquement être utilisée dans une chaine de style

Exemple

# ~/.config/starship.toml

[elixir]
symbol = '🔮 '

Elm

Le module elm affiche la version de Elm installée. Par défaut, le module sera affiché si l’une de ces conditions est remplie:

• Le dossier courant contient un fichier elm.json
• Le dossier courant contient un fichier elm-package.json
• Le dossier courant contient un fichier elm-version
• Le dossier courant contient un dossier elm-stuff
• Le dossier 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
symbole	'🌳 '	Une chaîne de format représentant le symbole d'Elm.
detect_extensionsdetect_extensions	['elm']	Les extensions qui déclenchent ce module.
detect_files	['elm.json', 'elm-package.json', '.elm-version']	Les fichiers qui activent ce module.
detect_folders	['elm-stuff']	Quels dossiers devraient activer ce module.
style	'cyan bold'	Le style pour le module.
disabled	false	Désactive le module elm.

Variables

Variable	Exemple	Description
version	v0.19.1	La version de elm
symbole		Reflète la valeur de l'option symbol
style*		Reflète la valeur de l'option style

*: Cette variable peut uniquement être utilisée dans une chaine de style

Exemple

# ~/.config/starship.toml

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

Variable d'environnement

Le module env_var affiche la valeur actuelle de la variable d’environnement choisie. Le module sera affiché si l'une de ces conditions est remplie:

• L'option variable correspond à une variable d'environnement existante
• L'option variable n'est pas définie, mais l'option default l'est

::: tip

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

:::

::: tip

Plusieurs variables d’environnement peuvent être affichées en utilisant un .. (voir exemple). Si l’option de configuration variable n’est pas définie, le module affichera la valeur de la variable dont le nom est le texte après le caractère ..

Exemple : la configuration suivante va afficher la valeur de la variable d’environnement UTILISATEUR

# ~/.config/starship.toml

[env_var.USER]
default = 'unknown user'

:::

Options

Option	Défaut	Description
symbole	""	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.
description	"<env_var module>"	The description of the module that is shown when running starship explain.
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
symbole		Reflète la valeur de l'option symbol
style*	black bold dimmed	Reflète la valeur de l'option style

*: Cette variable peut uniquement être utilisée dans une chaine de style

Exemple

# ~/.config/starship.toml

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

Afficher plusieurs variables d’environnement:

# ~/.config/starship.toml

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

Erlang

Le module erlang affiche la version de Erlang/OTP installée. Par défaut, le module sera affiché si l’une de ces conditions est remplie:

• Le dossier courant contient un fichier rebar.config.
• Le dossier 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
symbole	' '	Le symbole utilisé avant d'afficher la version d'erlang.
style	'bold red'	Le style pour le module.
detect_extensionsdetect_extensions	[]	Les extensions qui déclenchent ce module.
detect_files	['rebar.config', 'elang.mk']	Les fichiers qui activent 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
symbole		Reflète la valeur de l'option symbol
style*		Reflète la valeur de l'option style

*: Cette variable peut uniquement être utilisée dans une chaine de style

Exemple

# ~/.config/starship.toml

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

Fennel

The fennel module shows the currently installed version of Fennel. Par défaut, le module sera affiché si l’une de ces conditions est remplie:

• The current directory contains a file with the .fnl extension

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
symbole	'🧅 '	The symbol used before displaying the version of fennel.
style	'bold green'	Le style pour le module.
detect_extensionsdetect_extensions	[fnl]	Les extensions qui déclenchent ce module.
detect_files	[]	Les fichiers qui activent ce module.
detect_folders	[]	Quels dossiers devraient activer ce module.
disabled	false	Disables the fennel module.

Variables

Variable	Exemple	Description
version	v1.2.1	The version of fennel
symbole		Reflète la valeur de l'option symbol
style*		Reflète la valeur de l'option style

*: Cette variable peut uniquement être utilisée dans une chaine de style

Exemple

# ~/.config/starship.toml

[fennel]
symbol = '⫰ '

Remplissage

Le module fill remplit l’espace restant sur la ligne avec un symbole. Si plusieurs modules fill sont présents sur une ligne, ils divisent de manière égale l’espace entre eux. C’est utile pour aligner d’autres modules.

Options

Option	Défaut	Description
symbole	'.'	Le symbole utilisé pour remplir la ligne.
style	'bold black'	Le style pour le module.
disabled	false	Désactive le module fill

Exemple

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

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

Produit une invite qui ressemble à :

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

Fossil Branch

The fossil_branch module shows the name of the active branch of the check-out in your current directory.

Options

Option	Défaut	Description
format	'on [$symbol$branch]($style) '	Format du module. Use '$branch' to refer to the current branch name.
symbole	' '	The symbol used before the branch name of the check-out in your current directory.
style	'bold purple'	Le style pour le module.
truncation_length	2^63 - 1	Truncates a Fossil branch name to N graphemes
truncation_symbol	'…'	Le symbole utilisé pour indiquer qu'un nom de branche a été tronqué. You can use '' for no symbol.
disabled	true	Disables the fossil_branch module.

Variables

Variable	Exemple	Description
branch	trunk	The active Fossil branch
symbole		Reflète la valeur de l'option symbol
style*		Reflète la valeur de l'option style

*: Cette variable peut uniquement être utilisée dans une chaine de style

Exemple

# ~/.config/starship.toml

[fossil_branch]
symbol = '🦎 '
truncation_length = 4
truncation_symbol = ''

Fossil Metrics

The fossil_metrics module will show the number of added and deleted lines in the check-out in your current directory. At least v2.14 (2021-01-20) of Fossil is required.

Options

Option	Défaut	Description
format	'([+$added]($added_style) )([-$deleted]($deleted_style) )'	Format du module.
added_style	'bold green'	The style for the added count.
deleted_style	'bold red'	The style for the deleted count.
only_nonzero_diffs	true	Render status only for changed items.
disabled	true	Disables the fossil_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 peut uniquement être utilisée dans une chaine de style

Exemple

# ~/.config/starship.toml

[fossil_metrics]
added_style = 'bold blue'
format = '[+$added]($added_style)/[-$deleted]($deleted_style) '

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.

When the module is enabled it will always be active, unless detect_env_vars has been set in which case the module will only be active be active when one of the environment variables has been set.

Options

Option	Défaut	Description
format	'on [$symbol$account(@$domain)(\($region\))]($style) '	Format du module.
symbole	'☁️ '	The symbol used before displaying the current GCP profile.
region_aliases	{}	Table of region aliases to display in addition to the GCP name.
project_aliases	{}	Table of project aliases to display in addition to the GCP name.
detect_env_vars	[]	Which environmental variables should trigger this module
style	'bold blue'	Le style pour le module.
disabled	false	Disables the gcloud module.

Variables

Variable	Exemple	Description
region	us-central1	The current GCP region
account	foo	The current GCP profile
domain	example.com	The current GCP profile domain
project		The current GCP project
active	default	The active config name written in ~/.config/gcloud/active_config
symbole		Reflète la valeur de l'option symbol
style*		Reflète la valeur de l'option style

*: Cette variable peut uniquement être utilisée dans une chaine 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'

Afficher le compte et le projet aliasée

# ~/.config/starship.toml

[gcloud]
format = 'on [$symbol$account(@$domain)(\($project\))]($style) '
[gcloud.project_aliases]
very-long-project-name = 'vlpn'

Git Branch

The git_branch module shows the active branch of the repo in your current directory.

Options

Option	Défaut	Description
always_show_remote	false	Shows the remote tracking branch name, even if it is equal to the local branch name.
format	'on [$symbol$branch(:$remote_branch)]($style) '	Format du module. Use '$branch' to refer to the current branch name.
symbole	' '	A format string representing the symbol of git branch.
style	'bold purple'	Le style pour le module.
truncation_length	2^63 - 1	Truncates a git branch to N graphemes.
truncation_symbol	'…'	Le symbole utilisé pour indiquer qu'un nom de branche a été tronqué. You can use '' for no symbol.
only_attached	false	Only show the branch name when not in a detached HEAD state.
ignore_branches	[]	A list of names to avoid displaying. Useful for 'master' or 'main'.
disabled	false	Disables the git_branch module.

Variables

Variable	Exemple	Description
branch	master	The current branch name, falls back to HEAD if there's no current branch (e.g. git detached HEAD).
remote_name	origin	The remote name.
remote_branch	master	The name of the branch tracked on remote_name.
symbole		Reflète la valeur de l'option symbol
style*		Reflète la valeur de l'option style

*: Cette variable peut uniquement être utilisée dans une chaine de style

Exemple

# ~/.config/starship.toml

[git_branch]
symbol = '🌱 '
truncation_length = 4
truncation_symbol = ''
ignore_branches = ['master', 'main']

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	The length of the displayed git commit hash.
format	'[\($hash$tag\)]($style) '	Format du module.
style	'bold green'	Le style pour le module.
only_detached	true	Only show git commit hash when in detached HEAD state
tag_disabled	true	Disables showing tag info in git_commit module.
tag_max_candidates	0	How many commits to consider for tag display. The default only allows exact matches.
tag_symbol	' 🏷 '	Tag symbol prefixing the info shown
disabled	false	Disables the git_commit module.

Variables

Variable	Exemple	Description
hash	b703eb3	The current git commit hash
tag	v1.0.0	The tag name if showing tag info is enabled.
style*		Reflète la valeur de l'option style

*: Cette variable peut uniquement être utilisée dans une chaine de style

Exemple

# ~/.config/starship.toml

[git_commit]
commit_hash_length = 4
tag_symbol = '🔖 '

Git State

The git_state module will show in directories which are part of a git repository, and where there is an operation in progress, such as: REBASING, BISECTING, etc. If there is progress information (e.g., REBASING 3/10), that information will be shown too.

Options

Option	Défaut	Description
rebase	'REBASING'	A format string displayed when a rebase is in progress.
merge	'MERGING'	A format string displayed when a merge is in progress.
revert	'REVERTING'	A format string displayed when a revert is in progress.
cherry_pick	'CHERRY-PICKING'	A format string displayed when a cherry-pick is in progress.
bisect	'BISECTING'	A format string displayed when a bisect is in progress.
am	'AM'	A format string displayed when an apply-mailbox (git am) is in progress.
am_or_rebase	'AM/REBASE'	A format string displayed when an ambiguous apply-mailbox or rebase is in progress.
style	'bold yellow'	Le style pour le module.
format	'\([$state( $progress_current/$progress_total)]($style)\) '	Format du module.
disabled	false	Disables the git_state module.

Variables

Variable	Exemple	Description
state	REBASING	The current state of the repo
progress_current	1	The current operation progress
progress_total	2	The total operation progress
style*		Reflète la valeur de l'option style

*: Cette variable peut uniquement être utilisée dans une chaine 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 red'	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.
ignore_submodules	false	Ignore changes to submodules

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 peut uniquement être utilisée dans une chaine 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.

::: tip

The Git Status module is very slow in Windows directories (for example under /mnt/c/) when in a WSL environment. You can disable the module or use the windows_starship option to use a Windows-native Starship executable to compute git_status for those paths.

:::

Options

Option	Défaut	Description
format	'([\[$all_status$ahead_behind\]]($style) )'	The default format for git_status
conflicted	'='	This branch has merge conflicts.
ahead	'⇡'	The format of ahead
behind	'⇣'	The format of behind
diverged	'⇕'	The format of diverged
up_to_date	''	The format of up_to_date
untracked	'?'	The format of untracked
stashed	'$'	The format of stashed
modified	'!'	The format of modified
staged	'+'	The format of staged
renamed	'»'	The format of renamed
deleted	'✘'	The format of deleted
typechanged	""	The format of typechange
style	'bold red'	Le style pour le module.
ignore_submodules	false	Ignore changes to submodules.
disabled	false	Disables the git_status module.
windows_starship		Use this (Linux) path to a Windows Starship executable to render git_status when on Windows paths in WSL.

Variables

The following variables can be used in format:

Variable	Description
all_status	Shortcut for$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	Displays conflicted when this branch has merge conflicts.
untracked	Displays untracked when there are untracked files in the working directory.
stashed	Displays stashed when a stash exists for the local repository.
modified	Displays modified when there are file modifications in the working directory.
staged	Displays staged when a new file has been added to the staging area.
renamed	Displays renamed when a renamed file has been added to the staging area.
deleted	Displays deleted when a file's deletion has been added to the staging area.
typechanged	Displays typechange when a file's type has been changed in the staging area.
style*	Reflète la valeur de l'option style

*: Cette variable peut uniquement être utilisée dans une chaine de style

The following variables can be used in diverged:

Variable	Description
ahead_count	Number of commits ahead of the tracking branch
behind_count	Number of commits behind the tracking branch

The following variables can be used in conflicted, ahead, behind, untracked, stashed, modified, staged, renamed and deleted:

Variable	Description
count	Show the number of files

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}'

Use Windows Starship executable on Windows paths in WSL

# ~/.config/starship.toml

[git_status]
windows_starship = '/mnt/c/Users/username/scoop/apps/starship/current/starship.exe'

Go

The golang module shows the currently installed version of Go. Par défaut, le module sera affiché si l’une de ces conditions est remplie:

• Le dossier courant contient un fichier go.mod
• Le dossier courant contient un fichier go.sum
• Le dossier courant contient un fichier go.work
• Le dossier courant contient un fichier glide.yaml
• Le dossier courant contient un fichier Gopkg.yml
• Le dossier courant contient un fichier Gopkg.lock
• Le dossier courant contient un fichier .go-version
• Le dossier courant contient un dossier Godeps
• Le dossier courant 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
symbole	'🐹 '	A format string representing the symbol of Go.
detect_extensionsdetect_extensions	['go']	Les extensions qui déclenchent ce module.
detect_files	['go.mod', 'go.sum', 'go.work', 'glide.yaml', 'Gopkg.yml', 'Gopkg.lock', '.go-version']	Les fichiers qui activent ce module.
detect_folders	['Godeps']	Les dossiers qui activent ce module.
style	'bold cyan'	Le style pour le module.
not_capable_style	'bold red'	The style for the module when the go directive in the go.mod file does not match the installed Go version.
disabled	false	Disables the golang module.

Variables

Variable	Exemple	Description
version	v1.12.1	The version of go
mod_version	1.16	go version requirement as set in the go directive of go.mod. Will only show if the version requirement does not match the go version.
symbole		Reflète la valeur de l'option symbol
style*		Reflète la valeur de l'option style

*: Cette variable peut uniquement être utilisée dans une chaine de style

Exemple

# ~/.config/starship.toml

[golang]
format = 'via [🏎💨 $version](bold cyan) '

Using mod_version

# ~/.config/starship.toml

[golang]
format = 'via [$symbol($version )($mod_version )]($style)'

Guix-shell

The guix_shell module shows the guix-shell environment. The module will be shown when inside a guix-shell environment.

Options

Option	Défaut	Description
format	'via [$symbol]($style) '	Format du module.
symbole	"🐃 "	A format string representing the symbol of guix-shell.
style	"yellow bold"	Le style pour le module.
disabled	false	Disables the guix_shell module.

Variables

Variable	Exemple	Description
symbole		Reflète la valeur de l'option symbol
style*		Reflète la valeur de l'option style

*: Cette variable peut uniquement être utilisée dans une chaine de style

Exemple

# ~/.config/starship.toml

[guix_shell]
disabled = true
format = 'via [🐂](yellow bold) '

Gradle

The gradle module shows the version of the Gradle Wrapper currently used in the project directory.

Par défaut, le module sera affiché si l’une de ces conditions est remplie:

• The current directory contains a gradle/wrapper/gradle-wrapper.properties directory.
• The current directory contains a file ending with .gradle or .gradle.kts.

The gradle module is only able to read your Gradle Wrapper version from your config file, we don't execute your wrapper, because of the security concerns.

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
symbole	"🅶 "	A format string representing the symbol of Gradle.
detect_extensionsdetect_extensions	["gradle", "gradle.kts"]	Les extensions qui déclenchent ce module.
detect_files	[]	Les fichiers qui activent ce module.
detect_folders	["gradle"]	Les dossiers qui activent ce module.
style	"bold bright-cyan"	Le style pour le module.
disabled	false	Disables the gradle module.
recursive	false	Enables recursive finding for the gradle directory.

Variables

Variable	Exemple	Description
version	v7.5.1	The version of gradle
symbole		Reflète la valeur de l'option symbol
style*		Reflète la valeur de l'option style

*: Cette variable peut uniquement être utilisée dans une chaine de style

Haskell

The haskell module finds the current selected GHC version and/or the selected Stack snapshot.

Par défaut, le module sera affiché si l’une de ces conditions est remplie:

• Le dossier courant contient un fichier stack.yaml
• Le dossier courant contient un fichier .hs, .cabal ou .hs-boot

Options

Option	Défaut	Description
format	'via [$symbol($version )]($style)'	Format du module.
symbole	'λ '	A format string representing the symbol of Haskell
detect_extensionsdetect_extensions	['hs', 'cabal', 'hs-boot']	Les extensions qui déclenchent ce module.
detect_files	['stack.yaml', 'cabal.project']	Les fichiers qui activent ce module.
detect_folders	[]	Les dossiers qui activent ce module.
style	'bold purple'	Le style pour le module.
disabled	false	Disables the haskell module.

Variables

Variable	Exemple	Description
version		ghc_version or snapshot depending on whether the current project is a Stack project
snapshot	lts-18.12	Currently selected Stack snapshot
ghc_version	9.2.1	Currently installed GHC version
symbole		Reflète la valeur de l'option symbol
style*		Reflète la valeur de l'option style

*: Cette variable peut uniquement être utilisée dans une chaine de style

Haxe

The haxe module shows the currently installed version of Haxe. Par défaut, le module sera affiché si l’une de ces conditions est remplie:

• The current directory contains a project.xml, Project.xml, application.xml, haxelib.json, hxformat.json or .haxerc file
• The current directory contains a .haxelib or a haxe_libraries directory
• The current directory contains a file with the .hx or .hxml extension

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_extensionsdetect_extensions	["hx", "hxml"]	Les extensions qui déclenchent ce module.
detect_files	["project.xml", "Project.xml", "application.xml", "haxelib.json", "hxformat.json", ".haxerc"]	Les fichiers qui activent ce module.
detect_folders	[".haxelib", "haxe_libraries"]	Quels dossiers devraient activer ce module.
symbole	"⌘ "	Une chaîne de format représentant le symbole de Helm.
style	"bold fg:202"	Le style pour le module.
disabled	false	Disables the haxe module.

Variables

Variable	Exemple	Description
version	v4.2.5	The version of haxe
symbole		Reflète la valeur de l'option symbol
style*		Reflète la valeur de l'option style

*: Cette variable peut uniquement être utilisée dans une chaine de style

Exemple

# ~/.config/starship.toml

[haxe]
format = "via [⌘ $version](bold fg:202) "

Helm

The helm module shows the currently installed version of Helm. Par défaut, le module sera affiché si l’une de ces conditions est remplie:

• Le dossier courant contient un fichier helmfile.yaml
• Le dossier courant contient un fichier Chart.yaml

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_extensionsdetect_extensions	[]	Les extensions qui déclenchent ce module.
detect_files	['helmfile.yaml', 'Chart.yaml']	Les fichiers qui activent ce module.
detect_folders	[]	Quels dossiers devraient activer ce module.
symbole	'⎈ '	Une chaîne de format représentant le symbole de Helm.
style	'bold white'	Le style pour le module.
disabled	false	Disables the helm module.

Variables

Variable	Exemple	Description
version	v3.1.1	The version of helm
symbole		Reflète la valeur de l'option symbol
style*		Reflète la valeur de l'option style

*: Cette variable peut uniquement être utilisée dans une chaine 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	Only show hostname when connected to an SSH session.
ssh_symbol	'🌐 '	A format string representing the symbol when connected to SSH session.
trim_at	'.'	String that the hostname is cut off at, after the first match. '.' will stop after the first dot. '' will disable any truncation
format	'[$ssh_symbol$hostname]($style) in '	Format du module.
style	'bold dimmed green'	Le style pour le module.
disabled	false	Disables the hostname module.

Variables

Variable	Exemple	Description
hostname	computer	The hostname of the computer
style*		Reflète la valeur de l'option style
ssh_symbol	'🌏 '	The symbol to represent when connected to SSH session

*: Cette variable peut uniquement être utilisée dans une chaine de style

Exemple

# ~/.config/starship.toml

[hostname]
ssh_only = false
format = '[$ssh_symbol](bold blue) 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 affiché si l’une de ces conditions est remplie:

• The current directory contains a pom.xml, build.gradle.kts, build.sbt, .java-version, deps.edn, project.clj, build.boot, or .sdkmanrc file
• Le dossier courant 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_extensionsdetect_extensions	['java', 'class', 'gradle', 'jar', 'cljs', 'cljc']	Les extensions qui déclenchent ce module.
detect_files	['pom.xml', 'build.gradle.kts', 'build.sbt', '.java-version', 'deps.edn', 'project.clj', 'build.boot', '.sdkmanrc']	Les fichiers qui activent ce module.
detect_folders	[]	Quels dossiers devraient activer ce module.
symbole	'☕ '	A format string representing the symbol of Java
style	'red dimmed'	Le style pour le module.
disabled	false	Disables the java module.

Variables

Variable	Exemple	Description
version	v14	The version of java
symbole		Reflète la valeur de l'option symbol
style*		Reflète la valeur de l'option style

*: Cette variable peut uniquement être utilisée dans une chaine 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 tâche -> Rien n’est affiché.
• 1 tâche -> symbol est affiché.
• 2 taĉhes ou plus -> symbol + number sont affichés.

::: 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	Show number of jobs if exceeded.
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.
symbole	'✦'	The string used to represent the symbol variable.
style	'bold blue'	Le style pour le module.
disabled	false	Disables the jobs module.

*: This option is deprecated, please use the number_threshold and symbol_threshold options instead.

Variables

Variable	Exemple	Description
number	1	The number of jobs
symbole		Reflète la valeur de l'option symbol
style*		Reflète la valeur de l'option style

*: Cette variable peut uniquement être utilisée dans une chaine 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 affiché si l’une de ces conditions est remplie:

• Le dossier courant contient un fichier Project.toml
• Le dossier courant contient un fichier Manifest.toml
• Le dossier courant contient un fichier .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_extensionsdetect_extensions	['jl']	Les extensions qui déclenchent ce module.
detect_files	['Project.toml', 'Manifest.toml']	Les fichiers qui activent ce module.
detect_folders	[]	Quels dossiers devraient activer ce module.
symbole	'ஃ '	A format string representing the symbol of Julia.
style	'bold purple'	Le style pour le module.
disabled	false	Disables the julia module.

Variables

Variable	Exemple	Description
version	v1.4.0	The version of julia
symbole		Reflète la valeur de l'option symbol
style*		Reflète la valeur de l'option style

*: Cette variable peut uniquement être utilisée dans une chaine 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 affiché si l’une de ces conditions est remplie:

• Le dossier 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_extensionsdetect_extensions	['kt', 'kts']	Les extensions qui déclenchent ce module.
detect_files	[]	Les fichiers qui activent ce module.
detect_folders	[]	Quels dossiers devraient activer ce module.
symbole	'🅺 '	A format string representing the symbol of Kotlin.
style	'bold blue'	Le style pour le module.
kotlin_binary	'kotlin'	Configures the kotlin binary that Starship executes when getting the version.
disabled	false	Disables the kotlin module.

Variables

Variable	Exemple	Description
version	v1.4.21	The version of kotlin
symbole		Reflète la valeur de l'option symbol
style*		Reflète la valeur de l'option style

*: Cette variable peut uniquement être utilisée dans une chaine 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, user and cluster from the kubeconfig file. The namespace needs to be set in the kubeconfig file, this can be done via kubectl config set-context starship-context --namespace astronaut. Similarly, the user and cluster can be set with kubectl config set-context starship-context --user starship-user and kubectl config set-context starship-context --cluster starship-cluster. 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.

When the module is enabled it will always be active, unless any of detect_extensions, detect_files or detect_folders have been set in which case the module will only be active in directories that match those conditions.

:::

Options

::: warning

The context_aliases and user_aliases options are deprecated. Use contexts and the corresponding context_alias and user_alias options instead.

:::

Option	Défaut	Description
symbole	'☸ '	A format string representing the symbol displayed before the Cluster.
format	'[$symbol$context( \($namespace\))]($style) in '	Format du module.
style	'cyan bold'	Le style pour le module.
context_aliases*	{}	Table of context aliases to display.
user_aliases*	{}	Table of user aliases to display.
detect_extensionsdetect_extensions	[]	Les extensions qui déclenchent ce module.
detect_files	[]	Les fichiers qui activent ce module.
detect_folders	[]	Quels dossiers devraient activer ce module.
contexts	[]	Customized styles and symbols for specific contexts.
disabled	true	Disables the kubernetes module.

*: This option is deprecated, please add contexts with the corresponding context_alias and user_alias options instead.

To customize the style of the module for specific environments, use the following configuration as part of the contexts list:

Variable	Description
context_pattern	Required Regular expression to match current Kubernetes context name.
user_pattern	Regular expression to match current Kubernetes user name.
context_alias	Context alias to display instead of the full context name.
user_alias	User alias to display instead of the full user name.
style	The style for the module when using this context. If not set, will use module's style.
symbole	The symbol for the module when using this context. If not set, will use module's symbol.

Note that all regular expression are anchored with ^<pattern>$ and so must match the whole string. The *_pattern regular expressions may contain capture groups, which can be referenced in the corresponding alias via $name and $N (see example below and the rust Regex::replace() documentation).

Variables

Variable	Exemple	Description
context	starship-context	The current kubernetes context name
namespace	starship-namespace	If set, the current kubernetes namespace
user	starship-user	If set, the current kubernetes user
cluster	starship-cluster	If set, the current kubernetes cluster
symbole		Reflète la valeur de l'option symbol
style*		Reflète la valeur de l'option style

*: Cette variable peut uniquement être utilisée dans une chaine de style

Exemple

# ~/.config/starship.toml

[kubernetes]
format = 'on [⛵ ($user on )($cluster in )$context \($namespace\)](dimmed green) '
disabled = false
contexts = [
  { context_pattern = "dev.local.cluster.k8s", style = "green", symbol = "💔 " },
]

Only show the module in directories that contain a k8s file.

# ~/.config/starship.toml

[kubernetes]
disabled = false
detect_files = ['k8s']

Kubernetes Context specific config

The contexts configuration option is used to customise what the current Kubernetes context name looks like (style and symbol) if the name matches the defined regular expression.

# ~/.config/starship.toml

[[kubernetes.contexts]]
# "bold red" style + default symbol when Kubernetes current context name equals "production" *and* the current user
# equals "admin_user"
context_pattern = "production"
user_pattern = "admin_user"
style = "bold red"
context_alias = "prod"
user_alias = "admin"

[[kubernetes.contexts]]
# "green" style + a different symbol when Kubernetes current context name contains openshift
context_pattern = ".*openshift.*"
style = "green"
symbol = "💔 "
context_alias = "openshift"

[[kubernetes.contexts]]
# Using capture groups
# 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`):
context_pattern = "gke_.*_(?P<cluster>[\\w-]+)"
context_alias = "gke-$cluster"

Line Break

The line_break module separates the prompt into two lines.

Options

Option	Défaut	Description
disabled	false	Disables the line_break module, making the prompt a single line.

Exemple

# ~/.config/starship.toml

[line_break]
disabled = true

Local IP

The localip module shows the IPv4 address of the primary network interface.

Options

Option	Défaut	Description
ssh_only	true	Only show IP address when connected to an SSH session.
format	'[$localipv4]($style) '	Format du module.
style	'bold yellow'	Le style pour le module.
disabled	true	Disables the localip module.

Variables

Variable	Exemple	Description
localipv4	192.168.1.13	Contains the primary IPv4 address
style*		Reflète la valeur de l'option style

*: Cette variable peut uniquement être utilisée dans une chaine de style

Exemple

# ~/.config/starship.toml

[localip]
ssh_only = false
format = '@[$localipv4](bold red) '
disabled = false

Lua

The lua module shows the currently installed version of Lua. Par défaut, le module sera affiché si l’une de ces conditions est remplie:

• Le dossier courant contient un fichier .lua-version
• Le dossier courant contient un dossier lua
• Le dossier courant 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
symbole	'🌙 '	A format string representing the symbol of Lua.
detect_extensionsdetect_extensions	['lua']	Les extensions qui déclenchent ce module.
detect_files	['.lua-version']	Les fichiers qui activent ce module.
detect_folders	['lua']	Les dossiers qui activent ce module.
style	'bold blue'	Le style pour le module.
lua_binary	'lua'	Configures the lua binary that Starship executes when getting the version.
disabled	false	Disables the lua module.

Variables

Variable	Exemple	Description
version	v5.4.0	The version of lua
symbole		Reflète la valeur de l'option symbol
style*		Reflète la valeur de l'option style

*: Cette variable peut uniquement être utilisée dans une chaine de style

Exemple

# ~/.config/starship.toml

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

Memory Usage

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	Hide the memory usage unless it exceeds this percentage.
format	'via $symbol [${ram}( | ${swap})]($style) '	Format du module.
symbole	'🐏'	The symbol used before displaying the memory usage.
style	'bold dimmed white'	Le style pour le module.
disabled	true	Disables the memory_usage module.

Variables

Variable	Exemple	Description
ram	31GiB/65GiB	The usage/total RAM of the current system memory.
ram_pct	48%	The percentage of the current system memory.
swap**	1GiB/4GiB	The swap memory size of the current system swap memory file.
swap_pct**	77%	The swap memory percentage of the current system swap memory file.
symbole	🐏	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'

Meson

The meson module shows the current Meson developer environment status.

By default the Meson project name is displayed, if $MESON_DEVENV is set.

Options

Option	Défaut	Description
truncation_length	2^32 - 1	Truncates a project name to N graphemes.
truncation_symbol	'…'	The symbol used to indicate a project name was truncated. You can use '' for no symbol.
format	'via [$symbol$project]($style) '	Format du module.
symbole	'⬢ '	The symbol used before displaying the project name.
style	'blue bold'	Le style pour le module.
disabled	false	Disables the meson module.

Variables

Variable	Exemple	Description
project	starship	The current Meson project name
symbole	🐏	Reflète la valeur de l'option symbol
style*		Reflète la valeur de l'option style

*: Cette variable peut uniquement être utilisée dans une chaine de style

Exemple

# ~/.config/starship.toml

[meson]
disabled = false
truncation_symbol = '--'
symbol = ' '
style = 'bold dimmed green'

Mercurial Branch

The hg_branch module shows the active branch and topic of the repo in your current directory.

Options

Option	Défaut	Description
symbole	' '	The symbol used before the hg bookmark or branch name of the repo in your current directory.
style	'bold purple'	Le style pour le module.
format	'on [$symbol$branch(:$topic)]($style) '	Format du module.
truncation_length	2^63 - 1	Truncates the hg branch / topic name to N graphemes
truncation_symbol	'…'	Le symbole utilisé pour indiquer qu'un nom de branche a été tronqué.
disabled	true	Disables the hg_branch module.

Variables

Variable	Exemple	Description
branch	master	The active mercurial branch
topic	feature	The active mercurial topic
symbole		Reflète la valeur de l'option symbol
style*		Reflète la valeur de l'option style

*: Cette variable peut uniquement être utilisée dans une chaine 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 affiché si l’une de ces conditions est remplie:

• Le dossier courant contient un fichier nim.cfg
• Le dossier courant contient un fichier avec l’extension .nim
• Le dossier courant contient un fichier avec l’extension .nims
• Le dossier courant contient un fichier avec l’extension .nimble

Options

Option	Défaut	Description
format	'via [$symbol($version )]($style)'	The format for the module
version_format	'v${raw}'	Le format de la version. Les variables disponibles sont raw, major, minor, & patch
symbole	'👑 '	The symbol used before displaying the version of Nim.
detect_extensionsdetect_extensions	['nim', 'nims', 'nimble']	Les extensions qui déclenchent ce module.
detect_files	['nim.cfg']	Les fichiers qui activent ce module.
detect_folders	[]	Les dossiers qui activent ce module.
style	'bold yellow'	Le style pour le module.
disabled	false	Disables the nim module.

Variables

Variable	Exemple	Description
version	v1.2.0	The version of nimc
symbole		Reflète la valeur de l'option symbol
style*		Reflète la valeur de l'option style

*: Cette variable peut uniquement être utilisée dans une chaine 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.
symbole	'❄️ '	A format string representing the symbol of nix-shell.
style	'bold blue'	Le style pour le module.
impure_msg	'impure'	A format string shown when the shell is impure.
pure_msg	'pure'	A format string shown when the shell is pure.
unknown_msg	''	A format string shown when it is unknown if the shell is pure/impure.
disabled	false	Disables the nix_shell module.
heuristic	false	Attempts to detect new nix shell-style shells with a heuristic.

Variables

Variable	Exemple	Description
state	pure	The state of the nix-shell
name	lorri	The name of the nix-shell
symbole		Reflète la valeur de l'option symbol
style*		Reflète la valeur de l'option style

*: Cette variable peut uniquement être utilisée dans une chaine de style

Exemple

# ~/.config/starship.toml

[nix_shell]
disabled = true
impure_msg = '[impure shell](bold red)'
pure_msg = '[pure shell](bold green)'
unknown_msg = '[unknown shell](bold yellow)'
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 affiché si l’une de ces conditions est remplie:

• Le dossier courant contient un fichier package.json
• Le dossier courant contient un fichier .node-version
• Le dossier courant contient un fichier .nvmrc
• Le répertoire courant contient un répertoire node_modules
• Le dossier courant contient un fichier avec l’extension .js, .mjs ou .cjs
• Le dossier courant contient un fichier avec l’extension .ts, .mts ou .cts

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
symbole	' '	A format string representing the symbol of Node.js.
detect_extensionsdetect_extensions	['js', 'mjs', 'cjs', 'ts', 'mts', 'cts']	Les extensions qui déclenchent ce module.
detect_files	['package.json', '.node-version']	Les fichiers qui activent ce module.
detect_folders	['node_modules']	Les dossiers qui activent ce module.
style	'bold green'	Le style pour le module.
disabled	false	Disables the nodejs module.
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	The version of node
engines_version	>=12.0.0	node version requirement as set in the engines property of package.json. Will only show if the version requirement does not match the node version.
symbole		Reflète la valeur de l'option symbol
style*		Reflète la valeur de l'option style

*: Cette variable peut uniquement être utilisée dans une chaine 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 affiché si l’une de ces conditions est remplie:

• Le dossier courant contient un fichier avec l’extension .opam ou un dossier _opam
• Le répertoire courant contient un répertoire esy.lock
• Le dossier courant contient un fichier dune ou dune-project
• Le dossier courant contient un fichier jbuild ou jbuild-ignore
• Le dossier courant contient un fichier .merlin
• Le dossier courant 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
symbole	'🐫 '	The symbol used before displaying the version of OCaml.
global_switch_indicator	''	The format string used to represent global OPAM switch.
local_switch_indicator	'*'	The format string used to represent local OPAM switch.
detect_extensionsdetect_extensions	['opam', 'ml', 'mli', 're', 'rei']	Les extensions qui déclenchent ce module.
detect_files	['dune', 'dune-project', 'jbuild', 'jbuild-ignore', '.merlin']	Les fichiers qui activent ce module.
detect_folders	['_opam', 'esy.lock']	Les dossiers qui activent ce module.
style	'bold yellow'	Le style pour le module.
disabled	false	Disables the ocaml module.

Variables

Variable	Exemple	Description
version	v4.10.0	The version of ocaml
switch_name	my-project	The active OPAM switch
switch_indicator		Mirrors the value of indicator for currently active OPAM switch
symbole		Reflète la valeur de l'option symbol
style*		Reflète la valeur de l'option style

*: Cette variable peut uniquement être utilisée dans une chaine de style

Exemple

# ~/.config/starship.toml

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

Open Policy Agent

The opa module shows the currently installed version of the OPA tool. By default the module will be shown if the current directory contains a .rego 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
symbole	'🪖 '	A format string representing the symbol of OPA.
detect_extensionsdetect_extensions	['rego']	Les extensions qui déclenchent ce module.
detect_files	[]	Les fichiers qui activent ce module.
detect_folders	[]	Les dossiers qui activent ce module.
style	'bold blue'	Le style pour le module.
disabled	false	Disables the opa module.

Variables

Variable	Exemple	Description
version	v0.44.0	The version of opa
symbole		Reflète la valeur de l'option symbol
style*		Reflète la valeur de l'option style

*: Cette variable peut uniquement être utilisée dans une chaine de style

Exemple

# ~/.config/starship.toml

[opa]
format = 'via [⛑️  $version](bold red) '

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.
symbole	'☁️ '	The symbol used before displaying the current OpenStack cloud.
style	'bold yellow'	Le style pour le module.
disabled	false	Disables the openstack module.

Variables

Variable	Exemple	Description
cloud	corp	The current OpenStack cloud
project	dev	The current OpenStack project
symbole		Reflète la valeur de l'option symbol
style*		Reflète la valeur de l'option style

*: Cette variable peut uniquement être utilisée dans une chaine de style

Exemple

# ~/.config/starship.toml

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

OS

The os module shows the current operating system. OS information is detected via the os_info crate.

::: warning

The os_info crate used by this module is known to be inaccurate on some systems.

:::

::: tip

This module is disabled by default. To enable it, set disabled to false in your configuration file.

:::

Options

Option	Défaut	Description
format	"[$symbol]($style)"	Format du module.
style	"bold white"	Le style pour le module.
disabled	true	Disables the os module.
symbols		A table that maps each operating system to its symbol.

symbols allows you to define arbitrary symbols to display for each operating system type. Operating system types not defined by your configuration use the default symbols table below. All operating systems currently supported by the module are listed below. If you would like an operating system to be added, feel free to open a feature request.

# This is the default symbols table.
[os.symbols]
Alpaquita = "🔔 "
Alpine = "🏔️ "
Amazon = "🙂 "
Android = "🤖 "
Arch = "🎗️ "
Artix = "🎗️ "
CentOS = "💠 "
Debian = "🌀 "
DragonFly = "🐉 "
Emscripten = "🔗 "
EndeavourOS = "🚀 "
Fedora = "🎩 "
FreeBSD = "😈 "
Garuda = "🦅 "
Gentoo = "🗜️ "
HardenedBSD = "🛡️ "
Illumos = "🐦 "
Linux = "🐧 "
Mabox = "📦 "
Macos = "🍎 "
Manjaro = "🥭 "
Mariner = "🌊 "
MidnightBSD = "🌘 "
Mint = "🌿 "
NetBSD = "🚩 "
NixOS = "❄️ "
OpenBSD = "🐡 "
OpenCloudOS = "☁️ "
openEuler = "🦉 "
openSUSE = "🦎 "
OracleLinux = "🦴 "
Pop = "🍭 "
Raspbian = "🍓 "
Redhat = "🎩 "
RedHatEnterprise = "🎩 "
Redox = "🧪 "
Solus = "⛵ "
SUSE = "🦎 "
Ubuntu = "🎯 "
Unknown = "❓ "
Windows = "🪟 "

Variables

Variable	Exemple	Description
symbole	🎗️	The current operating system symbol from advanced option symbols
name	Arch Linux	The current operating system name
type	Arch	The current operating system type
codename		The current operating system codename, if applicable
edition		The current operating system edition, if applicable
version		The current operating system version, if applicable
style*		Reflète la valeur de l'option style

*: Cette variable peut uniquement être utilisée dans une chaine de style

Exemple

# ~/.config/starship.toml

[os]
format = "on [($name )]($style)"
style = "bold blue"
disabled = false

[os.symbols]
Windows = " "
Arch = "Arch is the best! "

Package Version

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, python, composer, gradle, julia, mix, helm, shards, daml and dart packages.

• npm – La version du paquet npm est extraite du package.json présent dans le répertoire courant
• Cargo – La version du paquet cargo est extraite du Cargo.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 commande nimble dump
• Poetry – La version du paquet poetry est extraite du pyproject.toml présent dans le répertoire courant
• Python - The python package version is extracted from a PEP 621 compliant pyproject.toml or a setup.cfg present in the current directory
• Composer – La version du paquet composer est extraite du composer.json présent dans le répertoire courant
• Gradle – The gradle package version is extracted from the build.gradle present in the current directory
• Julia - The package version is extracted from the Project.toml present in the current directory
• Mix - The mix package version is extracted from the mix.exs present in the current directory
• Helm - The helm chart version is extracted from the Chart.yaml present in the current directory
• Maven - The maven package version is extracted from the pom.xml present in the current directory
• Meson - The meson package version is extracted from the meson.build present in the current directory
• Shards - The shards package version is extracted from the shard.yml present in the current directory
• V - The vlang package version is extracted from the v.mod present in the current directory
• SBT - La version du paquet sbt est extraite du build.sbt présent dans le dossier courant
• Daml - The daml package version is extracted from the daml.yaml present in the current directory
• Dart – La version du paquet dart est extrait du pubspec.yaml présent dans le répertoire courant

⚠️ La version montrée est celle du paquet dont le code source est dans votre dossier courant, pas votre gestionnaire de paquet.

Options

Option	Défaut	Description
format	'is [$symbol$version]($style) '	Format du module.
symbole	'📦 '	The symbol used before displaying the version the package.
version_format	'v${raw}'	Le format de la version. Les variables disponibles sont raw, major, minor, & patch
style	'bold 208'	Le style pour le module.
display_private	false	Enable displaying version for packages marked as private.
disabled	false	Disables the package module.

Variables

Variable	Exemple	Description
version	v1.0.0	The version of your package
symbole		Reflète la valeur de l'option symbol
style*		Reflète la valeur de l'option style

*: Cette variable peut uniquement être utilisée dans une chaine 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 affiché si l’une de ces conditions est remplie:

• Le dossier courant contient un fichier Makefile.PL ou Build.PL
• Le dossier courant contient un fichier cpanfile ou cpanfile.snapshot
• Le dossier courant contient un fichier META.json ou META.yml
• Le dossier 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
symbole	'🐪 '	The symbol used before displaying the version of Perl
detect_extensionsdetect_extensions	['pl', 'pm', 'pod']	Les extensions qui déclenchent ce module.
detect_files	['Makefile.PL', 'Build.PL', 'cpanfile', 'cpanfile.snapshot', 'META.json', 'META.yml', '.perl-version']	Les fichiers qui activent ce module.
detect_folders	[]	Les dossiers qui activent ce module.
style	'bold 149'	Le style pour le module.
disabled	false	Disables the perl module.

Variables

Variable	Exemple	Description
version	v5.26.1	The version of perl
symbole		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 affiché si l’une de ces conditions est remplie:

• Le dossier courant contient un fichier composer.json
• Le dossier 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
symbole	'🐘 '	The symbol used before displaying the version of PHP.
detect_extensionsdetect_extensions	['php']	Les extensions qui déclenchent ce module.
detect_files	['composer.json', '.php-version']	Les fichiers qui activent ce module.
detect_folders	[]	Les dossiers qui activent ce module.
style	'147 bold'	Le style pour le module.
disabled	false	Disables the php module.

Variables

Variable	Exemple	Description
version	v7.3.8	The version of php
symbole		Reflète la valeur de l'option symbol
style*		Reflète la valeur de l'option style

*: Cette variable peut uniquement être utilisée dans une chaine de style

Exemple

# ~/.config/starship.toml

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

Pijul Channel

The pijul_channel module shows the active channel of the repo in your current directory.

Options

Option	Défaut	Description
symbole	' '	The symbol used before the pijul channel name of the repo in your current directory.
style	'bold purple'	Le style pour le module.
format	'on [$symbol$channel]($style) '	Format du module.
truncation_length	2^63 - 1	Truncates the pijul channel name to N graphemes
truncation_symbol	'…'	Le symbole utilisé pour indiquer qu'un nom de branche a été tronqué.
disabled	true	Disables the pijul module.

Pulumi

The pulumi module shows the current username, 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 affiché si l’une de ces conditions est remplie:

• Le dossier courant contient soit un Pulumi.yaml, soit un Pulumi.yml
• A parent directory contains either Pulumi.yaml or Pulumi.yml unless search_upwards is set to false

Options

Option	Défaut	Description
format	'via [$symbol($username@)$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
symbole	' '	A format string shown before the Pulumi stack.
style	'bold 5'	Le style pour le module.
search_upwards	true	Enable discovery of pulumi config files in parent directories.
disabled	false	Disables the pulumi module.

Variables

Variable	Exemple	Description
version	v0.12.24	The version of pulumi
stack	dev	The current Pulumi stack
username	alice	The current Pulumi username
symbole		Reflète la valeur de l'option symbol
style*		Reflète la valeur de l'option style

*: Cette variable peut uniquement être utilisée dans une chaine de style

Exemple

Avec la version de Pulumi

# ~/.config/starship.toml

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

Sans la version de Pulumi

# ~/.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 affiché si l’une de ces conditions est remplie:

• Le dossier courant contient un fichier spago.dhall
• Le dossier courant 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
symbole	'<=> '	The symbol used before displaying the version of PureScript.
detect_extensionsdetect_extensions	['purs']	Les extensions qui déclenchent ce module.
detect_files	['spago.dhall']	Les fichiers qui activent ce module.
detect_folders	[]	Les dossiers qui activent ce module.
style	'bold white'	Le style pour le module.
disabled	false	Disables the purescript module.

Variables

Variable	Exemple	Description
version	0.13.5	The version of purescript
symbole		Reflète la valeur de l'option symbol
style*		Reflète la valeur de l'option style

*: Cette variable peut uniquement être utilisée dans une chaine 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 affiché si l’une de ces conditions est remplie:

• Le dossier courant contient un fichier .python-version
• Le dossier courant contient un fichier Pipfile
• Le dossier courant contient un fichier __init__.py
• Le dossier courant contient un fichier pyproject.toml
• Le dossier courant contient un fichier requirements.txt
• Le dossier courant contient un fichier setup.py
• Le dossier courant contient un fichier tox.ini
• Le dossier courant 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
symbole	'🐍 '	A format string representing the symbol of Python
style	'yellow bold'	Le style pour le 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_extensionsdetect_extensions	['py']	Les extensions qui déclenchent 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	Disables the python module.

::: 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'	The version of python
symbole	'🐍 '	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 dossier courant contient un fichier avec l’extension .R.
• Le dossier courant contient un fichier avec l’extension .Rd.
• Le dossier courant contient un fichier avec l’extension .Rmd.
• Le dossier courant contient un fichier avec l’extension .Rproj.
• Le dossier courant contient un fichier avec l’extension .Rsx.
• Le dossier 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
symbole	'📐'	A format string representing the symbol of R.
style	'blue bold'	Le style pour le module.
detect_extensionsdetect_extensions	['R', 'Rd', 'Rmd', 'Rproj', 'Rsx']	Les extensions qui déclenchent ce module
detect_files	['.Rprofile']	Quels fichiers devraient activer ce module
detect_folders	['.Rproj.user']	Quels dossiers devraient activer ce module
disabled	false	Disables the r module.

Variables

Variable	Exemple	Description
version	v4.0.5	The version of R
symbole		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) '

Raku

The raku module shows the currently installed version of Raku. Par défaut, le module sera affiché si l’une de ces conditions est remplie:

• The current directory contains a META6.json file
• The current directory contains a .p6, .pm6, .raku, .rakumod or .pod6

Options

Option	Défaut	Description
format	'via [$symbol($version-$vm_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
symbole	'🦋 '	The symbol used before displaying the version of Raku
detect_extensionsdetect_extensions	['p6', 'pm6', 'pod6', 'raku', 'rakumod']	Les extensions qui déclenchent ce module.
detect_files	['META6.json']	Les fichiers qui activent ce module.
detect_folders	[]	Les dossiers qui activent ce module.
style	'bold 149'	Le style pour le module.
disabled	false	Disables the raku module.

Variables

Variable	Exemple	Description
version	v6.d	The version of raku
vm_version	moar	The version of VM raku is built on
symbole		Reflète la valeur de l'option symbol
style*		Reflète la valeur de l'option style

Exemple

# ~/.config/starship.toml

[raku]
format = 'via [🦪 $version]($style) '

Red

By default the red module shows the currently installed version of Red. The module will be shown if any of the following conditions are met:

• Le dossier courant 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
symbole	'🔺 '	A format string representing the symbol of Red.
detect_extensionsdetect_extensions	['red']	Les extensions qui déclenchent ce module.
detect_files	[]	Les fichiers qui activent ce module.
detect_folders	[]	Les dossiers qui activent ce module.
style	'red bold'	Le style pour le module.
disabled	false	Disables the red module.

Variables

Variable	Exemple	Description
version	v2.5.1	The version of red
symbole		Reflète la valeur de l'option symbol
style*		Reflète la valeur de l'option style

*: Cette variable peut uniquement être utilisée dans une chaine de style

Exemple

# ~/.config/starship.toml

[red]
symbol = '🔴 '

Ruby

By default the ruby module shows the currently installed version of Ruby. The module will be shown if any of the following conditions are met:

• Le dossier courant contient un fichier Gemfile
• Le dossier courant contient un fichier .ruby-version
• Le dossier courant contient un fichier .rb
• La variable d’environnement RUBY_VERSION ou RBENV_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
symbole	'💎 '	A format string representing the symbol of Ruby.
detect_extensionsdetect_extensions	['rb']	Les extensions qui déclenchent 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']	Which environment variables should trigger this module.
style	'bold red'	Le style pour le module.
disabled	false	Disables the ruby module.

Variables

Variable	Exemple	Description
version	v2.5.1	The version of ruby
symbole		Reflète la valeur de l'option symbol
style*		Reflète la valeur de l'option style

*: Cette variable peut uniquement être utilisée dans une chaine de style

Exemple

# ~/.config/starship.toml

[ruby]
symbol = '🔺 '

Rust

By default the rust module shows the currently installed version of Rust. The module will be shown if any of the following conditions are met:

• Le dossier courant contient un fichier Cargo.toml
• Le dossier courant 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
symbole	'🦀 '	A format string representing the symbol of Rust
detect_extensionsdetect_extensions	['rs']	Les extensions qui déclenchent ce module.
detect_files	['Cargo.toml']	Les fichiers qui activent ce module.
detect_folders	[]	Les dossiers qui activent ce module.
style	'bold red'	Le style pour le module.
disabled	false	Disables the rust module.

Variables

Variable	Exemple	Description
version	v1.43.0-nightly	The version of rustc
numver	1.51.0	The numeric component of the rustc version
toolchain	beta	The toolchain version
symbole		Reflète la valeur de l'option symbol
style*		Reflète la valeur de l'option style

*: Cette variable peut uniquement être utilisée dans une chaine 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 affiché si l’une de ces conditions est remplie:

• Le dossier courant contient un fichier build.sbt, .scalaenv ou .sbtenv
• Le dossier courant 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_extensionsdetect_extensions	['sbt', 'scala']	Les extensions qui déclenchent ce module.
detect_files	['.scalaenv', '.sbtenv', 'build.sbt']	Les fichiers qui activent ce module.
detect_folders	['.metals']	Quels dossiers devraient activer ce module.
symbole	'🆂 '	A format string representing the symbol of Scala.
style	'red dimmed'	Le style pour le module.
disabled	false	Disables the scala module.

Variables

Variable	Exemple	Description
version	2.13.5	The version of scala
symbole		Reflète la valeur de l'option symbol
style*		Reflète la valeur de l'option style

*: Cette variable peut uniquement être utilisée dans une chaine 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'	A format string used to represent bash.
fish_indicator	'fsh'	A format string used to represent fish.
zsh_indicator	'zsh'	A format string used to represent zsh.
powershell_indicator	'psh'	A format string used to represent powershell.
ion_indicator	'ion'	A format string used to represent ion.
elvish_indicator	'esh'	A format string used to represent elvish.
tcsh_indicator	'tsh'	A format string used to represent 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 pour le module.
disabled	true	Disables the shell module.

Variables

Variable	Défaut	Description
indicator		Mirrors the value of indicator for currently used shell.
style*		Mirrors the value of option style.

*: Cette variable peut uniquement être utilisée dans une chaine 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.
symbole	'↕️ '	The symbol used to represent the SHLVL.
repeat	false	Causes symbol to be repeated by the current SHLVL amount.
repeat_offset	0	Decrements number of times symbol is repeated by the offset value
style	'bold yellow'	Le style pour le module.
disabled	true	Disables the shlvl module.

Variables

Variable	Exemple	Description
shlvl	3	The current value of SHLVL
symbole		Reflète la valeur de l'option symbol
style*		Reflète la valeur de l'option style

*: Cette variable peut uniquement être utilisée dans une chaine de style

Exemple

# ~/.config/starship.toml

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

Using repeat and repeat_offset along with character module, one can get prompt like ❯❯❯ where last character is colored appropriately for return status code and preceeding characters are provided by shlvl.

# ~/.config/starship.toml

[shlvl]
disabled = false
format = '[$symbol$shlvl]($style)'
repeat = true
symbol = '❯'
repeat_offset = 1
threshold = 0

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.
symbole	''	A format string displayed before the image name.
style	'bold dimmed blue'	Le style pour le module.
disabled	false	Disables the singularity module.

Variables

Variable	Exemple	Description
env	centos.img	The current Singularity image
symbole		Reflète la valeur de l'option symbol
style*		Reflète la valeur de l'option style

*: Cette variable peut uniquement être utilisée dans une chaine de style

Exemple

# ~/.config/starship.toml

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

Solidity

The solidity module shows the currently installed version of Solidity The module will be shown if any of the following conditions are met:

• The current directory contains a file with the .sol extension

Options

Option	Défaut	Description
format	"via [$symbol($version )]($style)"	Format du module.
version_format	"v${major}.${minor}.${patch}"	Le format de la version. Les variables disponibles sont raw, major, minor, & patch
symbole	"S "	A format string representing the symbol of Solidity
`compiler	["solc"]	The default compiler for Solidity.
detect_extensionsdetect_extensions	["sol"]	Les extensions qui déclenchent ce module.
detect_files	[]	Les fichiers qui activent ce module.
detect_folders	[]	Les dossiers qui activent ce module.
style	"bold blue"	Le style pour le module.
disabled	false	Disables this module.

Variables

Variable	Exemple	Description
version	v0.8.1	The version of solidity
symbole		Reflète la valeur de l'option symbol
style*		Reflète la valeur de l'option style

*: Cette variable peut uniquement être utilisée dans une chaine de style

Exemple

# ~/.config/starship.toml
[solidity]
format = "via [S $version](blue bold)"

Spack

The spack module shows the current Spack environment, if $SPACK_ENV is set.

Options

Option	Défaut	Description
truncation_length	1	The number of directories the environment path should be truncated to. 0 ne signifie pas de troncature. Regardez aussi le module directory.
symbole	'🅢 '	Le symbole utilisé avant le nom d'environnement.
style	'bold blue'	Le style pour le module.
format	'via [$symbol$environment]($style) '	Format du module.
disabled	false	Disables the spack module.

Variables

Variable	Exemple	Description
environment	astronauts	The current spack environment
symbole		Reflète la valeur de l'option symbol
style*		Reflète la valeur de l'option style

*: Cette variable peut uniquement être utilisée dans une chaine de style

Exemple

# ~/.config/starship.toml

[spack]
format = '[$symbol$environment](dimmed blue) '

Status

The status module displays the exit code of the previous command. If $success_symbol is empty (default), the module will be shown only if the exit code is not 0. The status code will cast to a signed 32-bit integer.

::: tip

This module is disabled by default. To enable it, set disabled to false in your configuration file.

:::

Options

Option	Défaut	Description
format	'[$symbol$status]($style) '	The format of the module
symbole	'❌'	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 red'	Le style pour le 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	|	The symbol used to separate pipestatus segments (supports formatting)
pipestatus_format	'\[$pipestatus\] => [$symbol$common_meaning$signal_name$maybe_int]($style)'	The format of the module when the command is a pipeline
pipestatus_segment_format		When specified, replaces format when formatting pipestatus segments
disabled	true	Disables the status module.

Variables

Variable	Exemple	Description
status	127	The exit code of the last command
hex_status	0x7F	The exit code of the last command in hex
int	127	The exit code of the last command
common_meaning	ERROR	Meaning of the code if not a signal
signal_number	9	Signal number corresponding to the exit code, only if signalled
signal_name	KILL	Name of the signal corresponding to the exit code, only if signalled
maybe_int	7	Contains the exit code number when no meaning has been found
pipestatus		Rendering of in pipeline programs' exit codes, this is only available in pipestatus_format
symbole		Reflète la valeur de l'option symbol
style*		Reflète la valeur de l'option style

*: Cette variable peut uniquement être utilisée dans une chaine de style

Exemple

# ~/.config/starship.toml

[status]
style = 'bg:blue'
symbol = '🔴 '
success_symbol = '🟢 SUCCESS'
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
symbole	'🧙 '	The symbol displayed when credentials are cached
style	'bold blue'	Le style pour le module.
allow_windows	false	Since windows has no default sudo, default is disabled.
disabled	true	Disables the sudo module.

Variables

Variable	Exemple	Description
symbole		Reflète la valeur de l'option symbol
style*		Reflète la valeur de l'option style

*: Cette variable peut uniquement être utilisée dans une chaine 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. The module will be shown if any of the following conditions are met:

• Le dossier courant contient un fichier Package.swift
• Le dossier courant 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
symbole	'🐦 '	A format string representing the symbol of Swift
detect_extensionsdetect_extensions	['swift']	Les extensions qui déclenchent ce module.
detect_files	['Package.swift']	Les fichiers qui activent ce module.
detect_folders	[]	Les dossiers qui activent ce module.
style	'bold 202'	Le style pour le module.
disabled	false	Disables the swift module.

Variables

Variable	Exemple	Description
version	v5.2.4	The version of swift
symbole		Reflète la valeur de l'option symbol
style*		Reflète la valeur de l'option style

*: Cette variable peut uniquement être utilisée dans une chaine 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 affiché si l’une de ces conditions est remplie:

• Le dossier courant contient un dossier .terraform
• Le dossier 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
symbole	'💠'	A format string shown before the terraform workspace.
detect_extensionsdetect_extensions	['tf', 'tfplan', 'tfstate']	Les extensions qui déclenchent ce module.
detect_files	[]	Les fichiers qui activent ce module.
detect_folders	['.terraform']	Les dossiers qui activent ce module.
style	'bold 105'	Le style pour le module.
disabled	false	Disables the terraform module.

Variables

Variable	Exemple	Description
version	v0.12.24	The version of terraform
workspace	default	The current Terraform workspace
symbole		Reflète la valeur de l'option symbol
style*		Reflète la valeur de l'option style

*: Cette variable peut uniquement être utilisée dans une chaine 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	Enables 12 hour formatting
time_format	see below	The chrono format string used to format the time.
style	'bold yellow'	The style for the module time
utc_time_offset	'local'	Sets the UTC offset to use. Range from -24 < x < 24. Allows floats to accommodate 30/45 minute timezone offsets.
disabled	true	Disables the time module.
time_range	'-'	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 peut uniquement être utilisée dans une chaine 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'

Username

The username module shows active user's username. The module will be shown if any of the following conditions are met:

• L'utilisateur courant est root/admin
• L'utilisateur courant est différent de celui connecté
• L'utilisateur est actuellement connecté en tant que session SSH
• La variable show_always est définie à 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 red'	The style used when the user is root/admin.
style_user	'bold yellow'	The style used for non-root users.
format	'[$user]($style) in '	Format du module.
show_always	false	Always shows the username module.
disabled	false	Disables the username module.

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'	The currently logged-in user ID.

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 affiché si l’une de ces conditions est remplie:

• Le dossier 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
symbole	'⍱ '	A format string representing the symbol of Vagrant.
detect_extensionsdetect_extensions	[]	Les extensions qui déclenchent ce module.
detect_files	['Vagrantfile']	Les fichiers qui activent ce module.
detect_folders	[]	Les dossiers qui activent ce module.
style	'cyan bold'	Le style pour le module.
disabled	false	Disables the vagrant module.

Variables

Variable	Exemple	Description
version	Vagrant 2.2.10	The version of Vagrant
symbole		Reflète la valeur de l'option symbol
style*		Reflète la valeur de l'option style

*: Cette variable peut uniquement être utilisée dans une chaine 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 affiché si l’une de ces conditions est remplie:

• Le dossier courant contient un fichier avec l’extension .v
• Le dossier 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
symbole	'V '	A format string representing the symbol of V
detect_extensionsdetect_extensions	['v']	Les extensions qui déclenchent ce module.
detect_files	['v.mod', 'vpkg.json', '.vpkg-lock.json' ]	Les fichiers qui activent ce module.
detect_folders	[]	Les dossiers qui activent ce module.
style	'blue bold'	Le style pour le module.
disabled	false	Disables the vlang module.

Variables

Variable	Exemple	Description
version	v0.2	The version of v
symbole		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
symbole	''	The symbol used before displaying the repository name.
style	'bold yellow'	Le style pour le module.
format	'vcsh [$symbol$repo]($style) '	Format du module.
disabled	false	Disables the vcsh module.

Variables

Variable	Exemple	Description
repo	dotfiles if in a VCSH repo named dotfiles	The active repository name
symbole		Reflète la valeur de l'option symbol
style*	black bold dimmed	Reflète la valeur de l'option style

*: Cette variable peut uniquement être utilisée dans une chaine de style

Exemple

# ~/.config/starship.toml

[vcsh]
format = '[🆅 $repo](bold blue) '

Zig

By default the zig module shows the currently installed version of Zig. The module will be shown if any of the following conditions are met:

• Le dossier courant contient un fichier .zip

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
symbole	'↯ '	The symbol used before displaying the version of Zig.
style	'bold yellow'	Le style pour le module.
disabled	false	Disables the zig module.
detect_extensionsdetect_extensions	['zig']	Les extensions qui déclenchent ce module.
detect_files	[]	Les fichiers qui activent ce module.
detect_folders	[]	Les dossiers qui activent ce module.

Variables

Variable	Exemple	Description
version	v0.6.0	The version of zig
symbole		Reflète la valeur de l'option symbol
style*		Reflète la valeur de l'option style

*: Cette variable peut uniquement être utilisée dans une chaine de style

Exemple

# ~/.config/starship.toml

[zig]
symbol = '⚡️ '

Custom commands

The custom modules show the output of some arbitrary commands.

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

• Le dossier courant contient un fichier dont le nom est dans detect_files
• Le dossier courant contient un dossier dont le nom est dans detect_folders
• Le dossier courant contient un fichier dont l’extension est dans detect_extensions
• La commande when retourne 0
• The current Operating System (std::env::consts::OS) matches 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	false	Either a boolean value (true or false, without quotes) or a string shell command used as a condition to show the module. In case of a string, the module will be shown if the command returns a 0 status code.
require_repo	false	If true, the module will only be shown in paths containing a (git) repository. This option alone is not sufficient display condition in absence of other options.
shell		See below
description	'<custom module>'	The description of the module that is shown when running starship explain.
detect_files	[]	The files that will be searched in the working directory for a match.
detect_folders	[]	The directories that will be searched in the working directory for a match.
detect_extensionsdetect_extensions	[]	The extensions that will be searched in the working directory for a match.
symbole	''	The symbol used before displaying the command output.
style	'bold green'	Le style pour le module.
format	'[$symbol($output )]($style)'	Format du module.
disabled	false	Disables this custom module.
os		Operating System name on which the module will be shown (unix, linux, macos, windows, ... ) See possible values.
use_stdin		An optional boolean value that overrides whether commands should be forwarded to the shell via the standard input or as an argument. If unset standard input is used by default, unless the shell does not support it (cmd, nushell). Setting this disables shell-specific argument handling.
ignore_timeout	false	Ignore global command_timeout setting and keep running external commands, no matter how long they take.

Variables

Variable	Description
output	The output of shell command in shell
symbole	Reflète la valeur de l'option symbol
style*	Reflète la valeur de l'option style

*: Cette variable peut uniquement être utilisée dans une chaine 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 -. If shell is not given or only contains one element and Starship detects Cmd will be used, the following argument will automatically be added: /C and stdin will be set to false. If shell is not given or only contains one element and Starship detects Nushell will be used, the following arguments will automatically be added: -c and stdin will be set to false. 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
detect_files = ['foo'] # can specify filters but wildcards are not supported
when = ''' test "$HOME" = "$PWD" '''
format = ' transcending [$output]($style)'

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

[custom.time-as-arg]
command = 'time /T'
detect_extensions = ['pst'] # filters *.pst files
shell = ['pwsh.exe', '-NoProfile', '-Command']
use_stdin = false