diff options
author | Dario Vladović <d.vladimyr@gmail.com> | 2021-04-30 08:19:54 +0200 |
---|---|---|
committer | GitHub <noreply@github.com> | 2021-04-30 08:19:54 +0200 |
commit | ff3c893a76268efcd55e629cfa8e7587a9677067 (patch) | |
tree | beb21c3fa658db0d21e6b63db1a2631798cb5514 /docs | |
parent | d242d40db61ca225be834b0747adf3f91a81bd03 (diff) |
feat(gcloud): introduce separate `account` & `domain` format string variables (#2594)
* feat(gcloud): split gcloud profile into `account` & `domain` format variables
* docs(gcloud): update documentation
Co-authored-by: Filip Bachul <filip.b@masterborn.com>
Diffstat (limited to 'docs')
-rw-r--r-- | docs/config/README.md | 33 |
1 files changed, 17 insertions, 16 deletions
diff --git a/docs/config/README.md b/docs/config/README.md index 1613eaad9..3cad18597 100644 --- a/docs/config/README.md +++ b/docs/config/README.md @@ -1045,24 +1045,25 @@ This is based on the `~/.config/gcloud/active_config` file and the `~/.config/gc ### Options -| Option | Default | Description | -| ---------------- | ---------------------------------------------- | --------------------------------------------------------------- | -| `format` | `'on [$symbol$account(\($region\))]($style) '` | The format for the module. | -| `symbol` | `"☁️ "` | The symbol used before displaying the current GCP profile. | -| `region_aliases` | | Table of region aliases to display in addition to the GCP name. | -| `style` | `"bold blue"` | The style for the module. | -| `disabled` | `false` | Disables the `gcloud` module. | +| Option | Default | Description | +| ---------------- | -------------------------------------------------------- | --------------------------------------------------------------- | +| `format` | `'on [$symbol$account(@$domain)(\($region\))]($style) '` | The format for the module. | +| `symbol` | `"☁️ "` | The symbol used before displaying the current GCP profile. | +| `region_aliases` | | Table of region aliases to display in addition to the GCP name. | +| `style` | `"bold blue"` | The style for the module. | +| `disabled` | `false` | Disables the `gcloud` module. | ### 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` | +| Variable | Example | Description | +| -------- | ------------- | ------------------------------------------------------------------ | +| region | `us-central1` | The current GCP region | +| account | `foo` | The current GCP profile | +| domain | `example.com` | The current GCP profile domain | +| 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 @@ -1074,7 +1075,7 @@ This is based on the `~/.config/gcloud/active_config` file and the `~/.config/gc # ~/.config/starship.toml [gcloud] -format = 'on [$symbol$account(\($project\))]($style) ' +format = 'on [$symbol$account(@$domain)(\($project\))]($style) ' ``` #### Display active config name only |