Merge pull request #50 from caliban0/configRework

Config rework
cherryservers · Jul 23, 2024 · e7a309d · e7a309d
2 parents db3a107 + 0bf9c79
commit e7a309d
Show file tree

Hide file tree

Showing 79 changed files with 268 additions and 217 deletions.
diff --git a/docs/cherryctl.md b/docs/cherryctl.md
@@ -10,7 +10,7 @@ cherryctl is a command line interface (CLI) for Cherry Servers API
 
 ```
       --api-url string   Override default API endpoint (default "https://api.cherryservers.com/v1/")
-      --config string    Path to JSON or YAML configuration file
+      --config string    Path to configuration file directory. The CHERRY_CONFIG environment variable can be used as well.
       --context string   Specify a custom context name (default "default")
       --fields strings   Comma separated object field names to output in result. Fields can be used for list and get actions.
   -h, --help             help for cherryctl

diff --git a/docs/cherryctl_backup.md b/docs/cherryctl_backup.md
@@ -16,7 +16,7 @@ Server backup storage operations: plans, get, list, create, update, methods, upd
 
 ```
       --api-url string   Override default API endpoint (default "https://api.cherryservers.com/v1/")
-      --config string    Path to JSON or YAML configuration file
+      --config string    Path to configuration file directory. The CHERRY_CONFIG environment variable can be used as well.
       --context string   Specify a custom context name (default "default")
       --fields strings   Comma separated object field names to output in result. Fields can be used for list and get actions.
   -o, --output string    Output format (*table, json, yaml)

diff --git a/docs/cherryctl_backup_create.md b/docs/cherryctl_backup_create.md
@@ -33,7 +33,7 @@ cherryctl backup create {--server-id <id> | --server-hostname <hostname>} --plan
 
 ```
       --api-url string   Override default API endpoint (default "https://api.cherryservers.com/v1/")
-      --config string    Path to JSON or YAML configuration file
+      --config string    Path to configuration file directory. The CHERRY_CONFIG environment variable can be used as well.
       --context string   Specify a custom context name (default "default")
       --fields strings   Comma separated object field names to output in result. Fields can be used for list and get actions.
   -o, --output string    Output format (*table, json, yaml)

diff --git a/docs/cherryctl_backup_delete.md b/docs/cherryctl_backup_delete.md
@@ -33,7 +33,7 @@ cherryctl backup delete ID [-f] [flags]
 
 ```
       --api-url string   Override default API endpoint (default "https://api.cherryservers.com/v1/")
-      --config string    Path to JSON or YAML configuration file
+      --config string    Path to configuration file directory. The CHERRY_CONFIG environment variable can be used as well.
       --context string   Specify a custom context name (default "default")
       --fields strings   Comma separated object field names to output in result. Fields can be used for list and get actions.
   -o, --output string    Output format (*table, json, yaml)

diff --git a/docs/cherryctl_backup_get.md b/docs/cherryctl_backup_get.md
@@ -27,7 +27,7 @@ cherryctl backup get <backup_ID> [flags]
 
 ```
       --api-url string   Override default API endpoint (default "https://api.cherryservers.com/v1/")
-      --config string    Path to JSON or YAML configuration file
+      --config string    Path to configuration file directory. The CHERRY_CONFIG environment variable can be used as well.
       --context string   Specify a custom context name (default "default")
       --fields strings   Comma separated object field names to output in result. Fields can be used for list and get actions.
   -o, --output string    Output format (*table, json, yaml)

diff --git a/docs/cherryctl_backup_list.md b/docs/cherryctl_backup_list.md
@@ -28,7 +28,7 @@ cherryctl backup list [-p <project_id>] [flags]
 
 ```
       --api-url string   Override default API endpoint (default "https://api.cherryservers.com/v1/")
-      --config string    Path to JSON or YAML configuration file
+      --config string    Path to configuration file directory. The CHERRY_CONFIG environment variable can be used as well.
       --context string   Specify a custom context name (default "default")
       --fields strings   Comma separated object field names to output in result. Fields can be used for list and get actions.
   -o, --output string    Output format (*table, json, yaml)

diff --git a/docs/cherryctl_backup_methods-whitelist.md b/docs/cherryctl_backup_methods-whitelist.md
@@ -27,7 +27,7 @@ cherryctl backup methods-whitelist <backup_ID> [flags]
 
 ```
       --api-url string   Override default API endpoint (default "https://api.cherryservers.com/v1/")
-      --config string    Path to JSON or YAML configuration file
+      --config string    Path to configuration file directory. The CHERRY_CONFIG environment variable can be used as well.
       --context string   Specify a custom context name (default "default")
       --fields strings   Comma separated object field names to output in result. Fields can be used for list and get actions.
   -o, --output string    Output format (*table, json, yaml)

diff --git a/docs/cherryctl_backup_methods.md b/docs/cherryctl_backup_methods.md
@@ -27,7 +27,7 @@ cherryctl backup methods <backup_ID> [flags]
 
 ```
       --api-url string   Override default API endpoint (default "https://api.cherryservers.com/v1/")
-      --config string    Path to JSON or YAML configuration file
+      --config string    Path to configuration file directory. The CHERRY_CONFIG environment variable can be used as well.
       --context string   Specify a custom context name (default "default")
       --fields strings   Comma separated object field names to output in result. Fields can be used for list and get actions.
   -o, --output string    Output format (*table, json, yaml)

diff --git a/docs/cherryctl_backup_plans.md b/docs/cherryctl_backup_plans.md
@@ -27,7 +27,7 @@ cherryctl backup plans [flags]
 
 ```
       --api-url string   Override default API endpoint (default "https://api.cherryservers.com/v1/")
-      --config string    Path to JSON or YAML configuration file
+      --config string    Path to configuration file directory. The CHERRY_CONFIG environment variable can be used as well.
       --context string   Specify a custom context name (default "default")
       --fields strings   Comma separated object field names to output in result. Fields can be used for list and get actions.
   -o, --output string    Output format (*table, json, yaml)

diff --git a/docs/cherryctl_backup_update-method.md b/docs/cherryctl_backup_update-method.md
@@ -31,7 +31,7 @@ cherryctl backup update-method <backup_ID> --method-name <string> [--enable] [--
 
 ```
       --api-url string   Override default API endpoint (default "https://api.cherryservers.com/v1/")
-      --config string    Path to JSON or YAML configuration file
+      --config string    Path to configuration file directory. The CHERRY_CONFIG environment variable can be used as well.
       --context string   Specify a custom context name (default "default")
       --fields strings   Comma separated object field names to output in result. Fields can be used for list and get actions.
   -o, --output string    Output format (*table, json, yaml)

diff --git a/docs/cherryctl_backup_update.md b/docs/cherryctl_backup_update.md
@@ -32,7 +32,7 @@ cherryctl backup update <backup_ID> [--password <plain_text>] [--ssh-key <plain_
 
 ```
       --api-url string   Override default API endpoint (default "https://api.cherryservers.com/v1/")
-      --config string    Path to JSON or YAML configuration file
+      --config string    Path to configuration file directory. The CHERRY_CONFIG environment variable can be used as well.
       --context string   Specify a custom context name (default "default")
       --fields strings   Comma separated object field names to output in result. Fields can be used for list and get actions.
   -o, --output string    Output format (*table, json, yaml)

diff --git a/docs/cherryctl_backup_upgrade.md b/docs/cherryctl_backup_upgrade.md
@@ -28,7 +28,7 @@ cherryctl backup upgrade <backup_ID> --plan <backup_plan_slug> [flags]
 
 ```
       --api-url string   Override default API endpoint (default "https://api.cherryservers.com/v1/")
-      --config string    Path to JSON or YAML configuration file
+      --config string    Path to configuration file directory. The CHERRY_CONFIG environment variable can be used as well.
       --context string   Specify a custom context name (default "default")
       --fields strings   Comma separated object field names to output in result. Fields can be used for list and get actions.
   -o, --output string    Output format (*table, json, yaml)

diff --git a/docs/cherryctl_completion.md b/docs/cherryctl_completion.md
@@ -18,7 +18,7 @@ See each sub-command's help for details on how to use the generated script.
 
 ```
       --api-url string   Override default API endpoint (default "https://api.cherryservers.com/v1/")
-      --config string    Path to JSON or YAML configuration file
+      --config string    Path to configuration file directory. The CHERRY_CONFIG environment variable can be used as well.
       --context string   Specify a custom context name (default "default")
       --fields strings   Comma separated object field names to output in result. Fields can be used for list and get actions.
   -o, --output string    Output format (*table, json, yaml)

diff --git a/docs/cherryctl_completion_bash.md b/docs/cherryctl_completion_bash.md
@@ -41,7 +41,7 @@ cherryctl completion bash
 
 ```
       --api-url string   Override default API endpoint (default "https://api.cherryservers.com/v1/")
-      --config string    Path to JSON or YAML configuration file
+      --config string    Path to configuration file directory. The CHERRY_CONFIG environment variable can be used as well.
       --context string   Specify a custom context name (default "default")
       --fields strings   Comma separated object field names to output in result. Fields can be used for list and get actions.
   -o, --output string    Output format (*table, json, yaml)

diff --git a/docs/cherryctl_completion_fish.md b/docs/cherryctl_completion_fish.md
@@ -32,7 +32,7 @@ cherryctl completion fish [flags]
 
 ```
       --api-url string   Override default API endpoint (default "https://api.cherryservers.com/v1/")
-      --config string    Path to JSON or YAML configuration file
+      --config string    Path to configuration file directory. The CHERRY_CONFIG environment variable can be used as well.
       --context string   Specify a custom context name (default "default")
       --fields strings   Comma separated object field names to output in result. Fields can be used for list and get actions.
   -o, --output string    Output format (*table, json, yaml)

diff --git a/docs/cherryctl_completion_powershell.md b/docs/cherryctl_completion_powershell.md
@@ -29,7 +29,7 @@ cherryctl completion powershell [flags]
 
 ```
       --api-url string   Override default API endpoint (default "https://api.cherryservers.com/v1/")
-      --config string    Path to JSON or YAML configuration file
+      --config string    Path to configuration file directory. The CHERRY_CONFIG environment variable can be used as well.
       --context string   Specify a custom context name (default "default")
       --fields strings   Comma separated object field names to output in result. Fields can be used for list and get actions.
   -o, --output string    Output format (*table, json, yaml)

diff --git a/docs/cherryctl_completion_zsh.md b/docs/cherryctl_completion_zsh.md
@@ -43,7 +43,7 @@ cherryctl completion zsh [flags]
 
 ```
       --api-url string   Override default API endpoint (default "https://api.cherryservers.com/v1/")
-      --config string    Path to JSON or YAML configuration file
+      --config string    Path to configuration file directory. The CHERRY_CONFIG environment variable can be used as well.
       --context string   Specify a custom context name (default "default")
       --fields strings   Comma separated object field names to output in result. Fields can be used for list and get actions.
   -o, --output string    Output format (*table, json, yaml)

diff --git a/docs/cherryctl_docs.md b/docs/cherryctl_docs.md
@@ -27,7 +27,7 @@ cherryctl docs <destination>
 
 ```
       --api-url string   Override default API endpoint (default "https://api.cherryservers.com/v1/")
-      --config string    Path to JSON or YAML configuration file
+      --config string    Path to configuration file directory. The CHERRY_CONFIG environment variable can be used as well.
       --context string   Specify a custom context name (default "default")
       --fields strings   Comma separated object field names to output in result. Fields can be used for list and get actions.
   -o, --output string    Output format (*table, json, yaml)

diff --git a/docs/cherryctl_image.md b/docs/cherryctl_image.md
@@ -16,7 +16,7 @@ Image operations: list.
 
 ```
       --api-url string   Override default API endpoint (default "https://api.cherryservers.com/v1/")
-      --config string    Path to JSON or YAML configuration file
+      --config string    Path to configuration file directory. The CHERRY_CONFIG environment variable can be used as well.
       --context string   Specify a custom context name (default "default")
       --fields strings   Comma separated object field names to output in result. Fields can be used for list and get actions.
   -o, --output string    Output format (*table, json, yaml)

diff --git a/docs/cherryctl_image_list.md b/docs/cherryctl_image_list.md
@@ -28,7 +28,7 @@ cherryctl image list --plan <plan_slug> [flags]
 
 ```
       --api-url string   Override default API endpoint (default "https://api.cherryservers.com/v1/")
-      --config string    Path to JSON or YAML configuration file
+      --config string    Path to configuration file directory. The CHERRY_CONFIG environment variable can be used as well.
       --context string   Specify a custom context name (default "default")
       --fields strings   Comma separated object field names to output in result. Fields can be used for list and get actions.
   -o, --output string    Output format (*table, json, yaml)

diff --git a/docs/cherryctl_init.md b/docs/cherryctl_init.md
@@ -4,7 +4,12 @@ Configuration file initialization.
 
 ### Synopsis
 
-Init will prompt for account settings and store the values as defaults in a configuration file that may be shared with other Cherry Servers tools. This file is typically stored in $HOME/.config/cherry/config.yaml. Any Cherry CLI command line argument can be specified in the config file. Be careful not to define options that you do not intend to use as defaults. The configuration file path can be changed with the CHERRY_CONFIG environment variable or --config option.
+Init will prompt for account settings and store the values as defaults in a configuration file.
+This file is stored in the default user configuration directory (platform dependent), unless otherwise specified by the --config flag.
+The --context flag can be used to change the default config file name.
+Any Cherry CLI command line argument can be specified in the config file.
+Be careful not to define options that you do not intend to use as defaults.
+The configuration directory path can be changed with the CHERRY_CONFIG environment variable or --config option.
 
 ```
 cherryctl init
@@ -30,7 +35,7 @@ cherryctl init
 
 ```
       --api-url string   Override default API endpoint (default "https://api.cherryservers.com/v1/")
-      --config string    Path to JSON or YAML configuration file
+      --config string    Path to configuration file directory. The CHERRY_CONFIG environment variable can be used as well.
       --context string   Specify a custom context name (default "default")
       --fields strings   Comma separated object field names to output in result. Fields can be used for list and get actions.
   -o, --output string    Output format (*table, json, yaml)

diff --git a/docs/cherryctl_ip.md b/docs/cherryctl_ip.md
@@ -16,7 +16,7 @@ IP address operations: get, list, create, update, assign, unassign and delete.
 
 ```
       --api-url string   Override default API endpoint (default "https://api.cherryservers.com/v1/")
-      --config string    Path to JSON or YAML configuration file
+      --config string    Path to configuration file directory. The CHERRY_CONFIG environment variable can be used as well.
       --context string   Specify a custom context name (default "default")
       --fields strings   Comma separated object field names to output in result. Fields can be used for list and get actions.
   -o, --output string    Output format (*table, json, yaml)

diff --git a/docs/cherryctl_ip_assign.md b/docs/cherryctl_ip_assign.md
@@ -31,7 +31,7 @@ cherryctl ip assign ID {--target-hostname <hostname> | --target-id <server_id> |
 
 ```
       --api-url string   Override default API endpoint (default "https://api.cherryservers.com/v1/")
-      --config string    Path to JSON or YAML configuration file
+      --config string    Path to configuration file directory. The CHERRY_CONFIG environment variable can be used as well.
       --context string   Specify a custom context name (default "default")
       --fields strings   Comma separated object field names to output in result. Fields can be used for list and get actions.
   -o, --output string    Output format (*table, json, yaml)

diff --git a/docs/cherryctl_ip_create.md b/docs/cherryctl_ip_create.md
@@ -35,7 +35,7 @@ cherryctl ip create -p <project_id> --region <region_slug> [--target-hostname <h
 
 ```
       --api-url string   Override default API endpoint (default "https://api.cherryservers.com/v1/")
-      --config string    Path to JSON or YAML configuration file
+      --config string    Path to configuration file directory. The CHERRY_CONFIG environment variable can be used as well.
       --context string   Specify a custom context name (default "default")
       --fields strings   Comma separated object field names to output in result. Fields can be used for list and get actions.
   -o, --output string    Output format (*table, json, yaml)

diff --git a/docs/cherryctl_ip_delete.md b/docs/cherryctl_ip_delete.md
@@ -33,7 +33,7 @@ cherryctl ip delete ID [-f] [flags]
 
 ```
       --api-url string   Override default API endpoint (default "https://api.cherryservers.com/v1/")
-      --config string    Path to JSON or YAML configuration file
+      --config string    Path to configuration file directory. The CHERRY_CONFIG environment variable can be used as well.
       --context string   Specify a custom context name (default "default")
       --fields strings   Comma separated object field names to output in result. Fields can be used for list and get actions.
   -o, --output string    Output format (*table, json, yaml)

diff --git a/docs/cherryctl_ip_get.md b/docs/cherryctl_ip_get.md
@@ -27,7 +27,7 @@ cherryctl ip get ID [flags]
 
 ```
       --api-url string   Override default API endpoint (default "https://api.cherryservers.com/v1/")
-      --config string    Path to JSON or YAML configuration file
+      --config string    Path to configuration file directory. The CHERRY_CONFIG environment variable can be used as well.
       --context string   Specify a custom context name (default "default")
       --fields strings   Comma separated object field names to output in result. Fields can be used for list and get actions.
   -o, --output string    Output format (*table, json, yaml)

diff --git a/docs/cherryctl_ip_list.md b/docs/cherryctl_ip_list.md
@@ -29,7 +29,7 @@ cherryctl ip list -p <project_id> [flags]
 
 ```
       --api-url string   Override default API endpoint (default "https://api.cherryservers.com/v1/")
-      --config string    Path to JSON or YAML configuration file
+      --config string    Path to configuration file directory. The CHERRY_CONFIG environment variable can be used as well.
       --context string   Specify a custom context name (default "default")
       --fields strings   Comma separated object field names to output in result. Fields can be used for list and get actions.
   -o, --output string    Output format (*table, json, yaml)

diff --git a/docs/cherryctl_ip_unassign.md b/docs/cherryctl_ip_unassign.md
@@ -27,7 +27,7 @@ cherryctl ip unassign ID [flags]
 
 ```
       --api-url string   Override default API endpoint (default "https://api.cherryservers.com/v1/")
-      --config string    Path to JSON or YAML configuration file
+      --config string    Path to configuration file directory. The CHERRY_CONFIG environment variable can be used as well.
       --context string   Specify a custom context name (default "default")
       --fields strings   Comma separated object field names to output in result. Fields can be used for list and get actions.
   -o, --output string    Output format (*table, json, yaml)

diff --git a/docs/cherryctl_ip_update.md b/docs/cherryctl_ip_update.md
@@ -30,7 +30,7 @@ cherryctl ip update ID [--ptr-record <ptr>] [--a-record <a>] [--tags <tags>] [fl
 
 ```
       --api-url string   Override default API endpoint (default "https://api.cherryservers.com/v1/")
-      --config string    Path to JSON or YAML configuration file
+      --config string    Path to configuration file directory. The CHERRY_CONFIG environment variable can be used as well.
       --context string   Specify a custom context name (default "default")
       --fields strings   Comma separated object field names to output in result. Fields can be used for list and get actions.
   -o, --output string    Output format (*table, json, yaml)

diff --git a/docs/cherryctl_plan.md b/docs/cherryctl_plan.md
@@ -16,7 +16,7 @@ Plan operations: get, list.
 
 ```
       --api-url string   Override default API endpoint (default "https://api.cherryservers.com/v1/")
-      --config string    Path to JSON or YAML configuration file
+      --config string    Path to configuration file directory. The CHERRY_CONFIG environment variable can be used as well.
       --context string   Specify a custom context name (default "default")
       --fields strings   Comma separated object field names to output in result. Fields can be used for list and get actions.
   -o, --output string    Output format (*table, json, yaml)