Skip to content

Commit

Permalink
chore(docs): Update autogen CLI docs.
Browse files Browse the repository at this point in the history
Signed-off-by: spbsoluble <[email protected]>
  • Loading branch information
spbsoluble committed Nov 20, 2024
1 parent 131b7be commit 70f3d68
Show file tree
Hide file tree
Showing 51 changed files with 52 additions and 103 deletions.
3 changes: 1 addition & 2 deletions docs/kfutil.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,6 @@ A CLI wrapper around the Keyfactor Platform API.
--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.
--log-insecure Log insecure API requests. (USE AT YOUR OWN RISK, this WILL log sensitive information to the console.)
--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.
Expand All @@ -46,4 +45,4 @@ A CLI wrapper around the Keyfactor Platform API.
* [kfutil stores](kfutil_stores.md) - Keyfactor certificate stores APIs and utilities.
* [kfutil version](kfutil_version.md) - Shows version of kfutil

###### Auto generated by spf13/cobra on 6-Nov-2024
###### Auto generated by spf13/cobra on 20-Nov-2024
3 changes: 1 addition & 2 deletions docs/kfutil_completion.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,6 @@ See each sub-command's help for details on how to use the generated script.
--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.
--log-insecure Log insecure API requests. (USE AT YOUR OWN RISK, this WILL log sensitive information to the console.)
--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.
Expand All @@ -45,4 +44,4 @@ See each sub-command's help for details on how to use the generated script.
* [kfutil completion powershell](kfutil_completion_powershell.md) - Generate the autocompletion script for powershell
* [kfutil completion zsh](kfutil_completion_zsh.md) - Generate the autocompletion script for zsh

###### Auto generated by spf13/cobra on 6-Nov-2024
###### Auto generated by spf13/cobra on 20-Nov-2024
3 changes: 1 addition & 2 deletions docs/kfutil_completion_bash.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,6 @@ kfutil completion bash
--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.
--log-insecure Log insecure API requests. (USE AT YOUR OWN RISK, this WILL log sensitive information to the console.)
--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.
Expand All @@ -64,4 +63,4 @@ kfutil completion bash

* [kfutil completion](kfutil_completion.md) - Generate the autocompletion script for the specified shell

###### Auto generated by spf13/cobra on 6-Nov-2024
###### Auto generated by spf13/cobra on 20-Nov-2024
3 changes: 1 addition & 2 deletions docs/kfutil_completion_fish.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,6 @@ kfutil completion fish [flags]
--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.
--log-insecure Log insecure API requests. (USE AT YOUR OWN RISK, this WILL log sensitive information to the console.)
--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.
Expand All @@ -55,4 +54,4 @@ kfutil completion fish [flags]

* [kfutil completion](kfutil_completion.md) - Generate the autocompletion script for the specified shell

###### Auto generated by spf13/cobra on 6-Nov-2024
###### Auto generated by spf13/cobra on 20-Nov-2024
3 changes: 1 addition & 2 deletions docs/kfutil_completion_powershell.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,6 @@ kfutil completion powershell [flags]
--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.
--log-insecure Log insecure API requests. (USE AT YOUR OWN RISK, this WILL log sensitive information to the console.)
--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.
Expand All @@ -52,4 +51,4 @@ kfutil completion powershell [flags]

* [kfutil completion](kfutil_completion.md) - Generate the autocompletion script for the specified shell

###### Auto generated by spf13/cobra on 6-Nov-2024
###### Auto generated by spf13/cobra on 20-Nov-2024
3 changes: 1 addition & 2 deletions docs/kfutil_completion_zsh.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,6 @@ kfutil completion zsh [flags]
--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.
--log-insecure Log insecure API requests. (USE AT YOUR OWN RISK, this WILL log sensitive information to the console.)
--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.
Expand All @@ -66,4 +65,4 @@ kfutil completion zsh [flags]

* [kfutil completion](kfutil_completion.md) - Generate the autocompletion script for the specified shell

###### Auto generated by spf13/cobra on 6-Nov-2024
###### Auto generated by spf13/cobra on 20-Nov-2024
3 changes: 1 addition & 2 deletions docs/kfutil_containers.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@ A collections of APIs and utilities for interacting with Keyfactor certificate s
--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.
--log-insecure Log insecure API requests. (USE AT YOUR OWN RISK, this WILL log sensitive information to the console.)
--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.
Expand All @@ -41,4 +40,4 @@ A collections of APIs and utilities for interacting with Keyfactor certificate s
* [kfutil containers get](kfutil_containers_get.md) - Get certificate store container by ID or name.
* [kfutil containers list](kfutil_containers_list.md) - List certificate store containers.

###### Auto generated by spf13/cobra on 6-Nov-2024
###### Auto generated by spf13/cobra on 20-Nov-2024
3 changes: 1 addition & 2 deletions docs/kfutil_containers_get.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,6 @@ kfutil containers get [flags]
--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.
--log-insecure Log insecure API requests. (USE AT YOUR OWN RISK, this WILL log sensitive information to the console.)
--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.
Expand All @@ -44,4 +43,4 @@ kfutil containers get [flags]

* [kfutil containers](kfutil_containers.md) - Keyfactor certificate store container API and utilities.

###### Auto generated by spf13/cobra on 6-Nov-2024
###### Auto generated by spf13/cobra on 20-Nov-2024
3 changes: 1 addition & 2 deletions docs/kfutil_containers_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,6 @@ kfutil containers list [flags]
--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.
--log-insecure Log insecure API requests. (USE AT YOUR OWN RISK, this WILL log sensitive information to the console.)
--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.
Expand All @@ -43,4 +42,4 @@ kfutil containers list [flags]

* [kfutil containers](kfutil_containers.md) - Keyfactor certificate store container API and utilities.

###### Auto generated by spf13/cobra on 6-Nov-2024
###### Auto generated by spf13/cobra on 20-Nov-2024
3 changes: 1 addition & 2 deletions docs/kfutil_export.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,6 @@ kfutil export [flags]
--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.
--log-insecure Log insecure API requests. (USE AT YOUR OWN RISK, this WILL log sensitive information to the console.)
--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.
Expand All @@ -55,4 +54,4 @@ kfutil export [flags]

* [kfutil](kfutil.md) - Keyfactor CLI utilities

###### Auto generated by spf13/cobra on 6-Nov-2024
###### Auto generated by spf13/cobra on 20-Nov-2024
3 changes: 1 addition & 2 deletions docs/kfutil_helm.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,6 @@ kubectl helm uo | helm install -f - keyfactor-universal-orchestrator keyfactor/k
--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.
--log-insecure Log insecure API requests. (USE AT YOUR OWN RISK, this WILL log sensitive information to the console.)
--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.
Expand All @@ -46,4 +45,4 @@ kubectl helm uo | helm install -f - keyfactor-universal-orchestrator keyfactor/k
* [kfutil](kfutil.md) - Keyfactor CLI utilities
* [kfutil helm uo](kfutil_helm_uo.md) - Configure the Keyfactor Universal Orchestrator Helm Chart

###### Auto generated by spf13/cobra on 6-Nov-2024
###### Auto generated by spf13/cobra on 20-Nov-2024
3 changes: 1 addition & 2 deletions docs/kfutil_helm_uo.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,6 @@ kfutil helm uo [-t <token>] [-o <path>] [-f <file, url, or '-'>] [-e <extension
--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.
--log-insecure Log insecure API requests. (USE AT YOUR OWN RISK, this WILL log sensitive information to the console.)
--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.
Expand All @@ -50,4 +49,4 @@ kfutil helm uo [-t <token>] [-o <path>] [-f <file, url, or '-'>] [-e <extension

* [kfutil helm](kfutil_helm.md) - Helm utilities for configuring Keyfactor Helm charts

###### Auto generated by spf13/cobra on 6-Nov-2024
###### Auto generated by spf13/cobra on 20-Nov-2024
3 changes: 1 addition & 2 deletions docs/kfutil_import.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,6 @@ kfutil import [flags]
--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.
--log-insecure Log insecure API requests. (USE AT YOUR OWN RISK, this WILL log sensitive information to the console.)
--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.
Expand All @@ -54,4 +53,4 @@ kfutil import [flags]

* [kfutil](kfutil.md) - Keyfactor CLI utilities

###### Auto generated by spf13/cobra on 6-Nov-2024
###### Auto generated by spf13/cobra on 20-Nov-2024
3 changes: 1 addition & 2 deletions docs/kfutil_login.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,6 @@ kfutil login [flags]
--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.
--log-insecure Log insecure API requests. (USE AT YOUR OWN RISK, this WILL log sensitive information to the console.)
--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.
Expand All @@ -54,4 +53,4 @@ kfutil login [flags]

* [kfutil](kfutil.md) - Keyfactor CLI utilities

###### Auto generated by spf13/cobra on 6-Nov-2024
###### Auto generated by spf13/cobra on 20-Nov-2024
3 changes: 1 addition & 2 deletions docs/kfutil_logout.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,6 @@ kfutil logout [flags]
--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.
--log-insecure Log insecure API requests. (USE AT YOUR OWN RISK, this WILL log sensitive information to the console.)
--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.
Expand All @@ -43,4 +42,4 @@ kfutil logout [flags]

* [kfutil](kfutil.md) - Keyfactor CLI utilities

###### Auto generated by spf13/cobra on 6-Nov-2024
###### Auto generated by spf13/cobra on 20-Nov-2024
Loading

0 comments on commit 70f3d68

Please sign in to comment.