2019-07-19 22:18:52 +02:00
# Configuration
To get started configuring starship, create the following file: `~/.config/starship.toml` .
2020-02-07 18:36:23 +01:00
```sh
2021-03-31 17:31:55 +02:00
mkdir -p ~/.config & & starship print-config --default > ~/.config/starship.toml
2019-07-19 22:18:52 +02:00
```
All configuration for starship is done in this [TOML ](https://github.com/toml-lang/toml ) file:
2020-09-08 18:09:21 +02:00
2019-07-19 22:18:52 +02:00
```toml
2021-02-23 18:50:36 +01:00
# Inserts a blank line between shell prompts
add_newline = true
2019-07-28 00:25:13 +02:00
2019-08-18 17:34:45 +02:00
# Replace the "❯
2020-07-08 00:45:32 +02:00
[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"
2019-07-19 22:18:52 +02:00
# Disable the package module, hiding it from the prompt completely
[package]
disabled = true
```
2021-02-21 10:02:41 +01:00
You can change default configuration file location with `STARSHIP_CONFIG` environment variable:
2020-07-08 00:45:32 +02:00
2020-02-07 18:36:23 +01:00
```sh
2021-02-21 10:02:41 +01:00
export STARSHIP_CONFIG=~/.starship/config.toml
2020-01-04 20:20:07 +01:00
```
2020-05-21 18:22:45 +02:00
Equivalently in PowerShell (Windows) would be adding this line to your `$PROFILE` :
2020-07-08 00:45:32 +02:00
2021-01-14 21:48:06 +01:00
```powershell
2021-02-21 10:02:41 +01:00
$ENV:STARSHIP_CONFIG = "$HOME\.starship\config.toml"
2020-05-21 18:22:45 +02:00
```
2020-09-28 22:38:50 +02:00
### Logging
By default starship logs warnings and errors into a file named `~/.cache/starship/session_${STARSHIP_SESSION_KEY}.log` , where the session key is corresponding to a instance of your terminal.
This, however can be changed using the `STARSHIP_CACHE` environment variable:
```sh
export STARSHIP_CACHE=~/.starship/cache
```
Equivalently in PowerShell (Windows) would be adding this line to your `$PROFILE` :
2021-01-14 21:48:06 +01:00
```powershell
2020-09-28 22:38:50 +02:00
$ENV:STARSHIP_CACHE = "$HOME\AppData\Local\Temp"
```
2019-07-19 22:18:52 +02:00
### Terminology
**Module**: A component in the prompt giving information based on contextual information from your OS. For example, the "nodejs" module shows the version of NodeJS that is currently installed on your computer, if your current directory is a NodeJS project.
2020-12-18 18:24:48 +01:00
**Variable**: Smaller sub-components that contain information provided by the module. For example, the "version" variable in the "nodejs" module contains the current version of NodeJS.
2019-07-19 22:18:52 +02:00
2020-07-08 00:45:32 +02:00
By convention, most modules have a prefix of default terminal color (e.g. `via ` in "nodejs") and an empty space as a suffix.
2019-07-19 22:18:52 +02:00
2020-07-08 00:45:32 +02:00
### Format Strings
Format strings are the format that a module prints all its variables with.
Most modules have an entry called `format` that configures the display format of the module.
You can use texts, variables and text groups in a format string.
#### Variable
A variable contains a `$` symbol followed by the name of the variable.
The name of a variable only contains letters, numbers and `_` .
For example:
- `$version` is a format string with a variable named `version` .
- `$git_branch$git_commit` is a format string with two variables named `git_branch` and `git_commit` .
- `$git_branch $git_commit` has the two variables separated with a space.
#### Text Group
A text group is made up of two different parts.
The first part, which is enclosed in a `[]` , is a [format string ](#format-strings ).
You can add texts, variables, or even nested text groups in it.
In the second part, which is enclosed in a `()` , is a [style string ](#style-strings ). This can be used style the first part.
2019-07-19 22:18:52 +02:00
2020-07-08 00:45:32 +02:00
For example:
- `[on](red bold)` will print a string `on` with bold text colored red.
2021-02-22 21:10:36 +01:00
- `[⌘ $version](bold green)` will print a symbol `⌘ ` followed by the content of variable `version` , with bold text colored green.
2020-07-08 00:45:32 +02:00
- `[a [b](red) c](green)` will print `a b c` with `b` red, and `a` and `c` green.
#### Style Strings
2019-09-08 02:33:06 +02:00
Most modules in starship allow you to configure their display styles. This is done with an entry (usually called `style` ) which is a string specifying the configuration. Here are some examples of style strings along with what they do. For details on the full syntax, consult the [advanced config guide ](/advanced-config/ ).
- `"fg:green bg:blue"` sets green text on a blue background
- `"bg:blue fg:bright-green"` sets bright green text on a blue background
- `"bold fg:27"` sets bold text with [ANSI color ](https://i.stack.imgur.com/KTSQa.png ) 27
- `"underline bg:#bf5700"` sets underlined text on a burnt orange background
2019-09-12 23:10:42 +02:00
- `"bold italic fg:purple"` sets bold italic purple text
2019-09-08 02:33:06 +02:00
- `""` explicitly disables all styling
2019-09-12 23:10:42 +02:00
Note that what styling looks like will be controlled by your terminal emulator. For example, some terminal emulators will brighten the colors instead of bolding text, and some color themes use the same values for the normal and bright colors. Also, to get italic text, your terminal must support italics.
2019-09-08 02:33:06 +02:00
2020-07-08 00:45:32 +02:00
#### Conditional Format Strings
A conditional format string wrapped in `(` and `)` will not render if all variables inside are empty.
For example:
- `(@$region)` will show nothing if the variable `region` is `None` , otherwise `@` followed by the value of region.
- `(some text)` will always show nothing since there are no variables wrapped in the braces.
- When `$all` is a shortcut for `\[$a$b\] ` , `($all)` will show nothing only if `$a` and `$b` are both `None` .
This works the same as `(\[$a$b\] )` .
#### Escapable characters
The following symbols have special usage in a format string.
If you want to print the following symbols, you have to escape them with a backslash (`\`).
2020-09-08 18:09:21 +02:00
- \$
2020-07-08 00:45:32 +02:00
- \\
- [
- ]
- (
- )
Note that `toml` has [its own escape syntax ](https://github.com/toml-lang/toml#user-content-string ).
It is recommended to use a literal string (`''`) in your config.
If you want to use a basic string (`""`), pay attention to escape the backslash `\` .
For example, when you want to print a `$` symbol on a new line, the following configs for `format` are equivalent:
```toml
# with basic string
format = "\n\\$"
# with multiline basic string
format = """
\\$"""
# with literal string
format = '''
\$'''
```
2019-07-28 00:25:13 +02:00
## Prompt
This is the list of prompt-wide configuration options.
### Options
2021-04-18 19:32:00 +02:00
| Option | Default | Description |
| ----------------- | ------------------------------ | ------------------------------------------------------------ |
| `format` | [link ](#default-prompt-format ) | Configure the format of the prompt. |
| `scan_timeout` | `30` | Timeout for starship to scan files (in milliseconds). |
| `command_timeout` | `500` | Timeout for commands executed by starship (in milliseconds). |
| `add_newline` | `true` | Inserts blank line between shell prompts. |
2019-07-28 00:25:13 +02:00
### Example
```toml
# ~/.config/starship.toml
2020-07-08 00:45:32 +02:00
# Use custom format
format = """
[┌───────────────────> ](bold green )
[│ ](bold green )$directory$rust$package
[└─> ](bold green ) """
2019-10-28 14:41:16 +01:00
# Wait 10 milliseconds for starship to check files under the current directory.
scan_timeout = 10
2020-08-18 18:58:29 +02:00
2021-02-23 18:50:36 +01:00
# Disable the blank line at the start of the prompt
2020-08-18 18:58:29 +02:00
add_newline = false
2019-07-28 00:25:13 +02:00
```
2020-07-08 00:45:32 +02:00
### Default Prompt Format
2019-08-29 19:09:36 +02:00
2020-07-08 00:45:32 +02:00
The default `format` is used to define the format of the prompt, if empty or no `format` is provided. The default is as shown:
2019-08-29 19:09:36 +02:00
2019-09-13 16:24:07 +02:00
```toml
2020-08-18 18:58:29 +02:00
format = "$all"
2020-07-08 00:45:32 +02:00
# Which is equivalent to
format = """
$username\
$hostname\
2020-08-05 18:30:01 +02:00
$shlvl\
2020-07-08 00:45:32 +02:00
$kubernetes\
$directory\
2021-03-28 17:48:15 +02:00
$vcsh\
2020-07-08 00:45:32 +02:00
$git_branch\
$git_commit\
$git_state\
$git_status\
$hg_branch\
$docker_context\
$package\
2020-07-09 21:40:33 +02:00
$cmake\
2020-07-29 17:38:23 +02:00
$dart\
2021-04-15 15:22:12 +02:00
$deno\
2020-07-08 00:45:32 +02:00
$dotnet\
$elixir\
$elm\
$erlang\
$golang\
2020-07-17 09:51:25 +02:00
$helm\
2020-07-08 00:45:32 +02:00
$java\
$julia\
2020-12-26 15:26:50 +01:00
$kotlin\
2020-07-08 00:45:32 +02:00
$nim\
$nodejs\
$ocaml\
2020-08-04 18:22:44 +02:00
$perl\
2020-07-08 00:45:32 +02:00
$php\
$purescript\
$python\
2021-04-20 18:31:47 +02:00
$red\
2020-07-08 00:45:32 +02:00
$ruby\
$rust\
2021-03-14 20:37:00 +01:00
$scala\
2020-07-29 17:36:49 +02:00
$swift\
2020-07-08 00:45:32 +02:00
$terraform\
2021-01-30 12:05:16 +01:00
$vagrant\
2020-07-08 00:45:32 +02:00
$zig\
$nix_shell\
$conda\
$memory_usage\
$aws\
2020-08-03 23:30:20 +02:00
$gcloud\
2020-10-24 11:46:43 +02:00
$openstack\
2020-07-08 00:45:32 +02:00
$env_var\
$crystal\
$custom\
2020-12-05 19:57:22 +01:00
$cmd_duration\
2020-07-08 00:45:32 +02:00
$line_break\
2020-10-27 19:05:20 +01:00
$lua\
2020-07-08 00:45:32 +02:00
$jobs\
$battery\
$time\
2020-09-26 00:04:51 +02:00
$status\
2021-02-20 15:40:49 +01:00
$shell\
2020-07-08 00:45:32 +02:00
$character"""
2019-08-19 06:35:11 +02:00
```
2019-09-26 04:55:47 +02:00
## AWS
2019-10-14 17:05:03 +02:00
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.
2019-09-26 04:55:47 +02:00
2020-04-06 16:59:56 +02:00
When using [aws-vault ](https://github.com/99designs/aws-vault ) the profile
is read from the `AWS_VAULT` env var.
2021-03-13 09:35:50 +01:00
When using [awsu ](https://github.com/kreuzwerker/awsu ) the profile
is read from the `AWSU_PROFILE` env var.
2021-04-20 18:35:07 +02:00
When using [AWSume ](https://awsu.me ) the profile
is read from the `AWSUME_PROFILE` env var.
2019-09-26 04:55:47 +02:00
### Options
2021-04-16 22:51:37 +02:00
| Option | Default | Description |
| ---------------- | ------------------------------------------------- | --------------------------------------------------------------- |
2021-03-06 20:47:06 +01:00
| `format` | `'on [$symbol($profile )(\($region\) )]($style)'` | The format for the module. |
2021-04-16 22:51:37 +02:00
| `symbol` | `"☁️ "` | The symbol used before displaying the current AWS profile. |
| `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. |
2019-09-26 04:55:47 +02:00
2020-07-08 00:45:32 +02:00
### Variables
| Variable | Example | Description |
| -------- | ---------------- | ------------------------------------ |
| region | `ap-northeast-1` | The current AWS region |
| profile | `astronauts` | The current AWS profile |
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
### Examples
#### Display everything
```toml
# ~/.config/starship.toml
[aws]
2021-03-06 20:47:06 +01:00
format = 'on [$symbol($profile )(\($region\) ) ]($style )'
2020-07-08 00:45:32 +02:00
style = "bold blue"
symbol = "🅰 "
[aws.region_aliases]
ap-southeast-2 = "au"
us-east-1 = "va"
```
#### Display region
2019-09-26 04:55:47 +02:00
```toml
# ~/.config/starship.toml
[aws]
2020-07-08 00:45:32 +02:00
format = "on [$symbol$region ]($style ) "
2019-09-26 04:55:47 +02:00
style = "bold blue"
symbol = "🅰 "
2019-12-20 18:30:47 +01:00
[aws.region_aliases]
ap-southeast-2 = "au"
us-east-1 = "va"
2019-09-26 04:55:47 +02:00
```
2020-07-08 00:45:32 +02:00
#### Display profile
```toml
# ~/.config/starship.toml
[aws]
format = "on [$symbol$profile ]($style ) "
style = "bold blue"
symbol = "🅰 "
```
2019-07-19 22:18:52 +02:00
## 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
2021-01-01 12:16:55 +01:00
| Option | Default | Description |
| -------------------- | --------------------------------- | --------------------------------------------------- |
2021-04-03 13:10:45 +02:00
| `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. |
| `unknown_symbol` | `" "` | The symbol shown when the battery state is unknown. |
| `empty_symbol` | `" "` | The symbol shown when the battery state is empty. |
2021-01-01 12:16:55 +01:00
| `format` | `"[$symbol$percentage]($style) "` | The format for the module. |
| `display` | [link ](#battery-display ) | Display threshold and style for the module. |
| `disabled` | `false` | Disables the `battery` module. |
2019-07-19 22:18:52 +02:00
### Example
```toml
# ~/.config/starship.toml
[battery]
2021-04-03 13:10:45 +02:00
full_symbol = "🔋 "
charging_symbol = "⚡️ "
discharging_symbol = "💀 "
2019-07-19 22:18:52 +02:00
```
2019-09-12 20:06:59 +02:00
### Battery Display
2021-04-17 13:52:46 +02:00
The `display` configuration option is used to define when the battery indicator should be shown (threshold), which symbol would be used (symbol), and what it would like (style).
2019-09-12 20:06:59 +02:00
If no `display` is provided. The default is as shown:
```toml
[[battery.display]]
threshold = 10
style = "bold red"
```
2021-04-17 13:52:46 +02:00
The default value for the `charging_symbol` and `discharging_symbol` option is respectively the value of `battery` 's `charging_symbol` and `discharging_symbol` option.
2019-09-12 20:06:59 +02:00
#### Options
The `display` option is an array of the following table.
2021-04-17 13:52:46 +02:00
| Option | Default | Description |
| -------------------- | ---------- | ----------------------------------------------- |
| `threshold` | `10` | The upper bound for the display option. |
| `style` | `bold red` | The style used if the display option is in use. |
| `charging_symbol` | `-` | Optional symbol displayed if display option is in use, defaults to battery's `charging_symbol` option. |
| `discharging_symbol` | `-` | Optional symbol displayed if display option is in use, defaults to battery's `discharging_symbol` option. |
2019-09-12 20:06:59 +02:00
#### Example
```toml
2021-04-17 13:52:46 +02:00
[[battery.display]] # "bold red" style and discharging_symbol when capacity is between 0% and 10%
2019-09-12 20:06:59 +02:00
threshold = 10
style = "bold red"
2021-04-17 13:52:46 +02:00
[[battery.display]] # "bold yellow" style and 💦 symbol when capacity is between 10% and 30%
2019-09-12 20:06:59 +02:00
threshold = 30
style = "bold yellow"
2021-04-17 13:52:46 +02:00
discharging_symbol = 💦
2019-09-12 20:06:59 +02:00
# when capacity is over 30%, the battery indicator will not be displayed
```
2019-07-19 22:18:52 +02:00
## Character
The `character` module shows a character (usually an arrow) beside where the text
is entered in your terminal.
2019-08-17 22:38:20 +02:00
The character will tell you whether the last command was successful or not. It
2020-07-08 00:45:32 +02:00
can do this in two ways:
- changing color (`red`/`green`)
- changing shape (`❯
By default it only changes color. If you also want to change it's shape take a
look at [this example ](#with-custom-error-shape ).
2021-02-07 22:18:52 +01:00
2021-02-02 12:59:55 +01:00
::: warning
`error_symbol` is not supported on elvish shell.
:::
2019-07-19 22:18:52 +02:00
### Options
2020-07-08 00:45:32 +02:00
| Option | Default | Description |
| ---------------- | ------------------- | -------------------------------------------------------------------------------- |
| `format` | `"$symbol "` | The format string used before the text input. |
| `success_symbol` | `"[❯ | The format string used before the text input if the previous command succeeded. |
| `error_symbol` | `"[❯ | The format string used before the text input if the previous command failed. |
| `vicmd_symbol` | `"[❮ | The format string used before the text input if the shell is in vim normal mode. |
| `disabled` | `false` | Disables the `character` module. |
2019-07-19 22:18:52 +02:00
2020-07-08 00:45:32 +02:00
### Variables
| Variable | Example | Description |
| -------- | ------- | --------------------------------------------------------------------- |
| symbol | | A mirror of either `success_symbol` , `error_symbol` or `vicmd_symbol` |
### Examples
#### With custom error shape
```toml
# ~/.config/starship.toml
[character]
success_symbol = "[➜](bold green) "
error_symbol = "[✗](bold red) "
```
#### Without custom error shape
```toml
# ~/.config/starship.toml
[character]
success_symbol = "[➜](bold green) "
error_symbol = "[➜](bold red) "
```
#### With custom vim shape
2019-07-19 22:18:52 +02:00
```toml
# ~/.config/starship.toml
[character]
2020-07-08 00:45:32 +02:00
vicmd_symbol = "[V](bold green) "
2019-07-19 22:18:52 +02:00
```
2020-07-09 21:40:33 +02:00
## CMake
2021-02-13 11:38:47 +01:00
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:
2020-07-09 21:40:33 +02:00
- The current directory contains a `CMakeLists.txt` file
2020-10-25 19:10:42 +01:00
- The current directory contains a `CMakeCache.txt` file
2020-07-09 21:40:33 +02:00
### Options
2021-02-13 11:38:47 +01:00
| Option | Default | Description |
| ------------------- | -------------------------------------- | -------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
2021-04-16 22:51:37 +02:00
| `symbol` | `"△ "` | The symbol used before the version of cmake. |
2021-03-25 14:46:46 +01:00
| `detect_extensions` | `[]` | Which extensions should trigger this module |
2021-02-13 11:38:47 +01:00
| `detect_files` | `["CMakeLists.txt", "CMakeCache.txt"]` | Which filenames should trigger this module |
| `detect_folders` | `[]` | Which folders should trigger this module |
| `style` | `"bold blue"` | The style for the module. |
| `disabled` | `false` | Disables the `cmake` module. |
2020-07-09 21:40:33 +02:00
### Variables
| Variable | Example | Description |
| -------- | --------- | ------------------------------------ |
| version | `v3.17.3` | The version of cmake |
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
2019-08-08 19:25:30 +02:00
## Command Duration
The `cmd_duration` module shows how long the last command took to execute.
2019-09-25 10:13:58 +02:00
The module will be shown only if the command took longer than two seconds, or
2019-08-08 19:25:30 +02:00
the `min_time` config value, if it exists.
2019-08-17 22:38:20 +02:00
::: warning Do not hook the DEBUG trap in Bash
2019-09-28 13:20:18 +02:00
2019-08-14 04:49:47 +02:00
If you are running Starship in `bash` , do not hook the `DEBUG` trap after running
`eval $(starship init $0)` , or this module **will** break.
2019-09-28 13:20:18 +02:00
2019-08-08 19:25:30 +02:00
:::
2019-08-14 04:49:47 +02:00
Bash users who need preexec-like functionality can use
[rcaloras's bash_preexec framework ](https://github.com/rcaloras/bash-preexec ).
2019-08-17 22:38:20 +02:00
Simply define the arrays `preexec_functions` and `precmd_functions` before
2019-08-14 04:49:47 +02:00
running `eval $(starship init $0)` , and then proceed as normal.
2019-08-08 19:25:30 +02:00
### Options
2020-07-08 00:45:32 +02:00
| Option | 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. |
| `format` | `"took [$duration]($style) "` | The format for the module. |
| `style` | `"bold yellow"` | The style for the module. |
| `disabled` | `false` | Disables the `cmd_duration` module. |
2020-11-04 18:53:51 +01:00
| `show_notifications` | `false` | Show desktop notifications when command completes. |
| `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` .
:::
2020-07-08 00:45:32 +02:00
### Variables
| Variable | Example | Description |
| -------- | -------- | --------------------------------------- |
| duration | `16m40s` | The time it took to execute the command |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
2019-08-08 19:25:30 +02:00
### Example
```toml
# ~/.config/starship.toml
[cmd_duration]
2019-12-19 23:38:06 +01:00
min_time = 500
2020-07-08 00:45:32 +02:00
format = "underwent [$duration ](bold yellow )"
2019-08-08 19:25:30 +02:00
```
2019-10-05 20:25:25 +02:00
## Conda
The `conda` module shows the current conda environment, if `$CONDA_DEFAULT_ENV` is set.
2019-12-09 18:59:02 +01:00
::: tip
This does not suppress conda's own prompt modifier, you may want to run `conda config --set changeps1 False` .
:::
2019-10-05 20:25:25 +02:00
### Options
2021-04-16 22:51:37 +02:00
| Option | 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` | `"🅒 "` | The symbol used before the environment name. |
| `style` | `"bold green"` | The style for the module. |
2020-12-06 21:02:15 +01:00
| `format` | `"via [$symbol$environment]($style) "` | The format for the module. |
2021-04-16 22:51:37 +02:00
| `ignore_base` | `true` | Ignores `base` environment when activated. |
| `disabled` | `false` | Disables the `conda` module. |
2020-07-08 00:45:32 +02:00
### Variables
| Variable | Example | Description |
| ----------- | ------------ | ------------------------------------ |
| environment | `astronauts` | The current conda environment |
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
2019-10-05 20:25:25 +02:00
### Example
```toml
# ~/.config/starship.toml
[conda]
2020-07-08 00:45:32 +02:00
format = "[$symbol$environment](dimmed green) "
2019-10-05 20:25:25 +02:00
```
2020-03-16 02:07:08 +01:00
## Crystal
The `crystal` module shows the currently installed version of Crystal.
2021-02-14 18:14:55 +01:00
By default the module will be shown if any of the following conditions are met:
2020-03-16 02:07:08 +01:00
- The current directory contains a `shard.yml` file
- The current directory contains a `.cr` file
### Options
2021-02-14 18:14:55 +01:00
| Option | Default | Description |
| ------------------- | ------------------------------------ | --------------------------------------------------------- |
| `symbol` | `"🔮 "` | The symbol used before displaying the version of crystal. |
| `style` | `"bold red"` | The style for the 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)"` | The format for the module. |
| `disabled` | `false` | Disables the `crystal` module. |
2020-07-08 00:45:32 +02:00
### Variables
| Variable | Example | Description |
| -------- | --------- | ------------------------------------ |
| version | `v0.32.1` | The version of `crystal` |
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
2020-03-16 02:07:08 +01:00
### Example
```toml
# ~/.config/starship.toml
[crystal]
2020-07-08 00:45:32 +02:00
format = "via [✨ $version ](bold blue ) "
2020-03-16 02:07:08 +01:00
```
2020-07-29 17:38:23 +02:00
## Dart
The `dart` module shows the currently installed version of Dart.
2021-02-14 22:21:52 +01:00
By default the module will be shown if any of the following conditions are met:
2020-07-29 17:38:23 +02:00
- The current directory contains a file with `.dart` extension
- The current directory contains a `.dart_tool` directory
2021-02-14 22:21:52 +01:00
- The current directory contains a `pubspec.yaml` , `pubspec.yml` or `pubspec.lock` file
2020-07-29 17:38:23 +02:00
### Options
2021-02-14 22:21:52 +01:00
| Option | Default | Description |
| ------------------- | ------------------------------------------------- | ----------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"🎯 "` | A format string representing the symbol of Dart |
2021-03-25 14:46:46 +01:00
| `detect_extensions` | `['dart']` | Which extensions should trigger this module. |
2021-02-14 22:21:52 +01:00
| `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"` | The style for the module. |
| `disabled` | `false` | Disables the `dart` module. |
2020-07-29 17:38:23 +02:00
### Variables
| Variable | Example | Description |
| -------- | -------- | ------------------------------------ |
| version | `v2.8.4` | The version of `dart` |
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
### Example
```toml
# ~/.config/starship.toml
[dart]
format = "via [🔰 $version ](bold red ) "
```
2021-04-15 15:22:12 +02:00
## Deno
The `deno` module shows you your currently installed version of Deno.
By default the module will be shown if any of the following conditions are met:
- The current directory contains a `mod.ts` , `mod.js` , `deps.ts` or `deps.js` file
### Options
| Option | Default | Description |
| ------------------- | ------------------------------------------------- | ----------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"🦕 "` | A format string representing the symbol of Deno |
2021-04-16 22:51:37 +02:00
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
| `detect_files` | `["mod.ts", "mod.js", "deps.ts", "deps.js"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `"green bold"` | The style for the module. |
2021-04-15 15:22:12 +02:00
| `disabled` | `false` | Disables the `deno` module. |
### Variables
| Variable | Example | Description |
| -------- | -------- | ------------------------------------ |
| version | `v1.8.3` | The version of `deno` |
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
### Example
```toml
# ~/.config/starship.toml
[deno]
format = "via [🦕 $version ](green bold ) "
```
2019-07-19 22:18:52 +02:00
## 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.
2019-08-27 03:52:45 +02:00
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` .
2019-07-19 22:18:52 +02:00
### Options
2020-10-12 06:10:39 +02:00
| Option | Default | Description |
2020-10-01 00:38:57 +02:00
| ------------------- | -------------------------------------------------- | -------------------------------------------------------------------------------- |
| `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. |
| `format` | `"[$path]($style)[$read_only]($read_only_style) "` | The format for the module. |
| `style` | `"bold cyan"` | The style for the module. |
| `disabled` | `false` | Disables the `directory` module. |
| `read_only` | `"🔒"` | The symbol indicating current directory is read only. |
| `read_only_style` | `"red"` | The style for the read only symbol. |
2020-10-03 18:25:21 +02:00
| `truncation_symbol` | `""` | The symbol to prefix to truncated paths. eg: "…/" |
2021-04-16 22:51:37 +02:00
| `home_symbol` | `"~"` | The symbol indicating home directory. |
2019-09-20 18:28:09 +02:00
< details >
< summary > This module has a few advanced configuration options that control how the directory is displayed.< / summary >
2021-04-16 22:51:37 +02:00
| Advanced Option | Default | Description |
| --------------------------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `substitutions` | | A table of substitutions to be made to the path. |
| `fish_style_pwd_dir_length` | `0` | The number of characters to use when applying fish shell pwd path logic. |
refactor(directory): Introduce `logical-path` argument which allows a shell to explicitly specify both a logical and physical filesystem path (#2104)
* refactor(directory): Introduce `logical-path` argument which allows a shell to explicitly specify both a logical and physical filesystem path
Fix `directory::module` to consume both path and logical-path (if provided). The "logical" path is preferred when rendering the "display path", while the "physical" path is used to resolve the "read only" flag. Repo- and home-directory contraction behavior is maintained, based on the logical path if it is set, or the physical path if it is not.
The custom "get_current_dir" logic has been removed entirely, and the `directory` module now relies on `context.current_dir` / `context.logical_dir` entirely.
Changes have been made to `init/starship.ps1` to work with this new flag:
- Calculate and pass "physical" and "logical" paths explicitly (as other shells do not pass `--logical-path` that they fall back to rendering the physical path)
- Moved the "powershell provider prefix" cleanup code to the PowerShell script - this code _should_ now support any kind of powershell path prefix.
* fix(powershell): Fix an issue with trailing backslashes on file paths causing command line parsing issues.
This is a bit of a footgun!
The work-around chosen is to append a trailing space when a path string ends with a backslash, and then trim any extra whitespace away in the Context constructor.
Other alternatives considered and rejected:
1. Always trim trailing backslashes as the filesystem generally doesn't need them.
2. Escape trailing backslashes with another backslash. This proved complex as PS only quotes string args when the string includes some whitespace, and other backslashes within the string apparently don't need to be escaped.
* fix(powershell): Use Invoke-Native pattern for safely invoking native executables with strings which may contain characters which need to be escaped carefully.
* fix(context): Remove superfluous argument trims
These were in place to clean up extra whitespace sometimes injected by starship.ps1::prompt, and are no longer required with the new Invoke-Native helper in place.
* refactor(directory): Clean up the semantics of `logical_dir` defaulting it to `current_dir` but overridable by the `--logical-dir` flag.
- Restore `use_logical_path` config flag.
- Always attempt to contract repo paths from the `current_dir`.
* fix(directory) :Use logical_dir for contracting the home directory
This keeps the two calls to contract_path in sync.
* fix(directory): Remove test script
* refactor(directory): Convert current_dir to canonical filesystem path when use_logical_path = false
- This requires some clean-up to remove the extended-path prefix on Windows
- The configured logical_dir is ignored entirely in this mode - we calculate a new logical_dir by cleaning up the physical_dir path for display.
- Test coverage
* fix(directory): Use AsRef style for passing Path arguments
* fix(directory): Strip the windows extended-path prefix from the display string later in the render process
* fix(docs): Update docs/config/README.md for use_logical_path
* refactor(context): Populate `current_dir` from `--path` or `std::env::current_dir`, populate `logical_dir` from `--logical-path` or the `PWD` env var
- `current_dir` is always canonicalized
- On Windows, `current_dir` will have an extended-path prefix
- `logical_dir` is now always set
- `directory::module` now just selects between `current_dir` and `logical_dir` when picking which path to render
- Test coverage
* fix(directory): Fix path comparison operations in directory to ignore differences between path prefixes
- Added PathExt extension trait which adds `normalised_equals`, `normalised_starts_with` and `without_prefix`
* fix(path): Add test coverage for PathExt on *nix
* fix(directory): Test coverage for `contract_repo_path`, `contract_path` with variations of verbatim and non-verbatim paths
* fix(directory): Update path-slash to latest
This fixes the issue with the trailing character of some Windows paths being truncated, e.g. `\\server\share` and `C:`
* fix(powershell): Improve UTF8 output handling, argument encoding
- Use `ProcessStartInfo` to launch native executable, replacing manual UTF8 output encoding handling
- If we detect we're on PWSH6+ use the new `System.Diagnostics.ProcessStartInfo.ArgumentList` parameter, otherwise manually escape the argument string
- Move `Get-Cwd` and `Invoke-Native` into the prompt function scope so that they don't leak into the user's shell scope
* fix(path): Make PathExt methods no-ops on *nix
* fix(path): Cargo fmt
* fix(powershell): Remove typo ';'. Fix variable assignment lint.
2021-02-08 15:14:59 +01:00
| `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. |
2019-09-20 18:28:09 +02:00
2020-05-31 19:32:35 +02:00
`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.
```toml
[directory.substitutions]
"/Volumes/network/path" = "/net"
"src/com/long/java/path" = "mypath"
```
2020-02-21 01:08:20 +01:00
`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` .
2019-09-20 18:28:09 +02:00
< / details >
2020-07-08 00:45:32 +02:00
### Variables
| Variable | Example | Description |
| -------- | --------------------- | ----------------------------------- |
| path | `"D:/Projects"` | The current directory path |
| style\* | `"black bold dimmed"` | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
2019-07-29 03:05:13 +02:00
### Example
```toml
# ~/.config/starship.toml
[directory]
truncation_length = 8
2020-10-03 18:25:21 +02:00
truncation_symbol = "…/"
2019-07-29 03:05:13 +02:00
```
2019-07-19 22:18:52 +02:00
2020-04-05 21:42:55 +02:00
## Docker Context
The `docker_context` module shows the currently active
[Docker context ](https://docs.docker.com/engine/context/working-with-contexts/ ) if it's not set to
`default` .
### Options
2021-02-16 20:05:43 +01:00
| Option | Default | Description |
| ------------------- | ------------------------------------------------------------- | --------------------------------------------------------------------------------- |
| `format` | `"via [$symbol$context]($style) "` | The format for the 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"` | The style for the module. |
| `disabled` | `false` | Disables the `docker_context` module. |
2020-07-08 00:45:32 +02:00
### Variables
| Variable | Example | Description |
| -------- | -------------- | ------------------------------------ |
| context | `test_context` | The current docker context |
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
2020-04-05 21:42:55 +02:00
### Example
```toml
# ~/.config/starship.toml
[docker_context]
2020-07-08 00:45:32 +02:00
format = "via [🐋 $context ](blue bold )"
2020-04-05 21:42:55 +02:00
```
2019-10-02 08:56:49 +02:00
## 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.
2021-02-20 15:38:03 +01:00
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:
2020-07-08 00:45:32 +02:00
- `global.json`
- `project.json`
- `Directory.Build.props`
- `Directory.Build.targets`
- `Packages.props`
- `*.sln`
- `*.csproj`
- `*.fsproj`
- `*.xproj`
2020-06-21 10:22:20 +02:00
You'll also need the .NET Core SDK installed in order to use it correctly.
2019-10-02 08:56:49 +02:00
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.
2020-07-08 00:45:32 +02:00
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.
2019-10-02 08:56:49 +02:00
### Options
2021-02-20 18:32:04 +01:00
| Option | Default | Description |
| ------------------- | ------------------------------------------------------------------------------------------------------- | -------------------------------------------------------- |
| `format` | `"[$symbol($version )(🎯 $tfm )]($style)"` | The format for the module. |
2021-03-18 18:46:54 +01:00
| `symbol` | `".NET "` | The symbol used before displaying the version of dotnet. |
2021-02-20 18:32:04 +01:00
| `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"` | The style for the module. |
| `disabled` | `false` | Disables the `dotnet` module. |
2020-07-08 00:45:32 +02:00
### Variables
| Variable | Example | Description |
| -------- | ---------------- | ------------------------------------------------------------------ |
| version | `v3.1.201` | The version of `dotnet` sdk |
| tfm | `netstandard2.0` | The Target Framework Moniker that the current project is targeting |
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
2019-10-02 08:56:49 +02:00
### Example
```toml
# ~/.config/starship.toml
[dotnet]
symbol = "🥅 "
style = "green"
heuristic = false
```
2020-03-16 02:07:08 +01:00
## Elixir
The `elixir` module shows the currently installed version of Elixir and Erlang/OTP.
2021-02-20 18:32:04 +01:00
By default the module will be shown if any of the following conditions are met:
2020-03-16 02:07:08 +01:00
- The current directory contains a `mix.exs` file.
### Options
2021-02-20 18:32:04 +01:00
| Option | Default | 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"` | The style for the module. |
| `format` | `'via [$symbol($version \(OTP $otp_version\) )]($style)'` | The format for the module elixir. |
| `disabled` | `false` | Disables the `elixir` module. |
2020-07-08 00:45:32 +02:00
### Variables
| Variable | Example | Description |
| ----------- | ------- | ------------------------------------ |
| version | `v1.10` | The version of `elixir` |
| otp_version | | The otp version of `elixir` |
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
2020-03-16 02:07:08 +01:00
### Example
```toml
# ~/.config/starship.toml
[elixir]
symbol = "🔮 "
```
2020-02-06 04:57:04 +01:00
## Elm
2020-02-07 18:36:23 +01:00
The `elm` module shows the currently installed version of Elm.
2021-02-20 18:33:00 +01:00
By default the module will be shown if any of the following conditions are met:
2020-02-06 04:57:04 +01:00
- The current directory contains a `elm.json` file
- The current directory contains a `elm-package.json` file
2020-04-03 21:02:28 +02:00
- The current directory contains a `.elm-version` file
2020-02-06 04:57:04 +01:00
- The current directory contains a `elm-stuff` folder
- The current directory contains a `*.elm` files
### Options
2021-02-20 18:33:00 +01:00
| Option | Default | Description |
| ------------------- | -------------------------------------------------- | ----------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the 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"` | The style for the module. |
| `disabled` | `false` | Disables the `elm` module. |
2020-07-08 00:45:32 +02:00
### Variables
2020-02-06 04:57:04 +01:00
2020-07-08 00:45:32 +02:00
| Variable | Example | Description |
| -------- | --------- | ------------------------------------ |
| version | `v0.19.1` | The version of `elm` |
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
2020-02-06 04:57:04 +01:00
### Example
```toml
# ~/.config/starship.toml
[elm]
2020-07-08 00:45:32 +02:00
format = "via [ $version ](cyan bold ) "
2020-02-06 04:57:04 +01:00
```
2020-05-14 00:19:21 +02:00
## Environment Variable
2020-04-27 12:09:42 +02:00
2020-05-14 00:19:21 +02:00
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:
2020-04-27 12:09:42 +02:00
2020-05-14 00:19:21 +02:00
- The `variable` configuration option matches an existing environment variable
- The `variable` configuration option is not defined, but the `default` configuration option is
2020-04-27 12:09:42 +02:00
### Options
2020-07-08 00:45:32 +02:00
| Option | 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. |
| `format` | `"with [$env_value]($style) "` | The format for the module. |
| `disabled` | `false` | Disables the `env_var` module. |
### Variables
| Variable | Example | Description |
| --------- | ------------------------------------------- | ------------------------------------------ |
2020-09-08 18:09:21 +02:00
| env_value | `Windows NT` (if _variable_ would be `$OS` ) | The environment value of option `variable` |
2020-07-08 00:45:32 +02:00
| symbol | | Mirrors the value of option `symbol` |
| style\* | `black bold dimmed` | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
2020-04-27 12:09:42 +02:00
### Example
```toml
# ~/.config/starship.toml
2020-05-14 00:19:21 +02:00
[env_var]
variable = "SHELL"
default = "unknown shell"
2020-04-27 12:09:42 +02:00
```
2019-09-26 10:30:58 +02:00
2020-05-14 00:19:21 +02:00
## Erlang
2019-09-26 10:30:58 +02:00
2020-05-14 00:19:21 +02:00
The `erlang` module shows the currently installed version of Erlang/OTP.
2021-02-21 13:20:14 +01:00
By default the module will be shown if any of the following conditions are met:
2020-05-14 00:19:21 +02:00
- The current directory contains a `rebar.config` file.
- The current directory contains a `erlang.mk` file.
2019-09-26 10:30:58 +02:00
### Options
2021-02-21 13:20:14 +01:00
| Option | Default | Description |
| ------------------- | ------------------------------------ | -------------------------------------------------------- |
| `symbol` | `" "` | The symbol used before displaying the version of erlang. |
| `style` | `"bold red"` | The style for the 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)"` | The format for the module. |
| `disabled` | `false` | Disables the `erlang` module. |
2020-07-08 00:45:32 +02:00
### Variables
| Variable | Example | Description |
| -------- | --------- | ------------------------------------ |
| version | `v22.1.3` | The version of `erlang` |
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
2019-09-26 10:30:58 +02:00
### Example
```toml
# ~/.config/starship.toml
2020-05-14 00:19:21 +02:00
[erlang]
2020-07-08 00:45:32 +02:00
format = "via [e $version ](bold red ) "
2019-09-26 10:30:58 +02:00
```
2021-04-17 13:43:41 +02:00
## Google Cloud (`gcloud`)
2020-08-03 23:30:20 +02:00
The `gcloud` module shows the current configuration for [`gcloud` ](https://cloud.google.com/sdk/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
2020-10-12 06:10:39 +02:00
| Option | Default | Description |
| ---------------- | ---------------------------------------------- | --------------------------------------------------------------- |
| `format` | `'on [$symbol$account(\($region\))]($style) '` | The format for the module. |
2021-04-16 22:51:37 +02:00
| `symbol` | `"☁️ "` | The symbol used before displaying the current GCP profile. |
2020-10-12 06:10:39 +02:00
| `region_aliases` | | Table of region aliases to display in addition to the GCP name. |
| `style` | `"bold blue"` | The style for the module. |
| `disabled` | `false` | Disables the `gcloud` module. |
2020-08-03 23:30:20 +02:00
### Variables
| Variable | Example | Description |
| -------- | ----------------- | ------------------------------------------------------------------ |
| region | `us-central1` | The current GCP region |
| account | `foo@example.com` | The current GCP profile |
| project | | The current GCP project |
| active | `default` | The active config name written in `~/.config/gcloud/active_config` |
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
### Examples
#### Display account and project
```toml
# ~/.config/starship.toml
[gcloud]
2020-10-12 06:10:39 +02:00
format = 'on [$symbol$account(\($project\)) ]($style ) '
2020-08-03 23:30:20 +02:00
```
#### Display active config name only
```toml
# ~/.config/starship.toml
[gcloud]
format = "[$symbol$active]($style) "
style = "bold yellow"
```
#### Display account and aliased region
```toml
# ~/.config/starship.toml
[gcloud]
symbol = "️🇬️ "
[gcloud.region_aliases]
us-central1 = "uc1"
asia-northeast1 = "an1"
```
2019-07-19 22:18:52 +02:00
## Git Branch
The `git_branch` module shows the active branch of the repo in your current directory.
### Options
2021-04-16 22:51:37 +02:00
| Option | Default | 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) "` | The format for the module. Use `"$branch"` to refer to the current branch name. |
| `symbol` | `" "` | A format string representing the symbol of git branch. |
| `style` | `"bold purple"` | The style for the module. |
| `truncation_length` | `2^63 - 1` | Truncates a git branch to `N` 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. |
2020-07-08 00:45:32 +02:00
### Variables
2021-04-16 22:51:37 +02:00
| Variable | Example | 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 | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
2020-07-08 00:45:32 +02:00
\*: This variable can only be used as a part of a style string
2019-07-19 22:18:52 +02:00
### Example
```toml
# ~/.config/starship.toml
[git_branch]
symbol = "🌱 "
2019-10-15 13:48:53 +02:00
truncation_length = 4
2019-09-02 21:56:59 +02:00
truncation_symbol = ""
2019-07-19 22:18:52 +02:00
```
2019-12-06 17:57:42 +01:00
## Git Commit
2020-10-23 17:49:19 +02:00
The `git_commit` module shows the current commit hash and also the tag (if any) of the repo in your current directory.
2019-12-06 17:57:42 +01:00
### Options
2021-04-16 22:51:37 +02:00
| Option | Default | Description |
| -------------------- | ---------------------------------------------- | ------------------------------------------------------- |
| `commit_hash_length` | `7` | The length of the displayed git commit hash. |
| `format` | `"[\\($hash\\)]($style) [\\($tag\\)]($style)"` | The format for the module. |
| `style` | `"bold green"` | The style for the module. |
2021-03-24 18:19:51 +01:00
| `only_detached` | `true` | Only show git commit hash when in detached `HEAD` state |
2021-04-16 22:51:37 +02:00
| `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. |
2020-07-08 00:45:32 +02:00
### Variables
| Variable | Example | Description |
| -------- | --------- | ----------------------------------- |
| hash | `b703eb3` | The current git commit hash |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
2019-12-06 17:57:42 +01:00
### Example
```toml
# ~/.config/starship.toml
[git_commit]
commit_hash_length = 4
2020-10-23 17:49:19 +02:00
tag_symbol = "🔖 "
2019-12-06 17:57:42 +01:00
```
2019-09-05 18:45:04 +02:00
## 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
2020-10-12 06:10:39 +02:00
| Option | Default | 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"` | The style for the module. |
| `format` | `'\([$state( $progress_current/$progress_total)]($style)\) '` | The format for the module. |
| `disabled` | `false` | Disables the `git_state` module. |
2020-07-08 00:45:32 +02:00
### Variables
| Variable | Example | Description |
| ---------------- | ---------- | ----------------------------------- |
| state | `REBASING` | The current state of the repo |
| progress_current | `1` | The current operation progress |
| progress_total | `2` | The total operation progress |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
2019-09-05 18:45:04 +02:00
### Example
```toml
# ~/.config/starship.toml
[git_state]
2020-10-12 06:10:39 +02:00
format = '[\($state( $progress_current of $progress_total)\)]($style) '
2020-07-08 00:45:32 +02:00
cherry_pick = "[🍒 PICKING](bold red)"
2019-09-05 18:45:04 +02:00
```
2019-07-19 22:18:52 +02:00
## Git Status
The `git_status` module shows symbols representing the state of the repo in your
current directory.
### Options
2020-10-12 06:10:39 +02:00
| Option | Default | 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 red"` | The style for the module. |
| `disabled` | `false` | Disables the `git_status` module. |
2020-07-08 00:45:32 +02:00
### 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. |
2020-09-08 18:09:21 +02:00
| `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. |
2020-07-08 00:45:32 +02:00
| style\* | Mirrors the value of 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 |
2019-07-19 22:18:52 +02:00
### Example
```toml
# ~/.config/starship.toml
[git_status]
conflicted = "🏳"
ahead = "🏎💨"
behind = "😰"
diverged = "😵"
untracked = "🤷"
stashed = "📦"
modified = "📝"
2020-07-08 00:45:32 +02:00
staged = '[++\($count\)](green)'
2019-07-19 22:18:52 +02:00
renamed = "👅"
deleted = "🗑"
```
2020-09-26 19:15:52 +02:00
Show ahead/behind count of the branch being tracked
2020-10-01 00:38:57 +02:00
2020-09-26 19:15:52 +02:00
```toml
# ~/.config/starship.toml
[git_status]
ahead = "⇡${count}"
diverged = "⇕⇡${ahead_count}⇣${behind_count}"
behind = "⇣${count}"
```
2019-07-19 22:18:52 +02:00
## Golang
The `golang` module shows the currently installed version of Golang.
2021-02-17 18:58:21 +01:00
By default the module will be shown if any of the following conditions are met:
2019-07-19 22:18:52 +02:00
- 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
2020-04-03 21:02:28 +02:00
- The current directory contains a `.go-version` file
2019-07-19 22:18:52 +02:00
- The current directory contains a `Godeps` directory
- The current directory contains a file with the `.go` extension
### Options
2021-02-17 18:58:21 +01:00
| Option | Default | Description |
| -------------------- | ------------------------------------------------------------------------------ | ---------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"🐹 "` | A format string representing the symbol of Go. |
2021-03-25 14:46:46 +01:00
| `detect_extensions` | `["go"]` | Which extensions should trigger this module. |
2021-02-17 18:58:21 +01:00
| `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"` | The style for the module. |
| `disabled` | `false` | Disables the `golang` module. |
2020-07-08 00:45:32 +02:00
### Variables
| Variable | Example | Description |
| -------- | --------- | ------------------------------------ |
| version | `v1.12.1` | The version of `go` |
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
2019-07-19 22:18:52 +02:00
### Example
```toml
# ~/.config/starship.toml
[golang]
2020-07-08 00:45:32 +02:00
format = "via [🏎💨 $version ](bold cyan ) "
2019-07-19 22:18:52 +02:00
```
2020-07-17 09:51:25 +02:00
## Helm
The `helm` module shows the currently installed version of Helm.
2021-02-21 19:57:23 +01:00
By default the module will be shown if any of the following conditions are met:
2020-07-17 09:51:25 +02:00
- The current directory contains a `helmfile.yaml` file
- The current directory contains a `Chart.yaml` file
### Options
2021-02-21 19:57:23 +01:00
| Option | Default | Description |
| ------------------- | ------------------------------------ | ------------------------------------------------ |
| `format` | `"via [$symbol($version )]($style)"` | The format for the 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"` | The style for the module. |
| `disabled` | `false` | Disables the `helm` module. |
2020-07-17 09:51:25 +02:00
### Variables
2020-09-08 18:09:21 +02:00
| Variable | Example | Description |
| -------- | -------- | ------------------------------------ |
| version | `v3.1.1` | The version of `helm` |
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
2020-07-17 09:51:25 +02:00
\*: This variable can only be used as a part of a style string
### Example
```toml
# ~/.config/starship.toml
[helm]
format = "via [⎈ $version ](bold white ) "
```
2019-09-08 02:33:06 +02:00
## Hostname
The `hostname` module shows the system hostname.
### Options
2020-07-08 00:45:32 +02:00
| Option | Default | 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 |
2020-09-08 18:09:21 +02:00
| `format` | `"[$hostname]($style) in "` | The format for the module. |
2020-07-08 00:45:32 +02:00
| `style` | `"bold dimmed green"` | The style for the module. |
| `disabled` | `false` | Disables the `hostname` module. |
### Variables
| Variable | Example | Description |
| -------- | ------- | ------------------------------------ |
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
2019-09-08 02:33:06 +02:00
### Example
```toml
# ~/.config/starship.toml
[hostname]
ssh_only = false
2020-07-08 00:45:32 +02:00
format = "on [$hostname ](bold red ) "
2019-10-14 18:22:25 +02:00
trim_at = ".companyname.com"
2019-09-08 02:33:06 +02:00
disabled = false
```
2020-03-16 02:07:08 +01:00
## Java
The `java` module shows the currently installed version of Java.
2021-02-21 19:57:09 +01:00
By default the module will be shown if any of the following conditions are met:
2020-03-16 02:07:08 +01:00
2020-11-30 13:50:56 +01:00
- The current directory contains a `pom.xml` , `build.gradle.kts` , `build.sbt` , `.java-version` , `.deps.edn` , `project.clj` , or `build.boot` file
- The current directory contains a file with the `.java` , `.class` , `.gradle` , `.jar` , `.clj` , or `.cljc` extension
2020-03-16 02:07:08 +01:00
### Options
2021-04-09 00:37:54 +02:00
| Option | Default | Description |
| ------------------- | --------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
| `format` | `"via [${symbol}(${version} )]($style)"` | The format for the module. |
2021-04-10 19:06:25 +02:00
| `version_format` | `v{raw}` | The version format. Available vars are `raw` , `major` , `minor` , & `patch` |
2021-04-09 00:37:54 +02:00
| `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"` | The style for the module. |
| `disabled` | `false` | Disables the `java` module. |
2020-07-08 00:45:32 +02:00
### Variables
| Variable | Example | Description |
| -------- | ------- | ------------------------------------ |
| version | `v14` | The version of `java` |
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
2020-03-16 02:07:08 +01:00
### Example
```toml
# ~/.config/starship.toml
[java]
symbol = "🌟 "
```
2019-08-12 19:42:33 +02:00
## 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
2021-04-20 18:30:22 +02:00
more than the `threshold` config value, if it exists. If `threshold` is set to 0,
then the module will also show when there are 0 jobs running.
2019-08-12 19:42:33 +02:00
2021-02-27 19:55:27 +01:00
::: warning
This module is not supported on tcsh.
:::
2019-08-12 19:42:33 +02:00
### Options
2020-07-08 00:45:32 +02:00
| Option | Default | Description |
| ----------- | ----------------------------- | ------------------------------------------------ |
| `threshold` | `1` | Show number of jobs if exceeded. |
| `format` | `"[$symbol$number]($style) "` | The format for the module. |
| `symbol` | `"✦"` | A format string representing the number of jobs. |
| `style` | `"bold blue"` | The style for the module. |
| `disabled` | `false` | Disables the `jobs` module. |
### Variables
| Variable | Example | Description |
| -------- | ------- | ------------------------------------ |
| number | `1` | The number of jobs |
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
2019-08-12 19:42:33 +02:00
### Example
```toml
# ~/.config/starship.toml
[jobs]
2019-08-29 19:09:36 +02:00
symbol = "+ "
2019-08-12 19:42:33 +02:00
threshold = 4
```
2020-04-03 20:16:34 +02:00
## Julia
The `julia` module shows the currently installed version of Julia.
2021-02-21 19:56:55 +01:00
By default the module will be shown if any of the following conditions are met:
2020-04-03 20:16:34 +02:00
- 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
2021-02-21 19:56:55 +01:00
| Option | Default | Description |
| ------------------- | ------------------------------------ | ------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the 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"` | The style for the module. |
| `disabled` | `false` | Disables the `julia` module. |
2020-07-08 00:45:32 +02:00
### Variables
| Variable | Example | Description |
| -------- | -------- | ------------------------------------ |
| version | `v1.4.0` | The version of `julia` |
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
2020-04-03 20:16:34 +02:00
### Example
```toml
# ~/.config/starship.toml
[julia]
2020-04-07 11:07:51 +02:00
symbol = "∴ "
2020-04-03 20:16:34 +02:00
```
2020-07-08 00:45:32 +02:00
2020-12-26 15:26:50 +01:00
## Kotlin
The `kotlin` module shows the currently installed version of Kotlin.
2021-02-21 19:56:48 +01:00
By default the module will be shown if any of the following conditions are met:
2020-12-26 15:26:50 +01:00
- The current directory contains a `.kt` or a `.kts` file
### Options
2021-02-21 19:56:48 +01:00
| Option | Default | Description |
| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the 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. |
2021-04-16 22:51:37 +02:00
| `symbol` | `"🅺 "` | A format string representing the symbol of Kotlin. |
2021-02-21 19:56:48 +01:00
| `style` | `"bold blue"` | The style for the module. |
| `kotlin_binary` | `"kotlin"` | Configures the kotlin binary that Starship executes when getting the version. |
| `disabled` | `false` | Disables the `kotlin` module. |
2020-12-26 15:26:50 +01:00
### Variables
| Variable | Example | Description |
| -------- | --------- | ------------------------------------ |
| version | `v1.4.21` | The version of `kotlin` |
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
### Example
```toml
# ~/.config/starship.toml
[kotlin]
symbol = "🅺 "
```
```toml
# ~/.config/starship.toml
[kotlin]
# Uses the Kotlin Compiler binary to get the installed version
kotlin_binary = "kotlinc"
```
2019-10-01 20:58:24 +02:00
## Kubernetes
2020-07-08 00:45:32 +02:00
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` .
2019-10-01 20:58:24 +02:00
2019-10-05 11:31:23 +02:00
::: tip
This module is disabled by default.
To enable it, set `disabled` to `false` in your configuration file.
:::
2019-10-01 20:58:24 +02:00
### Options
2020-10-12 06:10:39 +02:00
| Option | Default | Description |
| ----------------------- | -------------------------------------------------- | --------------------------------------------------------------------- |
| `symbol` | `"☸ "` | A format string representing the symbol displayed before the Cluster. |
| `format` | `'[$symbol$context( \($namespace\))]($style) in '` | The format for the module. |
| `style` | `"cyan bold"` | The style for the module. |
| `context_aliases` | | Table of context aliases to display. |
| `disabled` | `true` | Disables the `kubernetes` module. |
2020-07-08 00:45:32 +02:00
### Variables
| Variable | Example | Description |
| --------- | -------------------- | ---------------------------------------- |
| context | `starship-cluster` | The current kubernetes context |
| namespace | `starship-namespace` | If set, the current kubernetes namespace |
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
2019-10-01 20:58:24 +02:00
### Example
```toml
# ~/.config/starship.toml
[kubernetes]
2020-10-12 06:10:39 +02:00
format = 'on [⛵ $context \($namespace\) ](dimmed green ) '
2019-10-05 11:31:23 +02:00
disabled = false
2020-04-03 20:18:44 +02:00
[kubernetes.context_aliases]
"dev.local.cluster.k8s" = "dev"
2019-10-01 20:58:24 +02:00
```
2019-07-19 22:18:52 +02:00
## Line Break
The `line_break` module separates the prompt into two lines.
### Options
2020-07-08 00:45:32 +02:00
| Option | Default | Description |
2019-07-19 22:18:52 +02:00
| ---------- | ------- | ------------------------------------------------------------------ |
| `disabled` | `false` | Disables the `line_break` module, making the prompt a single line. |
### Example
```toml
# ~/.config/starship.toml
[line_break]
disabled = true
```
2020-10-27 19:05:20 +01:00
## Lua
The `lua` module shows the currently installed version of Lua.
2021-02-17 19:03:09 +01:00
By default the module will be shown if any of the following conditions are met:
2020-10-27 19:05:20 +01:00
- 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
2021-02-17 19:03:09 +01:00
| Option | Default | Description |
| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"🌙 "` | A format string representing the symbol of Lua. |
2021-03-25 14:46:46 +01:00
| `detect_extensions` | `["lua"]` | Which extensions should trigger this module. |
2021-02-17 19:03:09 +01:00
| `detect_files` | `[".lua-version"]` | Which filenames should trigger this module. |
| `detect_folders` | `["lua"]` | Which folders should trigger this module. |
| `style` | `"bold blue"` | The style for the module. |
| `lua_binary` | `"lua"` | Configures the lua binary that Starship executes when getting the version. |
| `disabled` | `false` | Disables the `lua` module. |
2020-10-27 19:05:20 +01:00
### Variables
| Variable | Example | Description |
| -------- | --------- | ------------------------------------ |
| version | `v5.4.0` | The version of `lua` |
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
### Example
```toml
# ~/.config/starship.toml
[lua]
format = "via [🌕 $version ](bold blue ) "
```
2019-09-29 07:55:49 +02:00
## 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.
2019-09-30 09:04:49 +02:00
::: tip
This module is disabled by default.
To enable it, set `disabled` to `false` in your configuration file.
:::
2019-09-29 07:55:49 +02:00
### Options
2021-04-16 22:51:37 +02:00
| Option | Default | Description |
| ----------- | ---------------------------------------------- | -------------------------------------------------------- |
| `threshold` | `75` | Hide the memory usage unless it exceeds this percentage. |
| `format` | `"via $symbol [${ram}( \| ${swap})]($style) "` | The format for the module. |
| `symbol` | `"🐏"` | The symbol used before displaying the memory usage. |
| `style` | `"bold dimmed white"` | The style for the module. |
| `disabled` | `true` | Disables the `memory_usage` module. |
2020-07-08 00:45:32 +02:00
### Variables
2020-09-08 18:09:21 +02:00
| Variable | Example | 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 | `🐏` | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
2020-07-08 00:45:32 +02:00
\*: 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
2019-09-29 07:55:49 +02:00
### Example
```toml
# ~/.config/starship.toml
[memory_usage]
2020-03-23 17:53:04 +01:00
disabled = false
2019-09-29 07:55:49 +02:00
threshold = -1
2019-10-25 02:58:10 +02:00
symbol = " "
2019-09-29 07:55:49 +02:00
style = "bold dimmed green"
```
2020-03-16 02:07:08 +01:00
## Mercurial Branch
2020-02-05 00:27:06 +01:00
2020-03-16 02:07:08 +01:00
The `hg_branch` module shows the active branch of the repo in your current directory.
2020-02-05 00:27:06 +01:00
2020-03-16 02:07:08 +01:00
### Options
2020-07-08 00:45:32 +02:00
| Option | Default | Description |
| ------------------- | -------------------------------- | -------------------------------------------------------------------------------------------- |
| `symbol` | `" "` | The symbol used before the hg bookmark or branch name of the repo in your current directory. |
| `style` | `"bold purple"` | The style for the module. |
| `format` | `"on [$symbol$branch]($style) "` | The format for the module. |
2021-04-16 22:51:37 +02:00
| `truncation_length` | `2^63 - 1` | Truncates the hg branch name to `N` graphemes |
2020-07-08 00:45:32 +02:00
| `truncation_symbol` | `"…"` | The symbol used to indicate a branch name was truncated. |
| `disabled` | `true` | Disables the `hg_branch` module. |
### Variables
| Variable | Example | Description |
| -------- | -------- | ------------------------------------ |
| branch | `master` | The active mercurial branch |
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
2020-03-16 02:07:08 +01:00
### Example
```toml
# ~/.config/starship.toml
[hg_branch]
2020-07-08 00:45:32 +02:00
format = "on [🌱 $branch ](bold purple )"
2020-03-16 02:07:08 +01:00
truncation_length = 4
truncation_symbol = ""
```
2020-06-09 19:14:47 +02:00
## Nim
The `nim` module shows the currently installed version of Nim.
2021-02-21 13:21:20 +01:00
By default the module will be shown if any of the following conditions are met:
2020-07-08 00:45:32 +02:00
2020-06-09 19:14:47 +02:00
- The current directory contains a `nim.cfg` file
- The current directory contains a file with the `.nim` extension
- The current directory contains a file with the `.nims` extension
- The current directory contains a file with the `.nimble` extension
### Options
2021-02-21 13:21:20 +01:00
| Option | Default | Description |
| -------------------- | ------------------------------------ | ----------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module |
| `symbol` | `"👑 "` | The symbol used before displaying the version of Nim. |
2021-03-25 14:46:46 +01:00
| `detect_extensions` | `["nim", "nims", "nimble"]` | Which extensions should trigger this module. |
2021-02-21 13:21:20 +01:00
| `detect_files` | `["nim.cfg"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `"bold yellow"` | The style for the module. |
| `disabled` | `false` | Disables the `nim` module. |
2020-07-08 00:45:32 +02:00
### Variables
| Variable | Example | Description |
| -------- | -------- | ------------------------------------ |
| version | `v1.2.0` | The version of `nimc` |
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
2020-06-09 19:14:47 +02:00
### Example
```toml
# ~/.config/starship.toml
[nim]
style = "yellow"
symbol = "🎣 "
```
2020-03-16 02:07:08 +01:00
## Nix-shell
The `nix_shell` module shows the nix-shell environment.
The module will be shown when inside a nix-shell environment.
2020-02-05 00:27:06 +01:00
### Options
2020-10-12 06:10:39 +02:00
| Option | Default | Description |
| ------------ | -------------------------------------------- | ----------------------------------------------------- |
| `format` | `'via [$symbol$state( \($name\))]($style) '` | The format for the module. |
2021-04-16 22:51:37 +02:00
| `symbol` | `"❄️ "` | A format string representing the symbol of nix-shell. |
2020-10-12 06:10:39 +02:00
| `style` | `"bold blue"` | The style for the 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. |
2020-07-08 00:45:32 +02:00
### Variables
| Variable | Example | Description |
| -------- | ------- | ------------------------------------ |
| state | `pure` | The state of the nix-shell |
| name | `lorri` | The name of the nix-shell |
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
2020-02-05 00:27:06 +01:00
### Example
```toml
# ~/.config/starship.toml
2020-03-16 02:07:08 +01:00
[nix_shell]
disabled = true
2020-07-08 00:45:32 +02:00
impure_msg = "[impure shell](bold red)"
pure_msg = "[pure shell](bold green)"
2020-10-12 06:10:39 +02:00
format = 'via [☃️ $state( \($name\)) ](bold blue ) '
2020-02-05 00:27:06 +01:00
```
2019-07-19 22:18:52 +02:00
## NodeJS
The `nodejs` module shows the currently installed version of NodeJS.
2021-02-21 13:22:40 +01:00
By default the module will be shown if any of the following conditions are met:
2019-07-19 22:18:52 +02:00
- The current directory contains a `package.json` file
2020-04-03 21:02:28 +02:00
- The current directory contains a `.node-version` file
2021-04-22 18:08:12 +02:00
- The current directory contains a `.nvmrc` file
2019-07-19 22:18:52 +02:00
- The current directory contains a `node_modules` directory
2020-06-21 10:33:58 +02:00
- The current directory contains a file with the `.js` , `.mjs` or `.cjs` extension
- The current directory contains a file with the `.ts` extension
2019-07-19 22:18:52 +02:00
### Options
2021-04-09 00:37:54 +02:00
| Option | Default | Description |
| ------------------- | ------------------------------------ | ---------------------------------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
2021-04-10 19:06:25 +02:00
| `version_format` | `v{raw}` | The version format. Available vars are `raw` , `major` , `minor` , & `patch` |
2021-04-09 00:37:54 +02:00
| `symbol` | `" "` | A format string representing the symbol of NodeJS. |
2021-04-10 19:06:25 +02:00
| `detect_extensions` | `["js", "mjs", "cjs", "ts"]` | Which extensions should trigger this module. |
2021-04-09 00:37:54 +02:00
| `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"` | The style for the module. |
| `disabled` | `false` | Disables the `nodejs` module. |
| `not_capable_style` | `bold red` | The style for the module when an engines property in package.json does not match the NodeJS version. |
2020-07-08 00:45:32 +02:00
2021-03-24 21:44:52 +01:00
### Variables
2020-07-08 00:45:32 +02:00
| Variable | Example | Description |
| -------- | ---------- | ------------------------------------ |
| version | `v13.12.0` | The version of `node` |
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
2019-07-19 22:18:52 +02:00
### Example
```toml
# ~/.config/starship.toml
[nodejs]
2020-07-08 00:45:32 +02:00
format = "via [🤖 $version ](bold green ) "
2019-07-19 22:18:52 +02:00
```
2020-05-21 18:43:13 +02:00
## OCaml
The `ocaml` module shows the currently installed version of OCaml.
2021-02-21 19:50:40 +01:00
By default the module will be shown if any of the following conditions are met:
2020-05-21 18:43:13 +02:00
- The current directory contains a file with `.opam` extension or `_opam` directory
- The current directory contains a `esy.lock` directory
- The current directory contains a `dune` or `dune-project` file
- The current directory contains a `jbuild` or `jbuild-ignore` file
- The current directory contains a `.merlin` file
- The current directory contains a file with `.ml` , `.mli` , `.re` or `.rei` extension
### Options
2021-04-02 19:21:48 +02:00
| Option | Default | Description |
| ------------------------- | ------------------------------------------------------------------------ | ------------------------------------------------------- |
| `format` | `"via [$symbol($version )(\($switch_indicator$switch_name\) )]($style)"` | The format string for the module. |
| `symbol` | `"🐫 "` | The symbol used before displaying the version of OCaml. |
| `global_switch_indicator` | `""` | The format string used to represent global OPAM switch. |
| `local_switch_indicator` | `"*"` | The format string used to represent local OPAM switch. |
| `detect_extensions` | `["opam", "ml", "mli", "re", "rei"]` | Which extensions should trigger this module. |
| `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"` | The style for the module. |
| `disabled` | `false` | Disables the `ocaml` module. |
2020-07-08 00:45:32 +02:00
### Variables
2021-04-02 19:21:48 +02:00
| Variable | Example | Description |
| ---------------- | ------------ | ----------------------------------------------------------------- |
| version | `v4.10.0` | The version of `ocaml` |
| switch_name | `my-project` | The active OPAM switch |
| switch_indicator | | Mirrors the value of `indicator` for currently active OPAM switch |
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
2020-07-08 00:45:32 +02:00
\*: This variable can only be used as a part of a style string
2020-05-21 18:43:13 +02:00
### Example
```toml
# ~/.config/starship.toml
[ocaml]
2020-07-08 00:45:32 +02:00
format = "via [🐪 $version ]($style ) "
2020-05-21 18:43:13 +02:00
```
2020-10-24 11:46:43 +02:00
## 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 ](https://docs.openstack.org/python-openstackclient/latest/configuration/index.html#configuration-files ).
to fetch the current project in use.
### Options
| Option | Default | Description |
| ---------------- | ------------------------------------------------ | --------------------------------------------------------------- |
| `format` | `"on [$symbol$cloud(\\($project\\))]($style) "` | The format for the module. |
| `symbol` | `"☁️ "` | The symbol used before displaying the current OpenStack cloud. |
| `style` | `"bold yellow"` | The style for the module. |
2021-03-24 18:19:51 +01:00
| `disabled` | `false` | Disables the `openstack` module. |
2020-10-24 11:46:43 +02:00
### Variables
| Variable | Example | Description |
| -------- | ---------- | ------------------------------------ |
| cloud | `corp` | The current OpenStack cloud |
| project | `dev` | The current OpenStack project |
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
### Example
```toml
# ~/.config/starship.toml
[openstack]
format = "on [$symbol$cloud(\\($project\\)) ]($style ) "
style = "bold yellow"
symbol = "☁️ "
```
2020-11-14 19:41:58 +01:00
## 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** – `npm` package version is extracted from the `package.json` present
in the current directory
- **cargo** – `cargo` package version is extracted from the `Cargo.toml` present
in the current directory
- **poetry** – `poetry` package version is extracted from the `pyproject.toml` present
in the current directory
- **composer** – `composer` package version is extracted from the `composer.json` present
in the current directory
- **gradle** – `gradle` package version is extracted from the `build.gradle` present
- **julia** - The package version is extracted from the `Project.toml` present
- **mix** - The `mix` package version is extracted from the `mix.exs` present
- **helm** - The `helm` chart version is extracted from the `Chart.yaml` present
- **maven** - The `maven` package version is extracted from the `pom.xml` present
2020-12-19 14:17:34 +01:00
- **meson** - The `meson` package version is extracted from the `meson.build` present
2020-11-14 19:41:58 +01:00
> ⚠️ The version being shown is that of the package whose source code is in your
> current directory, not your package manager.
### Options
| Option | Default | Description |
| ----------------- | ---------------------------------- | ---------------------------------------------------------- |
2021-01-04 17:56:25 +01:00
| `format` | `"is [$symbol$version]($style) "` | The format for the module. |
2020-11-14 19:41:58 +01:00
| `symbol` | `"📦 "` | The symbol used before displaying the version the package. |
| `style` | `"bold 208"` | The style for the module. |
| `display_private` | `false` | Enable displaying version for packages marked as private. |
| `disabled` | `false` | Disables the `package` module. |
### Variables
| Variable | Example | Description |
| -------- | -------- | ------------------------------------ |
| version | `v1.0.0` | The version of your package |
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
### Example
```toml
# ~/.config/starship.toml
[package]
format = "via [🎁 $version ](208 bold ) "
```
2020-08-04 18:22:44 +02:00
## Perl
The `perl` module shows the currently installed version of Perl.
2021-02-21 19:51:36 +01:00
By default the module will be shown if any of the following conditions are met:
2020-08-04 18:22:44 +02:00
- The current directory contains a `Makefile.PL` or `Build.PL` file
- The current directory contains a `cpanfile` or `cpanfile.snapshot` file
- The current directory contains a `META.json` file or `META.yml` file
- The current directory contains a `.perl-version` file
- The current directory contains a `.pl` , `.pm` or `.pod`
### Options
2021-04-16 22:51:37 +02:00
| Option | Default | 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 module. |
| `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"` | The style for the module. |
| `disabled` | `false` | Disables the `perl` module. |
2020-08-04 18:22:44 +02:00
### Variables
| Variable | Example | Description |
| -------- | --------- | ------------------------------------ |
| version | `v5.26.1` | The version of `perl` |
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
### Example
```toml
# ~/.config/starship.toml
[perl]
format = "via [🦪 $version ]($style ) "
```
2019-12-05 19:04:27 +01:00
## PHP
The `php` module shows the currently installed version of PHP.
2021-02-21 19:52:19 +01:00
By default the module will be shown if any of the following conditions are met:
2019-12-05 19:04:27 +01:00
- The current directory contains a `composer.json` file
2020-04-03 21:02:28 +02:00
- The current directory contains a `.php-version` file
2021-02-21 19:52:19 +01:00
- The current directory contains a `.php` extension
2019-12-05 19:04:27 +01:00
### Options
2021-02-21 19:52:19 +01:00
| Option | Default | Description |
| -------------------- | ------------------------------------ | ----------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"🐘 "` | The symbol used before displaying the version of PHP. |
2021-03-25 14:46:46 +01:00
| `detect_extensions` | `["php"]` | Which extensions should trigger this module. |
2021-02-21 19:52:19 +01:00
| `detect_files` | `["composer.json", ".php-version"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `"147 bold"` | The style for the module. |
| `disabled` | `false` | Disables the `php` module. |
2020-07-08 00:45:32 +02:00
### Variables
| Variable | Example | Description |
| -------- | -------- | ------------------------------------ |
| version | `v7.3.8` | The version of `php` |
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
2019-12-05 19:04:27 +01:00
### Example
```toml
# ~/.config/starship.toml
[php]
2020-07-08 00:45:32 +02:00
format = "via [🔹 $version ](147 bold ) "
2019-12-05 19:04:27 +01:00
```
2020-11-14 19:41:58 +01:00
## PureScript
The `purescript` module shows the currently installed version of PureScript version.
2021-02-21 19:53:10 +01:00
By default the module will be shown if any of the following conditions are met:
2020-11-14 19:41:58 +01:00
- The current directory contains a `spago.dhall` file
2021-02-21 19:53:10 +01:00
- The current directory contains a file with the `.purs` extension
2020-11-14 19:41:58 +01:00
### Options
2021-02-21 19:53:10 +01:00
| Option | Default | Description |
| -------------------- | ------------------------------------ | ------------------------------------------------------------ |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"<=> "` | The symbol used before displaying the version of PureScript. |
2021-03-25 14:46:46 +01:00
| `detect_extensions` | `["purs"]` | Which extensions should trigger this module. |
2021-02-21 19:53:10 +01:00
| `detect_files` | `["spago.dhall"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `"bold white"` | The style for the module. |
| `disabled` | `false` | Disables the `purescript` module. |
2020-11-14 19:41:58 +01:00
### Variables
| Variable | Example | Description |
| -------- | -------- | ------------------------------------ |
| version | `0.13.5` | The version of `purescript` |
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
### Example
```toml
# ~/.config/starship.toml
[purescript]
format = "via [$symbol$version ](bold white )"
```
2019-07-19 22:18:52 +02:00
## Python
2020-05-14 00:19:21 +02:00
The `python` module shows the currently installed version of Python and the
current Python virtual environment if one is activated.
2019-08-13 03:12:55 +02:00
2020-05-14 00:19:21 +02:00
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` .
2019-08-13 03:12:55 +02:00
2021-02-07 22:18:52 +01:00
By default the module will be shown if any of the following conditions are met:
2019-07-19 22:18:52 +02:00
- The current directory contains a `.python-version` file
2019-08-22 00:54:22 +02:00
- The current directory contains a `Pipfile` file
2020-04-14 10:26:51 +02:00
- The current directory contains a `__init__.py` file
2021-02-07 22:18:52 +01:00
- 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.
2019-11-02 12:10:21 +01:00
- A virtual environment is currently activated
2019-07-19 22:18:52 +02:00
### Options
2021-02-07 22:18:52 +01:00
| Option | Default | Description |
| -------------------- | ------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------- |
2021-03-24 16:41:08 +01:00
| `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\) )]($style)'` | The format for the module. |
2021-04-10 19:06:25 +02:00
| `version_format` | `v{raw}` | The version format. Available vars are `raw` , `major` , `minor` , & `patch` |
2021-02-07 22:18:52 +01:00
| `symbol` | `"🐍 "` | A format string representing the symbol of Python |
| `style` | `"yellow bold"` | The style for the 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. |
2021-03-25 14:46:46 +01:00
| `detect_extensions` | `[".py"]` | Which extensions should trigger this module |
2021-02-07 22:18:52 +01:00
| `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. |
2020-11-30 20:14:18 +01:00
::: 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.
:::
2020-07-08 00:45:32 +02:00
### Variables
2020-09-21 17:48:26 +02:00
| Variable | Example | Description |
| ------------ | --------------- | ------------------------------------------ |
| version | `"v3.8.1"` | The version of `python` |
| symbol | `"🐍 "` | Mirrors the value of option `symbol` |
| style | `"yellow bold"` | Mirrors the value of option `style` |
| pyenv_prefix | `"pyenv "` | Mirrors the value of option `pyenv_prefix` |
| virtualenv | `"venv"` | The current `virtualenv` name |
2019-07-19 22:18:52 +02:00
2020-10-06 09:09:06 +02:00
### Example
2020-06-14 11:27:10 +02:00
```toml
# ~/.config/starship.toml
[python]
2020-10-06 09:09:06 +02:00
symbol = "👾 "
pyenv_version_name = true
2020-06-14 11:27:10 +02:00
```
2019-07-19 22:18:52 +02:00
```toml
# ~/.config/starship.toml
[python]
2020-11-30 20:14:18 +01:00
# Only use the `python3` binary to get the version.
2020-10-06 09:09:06 +02:00
python_binary = "python3"
2019-07-19 22:18:52 +02:00
```
2021-02-07 22:18:52 +01:00
```toml
# ~/.config/starship.toml
[python]
# Don't trigger for files with the py extension
detect_extensions = []
```
2021-04-20 18:31:47 +02:00
## Red
By default the `red` module shows the currently installed version of Red.
The module will be shown if any of the following conditions are met:
- The current directory contains a file with `.red` or `.reds` extension
### Options
| Option | Default | Description |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `version_format` | `v{raw}` | The version format. Available vars are `raw` , `major` , `minor` , & `patch` |
| `symbol` | `"🔺 "` | A format string representing the symbol of Red. |
| `detect_extensions` | `["red"]` | Which extensions should trigger this module. |
| `detect_files` | `[]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `"red bold"` | The style for the module. |
| `disabled` | `false` | Disables the `red` module. |
### Variables
| Variable | Example | Description |
| -------- | -------- | ------------------------------------ |
| version | `v2.5.1` | The version of `red` |
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
### Example
```toml
# ~/.config/starship.toml
[red]
symbol = "🔴 "
```
2019-09-08 02:33:06 +02:00
## Ruby
2021-02-21 18:01:01 +01:00
By default the `ruby` module shows the currently installed version of Ruby.
2019-09-08 02:33:06 +02:00
The module will be shown if any of the following conditions are met:
- The current directory contains a `Gemfile` file
2020-04-03 21:02:28 +02:00
- The current directory contains a `.ruby-version` file
2019-09-08 02:33:06 +02:00
- The current directory contains a `.rb` file
### Options
2021-04-09 00:37:54 +02:00
| Option | Default | Description |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
2021-04-10 19:06:25 +02:00
| `version_format` | `v{raw}` | The version format. Available vars are `raw` , `major` , `minor` , & `patch` |
2021-04-09 00:37:54 +02:00
| `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 red"` | The style for the module. |
| `disabled` | `false` | Disables the `ruby` module. |
2020-07-08 00:45:32 +02:00
### Variables
| Variable | Example | Description |
| -------- | -------- | ------------------------------------ |
| version | `v2.5.1` | The version of `ruby` |
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
2019-09-08 02:33:06 +02:00
2019-09-08 16:57:52 +02:00
### Example
```toml
# ~/.config/starship.toml
[ruby]
symbol = "🔺 "
```
2019-07-19 22:18:52 +02:00
## Rust
2021-02-21 18:01:17 +01:00
By default the `rust` module shows the currently installed version of Rust.
2019-07-19 22:18:52 +02:00
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
2021-04-09 00:37:54 +02:00
| Option | Default | Description |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
2021-04-10 19:06:25 +02:00
| `version_format` | `v{raw}` | The version format. Available vars are `raw` , `major` , `minor` , & `patch` |
2021-04-09 00:37:54 +02:00
| `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 red"` | The style for the module. |
| `disabled` | `false` | Disables the `rust` module. |
2020-07-08 00:45:32 +02:00
### Variables
| Variable | Example | Description |
| -------- | ----------------- | ------------------------------------ |
| version | `v1.43.0-nightly` | The version of `rustc` |
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
2019-07-19 22:18:52 +02:00
### Example
```toml
# ~/.config/starship.toml
[rust]
2020-07-08 00:45:32 +02:00
format = "via [⚙️ $version ](red bold )"
2019-07-19 22:18:52 +02:00
```
2021-03-14 20:37:00 +01:00
## 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
2021-04-16 22:51:37 +02:00
| Option | Default | Description |
| ------------------- | ------------------------------------------- | ------------------------------------------------- |
| `format` | `"via [${symbol}(${version} )]($style)"` | The format for the 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"` | The style for the module. |
| `disabled` | `false` | Disables the `scala` module. |
2021-03-14 20:37:00 +01:00
### Variables
| Variable | Example | Description |
| -------- | -----------| ------------------------------------ |
| version | `2.13.5` | The version of `scala` |
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
### Example
```toml
# ~/.config/starship.toml
[scala]
symbol = "🌟 "
```
2021-02-20 15:40:49 +01:00
## 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
2021-04-16 22:51:37 +02:00
| Option | Default | Description |
2021-02-20 15:40:49 +01:00
| ---------------------- | ------------- | --------------------------------------------- |
| `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. |
2021-02-27 19:55:27 +01:00
| `tcsh_indicator` | `tsh` | A format string used to represent tcsh. |
2021-02-20 15:40:49 +01:00
| `format` | `$indicator ` | The format for the module. |
| `disabled` | `true` | Disables the `shell` module. |
### Variables
| Variable | Default | Description |
| ----------- | ------- | ---------------------------------------------------------- |
| indicator | | Mirrors the value of `indicator` for currently used shell. |
### Examples
2021-03-24 21:44:52 +01:00
2021-02-20 15:40:49 +01:00
```toml
# ~/.config/starship.toml
[shell]
fish_indicator = ""
powershell_indicator = "_"
disabled = false
```
2020-08-05 18:30:01 +02:00
## SHLVL
2021-03-24 18:19:51 +01:00
The `shlvl` module shows the current `SHLVL` ("shell level") environment variable, if it is
2020-08-05 18:30:01 +02:00
set to a number and meets or exceeds the specified threshold.
### Options
2021-04-16 22:51:37 +02:00
| Option | Default | Description |
| ----------- | ---------------------------- | ------------------------------------------------------------- |
| `threshold` | `2` | Display threshold. |
| `format` | `"[$symbol$shlvl]($style) "` | The format for the module. |
| `symbol` | `"↕️ "` | The symbol used to represent the `SHLVL` . |
2021-03-24 18:19:51 +01:00
| `repeat` | `false` | Causes `symbol` to be repeated by the current `SHLVL` amount. |
2021-04-16 22:51:37 +02:00
| `style` | `"bold yellow"` | The style for the module. |
| `disabled` | `true` | Disables the `shlvl` module. |
2020-08-05 18:30:01 +02:00
### Variables
2020-09-08 18:09:21 +02:00
| Variable | Example | Description |
| -------- | ------- | ------------------------------------ |
2021-04-16 22:51:37 +02:00
| shlvl | `3` | The current value of `SHLVL` |
2020-09-08 18:09:21 +02:00
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
2020-08-05 18:30:01 +02:00
\*: This variable can only be used as a part of a style string
### Example
```toml
# ~/.config/starship.toml
[shlvl]
disabled = false
format = "$shlvl level(s) down"
threshold = 3
```
2020-02-26 17:18:19 +01:00
## Singularity
The `singularity` module shows the current singularity image, if inside a container
and `$SINGULARITY_NAME` is set.
### Options
2020-10-12 06:10:39 +02:00
| Option | Default | Description |
| ---------- | ------------------------------ | ------------------------------------------------ |
| `format` | `'[$symbol\[$env\]]($style) '` | The format for the module. |
| `symbol` | `""` | A format string displayed before the image name. |
| `style` | `"bold dimmed blue"` | The style for the module. |
| `disabled` | `false` | Disables the `singularity` module. |
2020-07-08 00:45:32 +02:00
### Variables
| Variable | Example | Description |
| -------- | ------------ | ------------------------------------ |
| env | `centos.img` | The current singularity image |
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
2020-02-26 17:18:19 +01:00
### Example
```toml
# ~/.config/starship.toml
[singularity]
2020-10-12 06:10:39 +02:00
format = '[📦 \[$env\]]($style) '
2020-02-26 17:18:19 +01:00
```
2020-09-26 00:04:51 +02:00
## 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
2020-10-01 00:38:57 +02:00
2020-09-26 00:04:51 +02:00
This module is disabled by default.
To enable it, set `disabled` to `false` in your configuration file.
2021-01-07 23:35:12 +01:00
2020-09-26 00:04:51 +02:00
:::
2021-02-02 12:59:55 +01:00
::: warning
This module is not supported on elvish shell.
:::
2020-09-26 00:04:51 +02:00
### Options
2021-04-16 22:51:37 +02:00
| Option | Default | Description |
| ------------------------- | ----------------------------- | ------------------------------------------------------ |
2021-01-26 22:42:41 +01:00
| `format` | `"[$symbol$status]($style) "` | The format of the module |
2021-04-16 22:51:37 +02:00
| `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 red"` | The style for the 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. |
2020-09-26 00:04:51 +02:00
### Variables
2021-01-03 04:09:13 +01:00
| Variable | Example | 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 | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
2020-09-26 00:04:51 +02:00
\*: This variable can only be used as a part of a style string
### Example
2020-10-01 00:38:57 +02:00
2020-09-26 00:04:51 +02:00
```toml
# ~/.config/starship.toml
[status]
style = "bg:blue"
2021-01-03 04:09:13 +01:00
symbol = "🔴"
2021-02-03 18:52:15 +01:00
format = '[\[$symbol $common_meaning$signal_name$maybe_int\]]($style) '
2021-01-03 04:09:13 +01:00
map_symbol = true
2020-09-26 00:04:51 +02:00
disabled = false
```
2020-11-14 19:41:58 +01:00
## Swift
2021-02-21 18:01:31 +01:00
By default the `swift` module shows the currently installed version of Swift.
2020-11-14 19:41:58 +01:00
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
2021-02-21 18:01:31 +01:00
| Option | Default | Description |
| ------------------- | ------------------------------------ | ------------------------------------------------ |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"🐦 "` | A format string representing the symbol of Swift |
2021-03-25 14:46:46 +01:00
| `detect_extensions` | `["swift"]` | Which extensions should trigger this module. |
2021-02-21 18:01:31 +01:00
| `detect_files` | `["Package.swift"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `"bold 202"` | The style for the module. |
| `disabled` | `false` | Disables the `swift` module. |
2020-11-14 19:41:58 +01:00
### Variables
| Variable | Example | Description |
| -------- | -------- | ------------------------------------ |
| version | `v5.2.4` | The version of `swift` |
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
### Example
```toml
# ~/.config/starship.toml
[swift]
format = "via [🏎 $version ](red bold )"
```
2019-12-09 02:42:51 +01:00
## Terraform
The `terraform` module shows the currently selected terraform workspace and version.
2021-01-23 15:17:51 +01:00
::: 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.
2020-07-08 00:45:32 +02:00
If you still want to enable it, [follow the example shown below ](#with-version ).
2021-01-23 15:17:51 +01:00
:::
2021-02-17 18:57:40 +01:00
By default the module will be shown if any of the following conditions are met:
2019-12-09 02:42:51 +01:00
- The current directory contains a `.terraform` folder
2020-11-14 18:33:21 +01:00
- Current directory contains a file with the `.tf` or `.hcl` extensions
2019-12-09 02:42:51 +01:00
### Options
2021-02-17 18:57:40 +01:00
| Option | Default | 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"` | The style for the module. |
| `disabled` | `false` | Disables the `terraform` module. |
2020-07-08 00:45:32 +02:00
### Variables
| Variable | Example | Description |
| --------- | ---------- | ------------------------------------ |
| version | `v0.12.24` | The version of `terraform` |
| workspace | `default` | The current terraform workspace |
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
2019-12-09 02:42:51 +01:00
### Example
2020-07-08 00:45:32 +02:00
#### With Version
2019-12-09 02:42:51 +01:00
```toml
# ~/.config/starship.toml
[terraform]
2020-07-08 00:45:32 +02:00
format = "[🏎💨 $version$workspace]($style) "
```
#### Without version
```toml
# ~/.config/starship.toml
[terraform]
format = "[🏎💨 $workspace]($style) "
2019-12-09 02:42:51 +01:00
```
2019-09-10 19:54:40 +02:00
## Time
The `time` module shows the current **local** time.
The `format` configuration value is used by the [`chrono` ](https://crates.io/crates/chrono ) crate to control how the time is displayed. Take a look [at the chrono strftime docs ](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html ) to see what options are available.
::: tip
2019-09-28 13:20:18 +02:00
2019-09-10 19:54:40 +02:00
This module is disabled by default.
To enable it, set `disabled` to `false` in your configuration file.
2019-09-28 13:20:18 +02:00
2019-09-10 19:54:40 +02:00
:::
### Options
2020-07-08 00:45:32 +02:00
| Option | Default | 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 ](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html ) 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.
2019-09-10 19:54:40 +02:00
2020-07-08 00:45:32 +02:00
### Variables
| Variable | Example | Description |
| -------- | ---------- | ----------------------------------- |
| time | `13:08:10` | The current time. |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
2019-09-10 19:54:40 +02:00
### Example
```toml
# ~/.config/starship.toml
[time]
disabled = false
2020-10-12 06:10:39 +02:00
format = '🕙[\[ $time \]]($style) '
2020-07-08 00:45:32 +02:00
time_format = "%T"
2020-02-28 19:01:47 +01:00
utc_time_offset = "-5"
2020-05-31 19:43:08 +02:00
time_range = "10:00:00-14:00:00"
2019-09-10 19:54:40 +02:00
```
2019-07-19 22:18:52 +02: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
2019-09-22 22:32:11 +02:00
- The variable `show_always` is set to true
2019-07-19 22:18:52 +02:00
2020-12-06 22:15:20 +01:00
::: tip
2021-01-07 23:35:12 +01:00
2020-12-06 22:15:20 +01:00
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.
2021-01-07 23:35:12 +01:00
2020-12-06 22:15:20 +01:00
:::
2019-07-19 22:18:52 +02:00
### Options
2020-09-08 18:09:21 +02:00
| Option | Default | Description |
| ------------- | ----------------------- | ------------------------------------- |
| `style_root` | `"bold red"` | The style used when the user is root. |
| `style_user` | `"bold yellow"` | The style used for non-root users. |
| `format` | `"[$user]($style) in "` | The format for the module. |
| `show_always` | `false` | Always shows the `username` module. |
| `disabled` | `false` | Disables the `username` module. |
2020-07-08 00:45:32 +02:00
### Variables
| Variable | Example | 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. |
2019-07-19 22:18:52 +02:00
### Example
```toml
# ~/.config/starship.toml
[username]
2020-07-08 00:45:32 +02:00
style_user = "white bold"
style_root = "black bold"
format = "user: [$user ]($style ) "
disabled = false
show_always = true
2019-07-19 22:18:52 +02:00
```
2020-04-11 18:37:24 +02:00
2021-01-30 12:05:16 +01:00
## Vagrant
The `vagrant` module shows the currently installed version of Vagrant.
2021-02-15 20:21:21 +01:00
By default the module will be shown if any of the following conditions are met:
2021-01-30 12:05:16 +01:00
- The current directory contains a `Vagrantfile` file
### Options
2021-02-15 20:21:21 +01:00
| Option | Default | Description |
| ------------------- | ------------------------------------ | --------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the 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"` | The style for the module. |
2021-03-24 18:19:51 +01:00
| `disabled` | `false` | Disables the `vagrant` module. |
2021-01-30 12:05:16 +01:00
### Variables
| Variable | Example | Description |
| -------- | ---------------- | ------------------------------------ |
| version | `Vagrant 2.2.10` | The version of `Vagrant` |
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
### Example
```toml
# ~/.config/starship.toml
[vagrant]
format = "via [⍱ $version ](bold white ) "
```
2021-03-28 17:48:15 +02:00
## VCSH
The `vcsh` module displays the current active VCSH repository.
The module will be shown only if a repository is currently in use.
### Options
2021-04-16 22:51:37 +02:00
| Option | Default | Description |
| ---------- | -------------------------------- | ------------------------------------------------------- |
| `symbol` | | The symbol used before displaying the repository name. |
| `style` | `"bold yellow"` | The style for the module. |
| `format` | `"vcsh [$symbol$repo]($style) "` | The format for the module. |
| `disabled` | `false` | Disables the `vcsh` module. |
2021-03-28 17:48:15 +02:00
### Variables
2021-04-16 22:51:37 +02:00
| Variable | Example | Description |
| -------- | ------------------------------------------- | ------------------------------------- |
| repo | `dotfiles` if in a VCSH repo named dotfiles | The active repository name |
| symbol | | Mirrors the value of option `symbol` |
| style\* | `black bold dimmed` | Mirrors the value of option `style` |
2021-03-28 17:48:15 +02:00
\*: This variable can only be used as a part of a style string
### Example
```toml
# ~/.config/starship.toml
[vcsh]
format = "[🆅 $repo](bold blue) "
```
2020-05-21 18:49:49 +02:00
## Zig
2021-02-14 22:21:44 +01:00
By default the the `zig` module shows the currently installed version of Zig.
2020-05-21 18:49:49 +02:00
The module will be shown if any of the following conditions are met:
- The current directory contains a `.zig` file
### Options
2021-02-14 22:21:44 +01:00
| Option | Default | Description |
| ------------------- | ------------------------------------ | ----------------------------------------------------- |
| `symbol` | `"↯ "` | The symbol used before displaying the version of Zig. |
| `style` | `"bold yellow"` | The style for the module. |
| `format` | `"via [$symbol($version )]($style)"` | The format for the 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. |
2020-07-08 00:45:32 +02:00
### Variables
| Variable | Example | Description |
| -------- | -------- | ------------------------------------ |
| version | `v0.6.0` | The version of `zig` |
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
2020-05-21 18:49:49 +02:00
### Example
```toml
# ~/.config/starship.toml
[zig]
symbol = "⚡️ "
```
2020-04-11 18:37:24 +02:00
## 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:
2020-07-08 00:45:32 +02:00
2020-04-11 18:37:24 +02:00
- 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
2020-09-08 18:09:21 +02:00
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 `${...}` ).
2020-09-01 19:07:12 +02:00
By default, the `custom` module will simply show all custom modules in the order they were defined.
:::
::: tip
[Issue #1252 ](https://github.com/starship/starship/discussions/1252 ) contains examples of custom modules.
If you have an interesting example not covered there, feel free to share it there!
2020-04-11 18:37:24 +02:00
:::
### Options
2021-04-16 22:51:37 +02:00
| Option | Default | Description |
2021-01-20 19:01:49 +01:00
| ------------- | ------------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
| `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 ](#custom-command-shell ) |
| `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"` | The style for the module. |
| `format` | `"[$symbol($output )]($style)"` | The format for the module. |
| `disabled` | `false` | Disables this `custom` module. |
2020-07-08 00:45:32 +02:00
### Variables
| Variable | Description |
| -------- | -------------------------------------- |
| output | The output of shell command in `shell` |
| symbol | Mirrors the value of option `symbol` |
| style\* | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
2020-04-11 18:37:24 +02:00
2020-05-27 09:38:05 +02:00
#### Custom command shell
`shell` accepts a non-empty list of strings, where:
2020-07-08 00:45:32 +02:00
2020-05-27 09:38:05 +02:00
- 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.
2020-09-01 19:07:12 +02:00
The `command` will be passed in on stdin.
2020-05-27 09:38:05 +02:00
If `shell` is not given or only contains one element and Starship detects PowerShell will be used,
2020-06-14 11:27:10 +02:00
the following arguments will automatically be added: `-NoProfile -Command -` .
2020-05-27 09:38:05 +02:00
This behavior can be avoided by explicitly passing arguments to the shell, e.g.
```toml
shell = ["pwsh", "-Command", "-"]
```
2020-05-28 17:37:54 +02:00
::: 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 ](https://github.com/starship/starship/issues/new/choose )
with shell details and starship configuration if you hit such scenario.
:::
2020-04-11 18:37:24 +02:00
### Example
```toml
# ~/.config/starship.toml
[custom.foo]
command = "echo foo" # shows output of command
files = ["foo"] # can specify filters
when = """ test "$HOME" == "$PWD" """
2020-09-19 20:50:52 +02:00
format = " transcending [$output ]($style )"
2020-05-28 17:37:54 +02:00
[custom.time]
command = "time /T"
files = ["*.pst"]
shell = ["pwsh.exe", "-NoProfile", "-Command", "-"]
2020-04-11 18:37:24 +02:00
```
