Skip to content
This repository has been archived by the owner on Feb 21, 2023. It is now read-only.

Commit

Permalink
cmd/root.go(rootCmd): Modify description to call it "command", not "s…
Browse files Browse the repository at this point in the history
…ubcommand".

To me, "subcommand" conjures something like the "s3" in "aws s3", that is, a subcommand of the tool
itself.  Whereas in fact, we mean to refer to external commands that yak will execute on our
behalf.  I think just calling it `<command>` in the docs and help text is clearer.
  • Loading branch information
toothbrush committed Aug 9, 2021
1 parent 6f89db1 commit a09cffd
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ yak [flags] -- <role> <command --with-flags>
-u, --okta-username string Your Okta username
-o, --output-format string Can be set to either 'json' or 'env'. The format in which to output credential data
--version Print the current version and exit
-- Terminator for -/-- flags. Necessary if you want to pass -/-- flags to subcommands
-- Terminator for -/-- flags. Necessary if you want to pass -/-- flags to commands
```

#### Environment Variables
Expand Down
8 changes: 4 additions & 4 deletions cmd/root.go
Original file line number Diff line number Diff line change
Expand Up @@ -20,19 +20,19 @@ import (
)

var rootCmd = &cobra.Command{
Use: "yak [flags] [--list-roles | [--] <role> [<subcommand...>]]",
Use: "yak [flags] [--list-roles | [--] <role> [<command...>]]",
Short: "A shim to do stuff with AWS credentials using Okta",
Long: `A shim to do stuff with AWS credentials using Okta
* With --list-roles, print a list of your available AWS roles.
Otherwise, yak will attempt to generate AWS keys for <role>.
* If <subcommand> is set, yak will attempt to execute it with the
* If <command> is set, yak will attempt to execute it with the
AWS keys injected into the environment. Otherwise, the
credentials will conveniently be printed stdout.
Note that if you want to pass -/-- flags to your <subcommand>,
you'll need to put a '--' separator before the <role> so yak
Note that if you want to pass -/-- flags to your <command>,
you'll need to put a '--' separator before the <command> so yak
knows not to interpret those arguments for itself`,
SilenceUsage: true,
SilenceErrors: true,
Expand Down

0 comments on commit a09cffd

Please sign in to comment.