Skip to content

Commit ebfac47

Browse files
committed
chore(docs): Update docs
Signed-off-by: spbsoluble <[email protected]>
1 parent 61cbfaa commit ebfac47

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

57 files changed

+60
-4
lines changed

cmd/inventory.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -607,11 +607,11 @@ var inventoryFixRFPKCS12 = &cobra.Command{
607607
Long: `Fix RFPKCS12 stores that contain 2 or more leaf certificates, by removing the certificate with the earliest issued date.`,
608608
Example: `
609609
# The below will create a CSV file that can be reviewed and modified before running the command with the --file option.
610-
kfutil stores inventory fixrfpkcs12
610+
kfutil stores inventory fixrfpkcs12 --exp
611611
612612
# The below will read the CSV file and schedule remove jobs as specified in the file where the 'Action' col is "REMOVE".
613613
# The --force flag is *required* to actually schedule the remove jobs for the certificates.
614-
kfutil stores inventory fixrfpkcs12 --file rfpkcs12_fix.csv --force
614+
kfutil stores inventory fixrfpkcs12 --file rfpkcs12_fix.csv --force --exp
615615
`,
616616
ValidArgs: nil,
617617
ValidArgsFunction: nil,

docs/kfutil.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ A CLI wrapper around the Keyfactor Platform API.
2121
--hostname string Hostname to use for authenticating to Keyfactor Command.
2222
--log-insecure Log insecure API requests. (USE AT YOUR OWN RISK, this WILL log sensitive information to the console.)
2323
--no-prompt Do not prompt for any user input and assume defaults or environmental variables are set.
24+
--offline Will not attempt to connect to GitHub for latest release information and resources.
2425
--password string Password to use for authenticating to Keyfactor Command. WARNING: Remember to delete your console history if providing kfcPassword here in plain text.
2526
--profile string Use a specific profile from your config file. If not specified the config named 'default' will be used if it exists.
2627
--username string Username to use for authenticating to Keyfactor Command.

docs/kfutil_completion.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ See each sub-command's help for details on how to use the generated script.
2828
--hostname string Hostname to use for authenticating to Keyfactor Command.
2929
--log-insecure Log insecure API requests. (USE AT YOUR OWN RISK, this WILL log sensitive information to the console.)
3030
--no-prompt Do not prompt for any user input and assume defaults or environmental variables are set.
31+
--offline Will not attempt to connect to GitHub for latest release information and resources.
3132
--password string Password to use for authenticating to Keyfactor Command. WARNING: Remember to delete your console history if providing kfcPassword here in plain text.
3233
--profile string Use a specific profile from your config file. If not specified the config named 'default' will be used if it exists.
3334
--username string Username to use for authenticating to Keyfactor Command.

docs/kfutil_completion_bash.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,7 @@ kfutil completion bash
5151
--hostname string Hostname to use for authenticating to Keyfactor Command.
5252
--log-insecure Log insecure API requests. (USE AT YOUR OWN RISK, this WILL log sensitive information to the console.)
5353
--no-prompt Do not prompt for any user input and assume defaults or environmental variables are set.
54+
--offline Will not attempt to connect to GitHub for latest release information and resources.
5455
--password string Password to use for authenticating to Keyfactor Command. WARNING: Remember to delete your console history if providing kfcPassword here in plain text.
5556
--profile string Use a specific profile from your config file. If not specified the config named 'default' will be used if it exists.
5657
--username string Username to use for authenticating to Keyfactor Command.

docs/kfutil_completion_fish.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@ kfutil completion fish [flags]
4242
--hostname string Hostname to use for authenticating to Keyfactor Command.
4343
--log-insecure Log insecure API requests. (USE AT YOUR OWN RISK, this WILL log sensitive information to the console.)
4444
--no-prompt Do not prompt for any user input and assume defaults or environmental variables are set.
45+
--offline Will not attempt to connect to GitHub for latest release information and resources.
4546
--password string Password to use for authenticating to Keyfactor Command. WARNING: Remember to delete your console history if providing kfcPassword here in plain text.
4647
--profile string Use a specific profile from your config file. If not specified the config named 'default' will be used if it exists.
4748
--username string Username to use for authenticating to Keyfactor Command.

docs/kfutil_completion_powershell.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@ kfutil completion powershell [flags]
3939
--hostname string Hostname to use for authenticating to Keyfactor Command.
4040
--log-insecure Log insecure API requests. (USE AT YOUR OWN RISK, this WILL log sensitive information to the console.)
4141
--no-prompt Do not prompt for any user input and assume defaults or environmental variables are set.
42+
--offline Will not attempt to connect to GitHub for latest release information and resources.
4243
--password string Password to use for authenticating to Keyfactor Command. WARNING: Remember to delete your console history if providing kfcPassword here in plain text.
4344
--profile string Use a specific profile from your config file. If not specified the config named 'default' will be used if it exists.
4445
--username string Username to use for authenticating to Keyfactor Command.

docs/kfutil_completion_zsh.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,7 @@ kfutil completion zsh [flags]
5353
--hostname string Hostname to use for authenticating to Keyfactor Command.
5454
--log-insecure Log insecure API requests. (USE AT YOUR OWN RISK, this WILL log sensitive information to the console.)
5555
--no-prompt Do not prompt for any user input and assume defaults or environmental variables are set.
56+
--offline Will not attempt to connect to GitHub for latest release information and resources.
5657
--password string Password to use for authenticating to Keyfactor Command. WARNING: Remember to delete your console history if providing kfcPassword here in plain text.
5758
--profile string Use a specific profile from your config file. If not specified the config named 'default' will be used if it exists.
5859
--username string Username to use for authenticating to Keyfactor Command.

docs/kfutil_containers.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ A collections of APIs and utilities for interacting with Keyfactor certificate s
2626
--hostname string Hostname to use for authenticating to Keyfactor Command.
2727
--log-insecure Log insecure API requests. (USE AT YOUR OWN RISK, this WILL log sensitive information to the console.)
2828
--no-prompt Do not prompt for any user input and assume defaults or environmental variables are set.
29+
--offline Will not attempt to connect to GitHub for latest release information and resources.
2930
--password string Password to use for authenticating to Keyfactor Command. WARNING: Remember to delete your console history if providing kfcPassword here in plain text.
3031
--profile string Use a specific profile from your config file. If not specified the config named 'default' will be used if it exists.
3132
--username string Username to use for authenticating to Keyfactor Command.

docs/kfutil_containers_get.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ kfutil containers get [flags]
3131
--hostname string Hostname to use for authenticating to Keyfactor Command.
3232
--log-insecure Log insecure API requests. (USE AT YOUR OWN RISK, this WILL log sensitive information to the console.)
3333
--no-prompt Do not prompt for any user input and assume defaults or environmental variables are set.
34+
--offline Will not attempt to connect to GitHub for latest release information and resources.
3435
--password string Password to use for authenticating to Keyfactor Command. WARNING: Remember to delete your console history if providing kfcPassword here in plain text.
3536
--profile string Use a specific profile from your config file. If not specified the config named 'default' will be used if it exists.
3637
--username string Username to use for authenticating to Keyfactor Command.

docs/kfutil_containers_list.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ kfutil containers list [flags]
3030
--hostname string Hostname to use for authenticating to Keyfactor Command.
3131
--log-insecure Log insecure API requests. (USE AT YOUR OWN RISK, this WILL log sensitive information to the console.)
3232
--no-prompt Do not prompt for any user input and assume defaults or environmental variables are set.
33+
--offline Will not attempt to connect to GitHub for latest release information and resources.
3334
--password string Password to use for authenticating to Keyfactor Command. WARNING: Remember to delete your console history if providing kfcPassword here in plain text.
3435
--profile string Use a specific profile from your config file. If not specified the config named 'default' will be used if it exists.
3536
--username string Username to use for authenticating to Keyfactor Command.

0 commit comments

Comments
 (0)