3a4c9063e9
* New translations README.md (Sorani (Kurdish)) * New translations README.md (Chinese Simplified) * New translations README.md (Chinese Simplified) * New translations README.md (Vietnamese) * New translations README.md (Vietnamese) * New translations README.md (Vietnamese) * New translations README.md (Vietnamese) * New translations README.md (Vietnamese) * New translations README.md (Vietnamese) * New translations README.md (Vietnamese) * New translations README.md (Vietnamese) * New translations README.md (Vietnamese) * New translations README.md (Vietnamese) * New translations README.md (Vietnamese) * New translations README.md (Vietnamese) * New translations README.md (Vietnamese) * New translations README.md (Vietnamese) * New translations README.md (Vietnamese) * New translations README.md (Vietnamese) * New translations README.md (Vietnamese) * New translations README.md (Vietnamese) * New translations README.md (Vietnamese) * New translations README.md (Vietnamese) * New translations README.md (Vietnamese) * New translations README.md (Vietnamese) * New translations README.md (Vietnamese) * New translations README.md (Vietnamese) * New translations README.md (Vietnamese) * New translations README.md (Vietnamese) * New translations README.md (Turkish) * New translations README.md (Russian) * New translations README.md (Portuguese) * New translations README.md (Polish) * New translations README.md (Dutch) * New translations README.md (Japanese) * New translations README.md (Italian) * New translations README.md (German) * New translations README.md (Chinese Simplified) * New translations README.md (Chinese Traditional) * New translations README.md (Sorani (Kurdish)) * New translations README.md (Portuguese, Brazilian) * New translations README.md (Vietnamese) * New translations README.md (Polish) * New translations README.md (Dutch) * New translations README.md (Korean) * New translations README.md (Japanese) * New translations README.md (Italian) * New translations README.md (German) * New translations README.md (Arabic) * New translations README.md (Spanish) * New translations README.md (French) * New translations README.md (Portuguese) * New translations README.md (Arabic) * New translations README.md (Spanish) * New translations README.md (French) * New translations README.md (Korean) * New translations README.md (Sorani (Kurdish)) * New translations README.md (Portuguese, Brazilian) * New translations README.md (Russian) * New translations README.md (Vietnamese) * New translations README.md (Chinese Traditional) * New translations README.md (Chinese Simplified) * New translations README.md (Turkish) * New translations README.md (Chinese Traditional) * New translations README.md (Chinese Traditional) * New translations README.md (Chinese Traditional) * New translations README.md (Spanish) * New translations README.md (Spanish) * New translations README.md (Spanish) * New translations README.md (Spanish) * New translations README.md (Spanish) * New translations README.md (Spanish) * New translations README.md (Italian) * New translations README.md (German) * New translations README.md (Arabic) * New translations README.md (Spanish) * New translations README.md (French) * New translations README.md (Spanish) * New translations README.md (Japanese) * New translations README.md (Korean) * New translations README.md (Chinese Simplified) * New translations README.md (Dutch) * New translations README.md (Polish) * New translations README.md (Portuguese) * New translations README.md (Russian) * New translations README.md (Turkish) * New translations README.md (Chinese Traditional) * New translations README.md (Vietnamese) * New translations README.md (Portuguese, Brazilian) * New translations README.md (Sorani (Kurdish)) * New translations README.md (Spanish) * New translations README.md (Spanish) * New translations README.md (Spanish) * New translations README.md (Spanish) * New translations README.md (Spanish) * New translations README.md (Spanish) * New translations README.md (Spanish) * New translations README.md (Spanish) * New translations README.md (Spanish) * New translations README.md (Spanish) * New translations README.md (Spanish) * New translations README.md (Spanish) * New translations README.md (Spanish) * New translations README.md (Spanish) * New translations README.md (Spanish) * New translations README.md (Spanish) * New translations README.md (Spanish) * New translations README.md (Spanish) * New translations README.md (Spanish) * New translations README.md (Spanish) * New translations README.md (Spanish) * New translations README.md (Spanish) * New translations README.md (Spanish) * New translations README.md (Spanish) * New translations README.md (Spanish) * New translations README.md (Korean) * New translations README.md (Korean) * New translations README.md (Korean) * New translations README.md (Korean) * New translations README.md (Japanese) * New translations README.md (Japanese) * New translations README.md (Japanese) * New translations README.md (Japanese) * New translations README.md (Japanese) * New translations README.md (Japanese) * New translations README.md (Japanese) * New translations README.md (Japanese) * New translations README.md (Japanese) * New translations README.md (French) * New translations README.md (Portuguese) * New translations README.md (Portuguese, Brazilian) * New translations README.md (Vietnamese) * New translations README.md (Chinese Traditional) * New translations README.md (Chinese Simplified) * New translations README.md (Turkish) * New translations README.md (Russian) * New translations README.md (Polish) * New translations README.md (Spanish) * New translations README.md (Dutch) * New translations README.md (Korean) * New translations README.md (Japanese) * New translations README.md (Italian) * New translations README.md (German) * New translations README.md (Arabic) * New translations README.md (Sorani (Kurdish)) * New translations README.md (French) * New translations README.md (Arabic) * New translations README.md (French) * New translations README.md (Polish) * New translations README.md (Dutch) * New translations README.md (Dutch) * New translations README.md (Korean) * New translations README.md (Korean) * New translations README.md (Japanese) * New translations README.md (Japanese) * New translations README.md (Italian) * New translations README.md (Italian) * New translations README.md (German) * New translations README.md (German) * New translations README.md (Arabic) * New translations README.md (Spanish) * New translations README.md (Spanish) * New translations README.md (Polish) * New translations README.md (Portuguese) * New translations README.md (Chinese Traditional) * New translations README.md (Sorani (Kurdish)) * New translations README.md (Sorani (Kurdish)) * New translations README.md (Portuguese, Brazilian) * New translations README.md (Portuguese, Brazilian) * New translations README.md (Vietnamese) * New translations README.md (Vietnamese) * New translations README.md (Chinese Traditional) * New translations README.md (Portuguese) * New translations README.md (Chinese Simplified) * New translations README.md (Chinese Simplified) * New translations README.md (Turkish) * New translations README.md (Turkish) * New translations README.md (Russian) * New translations README.md (Russian) * New translations README.md (Polish) * New translations README.md (Dutch) * New translations README.md (Japanese) * New translations README.md (Italian) * New translations README.md (German) * New translations README.md (Portuguese) * New translations README.md (Sorani (Kurdish)) * New translations README.md (Portuguese, Brazilian) * New translations README.md (Vietnamese) * New translations README.md (Chinese Traditional) * New translations README.md (Russian) * New translations README.md (Chinese Simplified) * New translations README.md (Turkish) * New translations README.md (Arabic) * New translations README.md (Spanish) * New translations README.md (French) * New translations README.md (Korean) * New translations README.md (German) * New translations README.md (Turkish) * New translations README.md (Russian) * New translations README.md (Portuguese) * New translations README.md (Polish) * New translations README.md (Dutch) * New translations README.md (Japanese) * New translations README.md (Italian) * New translations README.md (German) * New translations README.md (Chinese Simplified) * New translations README.md (Chinese Traditional) * New translations README.md (Sorani (Kurdish)) * New translations README.md (Portuguese, Brazilian) * New translations README.md (Vietnamese) * New translations README.md (Polish) * New translations README.md (Dutch) * New translations README.md (Korean) * New translations README.md (Japanese) * New translations README.md (Italian) * New translations README.md (German) * New translations README.md (Arabic) * New translations README.md (Spanish) * New translations README.md (French) * New translations README.md (Portuguese) * New translations README.md (Arabic) * New translations README.md (Spanish) * New translations README.md (French) * New translations README.md (Korean) * New translations README.md (Sorani (Kurdish)) * New translations README.md (Portuguese, Brazilian) * New translations README.md (Russian) * New translations README.md (Vietnamese) * New translations README.md (Chinese Traditional) * New translations README.md (Chinese Simplified) * New translations README.md (Turkish) * New translations README.md (Polish) * New translations README.md (Dutch) * New translations README.md (Japanese) * New translations README.md (Italian) * New translations README.md (German) * New translations README.md (Portuguese) * New translations README.md (Sorani (Kurdish)) * New translations README.md (Portuguese, Brazilian) * New translations README.md (Vietnamese) * New translations README.md (Chinese Traditional) * New translations README.md (Russian) * New translations README.md (Chinese Simplified) * New translations README.md (Turkish) * New translations README.md (Arabic) * New translations README.md (Spanish) * New translations README.md (French) * New translations README.md (Korean) * New translations README.md (Italian) * New translations README.md (Italian) |
||
---|---|---|
.. | ||
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:
# Inserts a blank line between shell prompts
add_newline = true
# Replace the "❯" symbol in the prompt with "➜"
[character] # The name of the module we are configuring is "character"
success_symbol = "[➜](bold green)" # The "success_symbol" segment is being set to "➜" with the color "bold green"
# Disable the package module, hiding it from the prompt completely
[package]
disabled = true
You can change default configuration file location with STARSHIP_CONFIG
environment variable:
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 NodeJS qui est actuellement installée sur votre ordinateur, si votre répertoire actuel est un projet NodeJS.
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 NodeJS.
Par convention, la plupart des modules ont un préfixe de la couleur par défaut du terminal (par exemple via
dans "nodejs") et un espace vide comme suffixe.
Chaîne de formatage
Les chaînes de formatage sont le format avec lequel un module affiche toutes ses variables. La plupart des modules ont une entrée appelée format
qui configure le format d'affichage du module. Vous pouvez utiliser des textes, des variables et des groupes de texte dans une chaîne de format.
Variable
Une variable contient un symbole $
suivi du nom de la variable. Le nom d'une variable ne contient que des lettres, des chiffres et _
.
Par exemple :
$version
est une chaîne de formatage avec une variable nomméeversion
.$git_branch$git_commit
est une chaîne de formatage avec deux variables appeléesgit_branch
etgit_commit
.$git_branch $git_commit
a les deux variables séparées par un espace.
Groupe de texte
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èreson
avec un texte gras de couleur rouge.[⌘ $version](bold green)
will print a symbol⌘
followed by the content of variableversion
, with bold text colored green.[a [b](red) c](green)
afficheraa b c
avecb
rouge, eta
etc
vert.
Chaînes de style
La plupart des modules de Starship vous permettent de configurer leurs styles d'affichage. Cela se fait avec une entrée (généralement appelée style
) qui est une chaîne de caractères spécifiant la configuration. Voici quelques exemples de chaînes de style avec ce qu'elles font. Pour plus de détails sur la syntaxe complète, consultez le guide de configuration avancé.
"fg:green bg:blue"
définit un texte vert sur un fond bleu"bg:blue fg:bright-green"
définit un texte vert clair sur un fond bleu"bold fg:27"
définit le texte en gras avec la couleur ANSI 27"underline bg:#bf5700"
définit le texte en souligné sur un fond orange foncé"bold italic fg:purple"
définit le texte en italique et gras sur un fond violet""
désactive explicitement tous les styles
Notez que ce style sera contrôlé par votre émulateur de terminal. Par exemple, certains émulateurs de terminal éclairciront les couleurs au lieu de mettre le texte en gras, et certains thèmes de couleurs utilisent les mêmes valeurs pour les couleurs normales et claires. De plus, pour obtenir du texte italique, votre terminal doit prendre en charge l'italique.
Chaînes de formatage conditionnel
Une chaîne de formatage conditionnel enveloppée dans (
et )
ne sera pas rendue si toutes les variables à l'intérieur sont vides.
Par exemple :
(@$region)
ne montrera rien si la variablerégion
estNone
, sinon@
suivi de la valeur de la région.(some text)
ne montrera toujours rien puisqu'il n'y a pas de variables enveloppées dans les accolades.- Lorsque
$all
est un raccourci pour\[$a$b\]
,($all)
ne montrera rien que si$a
et$b
sont tous les 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 d'attente avant que starship scanne les fichiers (en millisecondes). |
add_newline |
true |
Inserts blank line between shell prompts. |
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
# Disable the blank line at the start of the prompt
add_newline = false
Format par Défaut
Le format
par défaut est utilisé pour définir le format de l'invite, si il est vide ou mal formaté
. La valeur par défaut est la suivante :
format = "$all"
# Which is equivalent to
format = """
$username\
$hostname\
$shlvl\
$kubernetes\
$directory\
$git_branch\
$git_commit\
$git_state\
$git_status\
$hg_branch\
$docker_context\
$package\
$cmake\
$dart\
$dotnet\
$elixir\
$elm\
$erlang\
$golang\
$helm\
$java\
$julia\
$kotlin\
$nim\
$nodejs\
$ocaml\
$perl\
$php\
$purescript\
$python\
$ruby\
$rust\
$scala\
$swift\
$terraform\
$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
.
Quand aws-vault est utilisé, la valeur du profil est lu dans la variable d'environnement: AWS_VAULT
.
When using awsu the profile is read from the AWSU_PROFILE
env var.
Options
Option | Default | Description |
---|---|---|
format |
'on [$symbol($profile )(\($region\) )]($style)' |
Format du module. |
symbol |
"☁️ " |
Le symbole affiché avant le profil AWS actuel. |
region_aliases |
Table des alias de région à afficher en plus du nom AWS. | |
style |
"bold yellow" |
Le style du module. |
disabled |
false |
Désactive le module AWS . |
Variables
Variable | Exemple | Description |
---|---|---|
region | ap-northeast-1 |
La région AWS actuelle |
profile | astronauts |
Le profil AWS actuel |
symbol | Reflète la valeur de l'option symbol |
|
style* | Reflète la valeur de l'option style |
*: This variable can only be used as a part of a style string
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
The battery
module shows how charged the device's battery is and its current charging status. The module is only visible when the device's battery is below 10%.
Options
Option | 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
The display
configuration option is used to define when the battery indicator should be shown (threshold) and what it looks like (style). If no display
is provided. La valeur par défaut est la suivante :
[[battery.display]]
threshold = 10
style = "bold red"
Options
The display
option is an array of the following table.
Option | Description |
---|---|
threshold |
La limite supérieure pour l'option d'affichage. |
style |
Le style de l'option display si elle est utilisée. |
Exemple
[[battery.display]] # le style "bold red" lorsque la capacité est comprise entre 0% et 10%
threshold = 10
style = "bold red"
[[battery.display]] # le style "bold yellow" quand la capacité est comprise entre 10% et 30%
threshold = 30
style = "bold yellow"
# lorsque la capacité est supérieure à 30%, l'indicateur de batterie ne sera pas affiché
Caractères
The character
module shows a character (usually an arrow) beside where the text is entered in your terminal.
The character will tell you whether the last command was successful or not. It can do this in two ways:
- changement de couleur (
red
/green
) - changement de forme (
❯
/✖
)
By default it only changes color. If you also want to change it's shape take a look at this example.
::: warning error_symbol
is not supported on elvish shell. :::
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
The cmake
module shows the currently installed version of CMake. By default the module will be activated if any of the following conditions are met:
- Le répertoire actuel contient un fichier
CMakeLists.txt
- Le répertoire actuel contient un fichier
CMakeCache.txt
Options
Option | Défaut | Description |
---|---|---|
format |
"via [$symbol($version )]($style)" |
Format du module. |
symbol |
"△ " |
Le symbole utilisé avant la version de cmake. |
detect_extensions |
[] |
Which extensions should trigger this moudle |
detect_files |
["CMakeLists.txt", "CMakeCache.txt"] |
Which filenames should trigger this module |
detect_folders |
[] |
Which folders should trigger this module |
style |
"bold blue" |
Le style du module. |
disabled |
false |
Disables the cmake module. |
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 |
*: This variable can only be used as a part of a style string
Temps d'exécution
The cmd_duration
module shows how long the last command took to execute. The module will be shown only if the command took longer than two seconds, or the min_time
config value, if it exists.
::: warning Do not hook the DEBUG trap in Bash
If you are running Starship in bash
, do not hook the DEBUG
trap after running eval $(starship init $0)
, or this module will break.
:::
Bash users who need preexec-like functionality can use rcaloras's bash_preexec framework. Simply define the arrays preexec_functions
and precmd_functions
before running eval $(starship init $0)
, and then proceed as normal.
Options
Option | Défaut | Description |
---|---|---|
min_time |
2_000 |
Durée la plus courte quand afficher le temps (en millisecondes). |
show_milliseconds |
false |
Afficher les millisecondes en plus des secondes pendant la durée. |
format |
"took [$duration]($style) " |
Format du module. |
style |
"bold yellow" |
Le style du module. |
disabled |
false |
Désactive le module cmd_duration . |
show_notifications |
false |
Afficher les notifications du bureau lorsque la commande est terminée. |
min_time_to_notify |
45_000 |
Shortest duration for notification (in milliseconds). |
::: tip
Showing desktop notifications requires starship to be built with rust-notify
support. You check if your starship supports notifications by running STARSHIP_LOG=debug starship module cmd_duration -d 60000
when show_notifications
is set to true
.
:::
Variables
Variable | Exemple | Description |
---|---|---|
duration | 16m40s |
Le temps nécessaire pour exécuter la commande |
style* | Reflète la valeur de l'option style |
*: This variable can only be used as a part of a style string
Exemple
# ~/.config/starship.toml
[cmd_duration]
min_time = 500
format = "underwent [$duration](bold yellow)"
Conda
The conda
module shows the current conda environment, if $CONDA_DEFAULT_ENV
is set.
::: tip
This does not suppress conda's own prompt modifier, you may want to run conda config --set changeps1 False
.
:::
Options
Option | Défaut | Description |
---|---|---|
truncation_length |
1 |
Le nombre de répertoires dans lesquels le chemin d'environnement (Path) doit être tronqué, si l'environnement a été créé via conda create -p [path] . 0 ne signifie pas de troncature. Regardez aussi le module directory . |
symbol |
"🅒 " |
Le symbole utilisé avant le nom d'environnement. |
style |
"bold green" |
Le style du module. |
format |
"via [$symbol$environment]($style) " |
Format du module. |
ignore_base |
true |
Ignore l'environnement base lorsqu'il est activé. |
disabled |
false |
Désactive le module conda . |
Variables
Variable | Exemple | Description |
---|---|---|
environnement | astronauts |
La version courante de conda |
symbol | Reflète la valeur de l'option symbol |
|
style* | Reflète la valeur de l'option style |
*: This variable can only be used as a part of a style string
Exemple
# ~/.config/starship.toml
[conda]
format = "[$symbol$environment](dimmed green) "
Crystal
The crystal
module shows the currently installed version of Crystal. By default the module will be shown if any of the following conditions are met:
- Le répertoire courant contient un fichier
shard.yml
- Le répertoire courant contient un fichier
.cr
Options
Option | Défaut | Description |
---|---|---|
symbol |
"🔮 " |
Le symbole utilisé avant d'afficher la version de crystal. |
style |
"bold green" |
Le style du module. |
detect_extensions |
["cr"] |
Which extensions should trigger this module. |
detect_files |
["shard.yml"] |
Which filenames should trigger this module. |
detect_folders |
[] |
Which folders should trigger this module. |
format |
"via [$symbol($version )]($style)" |
Format du module. |
disabled |
false |
Disables the crystal module. |
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 |
*: This variable can only be used as a part of a style string
Exemple
# ~/.config/starship.toml
[crystal]
format = "via [✨ $version](bold blue) "
Dart
The dart
module shows the currently installed version of Dart. By default the module will be shown if any of the following conditions are met:
- Le répertoire courant contient un fichier
.dart
- Le répertoire courant contient un répertoire
.dart_tool
- The current directory contains a
pubspec.yaml
,pubspec.yml
orpubspec.lock
file
Options
Option | Défaut | Description |
---|---|---|
format |
"via [$symbol($version )]($style)" |
Format du module. |
symbol |
"🎯 " |
Une chaîne de caractères représentant le symbole de Dart |
detect_extensions |
['dart'] |
Which extensions should trigger this moudle. |
detect_files |
["pubspec.yaml", "pubspec.yml", "pubspec.lock"] |
Which filenames should trigger this module. |
detect_folders |
[".dart_tool"] |
Which folders should trigger this module. |
style |
"bold blue" |
Le style du module. |
disabled |
false |
Disables the dart module. |
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 |
*: This variable can only be used as a part of a style string
Exemple
# ~/.config/starship.toml
[dart]
format = "via [🔰 $version](bold red) "
Dossier
The directory
module shows the path to your current directory, truncated to three parent folders. Your directory will also be truncated to the root of the git repo that you're currently in.
When using the fish style pwd option, instead of hiding the path that is truncated, you will see a shortened name of each directory based on the number you enable for the option.
For example, given ~/Dev/Nix/nixpkgs/pkgs
where nixpkgs
is the repo root, and the option set to 1
. You will now see ~/D/N/nixpkgs/pkgs
, whereas before it would have been nixpkgs/pkgs
.
Options
Option | Défaut | Description |
---|---|---|
truncation_length |
3 |
Le nombre de dossiers parents selon lesquels le répertoire courant doit être tronqué. |
truncate_to_repo |
true |
Si oui ou non tronquer à la racine du repo git dans lequel vous vous trouvez. |
format |
"[$path]($style)[$read_only]($read_only_style) " |
Format du module. |
style |
"bold cyan" |
Le style du module. |
disabled |
false |
Désactive le module directory . |
read_only |
"🔒" |
Le symbole indiquant que le répertoire courant est en lecture seule. |
read_only_style |
"red" |
Le style du symbole en lecture seule. |
truncation_symbol |
"" |
Le symbole en préfixe aux chemins tronqués. eg: "…/" |
home_symbol |
"~" |
The symbol indicating home directory. |
This module has a few advanced configuration options that control how the directory is displayed.
Options avancées | Défaut | Description |
---|---|---|
substitutions |
Table de substitutions à faire au chemin. | |
fish_style_pwd_dir_length |
0 |
The number of characters to use when applying fish shell pwd path logic. |
use_logical_path |
true |
If true render the logical path sourced from the shell via PWD or --logical-path . If false instead render the physical filesystem path with symlinks resolved. |
substitutions
allows you to define arbitrary replacements for literal strings that occur in the path, for example long network prefixes or development directories (i.e. Java). Note that this will disable the fish style PWD.
[directory.substitutions]
"/Volumes/network/path" = "/net"
"src/com/long/java/path" = "mypath"
fish_style_pwd_dir_length
interacts with the standard truncation options in a way that can be surprising at first: if it's non-zero, the components of the path that would normally be truncated are instead displayed with that many characters. For example, the path /built/this/city/on/rock/and/roll
, which would normally be displayed as as rock/and/roll
, would be displayed as /b/t/c/o/rock/and/roll
with fish_style_pwd_dir_length = 1
--the path components that would normally be removed are displayed with a single character. For fish_style_pwd_dir_length = 2
, it would be /bu/th/ci/on/rock/and/roll
.
Variables
Variable | Exemple | Description |
---|---|---|
path | "D:/Projects" |
Le chemin du répertoire courant |
style* | "black bold dimmed" |
Reflète la valeur de l'option style |
*: This variable can only be used as a part of a style string
Exemple
# ~/.config/starship.toml
[directory]
truncation_length = 8
truncation_symbol = "…/"
Docker Context
The docker_context
module shows the currently active Docker context if it's not set to default
.
Options
Option | Défaut | Description |
---|---|---|
format |
"via [$symbol$context]($style) " |
Format du module. |
symbol |
"🐳 " |
The symbol used before displaying the Docker context. |
only_with_files |
true |
Only show when there's a match |
detect_extensions |
[] |
Which extensions should trigger this module (needs only_with_files to be true). |
detect_files |
["docker-compose.yml", "docker-compose.yaml", "Dockerfile"] |
Which filenames should trigger this module (needs only_with_files to be true). |
detect_folders |
[] |
Which folders should trigger this module (needs only_with_files to be true). |
style |
"blue bold" |
Le style du module. |
disabled |
false |
Disables the docker_context module. |
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 |
*: This variable can only be used as a part of a style string
Exemple
# ~/.config/starship.toml
[docker_context]
format = "via [🐋 $context](blue bold)"
Dotnet
The dotnet
module shows the relevant version of the .NET Core SDK for the current directory. If the SDK has been pinned in the current directory, the pinned version is shown. Otherwise the module shows the latest installed version of the SDK.
By default this module will only be shown in your prompt when one or more of the following files are present in the current directory:
global.json
project.json
Directory.Build.props
Directory.Build.targets
Packages.props
*.sln
*.csproj
*.fsproj
*.xproj
You'll also need the .NET Core SDK installed in order to use it correctly.
Internally, this module uses its own mechanism for version detection. Typically it is twice as fast as running dotnet --version
, but it may show an incorrect version if your .NET project has an unusual directory layout. If accuracy is more important than speed, you can disable the mechanism by setting heuristic = false
in the module options.
The module will also show the Target Framework Moniker (https://docs.microsoft.com/en-us/dotnet/standard/frameworks#supported-target-framework-versions) when there is a csproj file in the current directory.
Options
Option | Défaut | Description |
---|---|---|
format |
"[$symbol($version )(🎯 $tfm )]($style)" |
Format du module. |
symbol |
"•NET " |
The symbol used before displaying the version of dotnet. |
heuristic |
true |
Use faster version detection to keep starship snappy. |
detect_extensions |
["sln", "csproj", "fsproj", "xproj"] |
Which extensions should trigger this module. |
detect_files |
["global.json", "project.json", "Directory.Build.props", "Directory.Build.targets", "Packages.props"] |
Which filenames should trigger this module. |
detect_folders |
[] |
Which folders should trigger this modules. |
style |
"bold blue" |
Le style du module. |
disabled |
false |
Disables the dotnet module. |
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 |
*: This variable can only be used as a part of a style string
Exemple
# ~/.config/starship.toml
[dotnet]
symbol = "🥅 "
style = "green"
heuristic = false
Elixir
The elixir
module shows the currently installed version of Elixir and Erlang/OTP. By default the module will be shown if any of the following conditions are met:
- Le répertoire courant contient un fichier
mix.exs
.
Options
Option | Défaut | Description |
---|---|---|
symbol |
"💧 " |
The symbol used before displaying the version of Elixir/Erlang. |
detect_extensions |
[] |
Which extensions should trigger this module. |
detect_files |
["mix.exs"] |
Which filenames should trigger this module. |
detect_folders |
[] |
Which folders should trigger this modules. |
style |
"bold purple" |
Le style du module. |
format |
'via [$symbol($version \(OTP $otp_version\) )]($style)' |
The format for the module elixir. |
disabled |
false |
Disables the elixir module. |
Variables
Variable | Exemple | Description |
---|---|---|
version | v1.10 |
The version of elixir |
otp_version | The otp version of elixir |
|
symbol | Reflète la valeur de l'option symbol |
|
style* | Reflète la valeur de l'option style |
*: This variable can only be used as a part of a style string
Exemple
# ~/.config/starship.toml
[elixir]
symbol = "🔮 "
Elm
The elm
module shows the currently installed version of Elm. By default the module will be shown if any of the following conditions are met:
- Le répertoire courant contient un fichier
elm.json
- Le répertoire courant contient un fichier
elm-package.json
- The current directory contains a
.elm-version
file - The current directory contains a
elm-stuff
folder - The current directory contains a
*.elm
files
Options
Option | Défaut | Description |
---|---|---|
format |
"via [$symbol($version )]($style)" |
Format du module. |
symbol |
"🌳 " |
A format string representing the symbol of Elm. |
detect_extensions |
["elm"] |
Which extensions should trigger this module. |
detect_files |
["elm.json", "elm-package.json", ".elm-version"] |
Which filenames should trigger this module. |
detect_folders |
["elm-stuff"] |
Which folders should trigger this modules. |
style |
"cyan bold" |
Le style du module. |
disabled |
false |
Disables the elm module. |
Variables
Variable | Exemple | Description |
---|---|---|
version | v0.19.1 |
The version of elm |
symbol | Reflète la valeur de l'option symbol |
|
style* | Reflète la valeur de l'option style |
*: This variable can only be used as a part of a style string
Exemple
# ~/.config/starship.toml
[elm]
format = "via [ $version](cyan bold) "
Environment Variable
The env_var
module displays the current value of a selected environment variable. The module will be shown only if any of the following conditions are met:
- The
variable
configuration option matches an existing environment variable - The
variable
configuration option is not defined, but thedefault
configuration option is
Options
Option | Défaut | Description |
---|---|---|
symbol |
The symbol used before displaying the variable value. | |
variable |
The environment variable to be displayed. | |
défaut |
The default value to be displayed when the selected variable is not defined. | |
format |
"with [$env_value]($style) " |
Format du module. |
disabled |
false |
Disables the env_var module. |
Variables
Variable | Exemple | Description |
---|---|---|
env_value | Windows NT (if variable would be $OS ) |
The environment value of option variable |
symbol | Reflète la valeur de l'option symbol |
|
style* | black bold dimmed |
Reflète la valeur de l'option style |
*: This variable can only be used as a part of a style string
Exemple
# ~/.config/starship.toml
[env_var]
variable = "SHELL"
default = "unknown shell"
Erlang
The erlang
module shows the currently installed version of Erlang/OTP. By default the module will be shown if any of the following conditions are met:
- Le répertoire courant contient un fichier
rebar.config
. - Le répertoire courant contient un fichier
erlang.mk
.
Options
Option | Défaut | Description |
---|---|---|
symbol |
" " |
The symbol used before displaying the version of erlang. |
style |
"bold green" |
Le style du module. |
detect_extensions |
[] |
Which extensions should trigger this module. |
detect_files |
["rebar.config", "elang.mk"] |
Which filenames should trigger this module. |
detect_folders |
[] |
Which folders should trigger this modules. |
format |
"via [$symbol($version )]($style)" |
Format du module. |
disabled |
false |
Disables the erlang module. |
Variables
Variable | Exemple | Description |
---|---|---|
version | v22.1.3 |
The version of erlang |
symbol | Reflète la valeur de l'option symbol |
|
style* | Reflète la valeur de l'option style |
*: This variable can only be used as a part of a style string
Exemple
# ~/.config/starship.toml
[erlang]
format = "via [e $version](bold red) "
Gcloud
The gcloud
module shows the current configuration for gcloud
CLI. This is based on the ~/.config/gcloud/active_config
file and the ~/.config/gcloud/configurations/config_{CONFIG NAME}
file and the CLOUDSDK_CONFIG
env var.
Options
Option | Défaut | Description |
---|---|---|
format |
'on [$symbol$account(\($region\))]($style) ' |
Format du module. |
symbol |
"☁️ " |
The symbol used before displaying the current GCP profile. |
region_aliases |
Table of region aliases to display in addition to the GCP name. | |
style |
"bold blue" |
Le style du module. |
disabled |
false |
Disables the gcloud module. |
Variables
Variable | Exemple | Description |
---|---|---|
region | us-central1 |
The current GCP region |
account | foo@example.com |
The current GCP profile |
project | The current GCP project | |
active | défaut |
The active config name written in ~/.config/gcloud/active_config |
symbol | Reflète la valeur de l'option symbol |
|
style* | Reflète la valeur de l'option style |
*: This variable can only be used as a part of a style string
Exemples
Display account and project
# ~/.config/starship.toml
[gcloud]
format = 'on [$symbol$account(\($project\))]($style) '
Display active config name only
# ~/.config/starship.toml
[gcloud]
format = "[$symbol$active]($style) "
style = "bold yellow"
Display account and aliased region
# ~/.config/starship.toml
[gcloud]
symbol = "️🇬️ "
[gcloud.region_aliases]
us-central1 = "uc1"
asia-northeast1 = "an1"
Git Branch
The git_branch
module shows the active branch of the repo in your current directory.
Options
Option | Défaut | Description |
---|---|---|
always_show_remote |
false |
Shows the remote tracking branch name, even if it is equal to the local branch name. |
format |
"on [$symbol$branch]($style) " |
Format du module. Use "$branch" to refer to the current branch name. |
symbol |
" " |
A format string representing the symbol of git branch. |
style |
"bold purple" |
Le style du module. |
truncation_length |
2^63 - 1 |
Truncates a git branch to X graphemes. |
truncation_symbol |
"…" |
The symbol used to indicate a branch name was truncated. You can use "" for no symbol. |
only_attached |
false |
Only show the branch name when not in a detached HEAD state. |
disabled |
false |
Disables the git_branch module. |
Variables
Variable | Exemple | Description |
---|---|---|
branch | master |
The current branch name, falls back to HEAD if there's no current branch (e.g. git detached HEAD). |
remote_name | origin |
The remote name. |
remote_branch | master |
The name of the branch tracked on remote_name . |
symbol | Reflète la valeur de l'option symbol |
|
style* | Reflète la valeur de l'option style |
*: This variable can only be used as a part of a style string
Exemple
# ~/.config/starship.toml
[git_branch]
symbol = "🌱 "
truncation_length = 4
truncation_symbol = ""
Git Commit
The git_commit
module shows the current commit hash and also the tag (if any) of the repo in your current directory.
Options
Option | Défaut | Description |
---|---|---|
commit_hash_length |
7 |
The length of the displayed git commit hash. |
format |
"[\\($hash\\)]($style) [\\($tag\\)]($style)" |
Format du module. |
style |
"bold green" |
Le style du module. |
only_detached |
true |
Only show git commit hash when in detached HEAD state |
tag_disabled |
true |
Disables showing tag info in git_commit module. |
tag_symbol |
"🏷 " |
Tag symbol prefixing the info shown |
disabled |
false |
Disables the git_commit module. |
Variables
Variable | Exemple | Description |
---|---|---|
hash | b703eb3 |
The current git commit hash |
style* | Reflète la valeur de l'option style |
*: This variable can only be used as a part of a style string
Exemple
# ~/.config/starship.toml
[git_commit]
commit_hash_length = 4
tag_symbol = "🔖 "
Git State
The git_state
module will show in directories which are part of a git repository, and where there is an operation in progress, such as: REBASING, BISECTING, etc. If there is progress information (e.g., REBASING 3/10), that information will be shown too.
Options
Option | Défaut | Description |
---|---|---|
rebase |
"REBASING" |
A format string displayed when a rebase is in progress. |
merge |
"MERGING" |
A format string displayed when a merge is in progress. |
revert |
"REVERTING" |
A format string displayed when a revert is in progress. |
cherry_pick |
"CHERRY-PICKING" |
A format string displayed when a cherry-pick is in progress. |
bisect |
"BISECTING" |
A format string displayed when a bisect is in progress. |
am |
"AM" |
A format string displayed when an apply-mailbox (git am ) is in progress. |
am_or_rebase |
"AM/REBASE" |
A format string displayed when an ambiguous apply-mailbox or rebase is in progress. |
style |
"bold yellow" |
Le style du module. |
format |
'\([$state( $progress_current/$progress_total)]($style)\) ' |
Format du module. |
disabled |
false |
Disables the git_state module. |
Variables
Variable | Exemple | Description |
---|---|---|
state | REBASING |
The current state of the repo |
progress_current | 1 |
The current operation progress |
progress_total | 2 |
The total operation progress |
style* | Reflète la valeur de l'option style |
*: This variable can only be used as a part of a style string
Exemple
# ~/.config/starship.toml
[git_state]
format = '[\($state( $progress_current of $progress_total)\)]($style) '
cherry_pick = "[🍒 PICKING](bold red)"
Git Status
The git_status
module shows symbols representing the state of the repo in your current directory.
Options
Option | Défaut | Description |
---|---|---|
format |
'([\[$all_status$ahead_behind\]]($style) )' |
The default format for git_status |
conflicted |
"=" |
This branch has merge conflicts. |
ahead |
"⇡" |
The format of ahead |
behind |
"⇣" |
The format of behind |
diverged |
"⇕" |
The format of diverged |
untracked |
"?" |
The format of untracked |
stashed |
"$" |
The format of stashed |
modified |
"!" |
The format of modified |
staged |
"+" |
The format of staged |
renamed |
"»" |
The format of renamed |
deleted |
"✘" |
The format of deleted |
style |
"bold green" |
Le style du module. |
disabled |
false |
Disables the git_status module. |
Variables
The following variables can be used in format
:
Variable | Description |
---|---|
all_status |
Shortcut for$conflicted$stashed$deleted$renamed$modified$staged$untracked |
ahead_behind |
Displays diverged ahead or behind format string based on the current status of the repo |
conflicted |
Displays conflicted when this branch has merge conflicts. |
untracked |
Displays untracked when there are untracked files in the working directory. |
stashed |
Displays stashed when a stash exists for the local repository. |
modified |
Displays modified when there are file modifications in the working directory. |
staged |
Displays staged when a new file has been added to the staging area. |
renamed |
Displays renamed when a renamed file has been added to the staging area. |
deleted |
Displays deleted when a file's deletion has been added to the staging area. |
style* | Reflète la valeur de l'option style |
*: This variable can only be used as a part of a style string
The following variables can be used in diverged
:
Variable | Description |
---|---|
ahead_count |
Number of commits ahead of the tracking branch |
behind_count |
Number of commits behind the tracking branch |
The following variables can be used in conflicted
, ahead
, behind
, untracked
, stashed
, modified
, staged
, renamed
and deleted
:
Variable | Description |
---|---|
count |
Show the number of files |
Exemple
# ~/.config/starship.toml
[git_status]
conflicted = "🏳"
ahead = "🏎💨"
behind = "😰"
diverged = "😵"
untracked = "🤷"
stashed = "📦"
modified = "📝"
staged = '[++\($count\)](green)'
renamed = "👅"
deleted = "🗑"
Show ahead/behind count of the branch being tracked
# ~/.config/starship.toml
[git_status]
ahead = "⇡${count}"
diverged = "⇕⇡${ahead_count}⇣${behind_count}"
behind = "⇣${count}"
Golang
The golang
module shows the currently installed version of Golang. By default the module will be shown if any of the following conditions are met:
- Le répertoire courant contient un fichier
go.mod
- Le répertoire courant contient un fichier
go.sum
- Le répertoire courant contient un fichier
glide.yaml
- The current directory contains a
Gopkg.yml
file - The current directory contains a
Gopkg.lock
file - The current directory contains a
.go-version
file - The current directory contains a
Godeps
directory - The current directory contains a file with the
.go
extension
Options
Option | Défaut | Description |
---|---|---|
format |
"via [$symbol($version )]($style)" |
Format du module. |
symbol |
"🐹 " |
A format string representing the symbol of Go. |
detect_extensions |
["go"] |
Which extensions should trigger this moudle. |
detect_files |
["go.mod", "go.sum", "glide.yaml", "Gopkg.yml", "Gopkg.lock", ".go-version"] |
Which filenames should trigger this module. |
detect_folders |
["Godeps"] |
Which folders should trigger this module. |
style |
"bold cyan" |
Le style du module. |
disabled |
false |
Disables the golang module. |
Variables
Variable | Exemple | Description |
---|---|---|
version | v1.12.1 |
The version of go |
symbol | Reflète la valeur de l'option symbol |
|
style* | Reflète la valeur de l'option style |
*: This variable can only be used as a part of a style string
Exemple
# ~/.config/starship.toml
[golang]
format = "via [🏎💨 $version](bold cyan) "
Helm
The helm
module shows the currently installed version of Helm. By default the module will be shown if any of the following conditions are met:
- Le répertoire courant contient un fichier
helmfile.yaml
- The current directory contains a
Chart.yaml
file
Options
Option | Défaut | Description |
---|---|---|
format |
"via [$symbol($version )]($style)" |
Format du module. |
detect_extensions |
[] |
Which extensions should trigger this module. |
detect_files |
["helmfile.yaml", "Chart.yaml"] |
Which filenames should trigger this module. |
detect_folders |
[] |
Which folders should trigger this modules. |
symbol |
"⎈ " |
A format string representing the symbol of Helm. |
style |
"bold white" |
Le style du module. |
disabled |
false |
Disables the helm module. |
Variables
Variable | Exemple | Description |
---|---|---|
version | v3.1.1 |
The version of helm |
symbol | Reflète la valeur de l'option symbol |
|
style* | Reflète la valeur de l'option style |
*: This variable can only be used as a part of a style string
Exemple
# ~/.config/starship.toml
[helm]
format = "via [⎈ $version](bold white) "
Hostname
The hostname
module shows the system hostname.
Options
Option | Défaut | Description |
---|---|---|
ssh_only |
true |
Only show hostname when connected to an SSH session. |
trim_at |
"." |
String that the hostname is cut off at, after the first match. "." will stop after the first dot. "" will disable any truncation |
format |
"[$hostname]($style) in " |
Format du module. |
style |
"bold dimmed green" |
Le style du module. |
disabled |
false |
Disables the hostname module. |
Variables
Variable | Exemple | Description |
---|---|---|
symbol | Reflète la valeur de l'option symbol |
|
style* | Reflète la valeur de l'option style |
*: This variable can only be used as a part of a style string
Exemple
# ~/.config/starship.toml
[hostname]
ssh_only = false
format = "on [$hostname](bold red) "
trim_at = ".companyname.com"
disabled = false
Java
The java
module shows the currently installed version of Java. By default the module will be shown if any of the following conditions are met:
- The current directory contains a
pom.xml
,build.gradle.kts
,build.sbt
,.java-version
,.deps.edn
,project.clj
, orbuild.boot
file - The current directory contains a file with the
.java
,.class
,.gradle
,.jar
,.clj
, or.cljc
extension
Options
Option | Défaut | Description |
---|---|---|
format |
"via [${symbol}(${version} )]($style)" |
Format du module. |
detect_extensions |
["java", "class", "gradle", "jar", "cljs", "cljc"] |
Which extensions should trigger this module. |
detect_files |
["pom.xml", "build.gradle.kts", "build.sbt", ".java-version", ".deps.edn", "project.clj", "build.boot"] |
Which filenames should trigger this module. |
detect_folders |
[] |
Which folders should trigger this modules. |
symbol |
"☕ " |
A format string representing the symbol of Java |
style |
"red dimmed" |
Le style du module. |
disabled |
false |
Disables the java module. |
Variables
Variable | Exemple | Description |
---|---|---|
version | v14 |
The version of java |
symbol | Reflète la valeur de l'option symbol |
|
style* | Reflète la valeur de l'option style |
*: This variable can only be used as a part of a style string
Exemple
# ~/.config/starship.toml
[java]
symbol = "🌟 "
Jobs
The jobs
module shows the current number of jobs running. The module will be shown only if there are background jobs running. The module will show the number of jobs running if there is more than 1 job, or more than the threshold
config value, if it exists.
::: warning
This module is not supported on tcsh.
:::
Options
Option | Défaut | Description |
---|---|---|
threshold |
1 |
Show number of jobs if exceeded. |
format |
"[$symbol$number]($style) " |
Format du module. |
symbol |
"✦" |
A format string representing the number of jobs. |
style |
"bold blue" |
Le style du module. |
disabled |
false |
Disables the jobs module. |
Variables
Variable | Exemple | Description |
---|---|---|
number | 1 |
The number of jobs |
symbol | Reflète la valeur de l'option symbol |
|
style* | Reflète la valeur de l'option style |
*: This variable can only be used as a part of a style string
Exemple
# ~/.config/starship.toml
[jobs]
symbol = "+ "
threshold = 4
Julia
The julia
module shows the currently installed version of Julia. By default the module will be shown if any of the following conditions are met:
- The current directory contains a
Project.toml
file - The current directory contains a
Manifest.toml
file - The current directory contains a file with the
.jl
extension
Options
Option | Défaut | Description |
---|---|---|
format |
"via [$symbol($version )]($style)" |
Format du module. |
detect_extensions |
["jl"] |
Which extensions should trigger this module. |
detect_files |
["Project.toml", "Manifest.toml"] |
Which filenames should trigger this module. |
detect_folders |
[] |
Which folders should trigger this modules. |
symbol |
"ஃ " |
A format string representing the symbol of Julia. |
style |
"bold purple" |
Le style du module. |
disabled |
false |
Disables the julia module. |
Variables
Variable | Exemple | Description |
---|---|---|
version | v1.4.0 |
The version of julia |
symbol | Reflète la valeur de l'option symbol |
|
style* | Reflète la valeur de l'option style |
*: This variable can only be used as a part of a style string
Exemple
# ~/.config/starship.toml
[julia]
symbol = "∴ "
Kotlin
The kotlin
module shows the currently installed version of Kotlin. By default the module will be shown if any of the following conditions are met:
- The current directory contains a
.kt
or a.kts
file
Options
Option | Défaut | Description |
---|---|---|
format |
"via [$symbol($version )]($style)" |
Format du module. |
detect_extensions |
["kt", "kts"] |
Which extensions should trigger this module. |
detect_files |
[] |
Which filenames should trigger this module. |
detect_folders |
[] |
Which folders should trigger this modules. |
symbol |
"🅺 " |
A format string representing the symbol of Kotlin. |
style |
"bold blue" |
Le style du module. |
kotlin_binary |
"kotlin" |
Configures the kotlin binary that Starship executes when getting the version. |
disabled |
false |
Disables the kotlin module. |
Variables
Variable | Exemple | Description |
---|---|---|
version | v1.4.21 |
The version of kotlin |
symbol | Reflète la valeur de l'option symbol |
|
style* | Reflète la valeur de l'option style |
*: This variable can only be used as a part of a style string
Exemple
# ~/.config/starship.toml
[kotlin]
symbol = "🅺 "
# ~/.config/starship.toml
[kotlin]
# Uses the Kotlin Compiler binary to get the installed version
kotlin_binary = "kotlinc"
Kubernetes
Displays the current Kubernetes context name and, if set, the namespace from the kubeconfig file. The namespace needs to be set in the kubeconfig file, this can be done via kubectl config set-context starship-cluster --namespace astronaut
. If the $KUBECONFIG
env var is set the module will use that if not it will use the ~/.kube/config
.
::: tip
This module is disabled by default. To enable it, set disabled
to false
in your configuration file.
:::
Options
Option | Défaut | Description |
---|---|---|
symbol |
"☸ " |
A format string representing the symbol displayed before the Cluster. |
format |
'[$symbol$context( \($namespace\))]($style) in ' |
Format du module. |
style |
"cyan bold" |
Le style du module. |
context_aliases |
Table of context aliases to display. | |
disabled |
true |
Disables the kubernetes module. |
Variables
Variable | Exemple | Description |
---|---|---|
context | starship-cluster |
The current kubernetes context |
namespace | starship-namespace |
If set, the current kubernetes namespace |
symbol | Reflète la valeur de l'option symbol |
|
style* | Reflète la valeur de l'option style |
*: This variable can only be used as a part of a style string
Exemple
# ~/.config/starship.toml
[kubernetes]
format = 'on [⛵ $context \($namespace\)](dimmed green) '
disabled = false
[kubernetes.context_aliases]
"dev.local.cluster.k8s" = "dev"
Line Break
The line_break
module separates the prompt into two lines.
Options
Option | Défaut | Description |
---|---|---|
disabled |
false |
Disables the line_break module, making the prompt a single line. |
Exemple
# ~/.config/starship.toml
[line_break]
disabled = true
Lua
The lua
module shows the currently installed version of Lua. By default the module will be shown if any of the following conditions are met:
- The current directory contains a
.lua-version
file - The current directory contains a
lua
directory - The current directory contains a file with the
.lua
extension
Options
Option | Défaut | Description |
---|---|---|
format |
"via [$symbol($version )]($style)" |
Format du module. |
symbol |
"🌙 " |
A format string representing the symbol of Lua. |
detect_extensions |
["lua"] |
Which extensions should trigger this moudle. |
detect_files |
[".lua-version"] |
Which filenames should trigger this module. |
detect_folders |
["lua"] |
Which folders should trigger this module. |
style |
"bold blue" |
Le style du module. |
lua_binary |
"lua" |
Configures the lua binary that Starship executes when getting the version. |
disabled |
false |
Disables the lua module. |
Variables
Variable | Exemple | Description |
---|---|---|
version | v5.4.0 |
The version of lua |
symbol | Reflète la valeur de l'option symbol |
|
style* | Reflète la valeur de l'option style |
*: This variable can only be used as a part of a style string
Exemple
# ~/.config/starship.toml
[lua]
format = "via [🌕 $version](bold blue) "
Memory Usage
The memory_usage
module shows current system memory and swap usage.
By default the swap usage is displayed if the total system swap is non-zero.
::: tip
This module is disabled by default. To enable it, set disabled
to false
in your configuration file.
:::
Options
Option | Défaut | Description |
---|---|---|
threshold |
75 |
Hide the memory usage unless it exceeds this percentage. |
format |
`"via $symbol [${ram}( | ${swap})]($style) "` |
symbol |
"🐏" |
The symbol used before displaying the memory usage. |
style |
"bold dimmed white" |
Le style du module. |
disabled |
true |
Disables the memory_usage module. |
Variables
Variable | Exemple | Description |
---|---|---|
ram | 31GiB/65GiB |
The usage/total RAM of the current system memory. |
ram_pct | 48% |
The percentage of the current system memory. |
swap** | 1GiB/4GiB |
The swap memory size of the current system swap memory file. |
swap_pct** | 77% |
The swap memory percentage of the current system swap memory file. |
symbol | 🐏 |
Reflète la valeur de l'option symbol |
style* | Reflète la valeur de l'option style |
*: This variable can only be used as a part of a style string **: The SWAP file information is only displayed if detected on the current system
Exemple
# ~/.config/starship.toml
[memory_usage]
disabled = false
threshold = -1
symbol = " "
style = "bold dimmed green"
Mercurial Branch
The hg_branch
module shows the active branch of the repo in your current directory.
Options
Option | Défaut | Description |
---|---|---|
symbol |
" " |
The symbol used before the hg bookmark or branch name of the repo in your current directory. |
style |
"bold purple" |
Le style du module. |
format |
"on [$symbol$branch]($style) " |
Format du module. |
truncation_length |
2^63 - 1 |
Truncates the hg branch name to X graphemes |
truncation_symbol |
"…" |
The symbol used to indicate a branch name was truncated. |
disabled |
true |
Disables the hg_branch module. |
Variables
Variable | Exemple | Description |
---|---|---|
branch | master |
The active mercurial branch |
symbol | Reflète la valeur de l'option symbol |
|
style* | Reflète la valeur de l'option style |
*: This variable can only be used as a part of a style string
Exemple
# ~/.config/starship.toml
[hg_branch]
format = "on [🌱 $branch](bold purple)"
truncation_length = 4
truncation_symbol = ""
Nim
The nim
module shows the currently installed version of Nim. By default the module will be shown if any of the following conditions are met:
- Le répertoire courant contient un fichier
nim.cfg
- The current directory contains a file with the
.nim
extension - The current directory contains a file with the
.nims
extension - The current directory contains a file with the
.nimble
extension
Options
Option | Défaut | Description |
---|---|---|
format |
"via [$symbol($version )]($style)" |
Format du module |
symbol |
"👑 " |
The symbol used before displaying the version of Nim. |
detect_extensions |
["nim", "nims", "nimble"] |
Which extensions should trigger this moudle. |
detect_files |
["nim.cfg"] |
Which filenames should trigger this module. |
detect_folders |
[] |
Which folders should trigger this module. |
style |
"bold yellow" |
Le style du module. |
disabled |
false |
Disables the nim module. |
Variables
Variable | Exemple | Description |
---|---|---|
version | v1.2.0 |
The version of nimc |
symbol | Reflète la valeur de l'option symbol |
|
style* | Reflète la valeur de l'option style |
*: This variable can only be used as a part of a style string
Exemple
# ~/.config/starship.toml
[nim]
style = "yellow"
symbol = "🎣 "
Nix-shell
The nix_shell
module shows the nix-shell environment. The module will be shown when inside a nix-shell environment.
Options
Option | Défaut | Description |
---|---|---|
format |
'via [$symbol$state( \($name\))]($style) ' |
Format du module. |
symbol |
"❄️ " |
A format string representing the symbol of nix-shell. |
style |
"bold blue" |
Le style du module. |
impure_msg |
"impure" |
A format string shown when the shell is impure. |
pure_msg |
"pure" |
A format string shown when the shell is pure. |
disabled |
false |
Disables the nix_shell module. |
Variables
Variable | Exemple | Description |
---|---|---|
state | pure |
The state of the nix-shell |
name | lorri |
The name of the nix-shell |
symbol | Reflète la valeur de l'option symbol |
|
style* | Reflète la valeur de l'option style |
*: This variable can only be used as a part of a style string
Exemple
# ~/.config/starship.toml
[nix_shell]
disabled = true
impure_msg = "[impure shell](bold red)"
pure_msg = "[pure shell](bold green)"
format = 'via [☃️ $state( \($name\))](bold blue) '
NodeJS
The nodejs
module shows the currently installed version of NodeJS. By default the module will be shown if any of the following conditions are met:
- Le répertoire courant contient un fichier
package.json
- The current directory contains a
.node-version
file - The current directory contains a
node_modules
directory - The current directory contains a file with the
.js
,.mjs
or.cjs
extension - The current directory contains a file with the
.ts
extension
Options
Option | Défaut | Description |
---|---|---|
format |
"via [$symbol($version )]($style)" |
Format du module. |
symbol |
" " |
A format string representing the symbol of NodeJS. |
detect_extensions |
["js", "mjs", "cjs", "ts"] |
Which extensions should trigger this moudle. |
detect_files |
["package.json", ".node-version"] |
Which filenames should trigger this module. |
detect_folders |
["node_modules"] |
Which folders should trigger this module. |
style |
"bold green" |
Le style du module. |
disabled |
false |
Disables the nodejs module. |
not_capable_style |
bold red |
The style for the module when an engines property in Packages.json does not match the NodeJS version. |
Variables
Variable | Exemple | Description |
---|---|---|
version | v13.12.0 |
The version of node |
symbol | Reflète la valeur de l'option symbol |
|
style* | Reflète la valeur de l'option style |
*: This variable can only be used as a part of a style string
Exemple
# ~/.config/starship.toml
[nodejs]
format = "via [🤖 $version](bold green) "
OCaml
The ocaml
module shows the currently installed version of OCaml. By default the module will be shown if any of the following conditions are met:
- The current directory contains a file with
.opam
extension or_opam
directory - The current directory contains a
esy.lock
directory - The current directory contains a
dune
ordune-project
file - The current directory contains a
jbuild
orjbuild-ignore
file - The current directory contains a
.merlin
file - The current directory contains a file with
.ml
,.mli
,.re
or.rei
extension
Options
Option | Défaut | Description |
---|---|---|
format |
"via [$symbol($version )]($style)" |
The format string for the module. |
symbol |
"🐫 " |
The symbol used before displaying the version of OCaml. |
detect_extensions |
["opam", "ml", "mli", "re", "rei"] |
Which extensions should trigger this moudle. |
detect_files |
["dune", "dune-project", "jbuild", "jbuild-ignore", ".merlin"] |
Which filenames should trigger this module. |
detect_folders |
["_opam", "esy.lock"] |
Which folders should trigger this module. |
style |
"bold yellow" |
Le style du module. |
disabled |
false |
Disables the ocaml module. |
Variables
Variable | Exemple | Description |
---|---|---|
version | v4.10.0 |
The version of ocaml |
symbol | Reflète la valeur de l'option symbol |
|
style* | Reflète la valeur de l'option style |
*: This variable can only be used as a part of a style string
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 |
"☁️ " |
The symbol used before displaying the current OpenStack cloud. |
style |
"bold yellow" |
Le style du module. |
disabled |
false |
Disables the OpenStack module. |
Variables
Variable | Exemple | Description |
---|---|---|
cloud | corp |
The current OpenStack cloud |
project | dev |
The current OpenStack project |
symbol | Reflète la valeur de l'option symbol |
|
style* | Reflète la valeur de l'option style |
*: This variable can only be used as a part of a style string
Exemple
# ~/.config/starship.toml
[openstack]
format = "on [$symbol$cloud(\\($project\\))]($style) "
style = "bold yellow"
symbol = "☁️ "
Package Version
The package
module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports npm
, cargo
, poetry
, composer
, gradle
, julia
, mix
and helm
packages.
- npm – The
npm
package version is extracted from thepackage.json
present in the current directory - cargo – The
cargo
package version is extracted from theCargo.toml
present in the current directory - poetry – The
poetry
package version is extracted from thepyproject.toml
present in the current directory - composer – The
composer
package version is extracted from thecomposer.json
present in the current directory - gradle – The
gradle
package version is extracted from thebuild.gradle
present - julia - The package version is extracted from the
Project.toml
present - mix - The
mix
package version is extracted from themix.exs
present - helm - The
helm
chart version is extracted from theChart.yaml
present - maven - The
maven
package version is extracted from thepom.xml
present - meson - The
meson
package version is extracted from themeson.build
present
⚠️ The version being shown is that of the package whose source code is in your current directory, not your package manager.
Options
Option | Défaut | Description |
---|---|---|
format |
"is [$symbol$version]($style) " |
Format du module. |
symbol |
"📦 " |
The symbol used before displaying the version the package. |
style |
"bold 208" |
Le style du module. |
display_private |
false |
Enable displaying version for packages marked as private. |
disabled |
false |
Disables the package module. |
Variables
Variable | Exemple | Description |
---|---|---|
version | v1.0.0 |
The version of your package |
symbol | Reflète la valeur de l'option symbol |
|
style* | Reflète la valeur de l'option style |
*: This variable can only be used as a part of a style string
Exemple
# ~/.config/starship.toml
[package]
format = "via [🎁 $version](208 bold) "
Perl
The perl
module shows the currently installed version of Perl. By default the module will be shown if any of the following conditions are met:
- The current directory contains a
Makefile.PL
orBuild.PL
file - The current directory contains a
cpanfile
orcpanfile.snapshot
file - The current directory contains a
META.json
file orMETA.yml
file - The current directory contains a
.perl-version
file - The current directory contains a
.pl
,.pm
or.pod
Options
Option | Défaut | Description |
---|---|---|
format |
"via [$symbol($version )]($style)" |
The format string for the module. |
symbol |
"🐪 " |
The symbol used before displaying the version of Perl |
detect_extensions |
["pl", "pm", "pod"] |
Which extensions should trigger this moudle. |
detect_files |
["Makefile.PL", "Build.PL", "cpanfile", "cpanfile.snapshot", "META.json", "META.yml", ".perl-version"] |
Which filenames should trigger this module. |
detect_folders |
[] |
Which folders should trigger this module. |
style |
"bold 149" |
Le style du module. |
disabled |
false |
Disables the perl module. |
Variables
Variable | Exemple | Description |
---|---|---|
version | v5.26.1 |
The version of perl |
symbol | Reflète la valeur de l'option symbol |
|
style* | Reflète la valeur de l'option style |
Exemple
# ~/.config/starship.toml
[perl]
format = "via [🦪 $version]($style) "
PHP
The php
module shows the currently installed version of PHP. By default the module will be shown if any of the following conditions are met:
- Le répertoire courant contient un fichier
composer.json
- The current directory contains a
.php-version
file - The current directory contains a
.php
extension
Options
Option | Défaut | Description |
---|---|---|
format |
"via [$symbol($version )]($style)" |
Format du module. |
symbol |
"🐘 " |
The symbol used before displaying the version of PHP. |
detect_extensions |
["php"] |
Which extensions should trigger this moudle. |
detect_files |
["composer.json", ".php-version"] |
Which filenames should trigger this module. |
detect_folders |
[] |
Which folders should trigger this module. |
style |
"147 bold" |
Le style du module. |
disabled |
false |
Disables the php module. |
Variables
Variable | Exemple | Description |
---|---|---|
version | v7.3.8 |
The version of php |
symbol | Reflète la valeur de l'option symbol |
|
style* | Reflète la valeur de l'option style |
*: This variable can only be used as a part of a style string
Exemple
# ~/.config/starship.toml
[php]
format = "via [🔹 $version](147 bold) "
PureScript
The purescript
module shows the currently installed version of PureScript version. By default the module will be shown if any of the following conditions are met:
- Le répertoire courant contient un fichier
spago.dhall
- The current directory contains a file with the
.purs
extension
Options
Option | Défaut | Description |
---|---|---|
format |
"via [$symbol($version )]($style)" |
Format du module. |
symbol |
"<=> " |
Le symbole utilisé avant d'afficher la version de PureScript. |
detect_extensions |
["purs"] |
Which extensions should trigger this moudle. |
detect_files |
["spago.dhall"] |
Which filenames should trigger this module. |
detect_folders |
[] |
Which folders should trigger this module. |
style |
"bold white" |
Le style du module. |
disabled |
false |
Disables the purescript module. |
Variables
Variable | Exemple | Description |
---|---|---|
version | 0.13.5 |
The version of purescript |
symbol | Reflète la valeur de l'option symbol |
|
style* | Reflète la valeur de l'option style |
*: This variable can only be used as a part of a style string
Exemple
# ~/.config/starship.toml
[purescript]
format = "via [$symbol$version](bold white)"
Python
The python
module shows the currently installed version of Python and the current Python virtual environment if one is activated.
If pyenv_version_name
is set to true
, it will display the pyenv version name. Otherwise, it will display the version number from python --version
.
By default the module will be shown if any of the following conditions are met:
- The current directory contains a
.python-version
file - The current directory contains a
Pipfile
file - The current directory contains a
__init__.py
file - The current directory contains a
pyproject.toml
file - The current directory contains a
requirements.txt
file - The current directory contains a
setup.py
file - The current directory contains a
tox.ini
file - The current directory contains a file with the
.py
extension. - A virtual environment is currently activated
Options
Option | Défaut | Description |
---|---|---|
format |
'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\))]($style)' |
Format du module. |
symbol |
"🐍 " |
A format string representing the symbol of Python |
style |
"yellow bold" |
Le style du module. |
pyenv_version_name |
false |
Use pyenv to get Python version |
pyenv_prefix |
pyenv |
Prefix before pyenv version display, only used if pyenv is used |
python_binary |
["python", "python3, "python2"] |
Configures the python binaries that Starship should executes when getting the version. |
detect_extensions |
[".py"] |
Which extensions should trigger this moudle |
detect_files |
[".python-version", "Pipfile", "__init__.py", "pyproject.toml", "requirements.txt", "setup.py", "tox.ini"] |
Which filenames should trigger this module |
detect_folders |
[] |
Which folders should trigger this module |
disabled |
false |
Disables the python module. |
::: tip
The python_binary
variable accepts either a string or a list of strings. Starship will try executing each binary until it gets a result. Note you can only change the binary that Starship executes to get the version of Python not the arguments that are used.
The default values and order for python_binary
was chosen to first identify the Python version in a virtualenv/conda environments (which currently still add a python
, no matter if it points to python3
or python2
). This has the side effect that if you still have a system Python 2 installed, it may be picked up before any Python 3 (at least on Linux Distros that always symlink /usr/bin/python
to Python 2). If you do not work with Python 2 anymore but cannot remove the system Python 2, changing this to "python3"
will hide any Python version 2, see example below.
:::
Variables
Variable | Exemple | Description |
---|---|---|
version | "v3.8.1" |
The version of python |
symbol | "🐍 " |
Reflète la valeur de l'option symbol |
style | "yellow bold" |
Reflète la valeur de l'option style |
pyenv_prefix | "pyenv " |
Mirrors the value of option pyenv_prefix |
virtualenv | "venv" |
The current virtualenv name |
Exemple
# ~/.config/starship.toml
[python]
symbol = "👾 "
pyenv_version_name = true
# ~/.config/starship.toml
[python]
# Only use the `python3` binary to get the version.
python_binary = "python3"
# ~/.config/starship.toml
[python]
# Don't trigger for files with the py extension
detect_extensions = []
Ruby
By default the ruby
module shows the currently installed version of Ruby. The module will be shown if any of the following conditions are met:
- The current directory contains a
Gemfile
file - The current directory contains a
.ruby-version
file - The current directory contains a
.rb
file
Options
Option | Défaut | Description |
---|---|---|
format |
"via [$symbol($version )]($style)" |
Format du module. |
symbol |
"💎 " |
A format string representing the symbol of Ruby. |
detect_extensions |
["rb"] |
Which extensions should trigger this module. |
detect_files |
["Gemfile", ".ruby-version"] |
Which filenames should trigger this module. |
detect_folders |
[] |
Which folders should trigger this module. |
style |
"bold green" |
Le style du module. |
disabled |
false |
Disables the ruby module. |
Variables
Variable | Exemple | Description |
---|---|---|
version | v2.5.1 |
The version of ruby |
symbol | Reflète la valeur de l'option symbol |
|
style* | Reflète la valeur de l'option style |
*: This variable can only be used as a part of a style string
Exemple
# ~/.config/starship.toml
[ruby]
symbol = "🔺 "
Rust
By default the rust
module shows the currently installed version of Rust. The module will be shown if any of the following conditions are met:
- The current directory contains a
Cargo.toml
file - The current directory contains a file with the
.rs
extension
Options
Option | Défaut | Description |
---|---|---|
format |
"via [$symbol($version )]($style)" |
Format du module. |
symbol |
"🦀 " |
A format string representing the symbol of Rust |
detect_extensions |
["rs"] |
Which extensions should trigger this module. |
detect_files |
["Cargo.toml"] |
Which filenames should trigger this module. |
detect_folders |
[] |
Which folders should trigger this module. |
style |
"bold green" |
Le style du module. |
disabled |
false |
Disables the rust module. |
Variables
Variable | Exemple | Description |
---|---|---|
version | v1.43.0-nightly |
The version of rustc |
symbol | Reflète la valeur de l'option symbol |
|
style* | Reflète la valeur de l'option style |
*: This variable can only be used as a part of a style string
Exemple
# ~/.config/starship.toml
[rust]
format = "via [⚙️ $version](red bold)"
Scala
The scala
module shows the currently installed version of Scala. By default the module will be shown if any of the following conditions are met:
- The current directory contains a
build.sbt
,.scalaenv
or.sbtenv
file - The current directory contains a file with the
.scala
or.sbt
extension - The current directory contains a directory named
.metals
Options
Option | Défaut | Description |
---|---|---|
format |
"via [${symbol}(${version} )]($style)" |
Format du module. |
detect_extensions |
["sbt", "scala"] |
Which extensions should trigger this module. |
detect_files |
[".scalaenv", ".sbtenv", "build.sbt"] |
Which filenames should trigger this module. |
detect_folders |
[".metals"] |
Which folders should trigger this modules. |
symbol |
"🆂 " |
A format string representing the symbol of Scala. |
style |
"red dimmed" |
Le style du module. |
disabled |
false |
Disables the scala module. |
Variables
Variable | Exemple | Description |
---|---|---|
version | 2.13.5 |
The version of scala |
symbol | Reflète la valeur de l'option symbol |
|
style* | Reflète la valeur de l'option style |
*: This variable can only be used as a part of a style string
Exemple
# ~/.config/starship.toml
[scala]
symbol = "🌟 "
Shell
The shell
module shows an indicator for currently used shell.
::: tip
This module is disabled by default. To enable it, set disabled
to false
in your configuration file.
:::
Options
Option | Défaut | Description |
---|---|---|
bash_indicator |
bsh |
A format string used to represent bash. |
fish_indicator |
fsh |
A format string used to represent fish. |
zsh_indicator |
zsh |
A format string used to represent zsh. |
powershell_indicator |
psh |
A format string used to represent powershell. |
ion_indicator |
ion |
A format string used to represent ion. |
elvish_indicator |
esh |
A format string used to represent elvish. |
tcsh_indicator |
tsh |
A format string used to represent tcsh. |
format |
$indicator |
Format du module. |
disabled |
true |
Disables the shell module. |
Variables
Variable | Défaut | Description |
---|---|---|
indicator | Mirrors the value of indicator for currently used shell. |
Exemples
# ~/.config/starship.toml
[shell]
fish_indicator = ""
powershell_indicator = "_"
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 |
Disables the shlvl module. |
Variables
Variable | Exemple | Description |
---|---|---|
shlvl | 3 |
The current value of SHLVL |
symbol | Reflète la valeur de l'option symbol |
|
style* | Reflète la valeur de l'option style |
*: This variable can only be used as a part of a style string
Exemple
# ~/.config/starship.toml
[shlvl]
disabled = false
format = "$shlvl level(s) down"
threshold = 3
Singularity
The singularity
module shows the current singularity image, if inside a container and $SINGULARITY_NAME
is set.
Options
Option | Défaut | Description |
---|---|---|
format |
'[$symbol\[$env\]]($style) ' |
Format du module. |
symbol |
"" |
A format string displayed before the image name. |
style |
"bold dimmed blue" |
Le style du module. |
disabled |
false |
Disables the singularity module. |
Variables
Variable | Exemple | Description |
---|---|---|
env | centos.img |
The current singularity image |
symbol | Reflète la valeur de l'option symbol |
|
style* | Reflète la valeur de l'option style |
*: This variable can only be used as a part of a style string
Exemple
# ~/.config/starship.toml
[singularity]
format = '[📦 \[$env\]]($style) '
Status
The status
module displays the exit code of the previous command. The module will be shown only if the exit code is not 0
.
::: tip
This module is disabled by default. To enable it, set disabled
to false
in your configuration file.
:::
::: warning This module is not supported on elvish shell. :::
Options
Option | Défaut | Description |
---|---|---|
format |
"[$symbol$status]($style) " |
The format of the module |
symbol |
"✖" |
The symbol displayed on program error |
not_executable_symbol |
"🚫" |
The symbol displayed when file isn't executable |
not_found_symbol |
"🔍" |
The symbol displayed when the command can't be found |
sigint_symbol |
"🧱" |
The symbol displayed on SIGINT (Ctrl + c) |
signal_symbol |
"⚡" |
The symbol displayed on any signal |
style |
"bold green" |
Le style du module. |
recognize_signal_code |
true |
Enable signal mapping from exit code |
map_symbol |
false |
Enable symbols mapping from exit code |
disabled |
true |
Disables the status module. |
Variables
Variable | Exemple | Description |
---|---|---|
status | 127 |
The exit code of the last command |
int | 127 |
The exit code of the last command |
common_meaning | ERROR |
Meaning of the code if not a signal |
signal_number | 9 |
Signal number corresponding to the exit code, only if signalled |
signal_name | KILL |
Name of the signal corresponding to the exit code, only if signalled |
maybe_int | 7 |
Contains the exit code number when no meaning has been found |
symbol | Reflète la valeur de l'option symbol |
|
style* | Reflète la valeur de l'option style |
*: This variable can only be used as a part of a style string
Exemple
# ~/.config/starship.toml
[status]
style = "bg:blue"
symbol = "🔴"
format = '[\[$symbol $common_meaning$signal_name$maybe_int\]]($style) '
map_symbol = true
disabled = false
Swift
By default the swift
module shows the currently installed version of Swift. The module will be shown if any of the following conditions are met:
- The current directory contains a
Package.swift
file - The current directory contains a file with the
.swift
extension
Options
Option | Défaut | Description |
---|---|---|
format |
"via [$symbol($version )]($style)" |
Format du module. |
symbol |
"🐦 " |
A format string representing the symbol of Swift |
detect_extensions |
["swift"] |
Which extensions should trigger this moudle. |
detect_files |
["Package.swift"] |
Which filenames should trigger this module. |
detect_folders |
[] |
Which folders should trigger this module. |
style |
"bold 202" |
Le style du module. |
disabled |
false |
Disables the swift module. |
Variables
Variable | Exemple | Description |
---|---|---|
version | v5.2.4 |
The version of swift |
symbol | Reflète la valeur de l'option symbol |
|
style* | Reflète la valeur de l'option style |
*: This variable can only be used as a part of a style string
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.
:::
By default the module will be shown if any of the following conditions are met:
- The current directory contains a
.terraform
folder - Current directory contains a file with the
.tf
or.hcl
extensions
Options
Option | Défaut | Description |
---|---|---|
format |
"via [$symbol$workspace]($style) " |
The format string for the module. |
symbol |
"💠" |
A format string shown before the terraform workspace. |
detect_extensions |
["tf", "hcl"] |
Which extensions should trigger this module. |
detect_files |
[] |
Which filenames should trigger this module. |
detect_folders |
[".terraform"] |
Which folders should trigger this module. |
style |
"bold 105" |
Le style du module. |
disabled |
false |
Disables the terraform module. |
Variables
Variable | Exemple | Description |
---|---|---|
version | v0.12.24 |
The version of terraform |
workspace | défaut |
The current terraform workspace |
symbol | Reflète la valeur de l'option symbol |
|
style* | Reflète la valeur de l'option style |
*: This variable can only be used as a part of a style string
Exemple
With Version
# ~/.config/starship.toml
[terraform]
format = "[🏎💨 $version$workspace]($style) "
Without version
# ~/.config/starship.toml
[terraform]
format = "[🏎💨 $workspace]($style) "
Temps
The time
module shows the current local time. The format
configuration value is used by the chrono
crate to control how the time is displayed. Take a look at the chrono strftime docs to see what options are available.
::: tip
This module is disabled by default. To enable it, set disabled
to false
in your configuration file.
:::
Options
Option | Défaut | Description |
---|---|---|
format |
"at [$time]($style) " |
The format string for the module. |
use_12hr |
false |
Enables 12 hour formatting |
time_format |
see below | The chrono format string used to format the time. |
style |
"bold yellow" |
The style for the module time |
utc_time_offset |
"local" |
Sets the UTC offset to use. Range from -24 < x < 24. Allows floats to accommodate 30/45 minute timezone offsets. |
disabled |
true |
Disables the time module. |
time_range |
"-" |
Sets the time range during which the module will be shown. Times must be specified in 24-hours format |
If use_12hr
is true
, then time_format
defaults to "%r"
. Otherwise, it defaults to "%T"
. Manually setting time_format
will override the use_12hr
setting.
Variables
Variable | Exemple | Description |
---|---|---|
time | 13:08:10 |
The current time. |
style* | Reflète la valeur de l'option style |
*: This variable can only be used as a part of a style string
Exemple
# ~/.config/starship.toml
[time]
disabled = false
format = '🕙[\[ $time \]]($style) '
time_format = "%T"
utc_time_offset = "-5"
time_range = "10:00:00-14:00:00"
Username
The username
module shows active user's username. The module will be shown if any of the following conditions are met:
- The current user is root
- The current user isn't the same as the one that is logged in
- The user is currently connected as an SSH session
- The variable
show_always
is set to true
::: 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" |
The style used when the user is root. |
style_user |
"bold yellow" |
The style used for non-root users. |
format |
"[$user]($style) in " |
Format du module. |
show_always |
false |
Always shows the username module. |
disabled |
false |
Disables the username module. |
Variables
Variable | Exemple | Description |
---|---|---|
style |
"red bold" |
Mirrors the value of option style_root when root is logged in and style_user otherwise. |
user |
"matchai" |
The currently logged-in user ID. |
Exemple
# ~/.config/starship.toml
[username]
style_user = "white bold"
style_root = "black bold"
format = "user: [$user]($style) "
disabled = false
show_always = true
Vagrant
The vagrant
module shows the currently installed version of Vagrant. By default the module will be shown if any of the following conditions are met:
- The current directory contains a
Vagrantfile
file
Options
Option | Défaut | Description |
---|---|---|
format |
"via [$symbol($version )]($style)" |
Format du module. |
symbol |
"⍱ " |
A format string representing the symbol of Vagrant. |
detect_extensions |
[] |
Which extensions should trigger this module. |
detect_files |
["Vagrantfile"] |
Which filenames should trigger this module. |
detect_folders |
[] |
Which folders should trigger this module. |
style |
"cyan bold" |
Le style du module. |
disabled |
false |
Disables the Vagrant module. |
Variables
Variable | Exemple | Description |
---|---|---|
version | Vagrant 2.2.10 |
The version of Vagrant |
symbol | Reflète la valeur de l'option symbol |
|
style* | Reflète la valeur de l'option style |
*: This variable can only be used as a part of a style string
Exemple
# ~/.config/starship.toml
[vagrant]
format = "via [⍱ $version](bold white) "
Zig
By default the the zig
module shows the currently installed version of Zig. The module will be shown if any of the following conditions are met:
- The current directory contains a
.zig
file
Options
Option | Défaut | Description |
---|---|---|
symbol |
"↯ " |
The symbol used before displaying the version of Zig. |
style |
"bold yellow" |
Le style du module. |
format |
"via [$symbol($version )]($style)" |
Format du module. |
disabled |
false |
Disables the zig module. |
detect_extensions |
["zig"] |
Which extensions should trigger this module. |
detect_files |
[] |
Which filenames should trigger this module. |
detect_folders |
[] |
Which folders should trigger this module. |
Variables
Variable | Exemple | Description |
---|---|---|
version | v0.6.0 |
The version of zig |
symbol | Reflète la valeur de l'option symbol |
|
style* | Reflète la valeur de l'option style |
*: This variable can only be used as a part of a style string
Exemple
# ~/.config/starship.toml
[zig]
symbol = "⚡️ "
Custom commands
The custom
modules show the output of some arbitrary commands.
These modules will be shown if any of the following conditions are met:
- The current directory contains a file whose name is in
files
- The current directory contains a directory whose name is in
directories
- The current directory contains a file whose extension is in
extensions
- The
when
command returns 0
::: tip
Multiple custom modules can be defined by using a .
.
:::
::: tip
The order in which custom modules are shown can be individually set by including ${custom.foo}
in the top level format
(as it includes a dot, you need to use ${...}
). By default, the custom
module will simply show all custom modules in the order they were defined.
:::
::: tip
Issue #1252 contains examples of custom modules. If you have an interesting example not covered there, feel free to share it there!
:::
Options
Option | Défaut | Description |
---|---|---|
command |
The command whose output should be printed. The command will be passed on stdin to the shell. | |
when |
A shell command used as a condition to show the module. The module will be shown if the command returns a 0 status code. |
|
shell |
See below | |
description |
"<custom module>" |
The description of the module that is shown when running starship explain . |
files |
[] |
The files that will be searched in the working directory for a match. |
directories |
[] |
The directories that will be searched in the working directory for a match. |
extensions |
[] |
The extensions that will be searched in the working directory for a match. |
symbol |
"" |
The symbol used before displaying the command output. |
style |
"bold green" |
Le style du module. |
format |
"[$symbol($output )]($style)" |
Format du module. |
disabled |
false |
Disables this custom module. |
Variables
Variable | Description |
---|---|
output | The output of shell command in shell |
symbol | Reflète la valeur de l'option symbol |
style* | Reflète la valeur de l'option style |
*: This variable can only be used as a part of a style string
Commandes shell personnalisées
shell
accepts a non-empty list of strings, where:
- The first string is the path to the shell to use to execute the command.
- Other following arguments are passed to the shell.
If unset, it will fallback to STARSHIP_SHELL and then to "sh" on Linux, and "cmd /C" on Windows.
The command
will be passed in on stdin.
If shell
is not given or only contains one element and Starship detects PowerShell will be used, the following arguments will automatically be added: -NoProfile -Command -
. This behavior can be avoided by explicitly passing arguments to the shell, e.g.
shell = ["pwsh", "-Command", "-"]
::: warning Make sure your custom shell configuration exits gracefully
If you set a custom command, make sure that the default Shell used by starship will properly execute the command with a graceful exit (via the shell
option).
For example, PowerShell requires the -Command
parameter to execute a one liner. Omitting this parameter might throw starship into a recursive loop where the shell might try to load a full profile environment with starship itself again and hence re-execute the custom command, getting into a never ending loop.
Parameters similar to -NoProfile
in PowerShell are recommended for other shells as well to avoid extra loading time of a custom profile on every starship invocation.
Automatic detection of shells and proper parameters addition are currently implemented, but it's possible that not all shells are covered. Please open an issue with shell details and starship configuration if you hit such scenario.
:::
Exemple
# ~/.config/starship.toml
[custom.foo]
command = "echo foo" # shows output of command
files = ["foo"] # can specify filters
when = """ test "$HOME" == "$PWD" """
format = " transcending [$output]($style)"
[custom.time]
command = "time /T"
files = ["*.pst"]
shell = ["pwsh.exe", "-NoProfile", "-Command", "-"]