Skip to content

Commit

Permalink
Add consistency to commands help text
Browse files Browse the repository at this point in the history
  • Loading branch information
jeremylevy committed May 31, 2022
1 parent d0dd0a0 commit ad478c5
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 5 deletions.
4 changes: 3 additions & 1 deletion internal/cmd/aws.go
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,9 @@ Once started, you could stop it at any time, to save costs, using the command:
If you don't plan to use this development environment again, you could remove it using the command:
recode aws remove <repository>`,
recode aws remove <repository>
<repository> may be relative to your personal GitHub account (eg: cli) or fully qualified (eg: my-organization/api). `,

Example: ` recode aws start recode-sh/api --instance-type m4.large
recode aws stop recode-sh/api
Expand Down
4 changes: 2 additions & 2 deletions internal/cmd/aws_remove.go
Original file line number Diff line number Diff line change
Expand Up @@ -34,13 +34,13 @@ var awsRemoveForceDevEnvRemove bool

// awsRemoveCmd represents the aws remove command
var awsRemoveCmd = &cobra.Command{
Use: "remove (<repository_name>|<account_name/repository_name>)",
Use: "remove <repository>",

Short: "Remove a development environment",

Long: `Remove an existing development environment.
The development environment will be PERMANENTLY removed along with all its data.
The development environment will be PERMANENTLY removed along with ALL your data.
There is no going back, so please be sure to save your work before running this command.`,

Expand Down
2 changes: 1 addition & 1 deletion internal/cmd/aws_start.go
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ var awsStartForceDevEnvRebuild bool

// awsStartCmd represents the aws start command
var awsStartCmd = &cobra.Command{
Use: "start (<repository_name>|<account_name/repository_name>)",
Use: "start <repository>",

Short: "Start a development environment",

Expand Down
2 changes: 1 addition & 1 deletion internal/cmd/aws_stop.go
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ import (

// awsStopCmd represents the aws stop command
var awsStopCmd = &cobra.Command{
Use: "stop (<repository_name>|<account_name/repository_name>)",
Use: "stop <repository>",

Short: "Stop a development environment",

Expand Down

0 comments on commit ad478c5

Please # to comment.