Change default config path in usage string and regenerate docs

metal-toolbox · Aug 14, 2023 · 00270e5 · 00270e5
1 parent 79f2eca
commit 00270e5
Show file tree

Hide file tree

Showing 30 changed files with 30 additions and 30 deletions.
diff --git a/cmd/root.go b/cmd/root.go
@@ -45,6 +45,6 @@ func Execute() {
 }
 
 func init() {
-	RootCmd.PersistentFlags().StringVar(&cfgFile, "config", "", "config file (default is $HOME/.mctl.yml)")
+	RootCmd.PersistentFlags().StringVar(&cfgFile, "config", "", "config file (default is $XDG_CACHE_DIR/mctl/config.yml)")
 	RootCmd.PersistentFlags().BoolVar(&reAuth, "reauth", false, "re-authenticate with oauth services")
 }
diff --git a/docs/mctl.md b/docs/mctl.md
@@ -7,7 +7,7 @@ mctl is a CLI utility to interact with metal toolbox services
 ### Options
 
 ```
-      --config string   config file (default is $HOME/.mctl.yml)
+      --config string   config file (default is $XDG_CACHE_DIR/mctl/config.yml)
   -h, --help            help for mctl
       --reauth          re-authenticate with oauth services
 ```

diff --git a/docs/mctl_completion.md b/docs/mctl_completion.md
@@ -19,7 +19,7 @@ See each sub-command's help for details on how to use the generated script.
 ### Options inherited from parent commands
 
 ```
-      --config string   config file (default is $HOME/.mctl.yml)
+      --config string   config file (default is $XDG_CACHE_DIR/mctl/config.yml)
       --reauth          re-authenticate with oauth services
 ```
 

diff --git a/docs/mctl_completion_bash.md b/docs/mctl_completion_bash.md
@@ -42,7 +42,7 @@ mctl completion bash
 ### Options inherited from parent commands
 
 ```
-      --config string   config file (default is $HOME/.mctl.yml)
+      --config string   config file (default is $XDG_CACHE_DIR/mctl/config.yml)
       --reauth          re-authenticate with oauth services
 ```
 

diff --git a/docs/mctl_completion_fish.md b/docs/mctl_completion_fish.md
@@ -33,7 +33,7 @@ mctl completion fish [flags]
 ### Options inherited from parent commands
 
 ```
-      --config string   config file (default is $HOME/.mctl.yml)
+      --config string   config file (default is $XDG_CACHE_DIR/mctl/config.yml)
       --reauth          re-authenticate with oauth services
 ```
 

diff --git a/docs/mctl_completion_powershell.md b/docs/mctl_completion_powershell.md
@@ -30,7 +30,7 @@ mctl completion powershell [flags]
 ### Options inherited from parent commands
 
 ```
-      --config string   config file (default is $HOME/.mctl.yml)
+      --config string   config file (default is $XDG_CACHE_DIR/mctl/config.yml)
       --reauth          re-authenticate with oauth services
 ```
 

diff --git a/docs/mctl_completion_zsh.md b/docs/mctl_completion_zsh.md
@@ -44,7 +44,7 @@ mctl completion zsh [flags]
 ### Options inherited from parent commands
 
 ```
-      --config string   config file (default is $HOME/.mctl.yml)
+      --config string   config file (default is $XDG_CACHE_DIR/mctl/config.yml)
       --reauth          re-authenticate with oauth services
 ```
 

diff --git a/docs/mctl_create.md b/docs/mctl_create.md
@@ -17,7 +17,7 @@ mctl create [flags]
 ### Options inherited from parent commands
 
 ```
-      --config string   config file (default is $HOME/.mctl.yml)
+      --config string   config file (default is $XDG_CACHE_DIR/mctl/config.yml)
       --reauth          re-authenticate with oauth services
 ```
 

diff --git a/docs/mctl_create_firmware-set.md b/docs/mctl_create_firmware-set.md
@@ -20,7 +20,7 @@ mctl create firmware-set [flags]
 ### Options inherited from parent commands
 
 ```
-      --config string   config file (default is $HOME/.mctl.yml)
+      --config string   config file (default is $XDG_CACHE_DIR/mctl/config.yml)
       --reauth          re-authenticate with oauth services
 ```
 

diff --git a/docs/mctl_create_firmware.md b/docs/mctl_create_firmware.md
@@ -18,7 +18,7 @@ mctl create firmware [flags]
 ### Options inherited from parent commands
 
 ```
-      --config string   config file (default is $HOME/.mctl.yml)
+      --config string   config file (default is $XDG_CACHE_DIR/mctl/config.yml)
       --reauth          re-authenticate with oauth services
 ```
 

diff --git a/docs/mctl_delete.md b/docs/mctl_delete.md
@@ -17,7 +17,7 @@ mctl delete [flags]
 ### Options inherited from parent commands
 
 ```
-      --config string   config file (default is $HOME/.mctl.yml)
+      --config string   config file (default is $XDG_CACHE_DIR/mctl/config.yml)
       --reauth          re-authenticate with oauth services
 ```
 

diff --git a/docs/mctl_delete_condition.md b/docs/mctl_delete_condition.md
@@ -19,7 +19,7 @@ mctl delete condition [flags]
 ### Options inherited from parent commands
 
 ```
-      --config string   config file (default is $HOME/.mctl.yml)
+      --config string   config file (default is $XDG_CACHE_DIR/mctl/config.yml)
       --reauth          re-authenticate with oauth services
 ```
 

diff --git a/docs/mctl_delete_firmware-set.md b/docs/mctl_delete_firmware-set.md
@@ -18,7 +18,7 @@ mctl delete firmware-set [flags]
 ### Options inherited from parent commands
 
 ```
-      --config string   config file (default is $HOME/.mctl.yml)
+      --config string   config file (default is $XDG_CACHE_DIR/mctl/config.yml)
       --reauth          re-authenticate with oauth services
 ```
 

diff --git a/docs/mctl_edit.md b/docs/mctl_edit.md
@@ -17,7 +17,7 @@ mctl edit [flags]
 ### Options inherited from parent commands
 
 ```
-      --config string   config file (default is $HOME/.mctl.yml)
+      --config string   config file (default is $XDG_CACHE_DIR/mctl/config.yml)
       --reauth          re-authenticate with oauth services
 ```
 

diff --git a/docs/mctl_edit_firmware-set.md b/docs/mctl_edit_firmware-set.md
@@ -21,7 +21,7 @@ mctl edit firmware-set [flags]
 ### Options inherited from parent commands
 
 ```
-      --config string   config file (default is $HOME/.mctl.yml)
+      --config string   config file (default is $XDG_CACHE_DIR/mctl/config.yml)
       --reauth          re-authenticate with oauth services
 ```
 

diff --git a/docs/mctl_gendocs.md b/docs/mctl_gendocs.md
@@ -17,7 +17,7 @@ mctl gendocs [flags]
 ### Options inherited from parent commands
 
 ```
-      --config string   config file (default is $HOME/.mctl.yml)
+      --config string   config file (default is $XDG_CACHE_DIR/mctl/config.yml)
       --reauth          re-authenticate with oauth services
 ```
 

diff --git a/docs/mctl_get.md b/docs/mctl_get.md
@@ -18,7 +18,7 @@ mctl get [flags]
 ### Options inherited from parent commands
 
 ```
-      --config string   config file (default is $HOME/.mctl.yml)
+      --config string   config file (default is $XDG_CACHE_DIR/mctl/config.yml)
       --reauth          re-authenticate with oauth services
 ```
 

diff --git a/docs/mctl_get_bios-config.md b/docs/mctl_get_bios-config.md
@@ -18,7 +18,7 @@ mctl get bios-config [flags]
 ### Options inherited from parent commands
 
 ```
-      --config string   config file (default is $HOME/.mctl.yml)
+      --config string   config file (default is $XDG_CACHE_DIR/mctl/config.yml)
   -o, --output string   {json|text} (default "json")
       --reauth          re-authenticate with oauth services
 ```

diff --git a/docs/mctl_get_component.md b/docs/mctl_get_component.md
@@ -19,7 +19,7 @@ mctl get component [flags]
 ### Options inherited from parent commands
 
 ```
-      --config string   config file (default is $HOME/.mctl.yml)
+      --config string   config file (default is $XDG_CACHE_DIR/mctl/config.yml)
   -o, --output string   {json|text} (default "json")
       --reauth          re-authenticate with oauth services
 ```

diff --git a/docs/mctl_get_condition.md b/docs/mctl_get_condition.md
@@ -19,7 +19,7 @@ mctl get condition [flags]
 ### Options inherited from parent commands
 
 ```
-      --config string   config file (default is $HOME/.mctl.yml)
+      --config string   config file (default is $XDG_CACHE_DIR/mctl/config.yml)
   -o, --output string   {json|text} (default "json")
       --reauth          re-authenticate with oauth services
 ```

diff --git a/docs/mctl_get_firmware-set.md b/docs/mctl_get_firmware-set.md
@@ -19,7 +19,7 @@ mctl get firmware-set [flags]
 ### Options inherited from parent commands
 
 ```
-      --config string   config file (default is $HOME/.mctl.yml)
+      --config string   config file (default is $XDG_CACHE_DIR/mctl/config.yml)
   -o, --output string   {json|text} (default "json")
       --reauth          re-authenticate with oauth services
 ```

diff --git a/docs/mctl_get_firmware.md b/docs/mctl_get_firmware.md
@@ -18,7 +18,7 @@ mctl get firmware [flags]
 ### Options inherited from parent commands
 
 ```
-      --config string   config file (default is $HOME/.mctl.yml)
+      --config string   config file (default is $XDG_CACHE_DIR/mctl/config.yml)
   -o, --output string   {json|text} (default "json")
       --reauth          re-authenticate with oauth services
 ```

diff --git a/docs/mctl_install.md b/docs/mctl_install.md
@@ -17,7 +17,7 @@ mctl install [flags]
 ### Options inherited from parent commands
 
 ```
-      --config string   config file (default is $HOME/.mctl.yml)
+      --config string   config file (default is $XDG_CACHE_DIR/mctl/config.yml)
       --reauth          re-authenticate with oauth services
 ```
 

diff --git a/docs/mctl_install_firmware-set.md b/docs/mctl_install_firmware-set.md
@@ -21,7 +21,7 @@ mctl install firmware-set [flags]
 ### Options inherited from parent commands
 
 ```
-      --config string   config file (default is $HOME/.mctl.yml)
+      --config string   config file (default is $XDG_CACHE_DIR/mctl/config.yml)
       --reauth          re-authenticate with oauth services
 ```
 

diff --git a/docs/mctl_install_status.md b/docs/mctl_install_status.md
@@ -18,7 +18,7 @@ mctl install status --server | -s <server uuid> [flags]
 ### Options inherited from parent commands
 
 ```
-      --config string   config file (default is $HOME/.mctl.yml)
+      --config string   config file (default is $XDG_CACHE_DIR/mctl/config.yml)
       --reauth          re-authenticate with oauth services
 ```
 

diff --git a/docs/mctl_list.md b/docs/mctl_list.md
@@ -18,7 +18,7 @@ mctl list [flags]
 ### Options inherited from parent commands
 
 ```
-      --config string   config file (default is $HOME/.mctl.yml)
+      --config string   config file (default is $XDG_CACHE_DIR/mctl/config.yml)
       --reauth          re-authenticate with oauth services
 ```
 

diff --git a/docs/mctl_list_condition.md b/docs/mctl_list_condition.md
@@ -19,7 +19,7 @@ mctl list condition [flags]
 ### Options inherited from parent commands
 
 ```
-      --config string   config file (default is $HOME/.mctl.yml)
+      --config string   config file (default is $XDG_CACHE_DIR/mctl/config.yml)
       --output-json     Output listing as JSON
       --reauth          re-authenticate with oauth services
 ```

diff --git a/docs/mctl_list_firmware-set.md b/docs/mctl_list_firmware-set.md
@@ -19,7 +19,7 @@ mctl list firmware-set [flags]
 ### Options inherited from parent commands
 
 ```
-      --config string   config file (default is $HOME/.mctl.yml)
+      --config string   config file (default is $XDG_CACHE_DIR/mctl/config.yml)
       --output-json     Output listing as JSON
       --reauth          re-authenticate with oauth services
 ```

diff --git a/docs/mctl_list_firmware.md b/docs/mctl_list_firmware.md
@@ -17,7 +17,7 @@ mctl list firmware [flags]
 ### Options inherited from parent commands
 
 ```
-      --config string   config file (default is $HOME/.mctl.yml)
+      --config string   config file (default is $XDG_CACHE_DIR/mctl/config.yml)
       --output-json     Output listing as JSON
       --reauth          re-authenticate with oauth services
 ```

diff --git a/docs/mctl_version.md b/docs/mctl_version.md
@@ -17,7 +17,7 @@ mctl version [flags]
 ### Options inherited from parent commands
 
 ```
-      --config string   config file (default is $HOME/.mctl.yml)
+      --config string   config file (default is $XDG_CACHE_DIR/mctl/config.yml)
       --reauth          re-authenticate with oauth services
 ```