# Configuration

Pour commencer à configurer starship, créez le fichier suivant : ~/.config/starship.toml.

mkdir -p ~/.config && touch ~/.config/starship.toml

Toute la configuration de starship est faite dans ce fichier TOML (opens new window):

# N'écrivez pas une nouvelle ligne au début de la console
add_newline = false

# Remplacez le symbole "❯" dans la console avec "➜"
[character]             # Le nom du module que nous configurons est "character"
success_symbol = "[➜](bold green)"    # Le segment "success_symbol" est mis comme "➜" avec la couleur "bold green"

# Désactivez le module package, le masquant complètement dans la console
[package]
disabled = true

Vous pouvez changer l'emplacement par défaut du fichier starship.toml avec la variable d'environnement STARSHIP_CONFIG :

export STARSHIP_CONFIG=~/.starship

De manière équivalente, pour Powershell (Windows), ajoutez la ligne suivante à votre $PROFILE:

$ENV:STARSHIP_CONFIG = "$HOME\.starship"

# Journalisation

Par défaut, Starship enregistre les avertissements et les erreurs dans un fichier nommé ~/.cache/starship/session_${STARSHIP_SESSION_KEY}.log, où la clé de session correspond à une instance de votre 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"

# Terminologie

Module: Un composant dans l'invite donnant des informations basées sur des informations contextuelles à propos de votre Système d'Exploitation. Par exemple, le module "nodejs" montre la version de NodeJS qui est actuellement installée sur votre ordinateur, si votre répertoire actuel est un projet NodeJS.

Variable: Smaller sub-components that contain information provided by the module. Par exemple, la variable "version" dans le module "nodejs" contient la version actuelle de NodeJS.

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.

# 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 ne contient que des lettres, des chiffres et _.

Par exemple :

  • $version est une chaîne de formatage avec une variable nommée version.
  • $git_branch$git_commit est une chaîne de formatage avec deux variables appelées git_branch et git_commit.
  • $git_branch $git_commit a les deux variables séparées par un espace.

# 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. Ceci peut être utilisé pour styliser la première partie.

Par exemple :

  • [on](red bold) affichera une chaîne de caractères on avec un texte gras de couleur rouge.
  • [⬢ $version](bold green) affichera un symbole suivi du contenu de la variable version, avec un texte en gras de couleur verte.
  • [a [b](red) c](green) affichera a b c avec b rouge, et a et c vert.

# 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" définit un texte vert sur un fond bleu
  • "bg:blue fg:bright-green" définit un texte vert clair sur un fond bleu
  • "bold fg:27" définit le texte en gras avec la couleur ANSI (opens new window) 27
  • "underline bg:#bf5700" définit le texte en souligné sur un fond orange foncé
  • "bold italic fg:purple" définit le texte en italique et gras sur un fond violet
  • "" désactive explicitement tous les styles

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) ne montrera rien si la variable région est None, sinon @ suivi de la valeur de la région.
  • (some text) ne montrera toujours rien puisqu'il n'y a pas de variables enveloppées dans les accolades.
  • Lorsque $all est un raccourci pour \[$a$b\], ($all) ne montrera rien que si $a et $b sont tous les deux None. Cela fonctionne comme (\[$a$b\] ).

# Caractère d’échappement

Les symboles suivants ont une utilisation spéciale dans une chaîne de formatage. Si vous voulez afficher les symboles suivants, vous devez les échapper avec un antislash (\).

  • $
  • \
  • [
  • ]
  • (
  • )

Notez que toml a sa propre syntaxe d'échappement (opens new window). Il est recommandé d'utiliser une chaîne littérale ('') dans votre configuration. Si vous voulez utiliser une chaîne de base (""), faites attention à l'échappement de l'antislash \.

Par exemple, lorsque vous voulez imprimer un symbole $ sur une nouvelle ligne, les configurations suivantes pour le formatage sont équivalentes :

# avec la chaîne de base
format = "\n\\$"

# avec la chaîne de caractères de base multiligne
format = """

\\$"""

# avec la chaîne littérale
format = '''

\$'''

# Invite

Voici la liste des options de configuration de l'invite en lui-même.

# Options

Option Défaut Description
format lien Configure le format de l'invite.
scan_timeout 30 Délai d'attente avant que starship scanne les fichiers (en millisecondes).
add_newline true Ajoute une nouvelle ligne a début de l'invite.

# Exemple

# ~/.config/starship. oml

# Utilisez un format personnalisé
format = """
[┌───────────────────>](bold green)
[│](bold green)$directory$rust$package
[└─>](bold green) """

# Attendez 10 millisecondes pour que starship vérifie les fichiers dans le répertoire de travail.
scan_timeout = 10

# Désactive la nouvelle ligne au démarrage de l'invite
add_newline = false

# 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\
$shlvl\
$kubernetes\
$directory\
$git_branch\
$git_commit\
$git_state\
$git_status\
$hg_branch\
$docker_context\
$package\
$cmake\
$dart\
$dotnet\
$elixir\
$elm\
$erlang\
$golang\
$helm\
$java\
$julia\
$kotlin\
$nim\
$nodejs\
$ocaml\
$perl\
$php\
$purescript\
$python\
$ruby\
$rust\
$swift\
$terraform\
$zig\
$nix_shell\
$conda\
$memory_usage\
$aws\
$gcloud\
$openstack\
$env_var\
$crystal\
$custom\
$cmd_duration\
$line_break\
$lua\
$jobs\
$battery\
$time\
$status\
$character"""

# AWS

Le module aws affiche la région et le profil AWS courant. Ces informations sont basées sur les variables d'environnement AWS_REGION, AWS_DEFAULT_REGION, et AWS_PROFILE ainsi que le fichier ~/.aws/config.

Quand aws-vault (opens new window) est utilisé, la valeur du profil est lu dans la variable d'environnement: AWS_VAULT.

# Options

Option Default Description
format 'on [$symbol$profile(\($region\))]($style) ' Format du module.
symbol "☁️ " Le symbole affiché avant le profil AWS actuel.
region_aliases Table des alias de région à afficher en plus du nom AWS.
style "bold yellow" Le style du module.
disabled false Désactive le module AWS.

# Variables

Variable Exemple Description
region ap-northeast-1 La région AWS actuelle
profile astronauts Le profil AWS actuel
symbol Reflète la valeur de l'option symbol
style* Reflète la valeur de l'option style

* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style

# Exemples

# Tout afficher

# ~/.config/starship.toml

[aws]
format = 'on [$symbol$profile(\($region\))]($style) '
style = "bold blue"
symbol = "🅰 "
[aws.region_aliases]
ap-southeast-2 = "au"
us-east-1 = "va"

# Afficher la région

# ~/.config/starship.toml

[aws]
format = "on [$symbol$region]($style) "
style = "bold blue"
symbol = "🅰 "
[aws.region_aliases]
ap-southeast-2 = "au"
us-east-1 = "va"

# Afficher le profil

# ~/.config/starship.toml

[aws]
format = "on [$symbol$profile]($style) "
style = "bold blue"
symbol = "🅰 "

# 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 Default 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é (seuil) 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"

# Options

L'option display est une array de la table suivante.

Option Description
threshold La limite supérieure pour l'option d'affichage.
style Le style de l'option display si elle est utilisée.

# Exemple

[[battery.display]]  # le style "bold red" lorsque la capacité est comprise entre 0% et 10% 
threshold = 10
style = "bold red"

[[battery.display]]  # le style "bold yellow" quand la capacité est comprise entre 10% et 30%
threshold = 30
style = "bold yellow"

# lorsque la capacité est supérieure à 30%, l'indicateur de batterie ne sera pas affiché

# Caractères

Le module character affiche un caractère (habituellement une flèche) à côté de l'endroit où le texte est entré dans votre terminal.

Le caractère vous dira si la dernière commande a été réussie ou pas. Cela peut être fait de deux manières:

  • changement de couleur (red/green)
  • changement de forme (/)

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

# Options

Option Défaut Description
format "$symbol " Le format utilisée avant l'entrée de texte.
success_symbol "[❯](bold green)" Le format utilisé avant l'entrée de texte si la commande précédente a réussi.
error_symbol "[❯](bold red)" Le format utilisé avant l'entrée de texte si la commande précédente a échoué.
vicmd_symbol "[❮](bold green)" Le format utilisé avant l'entrée de texte si le shell est en mode vim normal.
disabled false Désactive le module character.

# Variables

Variable Exemple Description
symbol Reflète sois success_symbol, error_symbol ou vicmd_symbol

# Exemples

# Avec une forme d'erreur personnalisée

# ~/.config/starship.toml

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

# Sans forme d'erreur personnalisée

# ~/.config/starship.toml

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

# Avec une forme vim personnalisée

# ~/.config/starship.toml

[character]
vicmd_symbol = "[V](bold green) "

# CMake

Le module cmake affiche la version actuellement installée de CMake si l'une des conditions suivantes est remplie :

  • Le répertoire actuel contient un fichier CMakeLists.txt
  • Le répertoire actuel contient un fichier CMakeCache.txt

# Options

Option Défaut Description
format "via [$symbol$version]($style) " Format du module.
symbol "喝 " Le symbole utilisé avant la version de cmake.
style "bold blue" Le style du module.
disabled false Désactive le module cmake.

# Variables

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

* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style

# Temps d'exécution

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

::: attention, n'accrochez pas la trappe DEBUG en Bash

Si vous utilisez starship en bash, n'accrochez pas DEBUG après avoir exécuté eval $(starship init $0), ou ce module cassera.

:::

Les utilisateurs de Bash qui ont besoin de fonctionnalité pré-exec peuvent utiliser rcaloras's bash_preexec framework (opens new window). Définissez simplement les array preexec_functions et precmd_functions avant d'éxé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 du module.
disabled false Désactive le module cmd_duration.
show_notifications false Afficher les notifications du bureau lorsque la commande est terminée.
min_time_to_notify 45_000 Shortest duration for notification (in milliseconds).

TIP

Showing desktop notifications requires starship to be built with rust-notify support. You check if your starship supports notifications by running STARSHIP_LOG=debug starship module cmd_duration -d 60000 when show_notifications is set to true.

# Variables

Variable Exemple Description
duration 16m40s Le temps nécessaire pour exécuter la commande
style* Reflète la valeur de l'option style

* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style

# Exemple

# ~/.config/starship.toml

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

# Conda

Le module conda affiche l'environnement conda actuel, si $CONDA_DEFAULT_ENV est défini.

TIP

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

# Options

Option Défaut Description
truncation_length 1 Le nombre de répertoires dans lesquels le chemin d'environnement (Path) doit être tronqué, si l'environnement a été créé via conda create -p [path]. 0 ne signifie pas de troncature. Regardez aussi le module directory.
symbol "🅒 " Le symbole utilisé avant le nom d'environnement.
style "bold green" Le style du module.
format "via [$symbol$environment]($style) " Format du module.
ignore_base true Ignore l'environnement base lorsqu'il est activé.
disabled false Désactive le module conda.

# Variables

Variable Exemple Description
environnement astronauts La version courante de conda
symbol Reflète la valeur de l'option symbol
style* Reflète la valeur de l'option style

* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style

# Exemple

# ~/.config/starship.toml

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

# Crystal

Le module crystal affiche la version actuellement installée de Crystal. Le module est affiché si l'une des ces conditions est remplie :

  • Le répertoire courant contient un fichier shard.yml
  • Le répertoire courant contient un fichier .cr

# Options

Option Défaut Description
symbol "🔮 " Le symbole utilisé avant d'afficher la version de crystal.
style "bold green" Le style du module.
format "via [$symbol$version]($style) " Format du module.
disabled false Désactive le module crystal.

# Variables

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

* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style

# Exemple

# ~/.config/starship.toml

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

# Dart

Le module crystal affiche la version courante installée de Dart. Le module est affiché si l'une des ces conditions est remplie :

  • Le répertoire courant contient un fichier .dart
  • Le répertoire courant contient un répertoire .dart_tool
  • Le répertoire courant contient un fichier pubspec.yaml ou pubspec.lock

# Options

Option Défaut Description
format "via [$symbol$version]($style) " Format du module.
symbol "🎯 " Une chaîne de caractères représentant le symbole de Dart
style "bold blue" Le style du module.
disabled false Désactive le module dart.

# Variables

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

* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style

# Exemple

# ~/.config/starship.toml

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

# Dossier

Le mode directory montre le chemin de votre dossier actuel, tronqué au 3 dossiers parents. Votre répertoire sera également tronqué à la racine du repo git dans lequel vous vous trouvez actuellement.

Quand vous utilisez le style pwd de fish, au lieu de cacher le chemin qui est troqué, vous verrez un nom raccourcis de chaque dossiers basés sur le nombre établi pour l'option.

Par exemple, donné ~/Dev/Nix/nixpkgs/pkgsnixpkgs 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 selon lesquels le répertoire courant doit être tronqué.
truncate_to_repo true Si oui ou non tronquer à la racine du repo git dans lequel vous vous trouvez.
format "[$path]($style)[$read_only]($read_only_style) " Format du module.
style "bold cyan" Le style du module.
disabled false Désactive le module directory.
read_only "🔒" Le symbole indiquant que le répertoire courant est en lecture seule.
read_only_style "red" Le style du symbole en lecture seule.
truncation_symbol "" Le symbole en préfixe aux chemins tronqués. eg: "…/"
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 Table de substitutions à faire au chemin.
fish_style_pwd_dir_length 0 The number of characters to use when applying fish shell pwd path logic.
use_logical_path true Displays the logical path provided by the shell (PWD) instead of the path from the OS.

substitutions allows you to define arbitrary replacements for literal strings that occur in the path, for example long network prefixes or development directories (i.e. Java). Note that this will disable the fish style PWD.

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

fish_style_pwd_dir_length interacts with the standard truncation options in a way that can be surprising at first: if it's non-zero, the components of the path that would normally be truncated are instead displayed with that many characters. For example, the path /built/this/city/on/rock/and/roll, which would normally be displayed as as rock/and/roll, would be displayed as /b/t/c/o/rock/and/roll with fish_style_pwd_dir_length = 1--the path components that would normally be removed are displayed with a single character. For fish_style_pwd_dir_length = 2, it would be /bu/th/ci/on/rock/and/roll.

# Variables

Variable Exemple Description
path "D:/Projects" Le chemin du répertoire courant
style* "black bold dimmed" Reflète la valeur de l'option style

* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style

# Exemple

# ~/.config/starship.toml

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

# Docker Context

The docker_context module shows the currently active Docker context (opens new window) if it's not set to default.

# Options

Option Défaut Description
format "via [$symbol$context]($style) " Format du module.
symbol "🐳 " The symbol used before displaying the Docker context.
style "blue bold" Le style du module.
only_with_files false Only show when there's a docker-compose.yml or Dockerfile in the current directory.
disabled true Désactive le module docker_context.

# Variables

Variable Exemple Description
context test_context The current docker context
symbol Reflète la valeur de l'option symbol
style* Reflète la valeur de l'option style

* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style

# Exemple

# ~/.config/starship.toml

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

# Dotnet

The dotnet module shows the relevant version of the .NET Core SDK for the current directory. If the SDK has been pinned in the current directory, the pinned version is shown. Otherwise the module shows the latest installed version of the SDK.

This module will only be shown in your prompt when one or more of the following files are present in the current directory:

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

You'll also need the .NET Core SDK installed in order to use it correctly.

Internally, this module uses its own mechanism for version detection. Typically it is twice as fast as running dotnet --version, but it may show an incorrect version if your .NET project has an unusual directory layout. If accuracy is more important than speed, you can disable the mechanism by setting heuristic = false in the module options.

The module will also show the Target Framework Moniker (https://docs.microsoft.com/en-us/dotnet/standard/frameworks#supported-target-framework-versions (opens new window)) when there is a csproj file in the current directory.

# Options

Option Défaut Description
format "[$symbol$version( 🎯 $tfm)]($style) " Format du module.
symbol "•NET " The symbol used before displaying the version of dotnet.
heuristic true Use faster version detection to keep starship snappy.
style "bold blue" Le style du module.
disabled false Désactive le module dotnet.

# Variables

Variable Exemple Description
version v3.1.201 La version du sdk dotnet
tfm netstandard2.0 The Target Framework Moniker that the current project is targeting
symbol Reflète la valeur de l'option symbol
style* Reflète la valeur de l'option style

* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style

# Exemple

# ~/.config/starship.toml

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

# Elixir

The elixir module shows the currently installed version of Elixir and Erlang/OTP. Le module est affiché si l'une des ces conditions est remplie :

  • Le répertoire courant contient un fichier mix.exs.

# Options

Option Défaut Description
symbol "💧 " The symbol used before displaying the version of Elixir/Erlang.
style "bold purple" Le style du module.
format 'via [$symbol$version \(OTP $otp_version\)]($style) ' The format for the module elixir.
disabled false Disables the elixir module.

# Variables

Variable Exemple Description
version v1.10 The version of elixir
otp_version The otp version of elixir
symbol Reflète la valeur de l'option symbol
style* Reflète la valeur de l'option style

* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style

# Exemple

# ~/.config/starship.toml

[elixir]
symbol = "🔮 "

# Elm

The elm module shows the currently installed version of Elm. Le module est affiché si l'une des ces conditions est remplie :

  • Le répertoire courant contient un fichier elm.json
  • Le répertoire courant contient un fichier elm-package.json
  • The current directory contains a .elm-version file
  • The current directory contains a elm-stuff folder
  • The current directory contains a *.elm files

# Options

Option Défaut Description
format "via [$symbol$version]($style) " Format du module.
symbol "🌳 " A format string representing the symbol of Elm.
style "cyan bold" Le style du module.
disabled false Disables the elm module.

# Variables

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

* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style

# Exemple

# ~/.config/starship.toml

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

# Environment Variable

The env_var module displays the current value of a selected environment variable. The module will be shown only if any of the following conditions are met:

  • The variable configuration option matches an existing environment variable
  • The variable configuration option is not defined, but the default configuration option is

# Options

Option Défaut Description
symbol The symbol used before displaying the variable value.
variable The environment variable to be displayed.
défaut The default value to be displayed when the selected variable is not defined.
format "with [$env_value]($style) " Format du module.
disabled false Disables the env_var module.

# Variables

Variable Exemple Description
env_value Windows NT (if variable would be $OS) The environment value of option variable
symbol Reflète la valeur de l'option symbol
style* black bold dimmed Reflète la valeur de l'option style

* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style

# Exemple

# ~/.config/starship.toml

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

# Erlang

The erlang module shows the currently installed version of Erlang/OTP. Le module est affiché si l'une des ces conditions est remplie :

  • Le répertoire courant contient un fichier rebar.config.
  • Le répertoire courant contient un fichier erlang.mk.

# Options

Option Défaut Description
symbol " " The symbol used before displaying the version of erlang.
style "bold green" Le style du module.
format "via [$symbol$version]($style) " Format du module.
disabled false Disables the erlang module.

# Variables

Variable Exemple Description
version v22.1.3 The version of erlang
symbol Reflète la valeur de l'option symbol
style* Reflète la valeur de l'option style

* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style

# Exemple

# ~/.config/starship.toml

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

# Gcloud

The gcloud module shows the current configuration for gcloud (opens new window) CLI. This is based on the ~/.config/gcloud/active_config file and the ~/.config/gcloud/configurations/config_{CONFIG NAME} file and the CLOUDSDK_CONFIG env var.

# Options

Option Défaut Description
format 'on [$symbol$account(\($region\))]($style) ' Format du module.
symbol "☁️ " The symbol used before displaying the current GCP profile.
region_aliases Table of region aliases to display in addition to the GCP name.
style "bold blue" Le style du module.
disabled false Disables the gcloud module.

# Variables

Variable Exemple Description
region us-central1 The current GCP region
account [email protected] The current GCP profile
project The current GCP project
active défaut The active config name written in ~/.config/gcloud/active_config
symbol Reflète la valeur de l'option symbol
style* Reflète la valeur de l'option style

* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style

# Exemples

# Display account and project

# ~/.config/starship.toml

[gcloud]
format = 'on [$symbol$account(\($project\))]($style) '

# Display active config name only

# ~/.config/starship.toml

[gcloud]
format = "[$symbol$active]($style) "
style = "bold yellow"

# Display account and aliased region

# ~/.config/starship.toml

[gcloud]
symbol = "️🇬️ "
[gcloud.region_aliases]
us-central1 = "uc1"
asia-northeast1 = "an1"

# Git Branch

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

# 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]($style) " Format du module. Use "$branch" to refer to the current branch name.
symbol " " A format string representing the symbol of git branch.
style "bold purple" Le style du module.
truncation_length 2^63 - 1 Truncates a git branch to X graphemes.
truncation_symbol "…" The symbol used to indicate a branch name was truncated. You can use "" for no symbol.
only_attached false Only show the branch name when not in a detached HEAD state.
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.
symbol Reflète la valeur de l'option symbol
style* Reflète la valeur de l'option style

* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style

# Exemple

# ~/.config/starship.toml

[git_branch]
symbol = "🌱 "
truncation_length = 4
truncation_symbol = ""

# Git Commit

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\\)]($style) [\\($tag\\)]($style)" Format du module.
style "bold green" Le style du 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_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
style* Reflète la valeur de l'option style

* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style

# Exemple

# ~/.config/starship.toml

[git_commit]
commit_hash_length = 4
tag_symbol = "🔖 "

# 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 du 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 ne peut être utilisée que comme partie d'une chaîne de style

# Exemple

# ~/.config/starship.toml

[git_state]
format = '[\($state( $progress_current of $progress_total)\)]($style) '
cherry_pick = "[🍒 PICKING](bold red)"

# Git Status

The git_status module shows symbols representing the state of the repo in your current directory.

# Options

Option Défaut Description
format '([\[$all_status$ahead_behind\]]($style) )' The default format for git_status
conflicted "=" This branch has merge conflicts.
ahead "⇡" The format of ahead
behind "⇣" The format of behind
diverged "⇕" The format of diverged
untracked "?" The format of untracked
stashed "$" The format of stashed
modified "!" The format of modified
staged "+" The format of staged
renamed "»" The format of renamed
deleted "✘" The format of deleted
style "bold green" Le style du module.
disabled false Disables the git_status module.

# 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 or behind format string based on the current status of the repo
conflicted Displays conflicted when this branch has merge conflicts.
untracked Displays untracked when there are untracked files in the working directory.
stashed Displays stashed when a stash exists for the local repository.
modified Displays modified when there are file modifications in the working directory.
staged Displays staged when a new file has been added to the staging area.
renamed Displays renamed when a renamed file has been added to the staging area.
deleted Displays deleted when a file's deletion has been added to the staging area.
style* Reflète la valeur de l'option style

* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style

The following variables can be used in diverged:

Variable Description
ahead_count 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 = "😵"
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}"

# Golang

The golang module shows the currently installed version of Golang. Le module est affiché si l'une des ces conditions est remplie :

  • Le répertoire courant contient un fichier go.mod
  • Le répertoire courant contient un fichier go.sum
  • Le répertoire courant contient un fichier glide.yaml
  • The current directory contains a Gopkg.yml file
  • The current directory contains a Gopkg.lock file
  • The current directory contains a .go-version file
  • The current directory contains a Godeps directory
  • The current directory contains a file with the .go extension

# Options

Option Défaut Description
format "via [$symbol$version]($style) " Format du module.
symbol "🐹 " A format string representing the symbol of Go.
style "bold cyan" Le style du module.
disabled false Disables the golang module.

# Variables

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

* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style

# Exemple

# ~/.config/starship.toml

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

# Helm

The helm module shows the currently installed version of Helm. Le module est affiché si l'une des ces conditions est remplie :

  • Le répertoire courant contient un fichier helmfile.yaml
  • The current directory contains a Chart.yaml file

# Options

Option Défaut Description
format "via [$symbol$version]($style) " Format du module.
symbol "⎈ " A format string representing the symbol of Helm.
style "bold white" Le style du module.
disabled false Disables the helm module.

# Variables

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

* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style

# Exemple

# ~/.config/starship.toml

[helm]
format = "via [⎈ $version](bold white) "

# Hostname

The hostname module shows the system hostname.

# Options

Option Défaut Description
ssh_only true Only show hostname when connected to an SSH session.
trim_at "." String that the hostname is cut off at, after the first match. "." will stop after the first dot. "" will disable any truncation
format "[$hostname]($style) in " Format du module.
style "bold dimmed green" Le style du module.
disabled false Disables the hostname module.

# Variables

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

* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style

# Exemple

# ~/.config/starship.toml

[hostname]
ssh_only = false
format =  "on [$hostname](bold red) "
trim_at = ".companyname.com"
disabled = false

# Java

The java module shows the currently installed version of Java. Le module est affiché si l'une des ces conditions est remplie :

  • The current directory contains a pom.xml, build.gradle.kts, build.sbt, .java-version, .deps.edn, project.clj, or build.boot file
  • The current directory contains a file with the .java, .class, .gradle, .jar, .clj, or .cljc extension

# Options

Option Défaut Description
format "via [${symbol}${version}]($style) " Format du module.
symbol "☕ " A format string representing the symbol of Java
style "red dimmed" Le style du module.
disabled false Disables the java module.

# Variables

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

* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style

# Exemple

# ~/.config/starship.toml

[java]
symbol = "🌟 "

# Jobs

The jobs module shows the current number of jobs running. The module will be shown only if there are background jobs running. The module will show the number of jobs running if there is more than 1 job, or more than the threshold config value, if it exists.

# Options

Option Défaut Description
threshold 1 Show number of jobs if exceeded.
format "[$symbol$number]($style) " Format du module.
symbol "✦" A format string representing the number of jobs.
style "bold blue" Le style du module.
disabled false Disables the jobs module.

# Variables

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

* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style

# Exemple

# ~/.config/starship.toml

[jobs]
symbol = "+ "
threshold = 4

# Julia

The julia module shows the currently installed version of Julia. Le module est affiché si l'une des ces conditions est remplie :

  • The current directory contains a Project.toml file
  • The current directory contains a Manifest.toml file
  • The current directory contains a file with the .jl extension

# Options

Option Défaut Description
format "via [$symbol$version]($style) " Format du module.
symbol "ஃ " A format string representing the symbol of Julia.
style "bold purple" Le style du module.
disabled false Disables the julia module.

# Variables

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

* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style

# Exemple

# ~/.config/starship.toml

[julia]
symbol = "∴ "

# Kotlin

The kotlin module shows the currently installed version of Kotlin. Le module est affiché si l'une des ces conditions est remplie :

  • The current directory contains a .kt or a .kts file

# Options

Option Défaut Description
format "via [$symbol$version]($style) " Format du module.
symbol "🅺 " A format string representing the symbol of Kotlin.
style "bold blue" Le style du 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
symbol Reflète la valeur de l'option symbol
style* Reflète la valeur de l'option style

* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style

# Exemple

# ~/.config/starship.toml

[kotlin]
symbol = "🅺 "
# ~/.config/starship.toml

[kotlin]
# Uses the Kotlin Compiler binary to get the installed version
kotlin_binary = "kotlinc"

# Kubernetes

Displays the current Kubernetes context name and, if set, the namespace from the kubeconfig file. The namespace needs to be set in the kubeconfig file, this can be done via kubectl config set-context starship-cluster --namespace astronaut. If the $KUBECONFIG env var is set the module will use that if not it will use the ~/.kube/config.

TIP

Ce module est désactivé par défaut. Pour l'activer, configurez disabled sur false dans votre fichier de configuration.

# Options

Option Défaut Description
symbol "☸ " A format string representing the symbol displayed before the Cluster.
format '[$symbol$context( \($namespace\))]($style) in ' Format du module.
style "cyan bold" Le style du module.
context_aliases Table of context aliases to display.
disabled true Disables the kubernetes module.

# Variables

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

* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style

# Exemple

# ~/.config/starship.toml

[kubernetes]
format = 'on [⛵ $context \($namespace\)](dimmed green) '
disabled = false
[kubernetes.context_aliases]
"dev.local.cluster.k8s" = "dev"

# 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

# Lua

The lua module shows the currently installed version of Lua. Le module est affiché si l'une des ces conditions est remplie :

  • The current directory contains a .lua-version file
  • The current directory contains a lua directory
  • The current directory contains a file with the .lua extension

# Options

Option Défaut Description
format "via [$symbol$version]($style) " Format du module.
symbol "🌙 " A format string representing the symbol of Lua.
style "bold blue" Le style du 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
symbol Reflète la valeur de l'option symbol
style* Reflète la valeur de l'option style

* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style

# Exemple

# ~/.config/starship.toml

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

# 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

Ce module est désactivé par défaut. Pour l'activer, configurez disabled sur false dans votre fichier de configuration.

# 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.
symbol "🐏" The symbol used before displaying the memory usage.
style "bold dimmed white" Le style du 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.
symbol 🐏 Reflète la valeur de l'option symbol
style* Reflète la valeur de l'option style

*: This variable can only be used as a part of a style string **: The SWAP file information is only displayed if detected on the current system

# Exemple

# ~/.config/starship.toml

[memory_usage]
disabled = false
threshold = -1
symbol = " "
style = "bold dimmed green"

# Mercurial Branch

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

# Options

Option Défaut Description
symbol " " The symbol used before the hg bookmark or branch name of the repo in your current directory.
style "bold purple" Le style du module.
format "on [$symbol$branch]($style) " Format du module.
truncation_length 2^63 - 1 Truncates the hg branch name to X graphemes
truncation_symbol "…" The symbol used to indicate a branch name was truncated.
disabled true Disables the hg_branch module.

# Variables

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

* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style

# Exemple

# ~/.config/starship.toml

[hg_branch]
format = "on [🌱 $branch](bold purple)"
truncation_length = 4
truncation_symbol = ""

# Nim

The nim module shows the currently installed version of Nim. Le module est affiché si l'une des ces conditions est remplie :

  • The current directory contains a nim.cfg file
  • The current directory contains a file with the .nim extension
  • The current directory contains a file with the .nims extension
  • The current directory contains a file with the .nimble extension

# Options

Option Défaut Description
format "via [$symbol$version]($style) " Format du module
symbol "👑 " The symbol used before displaying the version of Nim.
style "bold yellow" Le style du module.
disabled false Disables the nim module.

# Variables

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

* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style

# Exemple

# ~/.config/starship.toml

[nim]
style = "yellow"
symbol = "🎣 "

# Nix-shell

The nix_shell module shows the nix-shell environment. The module will be shown when inside a nix-shell environment.

# Options

Option Défaut Description
format 'via [$symbol$state( \($name\))]($style) ' Format du module.
symbol "❄️ " A format string representing the symbol of nix-shell.
style "bold blue" Le style du 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.
disabled false Disables the nix_shell module.

# Variables

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

* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style

# Exemple

# ~/.config/starship.toml

[nix_shell]
disabled = true
impure_msg = "[impure shell](bold red)"
pure_msg = "[pure shell](bold green)"
format = 'via [☃️ $state( \($name\))](bold blue) '

# NodeJS

The nodejs module shows the currently installed version of NodeJS. Le module est affiché si l'une des ces conditions est remplie :

  • The current directory contains a package.json file
  • The current directory contains a .node-version file
  • The current directory contains a node_modules directory
  • The current directory contains a file with the .js, .mjs or .cjs extension
  • The current directory contains a file with the .ts extension

# Options

Option Défaut Description
format "via [$symbol$version]($style) " Format du module.
symbol "⬢ " A format string representing the symbol of NodeJS.
style "bold green" Le style du module.
disabled false Disables the nodejs module.
not_capable_style bold red The style for the module when an engines property in Packages.json does not match the NodeJS version.

# Variables

Variable Exemple Description
version v13.12.0 The version of node
symbol Reflète la valeur de l'option symbol
style* Reflète la valeur de l'option style

* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style

# Exemple

# ~/.config/starship.toml

[nodejs]
format = "via [🤖 $version](bold green) "

# OCaml

The ocaml module shows the currently installed version of OCaml. Le module est affiché si l'une des ces conditions est remplie :

  • The current directory contains a file with .opam extension or _opam directory
  • The current directory contains a esy.lock directory
  • The current directory contains a dune or dune-project file
  • The current directory contains a jbuild or jbuild-ignore file
  • The current directory contains a .merlin file
  • The current directory contains a file with .ml, .mli, .re or .rei extension

# Options

Option Défaut Description
format "via [$symbol$version]($style) " The format string for the module.
symbol "🐫 " The symbol used before displaying the version of OCaml.
style "bold yellow" Le style du module.
disabled false Disables the ocaml module.

# Variables

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

* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style

# Exemple

# ~/.config/starship.toml

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

# OpenStack

The openstack module shows the current OpenStack cloud and project. The module only active when the OS_CLOUD env var is set, in which case it will read clouds.yaml file from any of the default locations (opens new window). to fetch the current project in use.

# Options

Option Défaut Description
format "on [$symbol$cloud(\\($project\\))]($style) " Format du module.
symbol "☁️ " The symbol used before displaying the current OpenStack cloud.
style "bold yellow" Le style du module.
disabled false Disables the OpenStack module.

# Variables

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

* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style

# Exemple

# ~/.config/starship.toml

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

# 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, cargo, poetry, composer, gradle, julia, mix and helm packages.

  • npm – The npm package version is extracted from the package.json present in the current directory
  • cargo – The cargo package version is extracted from the Cargo.toml present in the current directory
  • poetry – The poetry package version is extracted from the pyproject.toml present in the current directory
  • composer – The composer package version is extracted from the composer.json present in the current directory
  • gradle – The gradle package version is extracted from the build.gradle present
  • julia - The package version is extracted from the Project.toml present
  • mix - The mix package version is extracted from the mix.exs present
  • helm - The helm chart version is extracted from the Chart.yaml present
  • maven - The maven package version is extracted from the pom.xml present
  • meson - The meson package version is extracted from the meson.build present

⚠️ The version being shown is that of the package whose source code is in your current directory, not your package manager.

# Options

Option Défaut Description
format "is [$symbol$version]($style) " Format du module.
symbol "📦 " The symbol used before displaying the version the package.
style "bold 208" Le style du 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
symbol Reflète la valeur de l'option symbol
style* Reflète la valeur de l'option style

* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style

# Exemple

# ~/.config/starship.toml

[package]
format = "via [🎁 $version](208 bold) "

# Perl

The perl module shows the currently installed version of Perl. Le module est affiché si l'une des ces conditions est remplie :

  • The current directory contains a Makefile.PL or Build.PL file
  • The current directory contains a cpanfile or cpanfile.snapshot file
  • The current directory contains a META.json file or META.yml file
  • The current directory contains a .perl-version file
  • The current directory contains a .pl, .pm or .pod

# Options

Option Défaut Description
format "via [$symbol$version]($style) " The format string for the module.
symbol "🐪 " The symbol used before displaying the version of Perl
style "bold 149" Le style du module.
disabled false Disables the perl module.

# Variables

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

# Exemple

# ~/.config/starship.toml

[perl]
format = "via [🦪 $version]($style) "

# PHP

The php module shows the currently installed version of PHP. Le module est affiché si l'une des ces conditions est remplie :

  • The current directory contains a composer.json file
  • The current directory contains a .php-version file
  • The current directory contains a .php file

# Options

Option Défaut Description
format "via [$symbol$version]($style) " Format du module.
symbol "🐘 " The symbol used before displaying the version of PHP.
style "147 bold" Le style du module.
disabled false Disables the php module.

# Variables

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

* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style

# Exemple

# ~/.config/starship.toml

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

# PureScript

Le module purescript affiche la version courante de Purescript installée. Le module est affiché si l'une des ces conditions est remplie :

  • Le répertoire courant contient un fichier spago.dhall
  • The current directory contains a *.purs files

# Options

Option Défaut Description
format "via [$symbol$version]($style) " Format du module.
symbol "<=> " Le symbole utilisé avant d'afficher la version de PureScript.
style "bold white" Le style du module.
disabled false Désactive le module purescript.

# Variables

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

* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style

# Exemple

# ~/.config/starship.toml

[purescript]
format = "via [$symbol$version](bold white)"

# Python

The python module shows the currently installed version of Python and the current Python virtual environment if one is activated.

If pyenv_version_name is set to true, it will display the pyenv version name. Otherwise, it will display the version number from python --version.

Le module est affiché si l'une des ces conditions est remplie :

  • The current directory contains a .python-version file
  • The current directory contains a requirements.txt file
  • The current directory contains a pyproject.toml file
  • The current directory contains a file with the .py extension (and scan_for_pyfiles is true)
  • The current directory contains a Pipfile file
  • Le répertoire courant contient un fichier tox.ini
  • Le répertoire courant contient un fichier setup.py
  • The current directory contains a __init__.py file
  • A virtual environment is currently activated

# Options

Option Défaut Description
format 'via [${symbol}${pyenv_prefix}${version}( \($virtualenv\))]($style) ' Format du module.
symbol "🐍 " A format string representing the symbol of Python
style "yellow bold" Le style du module.
pyenv_version_name false Use pyenv to get Python version
pyenv_prefix pyenv Prefix before pyenv version display, only used if pyenv is used
scan_for_pyfiles true If false, Python files in the current directory will not show this module.
python_binary ["python", "python3, "python2"] Configures the python binaries that Starship should executes when getting the version.
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
symbol "🐍 " Reflète la valeur de l'option symbol
style "yellow bold" Reflète la valeur de l'option style
pyenv_prefix "pyenv " Mirrors the value of option pyenv_prefix
virtualenv "venv" The current virtualenv name

# Exemple

# ~/.config/starship.toml

[python]
symbol = "👾 "
pyenv_version_name = true
# ~/.config/starship.toml

[python]
# Only use the `python3` binary to get the version.
python_binary = "python3"

# Ruby

The ruby module shows the currently installed version of Ruby. Le module est affiché si l'une des ces conditions est remplie :

  • The current directory contains a Gemfile file
  • The current directory contains a .ruby-version file
  • The current directory contains a .rb file

# Options

Option Défaut Description
format "via [$symbol$version]($style) " Format du module.
symbol "💎 " A format string representing the symbol of Ruby.
style "bold green" Le style du module.
disabled false Disables the ruby module.

# Variables

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

* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style

# Exemple

# ~/.config/starship.toml

[ruby]
symbol = "🔺 "

# Rust

The rust module shows the currently installed version of Rust. Le module est affiché si l'une des ces conditions est remplie :

  • The current directory contains a Cargo.toml file
  • The current directory contains a file with the .rs extension

# Options

Option Défaut Description
format "via [$symbol$version]($style) " Format du module.
symbol "🦀 " A format string representing the symbol of Rust
style "bold green" Le style du module.
disabled false Disables the rust module.

# Variables

Variable Exemple Description
version v1.43.0-nightly The version of rustc
symbol Reflète la valeur de l'option symbol
style* Reflète la valeur de l'option style

* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style

# Exemple

# ~/.config/starship.toml

[rust]
format = "via [⚙️ $version](red bold)"

# SHLVL

The shlvl module shows the current SHLVL ("shell level") environment variable, if it is set to a number and meets or exceeds the specified threshold.

# Options

Option Défaut Description
threshold 2 Display threshold.
format "[$symbol$shlvl]($style) " Format du module.
symbol "↕️ " The symbol used to represent the SHLVL.
repeat false Causes symbol to be repeated by the current SHLVL amount.
style "bold yellow" Le style du module.
disabled true Disables the shlvl module.

# Variables

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

* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style

# Exemple

# ~/.config/starship.toml

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

# Singularity

The singularity module shows the current singularity image, if inside a container and $SINGULARITY_NAME is set.

# Options

Option Défaut Description
format '[$symbol\[$env\]]($style) ' Format du module.
symbol "" A format string displayed before the image name.
style "bold dimmed blue" Le style du module.
disabled false Disables the singularity module.

# Variables

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

* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style

# Exemple

# ~/.config/starship.toml

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

# Status

The status module displays the exit code of the previous command. The module will be shown only if the exit code is not 0.

TIP

Ce module est désactivé par défaut. Pour l'activer, configurez disabled sur false dans votre fichier de configuration.

# Options

Option Défaut Description
format [$symbol$status]($style) The format of the module
symbol "✖" The symbol displayed on program error
not_executable_symbol "🚫" The symbol displayed when file isn't executable
not_found_symbol "🔍" The symbol displayed when the command can't be found
sigint_symbol "🧱" The symbol displayed on SIGINT (Ctrl + c)
signal_symbol "⚡" The symbol displayed on any signal
style "bold green" Le style du module.
recognize_signal_code true Enable signal mapping from exit code
map_symbol false Enable symbols mapping from exit code
disabled true Disables the status module.

# Variables

Variable Exemple Description
status 127 The exit code of the last command
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
symbol Reflète la valeur de l'option symbol
style* Reflète la valeur de l'option style

* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style

# Exemple


# ~/.config/starship.toml

[status]
style = "bg:blue"
symbol = "🔴"
format = '[\[$symbol $status_common_meaning$status_signal_name$status_maybe_int\]]($style) '
map_symbol = true
disabled = false

# Swift

The swift module shows the currently installed version of Swift. Le module est affiché si l'une des ces conditions est remplie :

  • The current directory contains a Package.swift file
  • The current directory contains a file with the .swift extension

# Options

Option Défaut Description
format "via [$symbol$version]($style) " Format du module.
symbol "🐦 " A format string representing the symbol of Swift
style "bold 202" Le style du module.
disabled false Disables the swift module.

# Variables

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

* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style

# Exemple

# ~/.config/starship.toml

[swift]
format = "via [🏎  $version](red bold)"

# Terraform

The terraform module shows the currently selected terraform workspace and version. By default the terraform version is not shown, since this is slow on current versions of terraform when a lot of plugins are in use. If you still want to enable it, follow the example shown below. Le module est affiché si l'une des ces conditions est remplie :

  • The current directory contains a .terraform folder
  • Current directory contains a file with the .tf or .hcl extensions

# Options

Option Défaut Description
format "via [$symbol$workspace]($style) " The format string for the module.
symbol "💠 " A format string shown before the terraform workspace.
style "bold 105" Le style du module.
disabled false Disables the terraform module.

# Variables

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

* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style

# Exemple

# With Version

# ~/.config/starship.toml

[terraform]
format = "[🏎💨 $version$workspace]($style) "

# Without version

# ~/.config/starship.toml

[terraform]
format = "[🏎💨 $workspace]($style) "

# Temps

The time module shows the current local time. The format configuration value is used by the chrono (opens new window) crate to control how the time is displayed. Take a look at the chrono strftime docs (opens new window) to see what options are available.

TIP

Ce module est désactivé par défaut. Pour l'activer, configurez disabled sur false dans votre fichier de configuration.

# Options

Option Défaut Description
format "at [$time]($style) " The format string for the module.
use_12hr false Activer le format 12h
time_format voir plus bas Le format chrono (opens new window) utilisé pour formater l'heure.
style "bold yellow" Le style utilisé par le module
utc_time_offset "local" Définir le décalage horaire UTC à utiliser. Range from -24 < x < 24. Accepte des nombres décimaux pour s'adapter aux décalages de 30/45 minutes.
disabled true Désactiver le module time.
time_range "-" Sets the time range during which the module will be shown. Times must be specified in 24-hours format

If use_12hr is true, then time_format defaults to "%r". Otherwise, it defaults to "%T". Manually setting time_format will override the use_12hr setting.

# Variables

Variable Exemple Description
temps 13:08:10 The current time.
style* Reflète la valeur de l'option style

* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style

# Exemple

# ~/.config/starship.toml

[time]
disabled = false
format = '🕙[\[ $time \]]($style) '
time_format = "%T"
utc_time_offset = "-5"
time_range = "10:00:00-14:00:00"

# Nom d'utilisateur

The username module shows active user's username. Le module est affiché si l'une des ces conditions est remplie :

  • L'utilisateur courant est root
  • L'utilisateur courant est différent de celui connecté
  • L'utilisateur est actuellement connecté à une session SSH
  • La variable show_always a comme valeur true

TIP

SSH connection is detected by checking environment variables SSH_CONNECTION, SSH_CLIENT, and SSH_TTY. If your SSH host does not set up these variables, one workaround is to set one of them with a dummy value.

# Options

Option Défaut Description
style_root "bold green" Le style utilisé quand l'utilisateur est root.
style_user "bold yellow" Le style utilisé pour les utilisateurs non-root.
format "[$user]($style) in " Format du module.
show_always false Toujours afficher le module username.
disabled false Désactiver le module username.

# Variables

Variable Exemple Description
style "red bold" Mirrors the value of option style_root when root is logged in and style_user otherwise.
user "matchai" 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

# Zig

The zig module shows the currently installed version of Zig. Le module est affiché si l'une des ces conditions est remplie :

  • The current directory contains a .zig file

# Options

Option Défaut Description
symbol "↯ " The symbol used before displaying the version of Zig.
style "bold yellow" Le style du module.
format "via [$symbol$version]($style) " Format du module.
disabled false Disables the zig module.

# Variables

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

* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style

# Exemple

# ~/.config/starship.toml

[zig]
symbol = "⚡️ "

# 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:

  • The current directory contains a file whose name is in files
  • The current directory contains a directory whose name is in directories
  • The current directory contains a file whose extension is in extensions
  • The when command returns 0

TIP

Multiple custom modules can be defined by using a ..

TIP

The order in which custom modules are shown can be individually set by 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 (opens new window) contains examples of custom modules. If you have an interesting example not covered there, feel free to share it there!

# Options

Option Défaut Description
command The command whose output should be printed. The command will be passed on stdin to the shell.
when A shell command used as a condition to show the module. The module will be shown if the command returns a 0 status code.
shell See below
description "<custom module>" The description of the module that is shown when running starship explain.
files [] The files that will be searched in the working directory for a match.
directories [] The directories that will be searched in the working directory for a match.
extensions [] The extensions that will be searched in the working directory for a match.
symbol "" The symbol used before displaying the command output.
style "bold green" Le style du module.
format "[$symbol$output]($style) " Format du module.
disabled false Disables this custom module.

# Variables

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

* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style

# Commandes shell personnalisées

shell accepts a non-empty list of strings, where:

  • La première chaîne est le chemin vers le shell à utiliser pour exécuter la commande.
  • Other following arguments are passed to the shell.

If unset, it will fallback to STARSHIP_SHELL and then to "sh" on Linux, and "cmd /C" on Windows.

The command will be passed in on stdin.

If shell is not given or only contains one element and Starship detects PowerShell will be used, the following arguments will automatically be added: -NoProfile -Command -. This behavior can be avoided by explicitly passing arguments to the shell, e.g.

shell = ["pwsh", "-Command", "-"]

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 (opens new window) with shell details and starship configuration if you hit such scenario.

# Exemple

# ~/.config/starship.toml

[custom.foo]
command = "echo foo"  # shows output of command
files = ["foo"]       # can specify filters
when = """ test "$HOME" == "$PWD" """
format = " transcending [$output]($style)"

[custom.time]
command = "time /T"
files = ["*.pst"]
shell = ["pwsh.exe", "-NoProfile", "-Command", "-"]