1164 lines
51 KiB
Markdown
1164 lines
51 KiB
Markdown
# Configuration
|
||
|
||
::: tip
|
||
|
||
🔥 La configuration est en train d'être travaillée. Beaucoup de nouvelles options de configuration seront disponibles dans les prochaines versions.
|
||
|
||
:::
|
||
|
||
Pour commencer à configurer starship, créez le fichier suivant : `~/.config/starship.toml`.
|
||
|
||
```sh
|
||
$ mkdir -p ~/.config && touch ~/.config/starship.toml
|
||
```
|
||
|
||
Toute la configuration de starship est effectuée dans ce fichier [TOML](https://github.com/toml-lang/toml) :
|
||
|
||
```toml
|
||
# N'écrivez pas une nouvelle ligne au début de la console
|
||
add_newline = false
|
||
|
||
# Remplacez le symbole "❯" dans la console avec "➜"
|
||
[character] # Le nom du module que nous configurons est "character"
|
||
symbol = "➜" # Le segment "symbol" est mis comme "➜"
|
||
|
||
# Désactivez le module package, le cachant complètement de la console
|
||
[package]
|
||
disabled = true
|
||
```
|
||
|
||
Vous pouvez changer l'emplacement du fichier de configuration `starship.toml` grâce à la variable d'environnement `STARSHIP_CONFIG`:
|
||
```sh
|
||
export STARSHIP_CONFIG=~/.starship
|
||
```
|
||
|
||
### 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.
|
||
|
||
**Segment**: Sous-composants plus petits qui composent un module. Par exemple, le segment "symbol" du module "nodejs" contient le caractère qui est affiché avant le numéro de version (⬢ par défaut).
|
||
|
||
Voici la représentation du module node. Dans l'exemple suivant, "symbol" et "version" sont des segments dans celui-ci. Chaque module a également un préfixe et un suffixe qui sont la couleur par défaut du terminal.
|
||
|
||
```
|
||
[prefix] [symbol] [version] [suffix]
|
||
"via " "⬢" "v10.4.1" ""
|
||
```
|
||
|
||
### 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é](/advanced-config/).
|
||
|
||
- `"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](https://i.stack.imgur.com/KTSQa.png) 27
|
||
- `"underline bg:#bf5700"` définit le texte en souligné sur un fond orange foncé
|
||
- `"bold italic fg:violet"` 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.
|
||
|
||
## Invite
|
||
|
||
Voici la liste des options de configuration de l'invite en lui-même.
|
||
|
||
### Options
|
||
|
||
| Variable | Default | Description |
|
||
| -------------- | ----------------------------- | ------------------------------------------------------------------------- |
|
||
| `add_newline` | `true` | Ajouter une nouvelle ligne avant le début de l'invite de commande. |
|
||
| `prompt_order` | [lien](#default-prompt-order) | Configurer l'ordre dans lequel les modules s'affichent. |
|
||
| `scan_timeout` | `30` | Délai d'attente pour que starship scanne les fichiers (en millisecondes). |
|
||
|
||
### Exemple
|
||
|
||
```toml
|
||
# ~/.config/starship.toml
|
||
|
||
# Disable the newline at the start of the prompt
|
||
add_newline = false
|
||
# Overwrite a default_prompt_order and use custom prompt_order
|
||
prompt_order=["rust","line_break","package","line_break","character"]
|
||
# Wait 10 milliseconds for starship to check files under the current directory.
|
||
scan_timeout = 10
|
||
```
|
||
|
||
### Ordre par défaut des modules
|
||
|
||
La valeur par défaut `prompt_order` est utilisée pour définir l'ordre selon lequel les modules sont affichés dans l'invite si aucun `prompt_order` n'est fourni ou s'il est vide. La valeur par défaut est la suivante :
|
||
|
||
```toml
|
||
prompt_order = [
|
||
"username",
|
||
"hostname",
|
||
"kubernetes",
|
||
"directory",
|
||
"git_branch",
|
||
"git_commit",
|
||
"git_state",
|
||
"git_status",
|
||
"hg_branch",
|
||
"package",
|
||
"dotnet",
|
||
"elixir",
|
||
"elm",
|
||
"golang",
|
||
"haskell",
|
||
"java",
|
||
"nodejs",
|
||
"php",
|
||
"python",
|
||
"ruby",
|
||
"rust",
|
||
"terraform",
|
||
"nix_shell",
|
||
"conda",
|
||
"memory_usage",
|
||
"aws",
|
||
"env_var",
|
||
"crystal",
|
||
"cmd_duration",
|
||
"line_break",
|
||
"jobs",
|
||
"battery",
|
||
"time",
|
||
"character",
|
||
]
|
||
```
|
||
|
||
## AWS
|
||
|
||
The `aws` module shows the current AWS region and profile. This is based on `AWS_REGION`, `AWS_DEFAULT_REGION`, and `AWS_PROFILE` env var with `~/.aws/config` file.
|
||
|
||
### Options
|
||
|
||
| Variable | Default | Description |
|
||
| ----------------- | --------------- | --------------------------------------------------------------------------- |
|
||
| `symbol` | `"☁️ "` | The symbol used before displaying the current AWS profile. |
|
||
| `displayed_items` | `all` | Choose which item to display. Possible values: [`all`, `profile`, `region`] |
|
||
| `region_aliases` | | Table of region aliases to display in addition to the AWS name. |
|
||
| `style` | `"bold yellow"` | The style for the module. |
|
||
| `disabled` | `false` | Disables the `AWS` module. |
|
||
|
||
### Exemple
|
||
|
||
```toml
|
||
# ~/.config/starship.toml
|
||
|
||
[aws]
|
||
style = "bold blue"
|
||
symbol = "🅰 "
|
||
displayed_items = "region"
|
||
[aws.region_aliases]
|
||
ap-southeast-2 = "au"
|
||
us-east-1 = "va"
|
||
```
|
||
|
||
## 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
|
||
|
||
| Variable | Default | Description |
|
||
| -------------------- | ------------------------ | ------------------------------------------------- |
|
||
| `full_symbol` | `"•"` | The symbol shown when the battery is full. |
|
||
| `charging_symbol` | `"⇡"` | The symbol shown when the battery is charging. |
|
||
| `discharging_symbol` | `"⇣"` | The symbol shown when the battery is discharging. |
|
||
| `display` | [lien](#battery-display) | Display threshold and style for the module. |
|
||
| `disabled` | `false` | Disables the `battery` module. |
|
||
|
||
<details>
|
||
<summary>There are also options for some uncommon battery states.</summary>
|
||
|
||
| Variable | Description |
|
||
| ---------------- | --------------------------------------------------- |
|
||
| `unknown_symbol` | The symbol shown when the battery state is unknown. |
|
||
| `empty_symbol` | The symbol shown when the battery state is empty. |
|
||
|
||
Note: Battery indicator will be hidden if the status is `unknown` or `empty` unless you specify the option in the config.
|
||
|
||
</details>
|
||
|
||
### Exemple
|
||
|
||
```toml
|
||
# ~/.config/starship.toml
|
||
|
||
[battery]
|
||
full_symbol = "🔋"
|
||
charging_symbol = "⚡️"
|
||
discharging_symbol = "💀"
|
||
```
|
||
|
||
### Battery Display
|
||
|
||
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 :
|
||
|
||
```toml
|
||
[[battery.display]]
|
||
threshold = 10
|
||
style = "bold red"
|
||
```
|
||
|
||
#### Options
|
||
|
||
The `display` option is an array of the following table.
|
||
|
||
| Variable | Description |
|
||
| ----------- | ----------------------------------------------- |
|
||
| `threshold` | The upper bound for the display option. |
|
||
| `style` | The style used if the display option is in use. |
|
||
|
||
#### Exemple
|
||
|
||
```toml
|
||
[[battery.display]] # "bold red" style when capacity is between 0% and 10%
|
||
threshold = 10
|
||
style = "bold red"
|
||
|
||
[[battery.display]] # "bold yellow" style when capacity is between 10% and 30%
|
||
threshold = 30
|
||
style = "bold yellow"
|
||
|
||
# when capacity is over 30%, the battery indicator will not be displayed
|
||
|
||
```
|
||
|
||
## Character
|
||
|
||
The `character` module shows a character (usually an arrow) beside where the text is entered in your terminal.
|
||
|
||
The character will tell you whether the last command was successful or not. It can do this in two ways: by changing color (red/green) or by changing its shape (❯/✖). The latter will only be done if `use_symbol_for_status` is set to `true`.
|
||
|
||
### Options
|
||
|
||
| Variable | Default | Description |
|
||
| ----------------------- | -------------- | ----------------------------------------------------------------------------------- |
|
||
| `symbol` | `"❯"` | The symbol used before the text input in the prompt. |
|
||
| `error_symbol` | `"✖"` | The symbol used before text input if the previous command failed. |
|
||
| `use_symbol_for_status` | `false` | Indicate error status by changing the symbol. |
|
||
| `vicmd_symbol` | `"❮"` | The symbol used before the text input in the prompt if shell is in vim normal mode. |
|
||
| `style_success` | `"bold green"` | The style used if the last command was successful. |
|
||
| `style_failure` | `"bold green"` | The style used if the last command failed. |
|
||
| `disabled` | `false` | Disables the `character` module. |
|
||
|
||
### Exemple
|
||
|
||
```toml
|
||
# ~/.config/starship.toml
|
||
|
||
[character]
|
||
symbol = "➜"
|
||
error_symbol = "✗"
|
||
use_symbol_for_status = true
|
||
```
|
||
|
||
## Command Duration
|
||
|
||
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](https://github.com/rcaloras/bash-preexec). Simply define the arrays `preexec_functions` and `precmd_functions` before running `eval $(starship init $0)`, and then proceed as normal.
|
||
|
||
### Options
|
||
|
||
| Variable | Default | Description |
|
||
| ------------------- | --------------- | ---------------------------------------------------------- |
|
||
| `min_time` | `2_000` | Shortest duration to show time for (in milliseconds). |
|
||
| `show_milliseconds` | `false` | Show milliseconds in addition to seconds for the duration. |
|
||
| `prefix` | `took` | Prefix to display immediately before the command duration. |
|
||
| `style` | `"bold yellow"` | The style for the module. |
|
||
| `disabled` | `false` | Disables the `cmd_duration` module. |
|
||
|
||
### Exemple
|
||
|
||
```toml
|
||
# ~/.config/starship.toml
|
||
|
||
[cmd_duration]
|
||
min_time = 500
|
||
prefix = "underwent "
|
||
```
|
||
|
||
## 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
|
||
|
||
| Variable | Default | Description |
|
||
| ------------------- | -------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||
| `truncation_length` | `1` | The number of directories the environment path should be truncated to, if the environment was created via `conda create -p [path]`. `0` means no truncation. Also see the [`directory`](#directory) module. |
|
||
| `symbol` | `"C "` | The symbol used before the environment name. |
|
||
| `style` | `"bold green"` | The style for the module. |
|
||
| `disabled` | `false` | Disables the `conda` module. |
|
||
|
||
### Exemple
|
||
|
||
```toml
|
||
# ~/.config/starship.toml
|
||
|
||
[conda]
|
||
style = "dimmed green"
|
||
```
|
||
|
||
## Crystal
|
||
|
||
The `crystal` module shows the currently installed version of Crystal. The module will be shown if any of the following conditions are met:
|
||
|
||
- The current directory contains a `shard.yml` file
|
||
- The current directory contains a `.cr` file
|
||
|
||
### Options
|
||
|
||
| Variable | Default | Description |
|
||
| ---------- | -------------- | --------------------------------------------------------- |
|
||
| `symbol` | `"🔮 "` | The symbol used before displaying the version of crystal. |
|
||
| `style` | `"bold green"` | The style for the module. |
|
||
| `disabled` | `false` | Disables the `crystal` module. |
|
||
|
||
### Exemple
|
||
|
||
```toml
|
||
# ~/.config/starship.toml
|
||
|
||
[crystal]
|
||
symbol = "✨ "
|
||
style = "bold blue"
|
||
```
|
||
|
||
## Directory
|
||
|
||
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
|
||
|
||
| Variable | Default | Description |
|
||
| ------------------- | ------------- | -------------------------------------------------------------------------------- |
|
||
| `truncation_length` | `3` | The number of parent folders that the current directory should be truncated to. |
|
||
| `truncate_to_repo` | `true` | Whether or not to truncate to the root of the git repo that you're currently in. |
|
||
| `prefix` | `"in "` | Prefix to display immediately before the directory. |
|
||
| `style` | `"bold cyan"` | The style for the module. |
|
||
| `disabled` | `false` | Disables the `directory` module. |
|
||
|
||
<details>
|
||
<summary>This module has a few advanced configuration options that control how the directory is displayed.</summary>
|
||
|
||
| Variable | Default | Description |
|
||
| --------------------------- | ------- | ---------------------------------------------------------------------------------------- |
|
||
| `fish_style_pwd_dir_length` | `0` | The number of characters to use when applying fish shell pwd path logic. |
|
||
| `use_logical_path` | `true` | Displays the logical path provided by the shell (`PWD`) instead of the path from the OS. |
|
||
|
||
`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`.
|
||
|
||
</details>
|
||
|
||
### Exemple
|
||
|
||
```toml
|
||
# ~/.config/starship.toml
|
||
|
||
[directory]
|
||
truncation_length = 8
|
||
```
|
||
|
||
## Dotnet
|
||
|
||
The `dotnet` module shows the relevant version of the .NET Core SDK for the current directory. If the SDK has been pinned in the current directory, the pinned version is shown. Otherwise the module shows the latest installed version of the SDK.
|
||
|
||
This module will only be shown in your prompt when one of the following files are present in the current directory: `global.json`, `project.json`, `*.sln`, `*.csproj`, `*.fsproj`, `*.xproj`. You'll also need the .NET Core command-line tools 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.
|
||
|
||
### Options
|
||
|
||
| Variable | Default | Description |
|
||
| ----------- | ------------- | -------------------------------------------------------- |
|
||
| `symbol` | `"•NET "` | The symbol used before displaying the version of dotnet. |
|
||
| `heuristic` | `true` | Use faster version detection to keep starship snappy. |
|
||
| `style` | `"bold blue"` | The style for the module. |
|
||
| `disabled` | `false` | Disables the `dotnet` module. |
|
||
|
||
### Exemple
|
||
|
||
```toml
|
||
# ~/.config/starship.toml
|
||
|
||
[dotnet]
|
||
symbol = "🥅 "
|
||
style = "green"
|
||
heuristic = false
|
||
```
|
||
|
||
## Elixir
|
||
|
||
The `elixir` module shows the currently installed version of Elixir and Erlang/OTP. The module will be shown if any of the following conditions are met:
|
||
|
||
- The current directory contains a `mix.exs` file.
|
||
|
||
### Options
|
||
|
||
| Variable | Default | Description |
|
||
| ---------- | ------- | --------------------------------------------------------------- |
|
||
| `symbol` | `"💧 "` | The symbol used before displaying the version of Elixir/Erlang. |
|
||
| `disabled` | `false` | Disables the `elixir` module. |
|
||
|
||
### Exemple
|
||
|
||
```toml
|
||
# ~/.config/starship.toml
|
||
|
||
[elixir]
|
||
symbol = "🔮 "
|
||
```
|
||
|
||
## Elm
|
||
|
||
The `elm` module shows the currently installed version of Elm. The module will be shown if any of the following conditions are met:
|
||
|
||
- The current directory contains a `elm.json` file
|
||
- The current directory contains a `elm-package.json` file
|
||
- The current directory contains a `elm-stuff` folder
|
||
- The current directory contains a `*.elm` files
|
||
|
||
### Options
|
||
|
||
| Variable | Default | Description |
|
||
| ---------- | ------------- | ----------------------------------------------------- |
|
||
| `symbol` | `"🌳 "` | The symbol used before displaying the version of Elm. |
|
||
| `style` | `"bold cyan"` | The style for the module. |
|
||
| `disabled` | `false` | Disables the `elm` module. |
|
||
|
||
|
||
### Exemple
|
||
|
||
```toml
|
||
# ~/.config/starship.toml
|
||
|
||
[elm]
|
||
symbol = " "
|
||
```
|
||
|
||
## Environment Variable
|
||
|
||
The `env_var` module displays the current value of a selected environment variable. The module will be shown only if any of the following conditions are met:
|
||
|
||
- The `variable` configuration option matches an existing environment variable
|
||
- The `variable` configuration option is not defined, but the `default` configuration option is
|
||
|
||
### Options
|
||
|
||
| Variable | Default | Description |
|
||
| ---------- | ---------------- | ---------------------------------------------------------------------------- |
|
||
| `symbol` | | The symbol used before displaying the variable value. |
|
||
| `variable` | | The environment variable to be displayed. |
|
||
| `default` | | The default value to be displayed when the selected variable is not defined. |
|
||
| `prefix` | `""` | Prefix to display immediately before the variable value. |
|
||
| `suffix` | `""` | Suffix to display immediately after the variable value. |
|
||
| `style` | `"dimmed black"` | The style for the module. |
|
||
| `disabled` | `false` | Disables the `env_var` module. |
|
||
|
||
### Exemple
|
||
|
||
```toml
|
||
# ~/.config/starship.toml
|
||
|
||
[env_var]
|
||
variable = "SHELL"
|
||
default = "unknown shell"
|
||
```
|
||
|
||
## Git Branch
|
||
|
||
The `git_branch` module shows the active branch of the repo in your current directory.
|
||
|
||
### Options
|
||
|
||
| Variable | Default | Description |
|
||
| ------------------- | --------------- | ------------------------------------------------------------------------------------- |
|
||
| `symbol` | `" "` | The symbol used before the branch name of the repo in your current directory. |
|
||
| `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 |
|
||
| `style` | `"bold purple"` | The style for the module. |
|
||
| `disabled` | `false` | Disables the `git_branch` module. |
|
||
|
||
### Exemple
|
||
|
||
```toml
|
||
# ~/.config/starship.toml
|
||
|
||
[git_branch]
|
||
symbol = "🌱 "
|
||
truncation_length = 4
|
||
truncation_symbol = ""
|
||
```
|
||
|
||
## Git Commit
|
||
|
||
The `git_commit` module shows the current commit hash of the repo in your current directory.
|
||
|
||
### Options
|
||
|
||
| Variable | Default | Description |
|
||
| -------------------- | -------------- | ----------------------------------------------------- |
|
||
| `commit_hash_length` | `7` | The length of the displayed git commit hash. |
|
||
| `prefix` | `"("` | Prefix to display immediately before git commit. |
|
||
| `suffix` | `")"` | Suffix to display immediately after git commit. |
|
||
| `style` | `"bold green"` | The style for the module. |
|
||
| `only_detached` | `true` | Only show git commit hash when in detached HEAD state |
|
||
| `disabled` | `false` | Disables the `git_commit` module. |
|
||
|
||
### Exemple
|
||
|
||
```toml
|
||
# ~/.config/starship.toml
|
||
|
||
[git_commit]
|
||
commit_hash_length = 4
|
||
```
|
||
|
||
## 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
|
||
|
||
| Variable | Default | Description |
|
||
| ------------------ | ------------------ | ---------------------------------------------------------------------------------------------------------------- |
|
||
| `rebase` | `"REBASING"` | The text displayed when a `rebase` is in progress. |
|
||
| `merge` | `"MERGING"` | The text displayed when a `merge` is in progress. |
|
||
| `revert` | `"REVERTING"` | The text displayed when a `revert` is in progress. |
|
||
| `cherry_pick` | `"CHERRY-PICKING"` | The text displayed when a `cherry-pick` is in progress. |
|
||
| `bisect` | `"BISECTING"` | The text displayed when a `bisect` is in progress. |
|
||
| `am` | `"AM"` | The text displayed when an `apply-mailbox` (`git am`) is in progress. |
|
||
| `am_or_rebase` | `"AM/REBASE"` | The text displayed when an ambiguous `apply-mailbox` or `rebase` is in progress. |
|
||
| `progress_divider` | `"/"` | The symbol or text which will separate the current and total progress amounts. (e.g., `" of "`, for `"3 of 10"`) |
|
||
| `style` | `"bold yellow"` | The style for the module. |
|
||
| `disabled` | `false` | Disables the `git_state` module. |
|
||
|
||
### Exemple
|
||
|
||
```toml
|
||
# ~/.config/starship.toml
|
||
|
||
[git_state]
|
||
progress_divider = " of "
|
||
cherry_pick = "🍒 PICKING"
|
||
```
|
||
|
||
## Git Status
|
||
|
||
The `git_status` module shows symbols representing the state of the repo in your current directory.
|
||
|
||
### Options
|
||
|
||
| Variable | Default | Description |
|
||
| ------------------ | -------------------------- | ------------------------------------------------------- |
|
||
| `conflicted` | `"="` | This branch has merge conflicts. |
|
||
| `conflicted_count` | [lien](#git-status-counts) | Show and style the number of conflicts. |
|
||
| `ahead` | `"⇡"` | This branch is ahead of the branch being tracked. |
|
||
| `behind` | `"⇣"` | This branch is behind of the branch being tracked. |
|
||
| `diverged` | `"⇕"` | This branch has diverged from the branch being tracked. |
|
||
| `untracked` | `"?"` | There are untracked files in the working directory. |
|
||
| `untracked_count` | [lien](#git-status-counts) | Show and style the number of untracked files. |
|
||
| `stashed` | `"$"` | A stash exists for the local repository. |
|
||
| `stashed_count` | [lien](#git-status-counts) | Show and style the number of stashes. |
|
||
| `modified` | `"!"` | There are file modifications in the working directory. |
|
||
| `modified_count` | [lien](#git-status-counts) | Show and style the number of modified files. |
|
||
| `staged` | `"+"` | A new file has been added to the staging area. |
|
||
| `staged_count` | [lien](#git-status-counts) | Show and style the number of files staged files. |
|
||
| `renamed` | `"»"` | A renamed file has been added to the staging area. |
|
||
| `renamed_count` | [lien](#git-status-counts) | Show and style the number of renamed files. |
|
||
| `deleted` | `"✘"` | A file's deletion has been added to the staging area. |
|
||
| `deleted_count` | [lien](#git-status-counts) | Show and style the number of deleted files. |
|
||
| `show_sync_count` | `false` | Show ahead/behind count of the branch being tracked. |
|
||
| `prefix` | `[` | Prefix to display immediately before git status. |
|
||
| `suffix` | `]` | Suffix to display immediately after git status. |
|
||
| `style` | `"bold green"` | The style for the module. |
|
||
| `disabled` | `false` | Disables the `git_status` module. |
|
||
|
||
#### Git Status Counts
|
||
|
||
| Variable | Default | Description |
|
||
| --------- | ------- | ------------------------------------------------------ |
|
||
| `enabled` | `false` | Show the number of files |
|
||
| `style` | | Optionally style the count differently than the module |
|
||
|
||
### Exemple
|
||
|
||
```toml
|
||
# ~/.config/starship.toml
|
||
|
||
[git_status]
|
||
conflicted = "🏳"
|
||
ahead = "🏎💨"
|
||
behind = "😰"
|
||
diverged = "😵"
|
||
untracked = "🤷"
|
||
stashed = "📦"
|
||
modified = "📝"
|
||
staged.value = "++"
|
||
staged.style = "green"
|
||
staged_count.enabled = true
|
||
staged_count.style = "green"
|
||
renamed = "👅"
|
||
deleted = "🗑"
|
||
```
|
||
|
||
## Golang
|
||
|
||
The `golang` module shows the currently installed version of Golang. The module will be shown if any of the following conditions are met:
|
||
|
||
- The current directory contains a `go.mod` file
|
||
- The current directory contains a `go.sum` file
|
||
- The current directory contains a `glide.yaml` file
|
||
- The current directory contains a `Gopkg.yml` file
|
||
- The current directory contains a `Gopkg.lock` file
|
||
- The current directory contains a `Godeps` directory
|
||
- The current directory contains a file with the `.go` extension
|
||
|
||
### Options
|
||
|
||
| Variable | Default | Description |
|
||
| ---------- | ------------- | -------------------------------------------------------- |
|
||
| `symbol` | `"🐹 "` | The symbol used before displaying the version of Golang. |
|
||
| `style` | `"bold cyan"` | The style for the module. |
|
||
| `disabled` | `false` | Disables the `golang` module. |
|
||
|
||
### Exemple
|
||
|
||
```toml
|
||
# ~/.config/starship.toml
|
||
|
||
[golang]
|
||
symbol = "🏎💨 "
|
||
```
|
||
## Haskell
|
||
|
||
The `haskell` module shows the currently installed version of Haskell Stack version. The module will be shown if any of the following conditions are met:
|
||
|
||
- The current directory contains a `stack.yaml` file
|
||
|
||
### Options
|
||
|
||
| Variable | Default | Description |
|
||
| ---------- | -------------- | --------------------------------------------------------- |
|
||
| `symbol` | `"λ "` | The symbol used before displaying the version of Haskell. |
|
||
| `style` | `"bold green"` | The style for the module. |
|
||
| `disabled` | `false` | Disables the `haskell` module. |
|
||
|
||
|
||
### Exemple
|
||
|
||
```toml
|
||
# ~/.config/starship.toml
|
||
|
||
[haskell]
|
||
symbol = " "
|
||
```
|
||
|
||
## Hostname
|
||
|
||
The `hostname` module shows the system hostname.
|
||
|
||
### Options
|
||
|
||
| Variable | Default | Description |
|
||
| ---------- | --------------------- | ------------------------------------------------------------------------------------------------------------------------------------ |
|
||
| `ssh_only` | `true` | Only show hostname when connected to an SSH session. |
|
||
| `prefix` | `""` | Prefix to display immediately before the hostname. |
|
||
| `suffix` | `""` | Suffix to display immediately after the hostname. |
|
||
| `trim_at` | `"."` | String that the hostname is cut off at, after the first match. `"."` will stop after the first dot. `""` will disable any truncation |
|
||
| `style` | `"bold dimmed green"` | The style for the module. |
|
||
| `disabled` | `false` | Disables the `hostname` module. |
|
||
|
||
### Exemple
|
||
|
||
```toml
|
||
# ~/.config/starship.toml
|
||
|
||
[hostname]
|
||
ssh_only = false
|
||
prefix = "⟪"
|
||
suffix = "⟫"
|
||
trim_at = ".companyname.com"
|
||
disabled = false
|
||
```
|
||
|
||
## Java
|
||
|
||
The `java` module shows the currently installed version of Java. The module will be shown if any of the following conditions are met:
|
||
|
||
- The current directory contains a `pom.xml`, `build.gradle.kts` or `build.sbt` file
|
||
- The current directory contains a file with the `.java`, `.class`, `.gradle` or `.jar` extension
|
||
|
||
### Options
|
||
|
||
| Variable | Default | Description |
|
||
| ---------- | -------------- | ------------------------------------------------------ |
|
||
| `symbol` | `"☕ "` | The symbol used before displaying the version of Java. |
|
||
| `style` | `"dimmed red"` | The style for the module. |
|
||
| `disabled` | `false` | Disables the `java` module. |
|
||
|
||
### Exemple
|
||
|
||
```toml
|
||
# ~/.config/starship.toml
|
||
|
||
[java]
|
||
symbol = "🌟 "
|
||
```
|
||
|
||
## Jobs
|
||
|
||
The `jobs` module shows the current number of jobs running. The module will be shown only if there are background jobs running. The module will show the number of jobs running if there is more than 1 job, or more than the `threshold` config value, if it exists.
|
||
|
||
### Options
|
||
|
||
| Variable | Default | Description |
|
||
| ----------- | ------------- | ----------------------------------------------------- |
|
||
| `symbol` | `"✦"` | The symbol used before displaying the number of jobs. |
|
||
| `threshold` | `1` | Show number of jobs if exceeded. |
|
||
| `style` | `"bold blue"` | The style for the module. |
|
||
| `disabled` | `false` | Disables the `jobs` module. |
|
||
|
||
### Exemple
|
||
|
||
```toml
|
||
# ~/.config/starship.toml
|
||
|
||
[jobs]
|
||
symbol = "+ "
|
||
threshold = 4
|
||
```
|
||
|
||
## Kubernetes
|
||
|
||
Displays the current Kubernetes context name and, if set, the namespace from the kubeconfig file. The namespace needs to be set in the kubeconfig file, this can be done via `kubectl config set-context starship-cluster --namespace astronaut`. If the `$KUBECONFIG` env var is set the module will use that if not it will use the `~/.kube/config`.
|
||
|
||
::: tip
|
||
|
||
Ce module est désactivé par défaut. Pour l'activer, configurez `disabled` sur `false` dans votre fichier de configuration.
|
||
|
||
:::
|
||
|
||
### Options
|
||
|
||
| Variable | Default | Description |
|
||
| ---------- | ------------- | --------------------------------------------------- |
|
||
| `symbol` | `"☸ "` | The symbol used before displaying the Cluster info. |
|
||
| `style` | `"bold blue"` | The style for the module. |
|
||
| `disabled` | `true` | Disables the `kubernetes` module |
|
||
|
||
### Exemple
|
||
|
||
```toml
|
||
# ~/.config/starship.toml
|
||
|
||
[kubernetes]
|
||
symbol = "⛵ "
|
||
style = "dimmed green"
|
||
disabled = false
|
||
```
|
||
|
||
## Line Break
|
||
|
||
The `line_break` module separates the prompt into two lines.
|
||
|
||
### Options
|
||
|
||
| Variable | Default | Description |
|
||
| ---------- | ------- | ------------------------------------------------------------------ |
|
||
| `disabled` | `false` | Disables the `line_break` module, making the prompt a single line. |
|
||
|
||
### Exemple
|
||
|
||
```toml
|
||
# ~/.config/starship.toml
|
||
|
||
[line_break]
|
||
disabled = true
|
||
```
|
||
|
||
## Memory Usage
|
||
|
||
The `memory_usage` module shows current system memory and swap usage.
|
||
|
||
By default the swap usage is displayed if the total system swap is non-zero.
|
||
|
||
::: tip
|
||
|
||
Ce module est désactivé par défaut. Pour l'activer, configurez `disabled` sur `false` dans votre fichier de configuration.
|
||
|
||
:::
|
||
|
||
### Options
|
||
|
||
| Variable | Default | Description |
|
||
| ----------------- | --------------------- | ------------------------------------------------------------- |
|
||
| `show_percentage` | `false` | Display memory usage as a percentage of the available memory. |
|
||
| `show_swap` | `true` | Display swap usage if total swap is non-zero. |
|
||
| `threshold` | `75` | Hide the memory usage unless it exceeds this percentage. |
|
||
| `symbol` | `"🐏 "` | The symbol used before displaying the memory usage. |
|
||
| `separator` | `" | "` | The symbol or text that will seperate the ram and swap usage. |
|
||
| `style` | `"bold dimmed white"` | The style for the module. |
|
||
| `disabled` | `true` | Disables the `memory_usage` module. |
|
||
|
||
### Exemple
|
||
|
||
```toml
|
||
# ~/.config/starship.toml
|
||
|
||
[memory_usage]
|
||
disabled = false
|
||
show_percentage = true
|
||
show_swap = true
|
||
threshold = -1
|
||
symbol = " "
|
||
separator = "/"
|
||
style = "bold dimmed green"
|
||
```
|
||
|
||
## Mercurial Branch
|
||
|
||
The `hg_branch` module shows the active branch of the repo in your current directory.
|
||
|
||
### Options
|
||
|
||
| Variable | Default | Description |
|
||
| ------------------- | --------------- | -------------------------------------------------------------------------------------------- |
|
||
| `symbol` | `" "` | The symbol used before the hg bookmark or branch name of the repo in your current directory. |
|
||
| `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. |
|
||
| `style` | `"bold purple"` | The style for the module. |
|
||
| `disabled` | `true` | Disables the `hg_branch` module. |
|
||
|
||
### Exemple
|
||
|
||
```toml
|
||
# ~/.config/starship.toml
|
||
|
||
[hg_branch]
|
||
symbol = "🌱 "
|
||
truncation_length = 4
|
||
truncation_symbol = ""
|
||
```
|
||
|
||
## Nix-shell
|
||
|
||
The `nix_shell` module shows the nix-shell environment. The module will be shown when inside a nix-shell environment.
|
||
|
||
### Options
|
||
|
||
| Variable | Default | Description |
|
||
| ------------ | -------------- | ---------------------------------- |
|
||
| `use_name` | `false` | Display the name of the nix-shell. |
|
||
| `impure_msg` | `"impure"` | Customize the "impure" msg. |
|
||
| `pure_msg` | `"pure"` | Customize the "pure" msg. |
|
||
| `style` | `"bold green"` | The style for the module. |
|
||
| `disabled` | `false` | Disables the `nix_shell` module. |
|
||
|
||
### Exemple
|
||
|
||
```toml
|
||
# ~/.config/starship.toml
|
||
|
||
[nix_shell]
|
||
disabled = true
|
||
use_name = true
|
||
impure_msg = "impure shell"
|
||
pure_msg = "pure shell"
|
||
```
|
||
|
||
## NodeJS
|
||
|
||
The `nodejs` module shows the currently installed version of NodeJS. The module will be shown if any of the following conditions are met:
|
||
|
||
- The current directory contains a `package.json` file
|
||
- The current directory contains a `node_modules` directory
|
||
- The current directory contains a file with the `.js` extension
|
||
|
||
### Options
|
||
|
||
| Variable | Default | Description |
|
||
| ---------- | -------------- | -------------------------------------------------------- |
|
||
| `symbol` | `"⬢ "` | The symbol used before displaying the version of NodeJS. |
|
||
| `style` | `"bold green"` | The style for the module. |
|
||
| `disabled` | `false` | Disables the `nodejs` module. |
|
||
|
||
### Exemple
|
||
|
||
```toml
|
||
# ~/.config/starship.toml
|
||
|
||
[nodejs]
|
||
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`, and `gradle` packages.
|
||
|
||
- **npm** – The `npm` package version is extracted from the `package.json` present in the current directory
|
||
- **cargo** – The `cargo` package version is extracted from the `Cargo.toml` present in the current directory
|
||
- **poetry** – The `poetry` package version is extracted from the `pyproject.toml` present in the current directory
|
||
- **composer** – The `composer` package version is extracted from the `composer.json` present in the current directory
|
||
- **gradle** – The `gradle` package version is extracted from the `build.gradle` present
|
||
|
||
> ⚠️ The version being shown is that of the package whose source code is in your current directory, not your package manager.
|
||
|
||
### Options
|
||
|
||
| Variable | Default | Description |
|
||
| ---------- | -------------- | ---------------------------------------------------------- |
|
||
| `symbol` | `"📦 "` | The symbol used before displaying the version the package. |
|
||
| `style` | `"bold green"` | The style for the module. |
|
||
| `disabled` | `false` | Disables the `package` module. |
|
||
|
||
### Exemple
|
||
|
||
```toml
|
||
# ~/.config/starship.toml
|
||
|
||
[package]
|
||
symbol = "🎁 "
|
||
```
|
||
|
||
## PHP
|
||
|
||
The `php` module shows the currently installed version of PHP. The module will be shown if any of the following conditions are met:
|
||
|
||
- The current directory contains a `composer.json` file
|
||
- The current directory contains a `.php` file
|
||
|
||
### Options
|
||
|
||
| Variable | Default | Description |
|
||
| ---------- | -------------- | ----------------------------------------------------- |
|
||
| `symbol` | `"🐘 "` | The symbol used before displaying the version of PHP. |
|
||
| `style` | `"bold green"` | The style for the module. |
|
||
| `disabled` | `false` | Disables the `php` module. |
|
||
|
||
### Exemple
|
||
|
||
```toml
|
||
# ~/.config/starship.toml
|
||
|
||
[php]
|
||
symbol = "🔹 "
|
||
```
|
||
|
||
## Python
|
||
|
||
The `python` module shows the currently installed version of Python.
|
||
|
||
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` and show the current Python virtual environment if one is activated.
|
||
|
||
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 `requirements.txt` file
|
||
- The current directory contains a `pyproject.toml` file
|
||
- The current directory contains a file with the `.py` extension
|
||
- The current directory contains a `Pipfile` file
|
||
- The current directory contains a `tox.ini` file
|
||
- A virtual environment is currently activated
|
||
|
||
### Options
|
||
|
||
| Variable | Default | Description |
|
||
| -------------------- | --------------- | --------------------------------------------------------------------------- |
|
||
| `symbol` | `"🐍 "` | The symbol used before displaying the version of Python. |
|
||
| `pyenv_version_name` | `false` | Use pyenv to get Python version |
|
||
| `pyenv_prefix` | `"pyenv "` | Prefix before pyenv version display (default display is `pyenv MY_VERSION`) |
|
||
| `style` | `"bold yellow"` | The style for the module. |
|
||
| `disabled` | `false` | Disables the `python` module. |
|
||
|
||
### Exemple
|
||
|
||
```toml
|
||
# ~/.config/starship.toml
|
||
|
||
[python]
|
||
symbol = "👾 "
|
||
pyenv_version_name = true
|
||
pyenv_prefix = "foo "
|
||
```
|
||
|
||
## Ruby
|
||
|
||
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 `.rb` file
|
||
|
||
### Options
|
||
|
||
| Variable | Default | Description |
|
||
| ---------- | -------------- | ------------------------------------------------------ |
|
||
| `symbol` | `"💎 "` | The symbol used before displaying the version of Ruby. |
|
||
| `style` | `"bold green"` | The style for the module. |
|
||
| `disabled` | `false` | Disables the `ruby` module. |
|
||
|
||
### Exemple
|
||
|
||
```toml
|
||
# ~/.config/starship.toml
|
||
|
||
[ruby]
|
||
symbol = "🔺 "
|
||
```
|
||
|
||
## Rust
|
||
|
||
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
|
||
|
||
| Variable | Default | Description |
|
||
| ---------- | -------------- | ------------------------------------------------------ |
|
||
| `symbol` | `"🦀 "` | The symbol used before displaying the version of Rust. |
|
||
| `style` | `"bold green"` | The style for the module. |
|
||
| `disabled` | `false` | Disables the `rust` module. |
|
||
|
||
### Exemple
|
||
|
||
```toml
|
||
# ~/.config/starship.toml
|
||
|
||
[rust]
|
||
symbol = "⚙️ "
|
||
```
|
||
|
||
## Singularity
|
||
|
||
The `singularity` module shows the current singularity image, if inside a container and `$SINGULARITY_NAME` is set.
|
||
|
||
:::
|
||
|
||
### Options
|
||
|
||
| Variable | Default | Description |
|
||
| ---------- | -------------------- | ------------------------------------------------ |
|
||
| `label` | `""` | Prefix before the image name display. |
|
||
| `prefix` | `"["` | Prefix to display immediately before image name. |
|
||
| `suffix` | `"]"` | Suffix to display immediately after image name. |
|
||
| `symbol` | `""` | The symbol used before the image name. |
|
||
| `style` | `"bold dimmed blue"` | The style for the module. |
|
||
| `disabled` | `false` | Disables the `singularity` module. |
|
||
|
||
### Exemple
|
||
|
||
```toml
|
||
# ~/.config/starship.toml
|
||
|
||
[singularity]
|
||
symbol = "📦 "
|
||
```
|
||
|
||
## Terraform
|
||
|
||
The `terraform` module shows the currently selected terraform workspace and version. By default the terraform version is not shown, since this is slow on current versions of terraform when a lot of plugins are in use. 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` extension
|
||
|
||
### Options
|
||
|
||
| Variable | Default | Description |
|
||
| -------------- | ------------ | ----------------------------------------------------------- |
|
||
| `symbol` | `"💠 "` | The symbol used before displaying the terraform workspace. |
|
||
| `show_version` | `false` | Shows the terraform version. Very slow on large workspaces. |
|
||
| `style` | `"bold 105"` | The style for the module. |
|
||
| `disabled` | `false` | Disables the `terraform` module. |
|
||
|
||
### Exemple
|
||
|
||
```toml
|
||
# ~/.config/starship.toml
|
||
|
||
[terraform]
|
||
symbol = "🏎💨 "
|
||
```
|
||
|
||
## Temps
|
||
|
||
Le module `time` affiche l'heure actuelle **localement**. La valeur de `format` est utilisée par le package [`chrono`](https://crates.io/crates/chrono) pour contrôler la façon dont l'heure est affichée. Consultez la [doc de chrono strftime](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) pour découvrir les options disponibles.
|
||
|
||
::: tip
|
||
|
||
Ce module est désactivé par défaut. Pour l'activer, configurez `disabled` sur `false` dans votre fichier de configuration.
|
||
|
||
:::
|
||
|
||
### Options
|
||
|
||
| Variable | Défault | Description |
|
||
| ----------------- | --------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||
| `use_12hr` | `false` | Activer le format 12h |
|
||
| `format` | voir plus bas | Le [format chrono](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) utilisé pour formater l'heure. |
|
||
| `style` | `"bold yellow"` | Le style utilisé par le module |
|
||
| `utc_time_offset` | `"local"` | Définir le décalage horaire UTC à utiliser. Intervalle de -24 < x < 24. Accepte des nombres décimaux pour s'adapter aux décalages de 30/45 minutes. |
|
||
| `disabled` | `true` | Désactiver le module `time`. |
|
||
|
||
Si `use_12hr` a pour valeur `true`, le `format` par défaut est `"%r"`. Sinon, il est défini comme `"%T"`. Définir manuellement le `format` passera outre la valeur de `user_12hr`.
|
||
|
||
### Exemple
|
||
|
||
```toml
|
||
# ~/.config/starship.toml
|
||
|
||
[time]
|
||
disabled = false
|
||
format = "🕙[ %T ]"
|
||
utc_time_offset = "-5"
|
||
```
|
||
|
||
## Nom d'utilisateur
|
||
|
||
Le module `username` affiche le nom d'utilisateur de l'utilisateur actif. Le module est affiché si l'une des ces conditions est remplie :
|
||
|
||
- L'utilisateur courant est root
|
||
- L'utilisateur courant est différent de celui connecté
|
||
- L'utilisateur est actuellement connecté à une session SSH
|
||
- La variable `show_always` a comme valeur true
|
||
|
||
### Options
|
||
|
||
| Variable | Défaut | Description |
|
||
| ------------- | --------------- | ------------------------------------------------ |
|
||
| `style_root` | `"bold red"` | Le style utilisé quand l'utilisateur est root. |
|
||
| `style_user` | `"bold yellow"` | Le style utilisé pour les utilisateurs non-root. |
|
||
| `show_always` | `false` | Toujours afficher le module `username`. |
|
||
| `disabled` | `false` | Désactiver le module `username`. |
|
||
|
||
### Exemple
|
||
|
||
```toml
|
||
# ~/.config/starship.toml
|
||
|
||
[username]
|
||
disabled = true
|
||
```
|