From 17b6a03983a4ec8128af79cccc18fcef1902b3a1 Mon Sep 17 00:00:00 2001 From: fabiante Date: Wed, 28 May 2025 14:51:16 +0200 Subject: [PATCH] Document --config flag explicitly in README When using the CLI, i found myself missing an equivalent to how tools like `kubectl` can be configured to use a different config. When searching for a similar option, i found the `--config` flag. With this commit I want to explicitly document that flag so that other users may find this option too. --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index 87231d4e..d8290031 100644 --- a/README.md +++ b/README.md @@ -46,10 +46,19 @@ projects: url: https://api.gridscale.io ``` +You can specify a custom location for the config file by using the `--config` flag, which +allows you to keep multiple configs per project or environment. For example: + +```shelld +gscloud --config production.yml info +gscloud --config staging.yml info +``` + Following environment variables can also be used instead of config file: - `GRIDSCALE_UUID` - corresponds to `userId` - `GRIDSCALE_TOKEN` - corresponds to `token` - `GRIDSCALE_URL` - corresponds to `url` + **Note**: If the config file and the environment variables are used at the same time, the config file will be ignored and the environment variables will be used. ## Kubernetes