Update authenticate command/subcommands help text (#1835)

* Make it clear in the subcommands that the given strings are examples
* Add an OIDC example to show that there are different types
* Remove password flag from examples
This commit is contained in:
Jeff Mitchell authored and GitHub committed 2022-01-31 11:50:45 -05:00
1 parent 029569a201
commit 5743580ca5
4 files changed
+15 -5

No files matched your search

+6
View File
@@ -4,6 +4,12 @@ Canonical reference for changes, improvements, and bugfixes for Boundary.
## Next
### New and Improved
* cli: Update authentication examples to remove password flag and make
subcommend selection a bit clearer
([PR](https://github.com/hashicorp/boundary/pull/1835))
## 0.7.4 (2022/01/18)
### Deprecations/Changes
@@ -22,9 +22,13 @@ func (c *Command) Help() string {
"",
" This command authenticates the Boundary commandline client using a specified auth method. Examples:",
"",
" Authenticate with password auth method:",
" Authenticate with a password auth method:",
"",
" $ boundary authenticate password -auth-method-id ampw_1234567890 -login-name foo -password \"bar\"",
" $ boundary authenticate password -auth-method-id ampw_1234567890 -login-name foo",
"",
" Authenticate with an OIDC auth method:",
"",
" $ boundary authenticate oidc -auth-method-id amoidc_1234567890",
"",
" Please see the auth method subcommand help for detailed usage information.",
})
+1 -1
View File
@@ -34,7 +34,7 @@ func (c *OidcCommand) Help() string {
return base.WrapForHelpText([]string{
"Usage: boundary authenticate oidc [options] [args]",
"",
" Invoke the OIDC auth method to authenticate the Boundary CLI:",
" Invoke the OIDC auth method to authenticate the Boundary CLI. Example:",
"",
` $ boundary authenticate oidc -auth-method-id amoidc_1234567890`,
"",
@@ -40,9 +40,9 @@ func (c *PasswordCommand) Help() string {
return base.WrapForHelpText([]string{
"Usage: boundary authenticate password [options] [args]",
"",
" Invoke the password auth method to authenticate the Boundary CLI:",
" Invoke the password auth method to authenticate the Boundary CLI. Example:",
"",
` $ boundary authenticate password -auth-method-id ampw_1234567890 -login-name foo -password "bar"`,
` $ boundary authenticate password -auth-method-id ampw_1234567890 -login-name foo`,
"",
"",
}) + c.Flags().Help()