andrei/starship
1
0
Fork 0
mirror of https://github.com/starship/starship.git synced 2026-06-23 02:05:51 +07:00
Code Issues Packages Projects Releases 10 Wiki Activity

docs: add tip for all disabled-by-default modules (#6830)

Browse Source
This commit is contained in:
Justin Su
2025-07-13 13:52:42 -04:00
committed by GitHub
parent dedf7af4df
commit 7e39fd8544
1 changed files with 40 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/config/README.md
+40
View File
@@ -464,6 +464,10 @@ Enterprise_Naming_Scheme-voidstars = 'void**'
The `azure` module shows the current Azure Subscription. This is based on showing the name of the default subscription or the username, as defined in the `~/.azure/azureProfile.json` file. The `azure` module shows the current Azure Subscription. This is based on showing the name of the default subscription or the username, as defined in the `~/.azure/azureProfile.json` file.
> [!TIP]
> This module is disabled by default.
> To enable it, set `disabled` to `false` in your configuration file.
### Options ### Options
| Variable | Default | Description | | Variable | Default | Description |
@@ -1263,6 +1267,10 @@ truncation_symbol = '…/'
The `direnv` module shows the status of the current rc file if one is present. The status includes the path to the rc file, whether it is loaded, and whether it has been allowed by `direnv`. The `direnv` module shows the status of the current rc file if one is present. The status includes the path to the rc file, whether it is loaded, and whether it has been allowed by `direnv`.
> [!TIP]
> This module is disabled by default.
> To enable it, set `disabled` to `false` in your configuration file.
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
@@ -1673,6 +1681,10 @@ AA -------------------------------------------- BB -----------------------------
The `fossil_branch` module shows the name of the active branch of the check-out in your current directory. The `fossil_branch` module shows the name of the active branch of the check-out in your current directory.
> [!TIP]
> This module is disabled by default.
> To enable it, set `disabled` to `false` in your configuration file.
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
@@ -1709,6 +1721,10 @@ truncation_symbol = ''
The `fossil_metrics` module will show the number of added and deleted lines in the check-out in your current directory. At least v2.14 (2021-01-20) of Fossil is required. The `fossil_metrics` module will show the number of added and deleted lines in the check-out in your current directory. At least v2.14 (2021-01-20) of Fossil is required.
> [!TIP]
> This module is disabled by default.
> To enable it, set `disabled` to `false` in your configuration file.
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
@@ -2765,6 +2781,10 @@ disabled = true
The `localip` module shows the IPv4 address of the primary network interface. The `localip` module shows the IPv4 address of the primary network interface.
> [!TIP]
> This module is disabled by default.
> To enable it, set `disabled` to `false` in your configuration file.
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
@@ -2925,6 +2945,10 @@ style = 'bold dimmed green'
The `hg_branch` module shows the active branch and topic of the repo in your current directory. The `hg_branch` module shows the active branch and topic of the repo in your current directory.
> [!TIP]
> This module is disabled by default.
> To enable it, set `disabled` to `false` in your configuration file.
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
@@ -2964,6 +2988,10 @@ The `hg_state` module will show in directories which are part of a mercurial
repository, and where there is an operation in progress, such as: _REBASING_, repository, and where there is an operation in progress, such as: _REBASING_,
_BISECTING_, etc. _BISECTING_, etc.
> [!TIP]
> This module is disabled by default.
> To enable it, set `disabled` to `false` in your configuration file.
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
@@ -2995,6 +3023,10 @@ _BISECTING_, etc.
The `mise` module shows the current mise health as reported by running `mise doctor`. The `mise` module shows the current mise health as reported by running `mise doctor`.
> [!TIP]
> This module is disabled by default.
> To enable it, set `disabled` to `false` in your configuration file.
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
@@ -3673,6 +3705,10 @@ format = 'via [🔹 $version](147 bold) '
The `pijul_channel` module shows the active channel of the repo in your current directory. The `pijul_channel` module shows the active channel of the repo in your current directory.
> [!TIP]
> This module is disabled by default.
> To enable it, set `disabled` to `false` in your configuration file.
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
@@ -4247,6 +4283,10 @@ disabled = false
The `shlvl` module shows the current [`SHLVL`](https://tldp.org/LDP/abs/html/internalvariables.html#SHLVLREF) ('shell level') environment variable, if it is The `shlvl` module shows the current [`SHLVL`](https://tldp.org/LDP/abs/html/internalvariables.html#SHLVLREF) ('shell level') environment variable, if it is
set to a number and meets or exceeds the specified threshold. set to a number and meets or exceeds the specified threshold.
> [!TIP]
> This module is disabled by default.
> To enable it, set `disabled` to `false` in your configuration file.
### Options ### Options
| Option | Default | Description | | Option | Default | Description |