summaryrefslogtreecommitdiffstats
path: root/docs/config/README.md
diff options
context:
space:
mode:
authorDenis Cornehl <denis@cornehl.org>2023-05-09 07:55:49 +0200
committerGitHub <noreply@github.com>2023-05-09 07:55:49 +0200
commitd07a8e3668838223aeeb94e810a0b29806e35f78 (patch)
tree1b2b0adc69eb7d87d02fe06343eb8f9fb71635e7 /docs/config/README.md
parent297176b0b8b9da34176d7b278837f77f960799b1 (diff)
feat(gcloud): add `detect_env_vars` option (#5166)
* feat(gcloud): add `detect_env_vars` option * regenerate config schema
Diffstat (limited to 'docs/config/README.md')
-rw-r--r--docs/config/README.md5
1 files changed, 5 insertions, 0 deletions
diff --git a/docs/config/README.md b/docs/config/README.md
index 510c51d5a..33bc1ee22 100644
--- a/docs/config/README.md
+++ b/docs/config/README.md
@@ -1609,6 +1609,10 @@ truncation_symbol = ''
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.
+When the module is enabled it will always be active, unless `detect_env_vars` has
+been set in which case the module will only be active be active when one of the
+environment variables has been set.
+
### Options
| Option | Default | Description |
@@ -1617,6 +1621,7 @@ This is based on the `~/.config/gcloud/active_config` file and the `~/.config/gc
| `symbol` | `'☁️ '` | The symbol used before displaying the current GCP profile. |
| `region_aliases` | `{}` | Table of region aliases to display in addition to the GCP name. |
| `project_aliases` | `{}` | Table of project aliases to display in addition to the GCP name. |
+| `detect_env_vars` | `[]` | Which environmental variables should trigger this module |
| `style` | `'bold blue'` | The style for the module. |
| `disabled` | `false` | Disables the `gcloud` module. |