chore(docs): Update CLI gen docs.

Signed-off-by: spbsoluble <[email protected]>
Keyfactor · Nov 20, 2024 · 43f1ee3 · 43f1ee3
1 parent cb81571
commit 43f1ee3
Show file tree

Hide file tree

Showing 51 changed files with 967 additions and 867 deletions.
diff --git a/docs/kfutil.md b/docs/kfutil.md
@@ -9,24 +9,26 @@ A CLI wrapper around the Keyfactor Platform API.
 ### Options
 
 ```
-      --api-path string                API Path to use for authenticating to Keyfactor Command. (default is KeyfactorAPI) (default "KeyfactorAPI")
-      --auth-provider-profile string   The profile to use defined in the securely stored config. If not specified the config named 'default' will be used if it exists. (default "default")
-      --auth-provider-type string      Provider type choices: (azid)
-      --client-id string               OAuth2 client-id to use for authenticating to Keyfactor Command.
-      --client-secret string           OAuth2 client-secret to use for authenticating to Keyfactor Command.
-      --config string                  Full path to config file in JSON format. (default is $HOME/.keyfactor/command_config.json)
-      --debug                          Enable debugFlag logging.
-      --domain string                  Domain to use for authenticating to Keyfactor Command.
-      --exp                            Enable expEnabled features. (USE AT YOUR OWN RISK, these features are not supported and may change or be removed at any time.)
-      --format text                    How to format the CLI output. Currently only text is supported. (default "text")
-  -h, --help                           help for kfutil
-      --hostname string                Hostname to use for authenticating to Keyfactor Command.
-      --no-prompt                      Do not prompt for any user input and assume defaults or environmental variables are set.
-      --offline                        Will not attempt to connect to GitHub for latest release information and resources.
-      --password string                Password to use for authenticating to Keyfactor Command. WARNING: Remember to delete your console history if providing kfcPassword here in plain text.
-      --profile string                 Use a specific profile from your config file. If not specified the config named 'default' will be used if it exists.
-      --token-url string               OAuth2 token endpoint full URL to use for authenticating to Keyfactor Command.
-      --username string                Username to use for authenticating to Keyfactor Command.
+      --api-path string                    API Path to use for authenticating to Keyfactor Command. (default is KeyfactorAPI) (default "KeyfactorAPI")
+      --auth-provider-flagProfile string   The flagProfile to use defined in the securely stored config. If not specified the config named 'default' will be used if it exists. (default "default")
+      --auth-provider-type string          Provider type choices: (azid)
+      --client-id string                   OAuth2 client-id to use for authenticating to Keyfactor Command.
+      --client-secret string               OAuth2 client-secret to use for authenticating to Keyfactor Command.
+      --config string                      Full path to config file in JSON format. (default is $HOME/.keyfactor/command_config.json)
+      --debug                              Enable flagEnableDebug logging.
+      --domain string                      Domain to use for authenticating to Keyfactor Command.
+      --exp                                Enable flagEnableExp features. (USE AT YOUR OWN RISK, these features are not supported and may change or be removed at any time.)
+      --flagOffline                        Will not attempt to connect to GitHub for latest release information and resources.
+      --flagProfile string                 Use a specific flagProfile from your config file. If not specified the config named 'default' will be used if it exists.
+      --format text                        How to format the CLI output. Currently only text is supported. (default "text")
+  -h, --help                               help for kfutil
+      --hostname string                    Hostname to use for authenticating to Keyfactor Command.
+      --no-prompt                          Do not prompt for any user input and assume defaults or environmental variables are set.
+      --password string                    Password to use for authenticating to Keyfactor Command. WARNING: Remember to delete your console history if providing flagPassword here in plain text.
+      --skip-verify                        Skip SSL verification when communicating to Keyfactor Command. (USE AT YOUR OWN RISK, this will disable SSL verification.)
+      --token string                       OAuth2 access token for authenticating to Keyfactor Command.
+      --token-url string                   OAuth2 token endpoint full URL to use for authenticating to Keyfactor Command.
+      --username string                    Username to use for authenticating to Keyfactor Command.
 ```
 
 ### SEE ALSO

diff --git a/docs/kfutil_completion.md b/docs/kfutil_completion.md
@@ -17,23 +17,25 @@ See each sub-command's help for details on how to use the generated script.
 ### Options inherited from parent commands
 
 ```
-      --api-path string                API Path to use for authenticating to Keyfactor Command. (default is KeyfactorAPI) (default "KeyfactorAPI")
-      --auth-provider-profile string   The profile to use defined in the securely stored config. If not specified the config named 'default' will be used if it exists. (default "default")
-      --auth-provider-type string      Provider type choices: (azid)
-      --client-id string               OAuth2 client-id to use for authenticating to Keyfactor Command.
-      --client-secret string           OAuth2 client-secret to use for authenticating to Keyfactor Command.
-      --config string                  Full path to config file in JSON format. (default is $HOME/.keyfactor/command_config.json)
-      --debug                          Enable debugFlag logging.
-      --domain string                  Domain to use for authenticating to Keyfactor Command.
-      --exp                            Enable expEnabled features. (USE AT YOUR OWN RISK, these features are not supported and may change or be removed at any time.)
-      --format text                    How to format the CLI output. Currently only text is supported. (default "text")
-      --hostname string                Hostname to use for authenticating to Keyfactor Command.
-      --no-prompt                      Do not prompt for any user input and assume defaults or environmental variables are set.
-      --offline                        Will not attempt to connect to GitHub for latest release information and resources.
-      --password string                Password to use for authenticating to Keyfactor Command. WARNING: Remember to delete your console history if providing kfcPassword here in plain text.
-      --profile string                 Use a specific profile from your config file. If not specified the config named 'default' will be used if it exists.
-      --token-url string               OAuth2 token endpoint full URL to use for authenticating to Keyfactor Command.
-      --username string                Username to use for authenticating to Keyfactor Command.
+      --api-path string                    API Path to use for authenticating to Keyfactor Command. (default is KeyfactorAPI) (default "KeyfactorAPI")
+      --auth-provider-flagProfile string   The flagProfile to use defined in the securely stored config. If not specified the config named 'default' will be used if it exists. (default "default")
+      --auth-provider-type string          Provider type choices: (azid)
+      --client-id string                   OAuth2 client-id to use for authenticating to Keyfactor Command.
+      --client-secret string               OAuth2 client-secret to use for authenticating to Keyfactor Command.
+      --config string                      Full path to config file in JSON format. (default is $HOME/.keyfactor/command_config.json)
+      --debug                              Enable flagEnableDebug logging.
+      --domain string                      Domain to use for authenticating to Keyfactor Command.
+      --exp                                Enable flagEnableExp features. (USE AT YOUR OWN RISK, these features are not supported and may change or be removed at any time.)
+      --flagOffline                        Will not attempt to connect to GitHub for latest release information and resources.
+      --flagProfile string                 Use a specific flagProfile from your config file. If not specified the config named 'default' will be used if it exists.
+      --format text                        How to format the CLI output. Currently only text is supported. (default "text")
+      --hostname string                    Hostname to use for authenticating to Keyfactor Command.
+      --no-prompt                          Do not prompt for any user input and assume defaults or environmental variables are set.
+      --password string                    Password to use for authenticating to Keyfactor Command. WARNING: Remember to delete your console history if providing flagPassword here in plain text.
+      --skip-verify                        Skip SSL verification when communicating to Keyfactor Command. (USE AT YOUR OWN RISK, this will disable SSL verification.)
+      --token string                       OAuth2 access token for authenticating to Keyfactor Command.
+      --token-url string                   OAuth2 token endpoint full URL to use for authenticating to Keyfactor Command.
+      --username string                    Username to use for authenticating to Keyfactor Command.
 ```
 
 ### SEE ALSO

diff --git a/docs/kfutil_completion_bash.md b/docs/kfutil_completion_bash.md
@@ -40,23 +40,25 @@ kfutil completion bash
 ### Options inherited from parent commands
 
 ```
-      --api-path string                API Path to use for authenticating to Keyfactor Command. (default is KeyfactorAPI) (default "KeyfactorAPI")
-      --auth-provider-profile string   The profile to use defined in the securely stored config. If not specified the config named 'default' will be used if it exists. (default "default")
-      --auth-provider-type string      Provider type choices: (azid)
-      --client-id string               OAuth2 client-id to use for authenticating to Keyfactor Command.
-      --client-secret string           OAuth2 client-secret to use for authenticating to Keyfactor Command.
-      --config string                  Full path to config file in JSON format. (default is $HOME/.keyfactor/command_config.json)
-      --debug                          Enable debugFlag logging.
-      --domain string                  Domain to use for authenticating to Keyfactor Command.
-      --exp                            Enable expEnabled features. (USE AT YOUR OWN RISK, these features are not supported and may change or be removed at any time.)
-      --format text                    How to format the CLI output. Currently only text is supported. (default "text")
-      --hostname string                Hostname to use for authenticating to Keyfactor Command.
-      --no-prompt                      Do not prompt for any user input and assume defaults or environmental variables are set.
-      --offline                        Will not attempt to connect to GitHub for latest release information and resources.
-      --password string                Password to use for authenticating to Keyfactor Command. WARNING: Remember to delete your console history if providing kfcPassword here in plain text.
-      --profile string                 Use a specific profile from your config file. If not specified the config named 'default' will be used if it exists.
-      --token-url string               OAuth2 token endpoint full URL to use for authenticating to Keyfactor Command.
-      --username string                Username to use for authenticating to Keyfactor Command.
+      --api-path string                    API Path to use for authenticating to Keyfactor Command. (default is KeyfactorAPI) (default "KeyfactorAPI")
+      --auth-provider-flagProfile string   The flagProfile to use defined in the securely stored config. If not specified the config named 'default' will be used if it exists. (default "default")
+      --auth-provider-type string          Provider type choices: (azid)
+      --client-id string                   OAuth2 client-id to use for authenticating to Keyfactor Command.
+      --client-secret string               OAuth2 client-secret to use for authenticating to Keyfactor Command.
+      --config string                      Full path to config file in JSON format. (default is $HOME/.keyfactor/command_config.json)
+      --debug                              Enable flagEnableDebug logging.
+      --domain string                      Domain to use for authenticating to Keyfactor Command.
+      --exp                                Enable flagEnableExp features. (USE AT YOUR OWN RISK, these features are not supported and may change or be removed at any time.)
+      --flagOffline                        Will not attempt to connect to GitHub for latest release information and resources.
+      --flagProfile string                 Use a specific flagProfile from your config file. If not specified the config named 'default' will be used if it exists.
+      --format text                        How to format the CLI output. Currently only text is supported. (default "text")
+      --hostname string                    Hostname to use for authenticating to Keyfactor Command.
+      --no-prompt                          Do not prompt for any user input and assume defaults or environmental variables are set.
+      --password string                    Password to use for authenticating to Keyfactor Command. WARNING: Remember to delete your console history if providing flagPassword here in plain text.
+      --skip-verify                        Skip SSL verification when communicating to Keyfactor Command. (USE AT YOUR OWN RISK, this will disable SSL verification.)
+      --token string                       OAuth2 access token for authenticating to Keyfactor Command.
+      --token-url string                   OAuth2 token endpoint full URL to use for authenticating to Keyfactor Command.
+      --username string                    Username to use for authenticating to Keyfactor Command.
 ```
 
 ### SEE ALSO

diff --git a/docs/kfutil_completion_fish.md b/docs/kfutil_completion_fish.md
@@ -31,23 +31,25 @@ kfutil completion fish [flags]
 ### Options inherited from parent commands
 
 ```
-      --api-path string                API Path to use for authenticating to Keyfactor Command. (default is KeyfactorAPI) (default "KeyfactorAPI")
-      --auth-provider-profile string   The profile to use defined in the securely stored config. If not specified the config named 'default' will be used if it exists. (default "default")
-      --auth-provider-type string      Provider type choices: (azid)
-      --client-id string               OAuth2 client-id to use for authenticating to Keyfactor Command.
-      --client-secret string           OAuth2 client-secret to use for authenticating to Keyfactor Command.
-      --config string                  Full path to config file in JSON format. (default is $HOME/.keyfactor/command_config.json)
-      --debug                          Enable debugFlag logging.
-      --domain string                  Domain to use for authenticating to Keyfactor Command.
-      --exp                            Enable expEnabled features. (USE AT YOUR OWN RISK, these features are not supported and may change or be removed at any time.)
-      --format text                    How to format the CLI output. Currently only text is supported. (default "text")
-      --hostname string                Hostname to use for authenticating to Keyfactor Command.
-      --no-prompt                      Do not prompt for any user input and assume defaults or environmental variables are set.
-      --offline                        Will not attempt to connect to GitHub for latest release information and resources.
-      --password string                Password to use for authenticating to Keyfactor Command. WARNING: Remember to delete your console history if providing kfcPassword here in plain text.
-      --profile string                 Use a specific profile from your config file. If not specified the config named 'default' will be used if it exists.
-      --token-url string               OAuth2 token endpoint full URL to use for authenticating to Keyfactor Command.
-      --username string                Username to use for authenticating to Keyfactor Command.
+      --api-path string                    API Path to use for authenticating to Keyfactor Command. (default is KeyfactorAPI) (default "KeyfactorAPI")
+      --auth-provider-flagProfile string   The flagProfile to use defined in the securely stored config. If not specified the config named 'default' will be used if it exists. (default "default")
+      --auth-provider-type string          Provider type choices: (azid)
+      --client-id string                   OAuth2 client-id to use for authenticating to Keyfactor Command.
+      --client-secret string               OAuth2 client-secret to use for authenticating to Keyfactor Command.
+      --config string                      Full path to config file in JSON format. (default is $HOME/.keyfactor/command_config.json)
+      --debug                              Enable flagEnableDebug logging.
+      --domain string                      Domain to use for authenticating to Keyfactor Command.
+      --exp                                Enable flagEnableExp features. (USE AT YOUR OWN RISK, these features are not supported and may change or be removed at any time.)
+      --flagOffline                        Will not attempt to connect to GitHub for latest release information and resources.
+      --flagProfile string                 Use a specific flagProfile from your config file. If not specified the config named 'default' will be used if it exists.
+      --format text                        How to format the CLI output. Currently only text is supported. (default "text")
+      --hostname string                    Hostname to use for authenticating to Keyfactor Command.
+      --no-prompt                          Do not prompt for any user input and assume defaults or environmental variables are set.
+      --password string                    Password to use for authenticating to Keyfactor Command. WARNING: Remember to delete your console history if providing flagPassword here in plain text.
+      --skip-verify                        Skip SSL verification when communicating to Keyfactor Command. (USE AT YOUR OWN RISK, this will disable SSL verification.)
+      --token string                       OAuth2 access token for authenticating to Keyfactor Command.
+      --token-url string                   OAuth2 token endpoint full URL to use for authenticating to Keyfactor Command.
+      --username string                    Username to use for authenticating to Keyfactor Command.
 ```
 
 ### SEE ALSO