| .. | ||
| README.md | ||
Configuration
Pour commencer à configurer starship, créez le fichier suivant : ~/.config/starship.toml.
mkdir -p ~/.config && touch ~/.config/starship.toml
Toute la configuration de starship est faite dans ce fichier TOML:
# Insérer une ligne vide entre deux invites
add_newline = true
# Remplacer le "❯" dans l'invite par "➜"
[character] # On configure le module appelé "character"
success_symbol = "[➜](bold green)" # Le segment "success_symbol" est configuré sur la valeur "➜" avec la couleur "bold green" (vert, gras)
# Désactiver le module "package", pour le supprimer totalement de l'invite
[package]
disabled = true
Vous pouvez changer l'emplacement par défaut du fichier avec la variable d'environnement STARSHIP_CONFIG :
export STARSHIP_CONFIG=~/.starship/config.toml
De manière équivalente, pour Powershell (Windows), ajoutez la ligne suivante à votre $PROFILE:
$ENV:STARSHIP_CONFIG = "$HOME\.starship\config.toml"
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 Node.js qui est actuellement installée sur votre ordinateur, si votre répertoire 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.
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 :
$versionest une chaîne de formatage avec une variable nomméeversion.$git_branch$git_commitest une chaîne de formatage avec deux variables appeléesgit_branchetgit_commit.$git_branch $git_commita 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èresonavec un texte gras de couleur rouge.[⌘ $version](bold green)affichera le symbole⌘suivi par le contenu de la variableversion, en texte gras de couleur verte.[a [b](red) c](green)afficheraa b cavecbrouge, etaetcvert.
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 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)will show nothing if the variableregionisNoneor empty string, otherwise@followed by the value of region.(some text)ne montrera toujours rien puisqu'il n'y a pas de variables enveloppées dans les accolades.- Lorsque
$allest un raccourci pour\[$a$b\],($all)ne montrera rien que si$aet$bsont tous les deuxNone. 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. 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 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. |
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ébut 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\
$vcsh\
$git_branch\
$git_commit\
$git_state\
$git_metrics\
$git_status\
$hg_branch\
$docker_context\
$package\
$cmake\
$dart\
$deno\
$dotnet\
$elixir\
$elm\
$erlang\
$golang\
$helm\
$java\
$julia\
$kotlin\
$nim\
$nodejs\
$ocaml\
$perl\
$php\
$purescript\
$python\
$red\
$ruby\
$rust\
$scala\
$swift\
$terraform\
$vlang\
$vagrant\
$zig\
$nix_shell\
$conda\
$memory_usage\
$aws\
$gcloud\
$openstack\
$env_var\
$crystal\
$custom\
$cmd_duration\
$line_break\
$lua\
$jobs\
$battery\
$time\
$status\
$shell\
$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. Ce module affiche également un minuteur d'expiration lorsque vous utilisez des identifiants temporaires.
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.
Options
| Option | Default | Description |
|---|---|---|
format |
'on [$symbol($profile )(\($region\) )(\[$duration\])]($style)' |
Format du module. |
symbol |
"☁️ " |
Le symbole affiché avant le profil AWS actuel. |
region_aliases |
Table des alias de région à afficher en plus du nom AWS. | |
style |
"bold yellow" |
Le style du module. |
expiration_symbol |
X |
Le symbole affiché lorsque les identifiants temporaires ont expiré. |
disabled |
false |
Désactive le module AWS. |
Variables
| Variable | Exemple | Description |
|---|---|---|
| region | ap-northeast-1 |
La région AWS actuelle |
| profile | astronauts |
Le profil AWS actuel |
| duration | 2h27m20s |
Durée de validité des identifiants temporaires |
| symbol | Reflète la valeur de l'option symbol |
|
| style* | Reflète la valeur de l'option style |
* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
Exemples
Tout afficher
# ~/.config/starship.toml
[aws]
format = 'on [$symbol($profile )(\($region\) )]($style)'
style = "bold blue"
symbol = "🅰 "
[aws.region_aliases]
ap-southeast-2 = "au"
us-east-1 = "va"
Afficher la région
# ~/.config/starship.toml
[aws]
format = "on [$symbol$region]($style) "
style = "bold blue"
symbol = "🅰 "
[aws.region_aliases]
ap-southeast-2 = "au"
us-east-1 = "va"
Afficher le profil
# ~/.config/starship.toml
[aws]
format = "on [$symbol$profile]($style) "
style = "bold blue"
symbol = "🅰 "
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é (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 |
bold red |
Le style de l'option display si elle est utilisée. |
charging_symbol |
- |
Symbole optionnel affiché si l'option display est utilisée, la valeur par défaut est l'option charging_symbol du module "battery". |
discharging_symbol |
- |
Symbole optionnel affiché si l'option display est utilisée, la valeur par défaut est l'option discharging_symbol du module "battery". |
Exemple
[[battery.display]] # Style "rouge gras" et affichage de discharging_symbol lorsque la batterie est entre 0% et 10% de sa capacité
threshold = 10
style = "bold red"
[[battery.display]] # Style "jaune gras" et affichage de💦 lorsque la batterie est entre 10% et 30% de sa capacité
threshold = 30
style = "bold yellow"
discharging_symbol = 💦
# Au-dessus de 30% de charge, 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. Il y a deux façons de faire :
- changement de couleur (
red/green) - changement de forme (
❯/✖)
Par défaut, seule la couleur change. Si vous désirez également changer sa forme, jetez un œil à cet exemple.
::: warning
error_symbol is not supported on elvish and nu shell.
:::
::: warning
vicmd_symbol n'est supporté qu'avec fish et 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é. |
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 soit 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. Par défaut le module sera activé si au moins 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. |
version_format |
"v${raw}" |
Le format de la version. Les variables disponibles sont raw, major, minor, & patch |
symbol |
"△ " |
Le symbole utilisé avant la version de cmake. |
detect_extensions |
[] |
Quelles extensions devraient activer ce module |
detect_files |
["CMakeLists.txt", "CMakeCache.txt"] |
Quels fichiers devraient activer ce module |
detect_folders |
[] |
Quels dossiers devraient activer ce module |
style |
"bold blue" |
Le style du module. |
disabled |
false |
Désactive le module cmake. |
Variables
| Variable | Exemple | Description |
|---|---|---|
| version | v3.17.3 |
La version de cmake |
| symbol | Reflète la valeur de l'option symbol |
|
| style* | Reflète la valeur de l'option style |
* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
Temps d'exécution
Le module cmd_duration montre combien de temps 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 plus que la valeur min_time, si elle existe.
::: warning N'interceptez pas le signal DEBUG avec 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 du module. |
disabled |
false |
Désactive le module cmd_duration. |
show_notifications |
false |
Afficher les notifications du bureau lorsque la commande est terminée. |
min_time_to_notify |
45_000 |
Durée minimale après laquelle activer la notification (en millisecondes). |
::: tip
L'affichage des notifications de bureau nécessite que starship soit compilé avec la prise en charge de rust-notify. Vérifiez si starship supporte les notifications en exécutant STARSHIP_LOG=debug starship module cmd_duration -d 60000 lorsque show_notifications est défini à 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 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. |
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. Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie:
- Le répertoire courant contient un fichier
shard.yml - Le répertoire courant contient un fichier
.cr
Options
| Option | Défaut | Description |
|---|---|---|
symbol |
"🔮 " |
Le symbole utilisé avant d'afficher la version de crystal. |
format |
"via [$symbol($version )]($style)" |
Format du module. |
version_format |
"v${raw}" |
Le format de la version. Les variables disponibles sont raw, major, minor, & patch |
style |
"bold green" |
Le style du module. |
detect_extensions |
["cr"] |
Quelles extensions devraient activer ce module. |
detect_files |
["shard.yml"] |
Quels fichiers devraient activer ce module. |
detect_folders |
[] |
Quels dossiers devraient activer ce module. |
disabled |
false |
Désactive le module crystal. |
Variables
| Variable | Exemple | Description |
|---|---|---|
| version | v0.32.1 |
La version de cristal |
| symbol | Reflète la valeur de l'option symbol |
|
| style* | Reflète la valeur de l'option style |
* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
Exemple
# ~/.config/starship.toml
[crystal]
format = "via [✨ $version](bold blue) "
Dart
Le module dart affiche la version actuellement installée de Dart. Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie:
- Le répertoire courant contient un fichier
.dart - Le répertoire courant contient un répertoire
.dart_tool - Le répertoire courant contient un fichier
pubspec.yaml,pubspec.ymloupubspec.lock
Options
| Option | Défaut | Description |
|---|---|---|
format |
"via [$symbol($version )]($style)" |
Format du module. |
version_format |
"v${raw}" |
Le format de la version. Les variables disponibles sont raw, major, minor, & patch |
symbol |
"🎯 " |
Une chaîne de caractères représentant le symbole de Dart |
detect_extensions |
["dart"] |
Quelles extensions devraient activer ce module. |
detect_files |
["pubspec.yaml", "pubspec.yml", "pubspec.lock"] |
Quels fichiers devraient activer ce module. |
detect_folders |
[".dart_tool"] |
Quels dossiers devraient activer ce module. |
style |
"bold blue" |
Le style du module. |
disabled |
false |
Désactive le module dart. |
Variables
| Variable | Exemple | Description |
|---|---|---|
| version | v2.8.4 |
La version de dart |
| symbol | Reflète la valeur de l'option symbol |
|
| style* | Reflète la valeur de l'option style |
* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
Exemple
# ~/.config/starship.toml
[dart]
format = "via [🔰 $version](bold red) "
Deno
Le module deno affiche la version actuellement installée de Deno. Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie:
- Le répertoire courant contient un fichier
mod.ts,mod.js,deps.tsoudeps.ts
Options
| Option | Défaut | Description |
|---|---|---|
format |
"via [$symbol($version )]($style)" |
Format du module. |
version_format |
"v${raw}" |
Le format de la version. Les variables disponibles sont raw, major, minor, & patch |
symbol |
"🦕 " |
Une chaîne de caractères représentant le symbole de Deno |
detect_extensions |
[] |
Quelles extensions devraient activer ce module. |
detect_files |
["mod.ts", "mod.js", "deps.ts", "deps.js"] |
Quels fichiers devraient activer ce module. |
detect_folders |
[] |
Quels dossiers devraient activer ce module. |
style |
"green bold" |
Le style du module. |
disabled |
false |
Désactive le module deno. |
Variables
| Variable | Exemple | Description |
|---|---|---|
| version | v1.8.3 |
La version de deno |
| symbol | Reflète la valeur de l'option symbol |
|
| style* | Reflète la valeur de l'option style |
Exemple
# ~/.config/starship.toml
[deno]
format = "via [🦕 $version](green bold) "
Dossier
Le module directory montre le chemin vers votre répertoire courant, tronqué à trois dossiers parents. Votre répertoire sera également tronqué à la racine du repo git dans lequel vous vous trouvez actuellement.
Lorsque vous utilisez le style de pwd de fish, au lieu de cacher le chemin tronqué, vous verrez une abréviation du nom de chaque dossier, en fonction du nombre que vous avez utilisé comme valeur.
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 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 de lecture seule. |
truncation_symbol |
"" |
Le symbole pour préfixer les chemins tronqués. ex: "…/" |
home_symbol |
"~" |
Le symbole indiquant le répertoire personnel. |
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. Par exemple, le chemin /built/this/city/on/rock/and/roll, qui devrait normalement être affiché comme rock/and/roll, sera affiché sous la forme de /b/t/c/o/rock/and/roll avec fish_style_pwd_dir_length = 1--les composants de chemin qui seraient normalement supprimés sont affichés avec un caractère unique. 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 ne peut être utilisée que comme partie d'une chaîne de style
Exemple
# ~/.config/starship.toml
[directory]
truncation_length = 8
truncation_symbol = "…/"
Contexte Docker
The docker_context module shows the currently active Docker context if it's not set to default or if the DOCKER_HOST or DOCKER_CONTEXT environment variables are set (as they are meant to override the context in use).
Options
| Option | Défaut | Description |
|---|---|---|
format |
"via [$symbol$context]($style) " |
Format du module. |
symbol |
"🐳 " |
Le symbole utilisé avant d'afficher le contexte Docker. |
only_with_files |
true |
Afficher uniquement quand il y a une correspondance |
detect_extensions |
[] |
Quelles extensions devraient activer ce module (il faut que only_with_files soit réglé sur true). |
detect_files |
["docker-compose.yml", "docker-compose.yaml", "Dockerfile"] |
Quels noms de fichier devraient activer ce module (il faut que only_with_files soit réglé sur true). |
detect_folders |
[] |
Quels dossiers devraient activer ce module (il faut que only_with_files soit réglé sur true). |
style |
"blue bold" |
Le style du module. |
disabled |
false |
Désactive le module docker_context. |
Variables
| Variable | Exemple | Description |
|---|---|---|
| context | test_context |
Le contexte actuel de Docker |
| symbol | Reflète la valeur de l'option symbol |
|
| style* | Reflète la valeur de l'option style |
* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
Exemple
# ~/.config/starship.toml
[docker_context]
format = "via [🐋 $context](blue bold)"
Dotnet
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.jsonproject.jsonDirectory.Build.propsDirectory.Build.targetsPackages.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.
The module will also show the Target Framework Moniker (https://docs.microsoft.com/en-us/dotnet/standard/frameworks#supported-target-framework-versions) when there is a csproj file in the current directory.
Options
| Option | Défaut | Description |
|---|---|---|
format |
"via [$symbol($version )(🎯 $tfm )]($style)" |
Format du module. |
version_format |
"v${raw}" |
Le format de la version. Les variables disponibles sont raw, major, minor, & patch |
symbol |
".NET " |
Le symbole utilisé avant d'afficher la version de dotnet. |
heuristic |
true |
Utilisez la détection de versions plus rapide pour garder starship instantané. |
detect_extensions |
["csproj", "fsproj", "xproj"] |
Quelles extensions devraient activer ce module. |
detect_files |
["global.json", "project.json", "Directory.Build.props", "Directory.Build.targets", "Packages.props"] |
Quels fichiers devraient activer ce module. |
detect_folders |
[] |
Quels dossiers devraient activer ce module. |
style |
"bold blue" |
Le style du module. |
disabled |
false |
Désactive le module dotnet. |
Variables
| Variable | Exemple | Description |
|---|---|---|
| version | v3.1.201 |
La version du sdk dotnet |
| tfm | netstandard2.0 |
The Target Framework Moniker that the current project is targeting |
| symbol | Reflète la valeur de l'option symbol |
|
| style* | Reflète la valeur de l'option style |
* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
Exemple
# ~/.config/starship.toml
[dotnet]
symbol = "🥅 "
style = "green"
heuristic = false
Elixir
Le module elixir montre la version actuellement installée de Elixir et Erlang/OTP. Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie:
- Le répertoire courant contient un fichier
mix.exs.
Options
| Option | Défaut | Description |
|---|---|---|
format |
'via [$symbol($version \(OTP $otp_version\) )]($style)' |
Format du module elixir. |
version_format |
"v${raw}" |
Le format de la version. Les variables disponibles sont raw, major, minor, & patch |
symbol |
"💧 " |
Le symbole utilisé avant d'afficher la version d'Elixir/Erlang. |
detect_extensions |
[] |
Quelles extensions devraient activer ce module. |
detect_files |
["mix.exs"] |
Quels fichiers devraient activer ce module. |
detect_folders |
[] |
Quels dossiers devraient activer ce module. |
style |
"bold purple" |
Le style du module. |
disabled |
false |
Désactive le module elixir. |
Variables
| Variable | Exemple | Description |
|---|---|---|
| version | v1.10 |
La version d' elixir |
| otp_version | La version otp d' elixir |
|
| symbol | Reflète la valeur de l'option symbol |
|
| style* | Reflète la valeur de l'option style |
* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
Exemple
# ~/.config/starship.toml
[elixir]
symbol = "🔮 "
Elm
Le module elm montre la version actuellement installée de Elm. Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie:
- Le répertoire courant contient un fichier
elm.json - Le répertoire courant contient un fichier
elm-package.json - Le répertoire courant contient un fichier
elm-version - Le répertoire courant contient un dossier
elm-stuff - Le répertoire courant contient des fichiers
*.elm
Options
| Option | Défaut | Description |
|---|---|---|
format |
"via [$symbol($version )]($style)" |
Format du module. |
version_format |
"v${raw}" |
Le format de la version. Les variables disponibles sont raw, major, minor, & patch |
symbol |
"🌳 " |
Une chaîne de format représentant le symbole d'Elm. |
detect_extensions |
["elm"] |
Quelles extensions devraient activer ce module. |
detect_files |
["elm.json", "elm-package.json", ".elm-version"] |
Quels fichiers devraient activer ce module. |
detect_folders |
["elm-stuff"] |
Quels dossiers devraient activer ce module. |
style |
"cyan bold" |
Le style du module. |
disabled |
false |
Désactive le module elm. |
Variables
| Variable | Exemple | Description |
|---|---|---|
| version | v0.19.1 |
La version de elm |
| symbol | Reflète la valeur de l'option symbol |
|
| style* | Reflète la valeur de l'option style |
* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
Exemple
# ~/.config/starship.toml
[elm]
format = "via [ $version](cyan bold) "
Variable d'environnement
The env_var module displays the current value of a selected environment variables. Le module est affiché si l'une de ces conditions est remplie :
- L'option
variablecorrespond à une variable d'environnement existante - L'option
variablen'est pas définie, mais l'optiondefaultl'est
::: tip Multiple environmental variables can be displayed by using a .. (see example) If the variable configuration option is not set, the module will display value of variable under the name of text after the . character.
Example: following configuration will display value of USER environment variable
# ~/.config/starship.toml
[env_var.USER]
default = "unknown user"
:::
Options
| Option | Défaut | Description |
|---|---|---|
symbol |
Le symbole utilisé avant d'afficher la valeur de la variable. | |
variable |
La variable d'environnement à afficher. | |
default |
La valeur par défaut à afficher lorsque la variable sélectionnée n'est pas définie. | |
format |
"with [$env_value]($style) " |
Format du module. |
disabled |
false |
Désactive le module env_var. |
Variables
| Variable | Exemple | Description |
|---|---|---|
| env_value | Windows NT (si variable était $OS) |
La valeur d'environnement de l'option variable |
| symbol | Reflète la valeur de l'option symbol |
|
| style* | black bold dimmed |
Reflète la valeur de l'option style |
* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
Exemple
# ~/.config/starship.toml
[env_var]
variable = "SHELL"
default = "unknown shell"
Displaying multiple environmental variables:
# ~/.config/starship.toml
[env_var.SHELL]
variable = "SHELL"
default = "unknown shell"
[env_var.USER]
default = "unknown user"
Erlang
Le module erlang montre la version actuellement installée de Erlang/OTP. Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie:
- Le répertoire courant contient un fichier
rebar.config. - Le répertoire courant contient un fichier
erlang.mk.
Options
| Option | Défaut | Description |
|---|---|---|
format |
"via [$symbol($version )]($style)" |
Format du module. |
version_format |
"v${raw}" |
Le format de la version. Les variables disponibles sont raw, major, minor, & patch |
symbol |
" " |
Le symbole utilisé avant d'afficher la version d'erlang. |
style |
"bold green" |
Le style du module. |
detect_extensions |
[] |
Quelles extensions devraient activer ce module. |
detect_files |
["rebar.config", "elang.mk"] |
Quels fichiers devraient activer ce module. |
detect_folders |
[] |
Quels dossiers devraient activer ce module. |
disabled |
false |
Désactive le module erlang. |
Variables
| Variable | Exemple | Description |
|---|---|---|
| version | v22.1.3 |
La version d'erlang |
| symbol | Reflète la valeur de l'option symbol |
|
| style* | Reflète la valeur de l'option style |
* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
Exemple
# ~/.config/starship.toml
[erlang]
format = "via [e $version](bold red) "
Google Cloud (gcloud)
Le module gcloud affiche la configuration actuelle pour gcloud CLI. Ceci est basé sur les fichiers ~/.config/gcloud/active_config et ~/.config/gcloud/configurations/config_{CONFIG NAME} et la variable d'environnement CLOUDSDK_CONFIG.
Options
| Option | Défaut | Description |
|---|---|---|
format |
'on [$symbol$account(@$domain)(\($region\))]($style) ' |
Format du module. |
symbol |
"☁️ " |
Le symbole affiché avant le profil GCP actuel. |
region_aliases |
Table des alias de région à afficher en plus du nom du GCP. | |
style |
"bold blue" |
Le style du module. |
disabled |
false |
Désactive le module gcloud. |
Variables
| Variable | Exemple | Description |
|---|---|---|
| region | us-central1 |
La région GCP actuelle |
| account | foo |
Le profil GCP actuel |
| domain | exemple.com |
Le domaine du profil GCP actuel |
| project | Le projet GCP actuel | |
| active | default |
Le nom de la configuration active écrit dans ~/.config/gcloud/active_config |
| symbol | Reflète la valeur de l'option symbol |
|
| style* | Reflète la valeur de l'option style |
* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
Exemples
Afficher le compte et le projet
# ~/.config/starship.toml
[gcloud]
format = 'on [$symbol$account(@$domain)(\($project\))]($style) '
Afficher uniquement le nom de la configuration active
# ~/.config/starship.toml
[gcloud]
format = "[$symbol$active]($style) "
style = "bold yellow"
Afficher le compte et la région aliasée
# ~/.config/starship.toml
[gcloud]
symbol = "️🇬️ "
[gcloud.region_aliases]
us-central1 = "uc1"
asia-northeast1 = "an1"
Branche Git
Le module git_branch affiche la branche active du dépôt dans votre répertoire courant.
Options
| Option | Défaut | Description |
|---|---|---|
always_show_remote |
false |
Affiche le nom de la branche suivie distante, même si elle est égale au nom de la branche locale. |
format |
"on [$symbol$branch]($style) " |
Format du module. Utilisez "$branch" pour vous référer au nom de la branche courante. |
symbol |
" " |
Une chaîne de format représentant le symbole de la branche git. |
style |
"bold purple" |
Le style du module. |
truncation_length |
2^63 - 1 |
Tronque une branche git à N graphèmes. |
truncation_symbol |
"…" |
Le symbole utilisé pour indiquer qu'un nom de branche a été tronqué. Vous pouvez utiliser "" pour ne pas afficher de symbole. |
only_attached |
false |
Ne montrer le nom de la branche que si elle n'est pas dans un état HEAD détachée. |
disabled |
false |
Désactive le module git_branch. |
Variables
| Variable | Exemple | Description |
|---|---|---|
| branch | master |
Le nom de la branche actuelle, par défaut à HEAD s'il n'y a pas de branche actuelle (par exemple HEAD détachée). |
| remote_name | origin |
Le nom du dépôt distant. |
| remote_branch | master |
Le nom de la branche suivie sur remote_name. |
| symbol | Reflète la valeur de l'option symbol |
|
| style* | Reflète la valeur de l'option style |
* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
Exemple
# ~/.config/starship.toml
[git_branch]
symbol = "🌱 "
truncation_length = 4
truncation_symbol = ""
Commit Git
Le module git_commit affiche le hash du commit actuel ainsi que le tag (le cas échéant) du dépôt dans votre répertoire courant.
Options
| Option | Défaut | Description |
|---|---|---|
commit_hash_length |
7 |
La longueur du hash affiché du commit git. |
format |
"[\\($hash$tag\\)]($style) " |
Format du module. |
style |
"bold green" |
Le style du module. |
only_detached |
true |
Ne montrer le hash du commit qu'en mode HEAD détachée. |
tag_disabled |
true |
Désactive l'affichage des informations du tag dans le module git_commit. |
tag_symbol |
" 🏷 " |
Symbole préfixant les informations affichées concernant le tag |
disabled |
false |
Désactive le module git_commit. |
Variables
| Variable | Exemple | Description |
|---|---|---|
| hash | b703eb3 |
Le hash du commit git actuel |
| style* | Reflète la valeur de l'option style |
* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
Exemple
# ~/.config/starship.toml
[git_commit]
commit_hash_length = 4
tag_symbol = "🔖 "
État Git
Le module git_state s'affichera dans les répertoires qui font partie d'un dépôt git, dans lesquels une opération est en cours, comme : REBASING, BISECTING, etc. S'il y a des informations de progression (par exemple, REBASING 3/10), ces informations seront également affichées.
Options
| Option | Défaut | Description |
|---|---|---|
rebase |
"REBASING" |
Une chaîne de format affichée lorsqu'un rebase est en cours. |
merge |
"MERGING" |
Une chaîne de format affichée quand un merge est en cours. |
revert |
"REVERTING" |
Une chaîne de format affichée quand un revert est en cours. |
cherry_pick |
"CHERRY-PICKING" |
Une chaîne de format affichée quand un cherry-pick est en cours. |
bisect |
"BISECTING" |
Une chaîne de format affichée quand un bisect est en cours. |
am |
"AM" |
Une chaîne de format affichée lorsqu'un apply-mailbox (git am) est en cours. |
am_or_rebase |
"AM/REBASE" |
Une chaîne de format affichée lorsqu'une apply-mailbox ou un rebase est en cours sans pouvoir les différencier. |
style |
"bold yellow" |
Le style du module. |
format |
'\([$state( $progress_current/$progress_total)]($style)\) ' |
Format du module. |
disabled |
false |
Désactive le module git_state. |
Variables
| Variable | Exemple | Description |
|---|---|---|
| state | REBASING |
L'état actuel du dépôt |
| progress_current | 1 |
Progression de l'opération en cours |
| progress_total | 2 |
Progression maximale de l'opération |
| style* | Reflète la valeur de l'option style |
* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
Exemple
# ~/.config/starship.toml
[git_state]
format = '[\($state( $progress_current of $progress_total)\)]($style) '
cherry_pick = "[🍒 PICKING](bold red)"
Git Metrics
The git_metrics module will show the number of added and deleted lines in the current git repository.
::: tip
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 |
|---|---|---|
added_style |
"bold green" |
The style for the added count. |
deleted_style |
"bold green" |
The style for the deleted count. |
format |
'[+$added]($added_style) [-$deleted]($deleted_style) ' |
Format du module. |
disabled |
true |
Disables the git_metrics module. |
Variables
| Variable | Exemple | Description |
|---|---|---|
| added | 1 |
The current number of added lines |
| deleted | 2 |
The current number of deleted lines |
| added_style* | Mirrors the value of option added_style |
|
| deleted_style* | Mirrors the value of option deleted_style |
* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
Exemple
# ~/.config/starship.toml
[git_metrics]
added_style = "bold blue"
format = '[+$added]($added_style)/[-$deleted]($deleted_style) '
Statut Git
Le module git_status affiche des symboles représentant l'état du dépôt dans votre répertoire courant.
Options
| Option | Défaut | Description |
|---|---|---|
format |
'([\[$all_status$ahead_behind\]]($style) )' |
Le format par défaut du module git_status |
conflicted |
"=" |
Cette branche a des conflits de fusion. |
ahead |
"⇡" |
Le format de ahead |
behind |
"⇣" |
Le format de behind |
diverged |
"⇕" |
Le format de diverged |
up_to_date |
"" |
The format of up_to_date |
untracked |
"?" |
Le format de untracked |
stashed |
"$" |
Le format de stashed |
modified |
"!" |
Le format de modified |
staged |
"+" |
Le format de staged |
renamed |
"»" |
Le format de renamed |
deleted |
"✘" |
Le format de deleted |
style |
"bold green" |
Le style du module. |
disabled |
false |
Désactive le module git_status. |
Variables
Les variables suivantes peuvent être utilisées pour la valeur de format:
| Variable | Description |
|---|---|
all_status |
Raccourci pour $conflicted$stashed$deleted$renamed$modified$staged$untracked |
ahead_behind |
Displays diverged, ahead, behind or up_to_date format string based on the current status of the repo. |
conflicted |
Affiche conflicted lorsque la branche courante a des conflits de fusion. |
untracked |
Affiche untracked lorsqu'il y a des fichiers non suivis dans le répertoire de travail. |
stashed |
Affiche stashed lorsqu'une remise existe pour le dépôt local. |
modified |
Affiche modified lorsqu'il y a des fichiers modifiés dans le répertoire de travail. |
staged |
Affiche staged lorsqu'un nouveau fichier a été ajouté à la zone de validation. |
renamed |
Affiche renamed lorsqu'un fichier renommé a été ajouté à la zone de validation. |
deleted |
Affiche deleted lorsque la suppression d'un fichier a été ajoutée à la zone de validation. |
| style* | Reflète la valeur de l'option style |
* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
Les variables suivantes peuvent être utilisées pour la valeur de diverged:
| Variable | Description |
|---|---|
ahead_count |
Nombre de commits en avance sur la branche suivie |
behind_count |
Nombre de commits en retard sur la branche suivie |
Les variables suivantes peuvent êtres utilisées dans conflicted, ahead, behind, untracked, stashed, modified, staged, renamed et deleted:
| Variable | Description |
|---|---|
count |
Affiche le nombre de fichiers concernés |
Exemple
# ~/.config/starship.toml
[git_status]
conflicted = "🏳"
ahead = "🏎💨"
behind = "😰"
diverged = "😵"
up_to_date = "✓"
untracked = "🤷"
stashed = "📦"
modified = "📝"
staged = '[++\($count\)](green)'
renamed = "👅"
deleted = "🗑"
Afficher le nombre de commits en avance/en retard par rapport à la branche suivie
# ~/.config/starship.toml
[git_status]
ahead = "⇡${count}"
diverged = "⇕⇡${ahead_count}⇣${behind_count}"
behind = "⇣${count}"
Golang
Le module golang montre la version actuellement installée de Golang. Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie:
- Le répertoire courant contient un fichier
go.mod - Le répertoire courant contient un fichier
go.sum - Le répertoire courant contient un fichier
glide.yaml - Le répertoire courant contient un fichier
Gopkg.yml - Le répertoire courant contient un fichier
Gopkg.lock - Le répertoire courant contient un fichier
.go-version - Le répertoire courant contient un répertoire
Godeps - Le répertoire actuel contient un fichier avec l'extension
.go
Options
| Option | Défaut | Description |
|---|---|---|
format |
"via [$symbol($version )]($style)" |
Format du module. |
version_format |
"v${raw}" |
Le format de la version. Les variables disponibles sont raw, major, minor, & patch |
symbol |
"🐹 " |
Une chaîne de caractères représentant le symbole de Go. |
detect_extensions |
["go"] |
Quelles extensions devraient activer ce module. |
detect_files |
["go.mod", "go.sum", "glide.yaml", "Gopkg.yml", "Gopkg.lock", ".go-version"] |
Quels fichiers devraient activer ce module. |
detect_folders |
["Godeps"] |
Quels dossiers devraient activer ce module. |
style |
"bold cyan" |
Le style du module. |
disabled |
false |
Désactive le module golang. |
Variables
| Variable | Exemple | Description |
|---|---|---|
| version | v1.12.1 |
La version de go |
| symbol | Reflète la valeur de l'option symbol |
|
| style* | Reflète la valeur de l'option style |
* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
Exemple
# ~/.config/starship.toml
[golang]
format = "via [🏎💨 $version](bold cyan) "
Helm
Le module helm montre la version actuellement installée de Helm. Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie:
- Le répertoire courant contient un fichier
helmfile.yaml - Le répertoire courant contient un fichier
Chart.yml
Options
| Option | Défaut | Description |
|---|---|---|
format |
"via [$symbol($version )]($style)" |
Format du module. |
version_format |
"v${raw}" |
Le format de la version. Les variables disponibles sont raw, major, minor, & patch |
detect_extensions |
[] |
Quelles extensions devraient activer ce module. |
detect_files |
["helmfile.yaml", "Chart.yaml"] |
Quels fichiers devraient activer ce module. |
detect_folders |
[] |
Quels dossiers devraient activer ce module. |
symbol |
"⎈ " |
Une chaîne de format représentant le symbole de Helm. |
style |
"bold white" |
Le style du module. |
disabled |
false |
Désactive le module helm. |
Variables
| Variable | Exemple | Description |
|---|---|---|
| version | v3.1.1 |
La version de helm |
| symbol | Reflète la valeur de l'option symbol |
|
| style* | Reflète la valeur de l'option style |
* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
Exemple
# ~/.config/starship.toml
[helm]
format = "via [⎈ $version](bold white) "
Nom d'hôte
Le module hostname affiche le nom d'hôte du système.
Options
| Option | Défaut | Description |
|---|---|---|
ssh_only |
true |
Afficher uniquement le nom d'hôte lorsque vous êtes connecté à une session SSH. |
trim_at |
"." |
Chaîne à laquelle le nom d'hôte est coupé, après la première correspondance. "." s'arrêtera après le premier point. "" désactivera toute troncature |
format |
"[$hostname]($style) in " |
Format du module. |
style |
"bold dimmed green" |
Le style du module. |
disabled |
false |
Désactive le module hostname. |
Variables
| Variable | Exemple | Description |
|---|---|---|
| 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
Le module java affiche la version actuellement installée de Java. Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie:
- Le répertoire actuel contient un fichier
pom.xml,build.gradle.kts,build.sbt,.java-version,.deps.edn,project.clj, oubuild.boot - Le répertoire actuel contient un fichier avec l'extension
.java,.class,. gradle,.jar,.clj, ou.cljc
Options
| Option | Défaut | Description |
|---|---|---|
format |
"via [${symbol}(${version} )]($style)" |
Format du module. |
version_format |
"v${raw}" |
Le format de la version. Les variables disponibles sont raw, major, minor, & patch |
detect_extensions |
["java", "class", "gradle", "jar", "cljs", "cljc"] |
Quelles extensions devraient activer ce module. |
detect_files |
["pom.xml", "build.gradle.kts", "build.sbt", ".java-version", ".deps.edn", "project.clj", "build.boot"] |
Quels fichiers devraient activer ce module. |
detect_folders |
[] |
Quels dossiers devraient activer ce module. |
symbol |
"☕ " |
Une chaîne de caractères représentant le symbole de Java |
style |
"red dimmed" |
Le style du module. |
disabled |
false |
Désactive le module java. |
Variables
| Variable | Exemple | Description |
|---|---|---|
| version | v14 |
La version de java |
| symbol | Reflète la valeur de l'option symbol |
|
| style* | Reflète la valeur de l'option style |
* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
Exemple
# ~/.config/starship.toml
[java]
symbol = "🌟 "
Jobs
Le module jobs affiche le nombre de tâches en cours d'exécution. Le module ne sera affiché que s'il y a des tâches de fond. The module will show the number of jobs running if there are at least 2 jobs, or more than the number_threshold config value, if it exists. The module will show a symbol if there is at least 1 job, or more than the symbol_threshold config value, if it exists. You can set both values to 0 in order to always show the symbol and number of jobs, even if there are 0 jobs running.
The default functionality is:
- 0 jobs -> Nothing is shown.
- 1 job ->
symbolis shown. - 2 jobs or more ->
symbol+numberare shown.
::: warning
This module is not supported on tcsh and nu.
:::
::: warning
The threshold option is deprecated, but if you want to use it, the module will show the number of jobs running if there is more than 1 job, or more than the threshold config value, if it exists. Si threshold est définie à 0, alors le module s'affichera également lorsqu'il n'y a pas de tâches de fond en cours.
:::
Options
| Option | Défaut | Description |
|---|---|---|
threshold* |
1 |
Afficher le nombre de jobs si dépassé. |
symbol_threshold |
1 |
Show symbol if the job count is at least symbol_threshold. |
number_threshold |
2 |
Show the number of jobs if the job count is at least number_threshold. |
format |
"[$symbol$number]($style) " |
Format du module. |
symbol |
"✦" |
The string used to represent the symbol variable. |
style |
"bold blue" |
Le style du module. |
disabled |
false |
Désactive le module jobs. |
| *: This option is deprecated, please use the |
number_threshold and symbol_threshold options instead.
Variables
| Variable | Exemple | Description |
|---|---|---|
| number | 1 |
Le nombre de tâches |
| symbol | Reflète la valeur de l'option symbol |
|
| style* | Reflète la valeur de l'option style |
* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
Exemple
# ~/.config/starship.toml
[jobs]
symbol = "+ "
number_threshold = 4
symbol_threshold = 0
Julia
Le module julia affiche la version actuellement installée de Julia. Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie:
- Le répertoire courant contient un fichier
Project.toml - Le répertoire courant contient un fichier
Manifest.toml - Le répertoire actuel contient un fichier avec l'extension
.jl
Options
| Option | Défaut | Description |
|---|---|---|
format |
"via [$symbol($version )]($style)" |
Format du module. |
version_format |
"v${raw}" |
Le format de la version. Les variables disponibles sont raw, major, minor, & patch |
detect_extensions |
["jl"] |
Quelles extensions devraient activer ce module. |
detect_files |
["Project.toml", "Manifest.toml"] |
Quels fichiers devraient activer ce module. |
detect_folders |
[] |
Quels dossiers devraient activer ce module. |
symbol |
"ஃ " |
Une chaîne de caractères représentant le symbole de Julia. |
style |
"bold purple" |
Le style du module. |
disabled |
false |
Désactive le module Julia. |
Variables
| Variable | Exemple | Description |
|---|---|---|
| version | v1.4.0 |
La version de julia |
| symbol | Reflète la valeur de l'option symbol |
|
| style* | Reflète la valeur de l'option style |
* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
Exemple
# ~/.config/starship.toml
[julia]
symbol = "∴ "
Kotlin
Le module kotlin affiche la version actuellement installée de Kotlin. Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie:
- Le répertoire courant contient un fichier
.ktou.kts
Options
| Option | Défaut | Description |
|---|---|---|
format |
"via [$symbol($version )]($style)" |
Format du module. |
version_format |
"v${raw}" |
Le format de la version. Les variables disponibles sont raw, major, minor, & patch |
detect_extensions |
["kt", "kts"] |
Quelles extensions devraient activer ce module. |
detect_files |
[] |
Quels fichiers devraient activer ce module. |
detect_folders |
[] |
Quels dossiers devraient activer ce module. |
symbol |
"🅺 " |
Une chaîne de caractères représentant le symbole de Kotlin. |
style |
"bold blue" |
Le style du module. |
kotlin_binary |
"kotlin" |
Configure le binaire kotlin que Starship exécute lors de l'obtention de la version. |
disabled |
false |
Désactive le module kotlin. |
Variables
| Variable | Exemple | Description |
|---|---|---|
| version | v1.4.21 |
La version de kotlin |
| symbol | Reflète la valeur de l'option symbol |
|
| style* | Reflète la valeur de l'option style |
* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
Exemple
# ~/.config/starship.toml
[kotlin]
symbol = "🅺 "
# ~/.config/starship.toml
[kotlin]
# Uses the Kotlin Compiler binary to get the installed version
kotlin_binary = "kotlinc"
Kubernetes
Affiche le nom du contexte Kubernets actuel et, si défini, l'espace de noms du fichier kubeconfig. L'espace de noms doit être défini dans le fichier kubeconfig, cela peut être fait via kubectl config set-context starship-cluster --namespace astronaut. Si la variable d'environnement $KUBECONFIG est définie, le module l'utilisera sinon il utilisera le fichier ~/.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 |
"☸ " |
Une chaîne de format représentant le symbole affiché avant le Cluster. |
format |
'[$symbol$context( \($namespace\))]($style) in ' |
Format du module. |
style |
"cyan bold" |
Le style du module. |
context_aliases |
Tableau des alias de contexte à afficher. | |
disabled |
true |
Désactiver le module kubernetes. |
Variables
| Variable | Exemple | Description |
|---|---|---|
| context | starship-cluster |
Le contexte kubernetes actuel |
| namespace | starship-namespace |
Si défini, l'espace de noms actuel de kubernetes |
| symbol | Reflète la valeur de l'option symbol |
|
| style* | Reflète la valeur de l'option style |
* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
Exemple
# ~/.config/starship.toml
[kubernetes]
format = 'on [⛵ $context \($namespace\)](dimmed green) '
disabled = false
[kubernetes.context_aliases]
"dev.local.cluster.k8s" = "dev"
".*/openshift-cluster/.*" = "openshift"
"gke_.*_(?P<cluster>[\\w-]+)" = "gke-$cluster"
Regex Matching
Additional to simple aliasing, context_aliases also supports extended matching and renaming using regular expressions.
The regular expression must match on the entire kube context, capture groups can be referenced using $name and $N in the replacement. This is more explained in the regex crate documentation.
Long and automatically generated cluster names can be identified and shortened using regular expressions:
[kubernetes.context_aliases]
# OpenShift contexts carry the namespace and user in the kube context: `namespace/name/user`:
".*/openshift-cluster/.*" = "openshift"
# Or better, to rename every OpenShift cluster at once:
".*/(?P<cluster>[\\w-]+)/.*" = "$cluster"
# Contexts from GKE, AWS and other cloud providers usually carry additional information, like the region/zone.
# The following entry matches on the GKE format (`gke_projectname_zone_cluster-name`)
# and renames every matching kube context into a more readable format (`gke-cluster-name`):
"gke_.*_(?P<cluster>[\\w-]+)" = "gke-$cluster"
Saut de ligne
Le module line_break sépare l'invite en deux lignes.
Options
| Option | Défaut | Description |
|---|---|---|
disabled |
false |
Désactive le module line_break , faisant de l'invite une seule ligne. |
Exemple
# ~/.config/starship.toml
[line_break]
disabled = true
Lua
Le module lua affiche la version actuellement installée de Lua. Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie:
- Le répertoire courant contient un fichier
.lua-version - Le répertoire courant contient un répertoire
lua - Le répertoire actuel contient un fichier avec l'extension
.lua
Options
| Option | Défaut | Description |
|---|---|---|
format |
"via [$symbol($version )]($style)" |
Format du module. |
version_format |
"v${raw}" |
Le format de la version. Les variables disponibles sont raw, major, minor, & patch |
symbol |
"🌙 " |
Une chaîne de caractères représentant le symbole de Lua. |
detect_extensions |
["lua"] |
Quelles extensions devraient activer ce module. |
detect_files |
[".lua-version"] |
Quels fichiers devraient activer ce module. |
detect_folders |
["lua"] |
Quels dossiers devraient activer ce module. |
style |
"bold blue" |
Le style du module. |
lua_binary |
"lua" |
Configure le binaire lua que Starship exécute lors de l'obtention de la version. |
disabled |
false |
Désactive le module lua. |
Variables
| Variable | Exemple | Description |
|---|---|---|
| version | v5.4.0 |
La version de lua |
| symbol | Reflète la valeur de l'option symbol |
|
| style* | Reflète la valeur de l'option style |
* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
Exemple
# ~/.config/starship.toml
[lua]
format = "via [🌕 $version](bold blue) "
Utilisation mémoire
Le module memory_usage affiche la mémoire système actuelle et l'utilisation de swap.
Par défaut, l'utilisation du swap est affichée si le swap total du système n'est pas nul.
::: 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 |
Masquer l'utilisation de la mémoire à moins qu'elle ne dépasse ce pourcentage. |
format |
"via $symbol [${ram}( | ${swap})]($style) " |
Format du module. |
symbol |
"🐏" |
Le symbole utilisé avant d'afficher l'utilisation de la mémoire. |
style |
"bold dimmed white" |
Le style du module. |
disabled |
true |
Désactiver le module memory_usage. |
Variables
| Variable | Exemple | Description |
|---|---|---|
| ram | 31GiB/65GiB |
La mémoire système utilisée/totale . |
| ram_pct | 48% |
Le pourcentage de la mémoire du système actuel. |
| swap** | 1GiB/4GiB |
La taille de la mémoire swap du fichier de mémoire swap du système courant. |
| swap_pct** | 77% |
Le poucentage de la mémoire swap du fichier de mémoire swap du système courant. |
| symbol | 🐏 |
Reflète la valeur de l'option symbol |
| style* | Reflète la valeur de l'option style |
* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style ** : Les informations sur le fichier SWAP ne sont affichées que si détectées sur le système actuel
Exemple
# ~/.config/starship.toml
[memory_usage]
disabled = false
threshold = -1
symbol = " "
style = "bold dimmed green"
Branche Mercurial
Le module hg_branch affiche la branche active du dépôt dans votre répertoire courant.
Options
| Option | Défaut | Description |
|---|---|---|
symbol |
" " |
Le symbole utilisé avant le marque-page hg ou le nom de la branche du dépôt dans votre répertoire courant. |
style |
"bold purple" |
Le style du module. |
format |
"on [$symbol$branch]($style) " |
Format du module. |
truncation_length |
2^63 - 1 |
Tronque le nom de la branche hg à N graphèmes |
truncation_symbol |
"…" |
Le symbole utilisé pour indiquer qu'un nom de branche a été tronqué. |
disabled |
true |
Désactive le module hg_branch. |
Variables
| Variable | Exemple | Description |
|---|---|---|
| branch | master |
La branche mercuriale active |
| symbol | Reflète la valeur de l'option symbol |
|
| style* | Reflète la valeur de l'option style |
* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
Exemple
# ~/.config/starship.toml
[hg_branch]
format = "on [🌱 $branch](bold purple)"
truncation_length = 4
truncation_symbol = ""
Nim
Le module nim affiche la version actuellement installée de Nim. Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie:
- Le répertoire courant contient un fichier
nim.cfg - Le répertoire actuel contient un fichier avec l'extension
.nim - Le répertoire actuel contient un fichier avec l'extension
.nims - Le répertoire actuel contient un fichier avec l'extension
.nimble
Options
| Option | Défaut | Description |
|---|---|---|
format |
"via [$symbol($version )]($style)" |
Format du module |
version_format |
"v${raw}" |
Le format de la version. Les variables disponibles sont raw, major, minor, & patch |
symbol |
"👑 " |
Le symbole utilisé avant d'afficher la version de Nim. |
detect_extensions |
["nim", "nims", "nimble"] |
Quelles extensions devraient activer ce module. |
detect_files |
["nim.cfg"] |
Quels fichiers devraient activer ce module. |
detect_folders |
[] |
Quels dossiers devraient activer ce module. |
style |
"bold yellow" |
Le style du module. |
disabled |
false |
Désactive le module nim. |
Variables
| Variable | Exemple | Description |
|---|---|---|
| version | v1.2.0 |
La version de nim |
| symbol | Reflète la valeur de l'option symbol |
|
| style* | Reflète la valeur de l'option style |
* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
Exemple
# ~/.config/starship.toml
[nim]
style = "yellow"
symbol = "🎣 "
Nix-shell
The nix_shell module shows the nix-shell environment. The module will be shown when inside a nix-shell environment.
Options
| Option | Défaut | Description |
|---|---|---|
format |
'via [$symbol$state( \($name\))]($style) ' |
Format du module. |
symbol |
"❄️ " |
Une chaîne de format représentant le symbole de nix-shell. |
style |
"bold blue" |
Le style du module. |
impure_msg |
"impure" |
Une chaîne de format affichée lorsque le shell est impur. |
pure_msg |
"pure" |
Une chaîne de format affichée lorsque le shell est pur. |
disabled |
false |
Désactive le module nix_shell. |
Variables
| Variable | Exemple | Description |
|---|---|---|
| state | pure |
The state of the nix-shell |
| name | lorri |
The name of the nix-shell |
| symbol | Reflète la valeur de l'option symbol |
|
| style* | Reflète la valeur de l'option style |
* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
Exemple
# ~/.config/starship.toml
[nix_shell]
disabled = true
impure_msg = "[impure shell](bold red)"
pure_msg = "[pure shell](bold green)"
format = 'via [☃️ $state( \($name\))](bold blue) '
Node.js
Le module nodejs affiche la version actuellement installée de Node.js. Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie:
- Le répertoire courant contient un fichier
package.json - Le répertoire courant contient un fichier
.node-version - Le répertoire courant contient un fichier
.nvmrc - Le répertoire courant contient un répertoire
node_modules - Le répertoire actuel contient un fichier avec l'extension
.js,.mjsou.cjs - Le répertoire actuel contient un fichier avec l'extension
.ts
Options
| Option | Défaut | Description |
|---|---|---|
format |
"via [$symbol($version )]($style)" |
Format du module. |
version_format |
"v${raw}" |
Le format de la version. Les variables disponibles sont raw, major, minor, & patch |
symbol |
" " |
Une chaîne de caractères représentant le symbole de Node.js. |
detect_extensions |
["js", "mjs", "cjs", "ts"] |
Quelles extensions devraient activer ce module. |
detect_files |
["package.json", ".node-version"] |
Quels fichiers devraient activer ce module. |
detect_folders |
["node_modules"] |
Quels dossiers devraient activer ce module. |
style |
"bold green" |
Le style du module. |
disabled |
false |
Désactive le module nodejs. |
not_capable_style |
bold red |
The style for the module when an engines property in package.json does not match the Node.js version. |
Variables
| Variable | Exemple | Description |
|---|---|---|
| version | v13.12.0 |
La version de node |
| symbol | Reflète la valeur de l'option symbol |
|
| style* | Reflète la valeur de l'option style |
* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
Exemple
# ~/.config/starship.toml
[nodejs]
format = "via [🤖 $version](bold green) "
OCaml
Le module ocaml affiche la version actuellement installée de OCaml. Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie:
- Le répertoire courant contient un fichier avec l'extension
.opamou le répertoire_opam - Le répertoire courant contient un répertoire
esy.lock - Le répertoire courant contient un fichier
duneoudune-project - Le répertoire courant contient un fichier
jbuildoujbuild-ignore - Le répertoire courant contient un fichier
.merlin - Le répertoire actuel contient un fichier avec l'extension
.ml,.mli,.reou.rei
Options
| Option | Défaut | Description |
|---|---|---|
format |
"via [$symbol($version )(\($switch_indicator$switch_name\) )]($style)" |
La chaîne de format pour le module. |
version_format |
"v${raw}" |
Le format de la version. Les variables disponibles sont raw, major, minor, & patch |
symbol |
"🐫 " |
Le symbole utilisé avant d'afficher la version de OCaml. |
global_switch_indicator |
"" |
La chaîne de caractères utilisée pour représenter le commutateur OPAM global. |
local_switch_indicator |
"*" |
La chaîne de caractères utilisée pour représenter le commutateur OPAM local. |
detect_extensions |
["opam", "ml", "mli", "re", "rei"] |
Quelles extensions devraient activer ce module. |
detect_files |
["dune", "dune-project", "jbuild", "jbuild-ignore", ".merlin"] |
Quels fichiers devraient activer ce module. |
detect_folders |
["_opam", "esy.lock"] |
Quels dossiers devraient activer ce module. |
style |
"bold yellow" |
Le style du module. |
disabled |
false |
Désactive le module ocaml. |
Variables
| Variable | Exemple | Description |
|---|---|---|
| version | v4.10.0 |
La version de ocaml |
| switch_name | my-project |
The active OPAM switch |
| switch_indicator | Mirrors the value of indicator for currently active OPAM switch |
|
| symbol | Reflète la valeur de l'option symbol |
|
| style* | Reflète la valeur de l'option style |
* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
Exemple
# ~/.config/starship.toml
[ocaml]
format = "via [🐪 $version]($style) "
OpenStack
The openstack module shows the current OpenStack cloud and project. The module only active when the OS_CLOUD env var is set, in which case it will read clouds.yaml file from any of the default locations. to fetch the current project in use.
Options
| Option | Défaut | Description |
|---|---|---|
format |
"on [$symbol$cloud(\\($project\\))]($style) " |
Format du module. |
symbol |
"☁️ " |
Le symbole utilisé avant d'afficher le cloud OpenStack actuel. |
style |
"bold yellow" |
Le style du module. |
disabled |
false |
Désactive le module openstack. |
Variables
| Variable | Exemple | Description |
|---|---|---|
| cloud | corp |
The current OpenStack cloud |
| project | dev |
The current OpenStack project |
| symbol | Reflète la valeur de l'option symbol |
|
| style* | Reflète la valeur de l'option style |
* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
Exemple
# ~/.config/starship.toml
[openstack]
format = "on [$symbol$cloud(\\($project\\))]($style) "
style = "bold yellow"
symbol = "☁️ "
Version du package
The package module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports npm, nimble, cargo, poetry, composer, gradle, julia, mix and helm packages.
- npm – The
npmpackage version is extracted from thepackage.jsonpresent in the current directory - cargo – The
cargopackage version is extracted from theCargo.tomlpresent in the current directory - nimble - The
nimblepackage version is extracted from the*.nimblefile present in the current directory with thenimble dumpcommand - poetry – The
poetrypackage version is extracted from thepyproject.tomlpresent in the current directory - python - The
pythonpackage version is extracted from thesetup.cfgpresent in the current directory - composer – The
composerpackage version is extracted from thecomposer.jsonpresent in the current directory - gradle – The
gradlepackage version is extracted from thebuild.gradlepresent - julia - The package version is extracted from the
Project.tomlpresent - mix - The
mixpackage version is extracted from themix.exspresent - helm - The
helmchart version is extracted from theChart.yamlpresent - maven - The
mavenpackage version is extracted from thepom.xmlpresent - meson - The
mesonpackage version is extracted from themeson.buildpresent - vlang - The
vlangpackage version is extracted from thev.modpresent
⚠️ 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 |
"📦 " |
Le symbole utilisé avant d'afficher la version du paquet. |
version_format |
"v${raw}" |
Le format de la version. Les variables disponibles sont raw, major, minor, & patch |
style |
"bold 208" |
Le style du module. |
display_private |
false |
Enable displaying version for packages marked as private. |
disabled |
false |
Désactive le module package. |
Variables
| Variable | Exemple | Description |
|---|---|---|
| version | v1.0.0 |
La version de votre package |
| symbol | Reflète la valeur de l'option symbol |
|
| style* | Reflète la valeur de l'option style |
* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
Exemple
# ~/.config/starship.toml
[package]
format = "via [🎁 $version](208 bold) "
Perl
Le module perl affiche la version actuellement installée de Perl. Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie:
- Le répertoire courant contient un fichier
Makefile.PLouBuild.PL - Le répertoire courant contient un fichier
cpanfileoucpanfile.snapshot - Le répertoire courant contient un fichier
META.jsonouMETA.yml - Le répertoire courant contient un fichier
.perl-version - Le répertoire courant contient un fichier
.pl,.pmou.pod
Options
| Option | Défaut | Description |
|---|---|---|
format |
"via [$symbol($version )]($style)" |
La chaîne de format pour le module. |
version_format |
"v${raw}" |
Le format de la version. Les variables disponibles sont raw, major, minor, & patch |
symbol |
"🐪 " |
Le symbole utilisé avant d'afficher la version de Perl |
detect_extensions |
["pl", "pm", "pod"] |
Quelles extensions devraient activer ce module. |
detect_files |
["Makefile.PL", "Build.PL", "cpanfile", "cpanfile.snapshot", "META.json", "META.yml", ".perl-version"] |
Quels fichiers devraient activer ce module. |
detect_folders |
[] |
Quels dossiers devraient activer ce module. |
style |
"bold 149" |
Le style du module. |
disabled |
false |
Désactive le module perl. |
Variables
| Variable | Exemple | Description |
|---|---|---|
| version | v5.26.1 |
La version de perl |
| symbol | Reflète la valeur de l'option symbol |
|
| style* | Reflète la valeur de l'option style |
Exemple
# ~/.config/starship.toml
[perl]
format = "via [🦪 $version]($style) "
PHP
Le module php affiche la version actuellement installée de PHP. Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie:
- Le répertoire courant contient un fichier
composer.json - Le répertoire courant contient un fichier
.php-version - Le répertoire courant contient un fichier avec l'extension
.php
Options
| Option | Défaut | Description |
|---|---|---|
format |
"via [$symbol($version )]($style)" |
Format du module. |
version_format |
"v${raw}" |
Le format de la version. Les variables disponibles sont raw, major, minor, & patch |
symbol |
"🐘 " |
Le symbole utilisé avant d'afficher la version de PHP. |
detect_extensions |
["php"] |
Quelles extensions devraient activer ce module. |
detect_files |
["composer.json", ".php-version"] |
Quels fichiers devraient activer ce module. |
detect_folders |
[] |
Quels dossiers devraient activer ce module. |
style |
"147 bold" |
Le style du module. |
disabled |
false |
Désactive le module php. |
Variables
| Variable | Exemple | Description |
|---|---|---|
| version | v7.3.8 |
La version de php |
| symbol | Reflète la valeur de l'option symbol |
|
| style* | Reflète la valeur de l'option style |
* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
Exemple
# ~/.config/starship.toml
[php]
format = "via [🔹 $version](147 bold) "
PureScript
Le module purescript affiche la version actuellement installée de PureScript. Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie:
- Le répertoire courant contient un fichier
spago.dhall - Le répertoire actuel contient un fichier avec l'extension
.purs
Options
| Option | Défaut | Description |
|---|---|---|
format |
"via [$symbol($version )]($style)" |
Format du module. |
version_format |
"v${raw}" |
Le format de la version. Les variables disponibles sont raw, major, minor, & patch |
symbol |
"<=> " |
Le symbole utilisé avant d'afficher la version de PureScript. |
detect_extensions |
["purs"] |
Quelles extensions devraient activer ce module. |
detect_files |
["spago.dhall"] |
Quels fichiers devraient activer ce module. |
detect_folders |
[] |
Quels dossiers devraient activer ce module. |
style |
"bold white" |
Le style du module. |
disabled |
false |
Désactive le module purescript. |
Variables
| Variable | Exemple | Description |
|---|---|---|
| version | 0.13.5 |
La version de purescript |
| symbol | Reflète la valeur de l'option symbol |
|
| style* | Reflète la valeur de l'option style |
* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
Exemple
# ~/.config/starship.toml
[purescript]
format = "via [$symbol$version](bold white)"
Python
Le module python affiche la version actuellement installée de Python ainsi que la version d'environnement virtuel Python si il y en a un d'activé.
If pyenv_version_name is set to true, it will display the pyenv version name. Otherwise, it will display the version number from python --version.
Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie:
- Le répertoire courant contient un fichier
.python-version - Le répertoire courant contient un fichier
Pipfile - Le répertoire courant contient un fichier
__init__.py - Le répertoire courant contient un fichier
pyproject.toml - Le répertoire courant contient un fichier
requirements.txt - Le répertoire courant contient un fichier
setup.py - Le répertoire courant contient un fichier
tox.ini - Le répertoire actuel contient un fichier avec l'extension
.py. - Un environnement virtuel est actuellement activé
Options
| Option | Défaut | Description |
|---|---|---|
format |
'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\) )]($style)' |
Format du module. |
version_format |
"v${raw}" |
Le format de la version. Les variables disponibles sont raw, major, minor, & patch |
symbol |
"🐍 " |
Une chaîne de caractères représentant le symbole de Python |
style |
"yellow bold" |
Le style du module. |
pyenv_version_name |
false |
Use pyenv to get Python version |
pyenv_prefix |
pyenv |
Prefix before pyenv version display, only used if pyenv is used |
python_binary |
["python", "python3", "python2"] |
Configures the python binaries that Starship should executes when getting the version. |
detect_extensions |
["py"] |
Quelles extensions devraient activer ce module |
detect_files |
[".python-version", "Pipfile", "__init__.py", "pyproject.toml", "requirements.txt", "setup.py", "tox.ini"] |
Quels fichiers devraient activer ce module |
detect_folders |
[] |
Quels dossiers devraient activer ce module |
disabled |
false |
Désactive le module python. |
::: tip
The python_binary variable accepts either a string or a list of strings. Starship will try executing each binary until it gets a result. Note you can only change the binary that Starship executes to get the version of Python not the arguments that are used.
The default values and order for python_binary was chosen to first identify the Python version in a virtualenv/conda environments (which currently still add a python, no matter if it points to python3 or python2). This has the side effect that if you still have a system Python 2 installed, it may be picked up before any Python 3 (at least on Linux Distros that always symlink /usr/bin/python to Python 2). If you do not work with Python 2 anymore but cannot remove the system Python 2, changing this to "python3" will hide any Python version 2, see example below.
:::
Variables
| Variable | Exemple | Description |
|---|---|---|
| version | "v3.8.1" |
La version de python |
| symbol | "🐍 " |
Reflète la valeur de l'option symbol |
| style | "yellow bold" |
Reflète la valeur de l'option style |
| pyenv_prefix | "pyenv " |
Mirrors the value of option pyenv_prefix |
| virtualenv | "venv" |
The current virtualenv name |
Exemple
# ~/.config/starship.toml
[python]
symbol = "👾 "
pyenv_version_name = true
# ~/.config/starship.toml
[python]
# N'utilisez que le binaire `python3` pour obtenir la version.
python_binary = "python3"
# ~/.config/starship.toml
[python]
# Ne pas déclencher pour les fichiers avec l'extension py
detect_extensions = []
# ~/.config/starship.toml
[python]
# Affiche la version de python depuis l'intérieur d'un venv local.
#
# Notez que cela ne fonctionnera que lorsque le venv est à l'intérieur du projet,
# et uniquement lorsque vous vous situez dans le répertoire contenant le dossier du venv
# mais peut-être que c'est suffisant?
python_binary = ["./venv/bin/python", "python", "python3", "python2"]
R
The rlang module shows the currently installed version of R. The module will be shown if any of the following conditions are met:
- Le répertoire actuel contient un fichier avec l'extension
.R. - Le répertoire actuel contient un fichier avec l'extension
.Rd. - Le répertoire actuel contient un fichier avec l'extension
.Rmd. - Le répertoire actuel contient un fichier avec l'extension
.Rproj. - Le répertoire actuel contient un fichier avec l'extension
.Rsx. - Le répertoire courant contient un fichier
.Rprofile - Le répertoire courant contient un dossier
.Rproj.user
Options
| Option | Défaut | Description |
|---|---|---|
format |
"via [$symbol($version )]($style)" |
Format du module. |
version_format |
"v${raw}" |
Le format de la version. Les variables disponibles sont raw, major, minor, & patch |
symbol |
"📐" |
Une chaîne de caractères représentant le symbole de R. |
style |
"blue bold" |
Le style du module. |
detect_extensions |
["R", "Rd", "Rmd", "Rproj", "Rsx"] |
Quelles extensions devraient activer ce module |
detect_files |
[".Rprofile"] |
Quels fichiers devraient activer ce module |
detect_folders |
[".Rproj.user"] |
Quels dossiers devraient activer ce module |
disabled |
false |
Désactive le module r. |
Variables
| Variable | Exemple | Description |
|---|---|---|
| version | v4.0.5 |
La version de R |
| symbol | Reflète la valeur de l'option symbol |
|
| style | "blue bold" |
Reflète la valeur de l'option style |
Exemple
# ~/.config/starship.toml
[rlang]
format = "with [📐 $version](blue bold) "
Red
Par défaut, le module red affiche la version actuellement installée de Red. Le module est affiché si l'une de ces conditions est remplie :
- Le répertoire actuel contient un fichier avec l'extension
.redou.reds
Options
| Option | Défaut | Description |
|---|---|---|
format |
"via [$symbol($version )]($style)" |
Format du module. |
version_format |
"v${raw}" |
Le format de la version. Les variables disponibles sont raw, major, minor, & patch |
symbol |
"🔺 " |
Une chaîne de caractères représentant le symbole de Red. |
detect_extensions |
["red"] |
Quelles extensions devraient activer ce module. |
detect_files |
[] |
Quels fichiers devraient activer ce module. |
detect_folders |
[] |
Quels dossiers devraient activer ce module. |
style |
"red bold" |
Le style du module. |
disabled |
false |
Désactive le module red. |
Variables
| Variable | Exemple | Description |
|---|---|---|
| version | v2.5.1 |
La version de red |
| symbol | Reflète la valeur de l'option symbol |
|
| style* | Reflète la valeur de l'option style |
* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
Exemple
# ~/.config/starship.toml
[red]
symbol = "🔴 "
Ruby
Par défaut, le module ruby affiche la version actuellement installée de Ruby. Le module est affiché si l'une de ces conditions est remplie :
- Le répertoire courant contient un fichier
Gemfile - Le répertoire courant contient un fichier
.ruby-version - Le répertoire courant contient un fichier
.rb
Options
| Option | Défaut | Description |
|---|---|---|
format |
"via [$symbol($version )]($style)" |
Format du module. |
version_format |
"v${raw}" |
Le format de la version. Les variables disponibles sont raw, major, minor, & patch |
symbol |
"💎 " |
Une chaîne de caractères représentant le symbole de Ruby. |
detect_extensions |
["rb"] |
Quelles extensions devraient activer ce module. |
detect_files |
["Gemfile", ".ruby-version"] |
Quels fichiers devraient activer ce module. |
detect_folders |
[] |
Quels dossiers devraient activer ce module. |
style |
"bold green" |
Le style du module. |
disabled |
false |
Désactive le module ruby. |
Variables
| Variable | Exemple | Description |
|---|---|---|
| version | v2.5.1 |
La version de ruby |
| symbol | Reflète la valeur de l'option symbol |
|
| style* | Reflète la valeur de l'option style |
* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
Exemple
# ~/.config/starship.toml
[ruby]
symbol = "🔺 "
Rust
Par défaut, le module rust affiche la version actuellement installée de Rust. Le module est affiché si l'une de ces conditions est remplie :
- Le répertoire courant contient un fichier
Cargo.toml - Le répertoire actuel contient un fichier avec l'extension
.rs
Options
| Option | Défaut | Description |
|---|---|---|
format |
"via [$symbol($version )]($style)" |
Format du module. |
version_format |
"v${raw}" |
Le format de la version. Les variables disponibles sont raw, major, minor, & patch |
symbol |
"🦀 " |
Une chaîne de caractères représentant le symbole de Rust |
detect_extensions |
["rs"] |
Quelles extensions devraient activer ce module. |
detect_files |
["Cargo.toml"] |
Quels fichiers devraient activer ce module. |
detect_folders |
[] |
Quels dossiers devraient activer ce module. |
style |
"bold green" |
Le style du module. |
disabled |
false |
Désactive le module rust. |
Variables
| Variable | Exemple | Description |
|---|---|---|
| version | v1.43.0-nightly |
La version de rustc |
| symbol | Reflète la valeur de l'option symbol |
|
| style* | Reflète la valeur de l'option style |
* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
Exemple
# ~/.config/starship.toml
[rust]
format = "via [⚙️ $version](red bold)"
Scala
Le module scala affiche la version actuellement installée de Scala. Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie:
- Le répertoire courant contient un fichier
build.sbt,.scalaenvou.sbtenv - Le répertoire actuel contient un fichier avec l'extension
.scalaou.sbt - Le répertoire courant contient un répertoire nommé
.metals
Options
| Option | Défaut | Description |
|---|---|---|
format |
"via [${symbol}(${version} )]($style)" |
Format du module. |
version_format |
"v${raw}" |
Le format de la version. Les variables disponibles sont raw, major, minor, & patch |
detect_extensions |
["sbt", "scala"] |
Quelles extensions devraient activer ce module. |
detect_files |
[".scalaenv", ".sbtenv", "build.sbt"] |
Quels fichiers devraient activer ce module. |
detect_folders |
[".metals"] |
Quels dossiers devraient activer ce module. |
symbol |
"🆂 " |
Une chaîne de caractères représentant le symbole de Scala. |
style |
"red dimmed" |
Le style du module. |
disabled |
false |
Désactive le module scala. |
Variables
| Variable | Exemple | Description |
|---|---|---|
| version | 2.13.5 |
La version de scala |
| symbol | Reflète la valeur de l'option symbol |
|
| style* | Reflète la valeur de l'option style |
* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
Exemple
# ~/.config/starship.toml
[scala]
symbol = "🌟 "
Shell
The shell module shows an indicator for currently used shell.
::: tip
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 |
|---|---|---|
bash_indicator |
bsh |
Une chaîne de format utilisée pour représenter bash. |
fish_indicator |
fsh |
Une chaîne de format utilisée pour représenter fish. |
zsh_indicator |
zsh |
Une chaîne de format utilisée pour représenter zsh. |
powershell_indicator |
psh |
Une chaîne de format utilisée pour représenter powershell. |
ion_indicator |
ion |
Une chaîne de format utilisée pour représenter ion. |
elvish_indicator |
esh |
Une chaîne de format utilisée pour représenter elvish. |
tcsh_indicator |
tsh |
Une chaîne de format utilisée pour représenter tcsh. |
xonsh_indicator |
xsh |
A format string used to represent xonsh. |
unknown_indicator |
The default value to be displayed when the shell is unknown. | |
format |
$indicator |
Format du module. |
disabled |
true |
Désactive le module shell. |
Variables
| Variable | Défaut | Description |
|---|---|---|
| indicator | Mirrors the value of indicator for currently used shell. |
Exemples
# ~/.config/starship.toml
[shell]
fish_indicator = ""
powershell_indicator = "_"
unknown_indicator = "mystery shell"
disabled = false
SHLVL
The shlvl module shows the current SHLVL ("shell level") environment variable, if it is set to a number and meets or exceeds the specified threshold.
Options
| Option | Défaut | Description |
|---|---|---|
threshold |
2 |
Display threshold. |
format |
"[$symbol$shlvl]($style) " |
Format du module. |
symbol |
"↕️ " |
The symbol used to represent the SHLVL. |
repeat |
false |
Causes symbol to be repeated by the current SHLVL amount. |
style |
"bold yellow" |
Le style du module. |
disabled |
true |
Désactive le module shlvl. |
Variables
| Variable | Exemple | Description |
|---|---|---|
| shlvl | 3 |
The current value of SHLVL |
| symbol | Reflète la valeur de l'option symbol |
|
| style* | Reflète la valeur de l'option style |
* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
Exemple
# ~/.config/starship.toml
[shlvl]
disabled = false
format = "$shlvl level(s) down"
threshold = 3
Singularity
The singularity module shows the current Singularity image, if inside a container and $SINGULARITY_NAME is set.
Options
| Option | Défaut | Description |
|---|---|---|
format |
'[$symbol\[$env\]]($style) ' |
Format du module. |
symbol |
"" |
Une chaîne de format affichée avant le nom de l'image. |
style |
"bold dimmed blue" |
Le style du module. |
disabled |
false |
Désactive le module singularity. |
Variables
| Variable | Exemple | Description |
|---|---|---|
| env | centos.img |
The current Singularity image |
| symbol | Reflète la valeur de l'option symbol |
|
| style* | Reflète la valeur de l'option style |
* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
Exemple
# ~/.config/starship.toml
[singularity]
format = '[📦 \[$env\]]($style) '
Status
The status module displays the exit code of the previous command. The module will be shown only if the exit code is not 0.
::: tip
Ce module est désactivé par défaut. Pour l'activer, configurez disabled sur false dans votre fichier de configuration.
:::
::: warning This module is not supported on elvish and nu shell. :::
Options
| Option | Défaut | Description |
|---|---|---|
format |
"[$symbol$status]($style) " |
The format of the module |
symbol |
"✖" |
The symbol displayed on program error |
success_symbol |
"✔️" |
The symbol displayed on program success |
not_executable_symbol |
"🚫" |
The symbol displayed when file isn't executable |
not_found_symbol |
"🔍" |
The symbol displayed when the command can't be found |
sigint_symbol |
"🧱" |
The symbol displayed on SIGINT (Ctrl + c) |
signal_symbol |
"⚡" |
The symbol displayed on any signal |
style |
"bold green" |
Le style du module. |
recognize_signal_code |
true |
Enable signal mapping from exit code |
map_symbol |
false |
Enable symbols mapping from exit code |
pipestatus |
false |
Enable pipestatus reporting |
pipestatus_separator |
` | ` |
pipestatus_format |
\\[$pipestatus\\] => [$symbol$common_meaning$signal_name$maybe_int]($style) |
The format of the module when the command is a pipeline |
disabled |
true |
Désactiver le module status. |
Variables
| Variable | Exemple | Description |
|---|---|---|
| status | 127 |
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 |
| pipestatus | Rendering of in pipeline programs's exit codes, this is only available in pipestatus_format | |
| symbol | Reflète la valeur de l'option symbol |
|
| style* | Reflète la valeur de l'option style |
* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
Exemple
# ~/.config/starship.toml
[status]
style = "bg:blue"
symbol = "🔴"
format = '[\[$symbol $common_meaning$signal_name$maybe_int\]]($style) '
map_symbol = true
disabled = false
Swift
Par défaut, le module swift affiche la version actuellement installée de Swift. Le module est affiché si l'une de ces conditions est remplie :
- Le répertoire courant contient un fichier
Package.swift - Le répertoire actuel contient un fichier avec l'extension
.swift
Options
| Option | Défaut | Description |
|---|---|---|
format |
"via [$symbol($version )]($style)" |
Format du module. |
version_format |
"v${raw}" |
Le format de la version. Les variables disponibles sont raw, major, minor, & patch |
symbol |
"🐦 " |
Une chaîne de caractères représentant le symbole de Swift |
detect_extensions |
["swift"] |
Quelles extensions devraient activer ce module. |
detect_files |
["Package.swift"] |
Quels fichiers devraient activer ce module. |
detect_folders |
[] |
Quels dossiers devraient activer ce module. |
style |
"bold 202" |
Le style du module. |
disabled |
false |
Désactiver le module swift. |
Variables
| Variable | Exemple | Description |
|---|---|---|
| version | v5.2.4 |
La version de swift |
| symbol | Reflète la valeur de l'option symbol |
|
| style* | Reflète la valeur de l'option style |
* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
Exemple
# ~/.config/starship.toml
[swift]
format = "via [🏎 $version](red bold)"
Terraform
The terraform module shows the currently selected Terraform workspace and version.
::: tip
By default the Terraform version is not shown, since this is slow for current versions of Terraform when a lot of plugins are in use. If you still want to enable it, follow the example shown below.
:::
Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie:
- Le répertoire courant contient un dossier
.terraform - Le répertoire actuel contient un fichier avec l'extension
.tfou.hcl
Options
| Option | Défaut | Description |
|---|---|---|
format |
"via [$symbol$workspace]($style) " |
La chaîne de format pour le module. |
version_format |
"v${raw}" |
Le format de la version. Les variables disponibles sont raw, major, minor, & patch |
symbol |
"💠" |
Une chaîne de format montrée avant l'espace de travail terraform. |
detect_extensions |
["tf", "hcl"] |
Quelles extensions devraient activer ce module. |
detect_files |
[] |
Quels fichiers devraient activer ce module. |
detect_folders |
[".terraform"] |
Quels dossiers devraient activer ce module. |
style |
"bold 105" |
Le style du module. |
disabled |
false |
Désactive le module terraform. |
Variables
| Variable | Exemple | Description |
|---|---|---|
| version | v0.12.24 |
La version de terraform |
| workspace | default |
The current Terraform workspace |
| symbol | Reflète la valeur de l'option symbol |
|
| style* | Reflète la valeur de l'option style |
* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
Exemple
Avec la version de Terraform
# ~/.config/starship.toml
[terraform]
format = "[🏎💨 $version$workspace]($style) "
Sans la version de Terraform
# ~/.config/starship.toml
[terraform]
format = "[🏎💨 $workspace]($style) "
Date et Heure
Le module time affiche l'heure actuelle localement. La valeur de format est utilisée par le package chrono pour contrôler la façon dont l'heure est affichée. Consultez la doc de chrono strftime pour découvrir les options disponibles.
::: 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) " |
La chaîne de format pour le module. |
use_12hr |
false |
Activer le format 12h |
time_format |
voir plus bas | Le format chrono utilisé pour formater l'heure. |
style |
"bold yellow" |
Le style utilisé par le module |
utc_time_offset |
"local" |
Définir le décalage horaire UTC à utiliser. 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". Sinon, il est défini comme "%T". Manually setting time_format will override the use_12hr setting.
Variables
| Variable | Exemple | Description |
|---|---|---|
| time | 13:08:10 |
The current time. |
| style* | Reflète la valeur de l'option style |
* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
Exemple
# ~/.config/starship.toml
[time]
disabled = false
format = '🕙[\[ $time \]]($style) '
time_format = "%T"
utc_time_offset = "-5"
time_range = "10:00:00-14:00:00"
Nom d'utilisateur
Le module username affiche le nom d'utilisateur de l'utilisateur actif. Le module est affiché si l'une de ces conditions est remplie :
- L'utilisateur courant est root
- L'utilisateur courant est différent de celui connecté
- L'utilisateur est actuellement connecté à une session SSH
- La variable
show_alwaysa 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
Vagrant
Le module vagrant affiche la version actuellement installée de Vagrant. Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie:
- Le répertoire courant contient un fichier
Vagrantfile
Options
| Option | Défaut | Description |
|---|---|---|
format |
"via [$symbol($version )]($style)" |
Format du module. |
version_format |
"v${raw}" |
Le format de la version. Les variables disponibles sont raw, major, minor, & patch |
symbol |
"⍱ " |
Une chaîne de caractères représentant le symbole de Vagrant. |
detect_extensions |
[] |
Quelles extensions devraient activer ce module. |
detect_files |
["Vagrantfile"] |
Quels fichiers devraient activer ce module. |
detect_folders |
[] |
Quels dossiers devraient activer ce module. |
style |
"cyan bold" |
Le style du module. |
disabled |
false |
Désactive le module vagrant. |
Variables
| Variable | Exemple | Description |
|---|---|---|
| version | Vagrant 2.2.10 |
La version de Vagrant |
| symbol | Reflète la valeur de l'option symbol |
|
| style* | Reflète la valeur de l'option style |
* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
Exemple
# ~/.config/starship.toml
[vagrant]
format = "via [⍱ $version](bold white) "
VLang
Le module vlang vous montre votre version de V actuellement installée. Par défaut, le module sera affiché si l'une des conditions suivantes est remplie :
- Le répertoire courant contient un fichier avec l'extension
.v - Le répertoire courant contient un fichier
v.mod,vpkg.jsonou.vpkg-lock.json
Options
| Option | Défaut | Description |
|---|---|---|
format |
"via [$symbol($version )]($style)" |
Format du module. |
version_format |
"v${raw}" |
Le format de la version. Les variables disponibles sont raw, major, minor, & patch |
symbol |
"V " |
Une chaîne de caractères représentant le symbole de V |
detect_extensions |
["v"] |
Quelles extensions devraient activer ce module. |
detect_files |
["v.mod", "vpkg.json", ".vpkg-lock.json" ] |
Quels fichiers devraient activer ce module. |
detect_folders |
[] |
Quels dossiers devraient activer ce module. |
style |
"blue bold" |
Le style du module. |
disabled |
false |
Désactive le module vlang. |
Variables
| Variable | Exemple | Description |
|---|---|---|
| version | v0.2 |
La version de v |
| symbol | Reflète la valeur de l'option symbol |
|
| style* | Reflète la valeur de l'option style |
Exemple
# ~/.config/starship.toml
[v]
format = "via [V $version](blue bold) "
VCSH
The vcsh module displays the current active VCSH repository. The module will be shown only if a repository is currently in use.
Options
| Option | Défaut | Description |
|---|---|---|
symbol |
Le symbole utilisé avant d'afficher le nom du dépôt. | |
style |
"bold yellow" |
Le style du module. |
format |
"vcsh [$symbol$repo]($style) " |
Format du module. |
disabled |
false |
Désactive le module vcsh. |
Variables
| Variable | Exemple | Description |
|---|---|---|
| repo | dotfiles si dans un dépôt VCSH nommé dotfiles |
The active repository name |
| symbol | Reflète la valeur de l'option symbol |
|
| style* | black bold dimmed |
Reflète la valeur de l'option style |
* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
Exemple
# ~/.config/starship.toml
[vcsh]
format = "[🆅 $repo](bold blue) "
Zig
Par défaut, le module zig affiche la version actuellement installée de Zig. Le module est affiché si l'une de ces conditions est remplie :
- Le répertoire courant contient un fichier
.zig
Options
| Option | Défaut | Description |
|---|---|---|
format |
"via [$symbol($version )]($style)" |
Format du module. |
version_format |
"v${raw}" |
Le format de la version. Les variables disponibles sont raw, major, minor, & patch |
symbol |
"↯ " |
Le symbole utilisé avant d'afficher la version de Zig. |
style |
"bold yellow" |
Le style du module. |
disabled |
false |
Désactive le module zig. |
detect_extensions |
["zig"] |
Quelles extensions devraient activer ce module. |
detect_files |
[] |
Quels fichiers devraient activer ce module. |
detect_folders |
[] |
Quels dossiers devraient activer ce module. |
Variables
| Variable | Exemple | Description |
|---|---|---|
| version | v0.6.0 |
La version de zig |
| symbol | Reflète la valeur de l'option symbol |
|
| style* | Reflète la valeur de l'option style |
* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
Exemple
# ~/.config/starship.toml
[zig]
symbol = "⚡️ "
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
whencommand returns 0 - The current Operating System (std::env::consts::OS) matchs with
osfield 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!
:::
Options
| Option | Défaut | Description |
|---|---|---|
command |
The command whose output should be printed. The command will be passed on stdin to the shell. | |
when |
A shell command used as a condition to show the module. The module will be shown if the command returns a 0 status code. |
|
shell |
See below | |
description |
"<custom module>" |
The description of the module that is shown when running starship explain. |
files |
[] |
The files that will be searched in the working directory for a match. |
directories |
[] |
The directories that will be searched in the working directory for a match. |
extensions |
[] |
The extensions that will be searched in the working directory for a match. |
symbol |
"" |
Le symbole utilisé avant d'afficher la sortie de la commande. |
style |
"bold green" |
Le style du module. |
format |
"[$symbol($output )]($style)" |
Format du module. |
disabled |
false |
Désactive le module custom. |
os |
Operating System name on which the module will be shown (unix, linux, macos, windows, ... ) See possible values. |
Variables
| Variable | Description |
|---|---|
| output | The output of shell command in shell |
| symbol | Reflète la valeur de l'option symbol |
| style* | Reflète la valeur de l'option style |
* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
Commandes shell personnalisées
shell accepte une liste de chaînes non vide, où:
- La première chaîne est le chemin vers le shell à utiliser pour exécuter la commande.
- Other following arguments are passed to the shell.
If unset, it will fallback to STARSHIP_SHELL and then to "sh" on Linux, and "cmd /C" on Windows.
The command will be passed in on stdin.
If shell is not given or only contains one element and Starship detects PowerShell will be used, the following arguments will automatically be added: -NoProfile -Command -. This behavior can be avoided by explicitly passing arguments to the shell, e.g.
shell = ["pwsh", "-Command", "-"]
::: warning Make sure your custom shell configuration exits gracefully
If you set a custom command, make sure that the default Shell used by starship will properly execute the command with a graceful exit (via the shell option).
For example, PowerShell requires the -Command parameter to execute a one liner. Omitting this parameter might throw starship into a recursive loop where the shell might try to load a full profile environment with starship itself again and hence re-execute the custom command, getting into a never ending loop.
Parameters similar to -NoProfile in PowerShell are recommended for other shells as well to avoid extra loading time of a custom profile on every starship invocation.
Automatic detection of shells and proper parameters addition are currently implemented, but it's possible that not all shells are covered. Please open an issue with shell details and starship configuration if you hit such scenario.
:::
Exemple
# ~/.config/starship.toml
[custom.foo]
command = "echo foo" # affiche la sortie de la commande
files = ["foo"] # ajoute un filtre
when = """ test "$HOME" == "$PWD" """
format = " transcending [$output]($style)"
[custom.time]
command = "time /T"
files = ["*.pst"]
shell = ["pwsh.exe", "-NoProfile", "-Command", "-"]