Skip to content

Commit

Permalink
Update documentation to show we require the "=" in the command flags
Browse files Browse the repository at this point in the history
  • Loading branch information
RyanFrench committed Mar 29, 2018
1 parent 0f889f6 commit f5cae2d
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Currently, the only way to install the utility is from source. It requires you t

### Assume a role

`aws-role --role-arn [role] [command]`
`aws-role --role-arn=[role] [command]`

This will assume `[role]` and then run `[command]` using that role.

Expand Down
2 changes: 1 addition & 1 deletion cmd/root.go
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ var (
)

var rootCmd = &cobra.Command{
Use: "aws-role --role-arn [role] [command]",
Use: "aws-role --role-arn=[role] [command]",
Short: "Assume a role in AWS and optionally run a command",
Long: `
Run a command within the context of assuming a role. This is not persistent, and will only affect the command that is passed in.
Expand Down

0 comments on commit f5cae2d

Please sign in to comment.