fixup! Add completions for env names

cmoog · cmoog · commit 6a41406d32c3 · 2020-08-07T16:28:47.000-05:00
diff --git a/ci/integration/setup_test.go b/ci/integration/setup_test.go
@@ -13,6 +13,7 @@ import (
 	"golang.org/x/xerrors"
 )
 
+// binpath is populated during package initialization with a path to the coder binary
 var binpath string
 
 // initialize integration tests by building the coder-cli binary
diff --git a/cmd/coder/secrets.go b/cmd/coder/secrets.go
@@ -28,16 +28,18 @@ func makeSecretsCmd() *cobra.Command {
 		},
 		makeCreateSecret(),
 		&cobra.Command{
-			Use:   "rm [...secret_name]",
-			Short: "Remove one or more secrets by name",
-			Args:  cobra.MinimumNArgs(1),
-			RunE:  removeSecrets,
+			Use:     "rm [...secret_name]",
+			Short:   "Remove one or more secrets by name",
+			Args:    cobra.MinimumNArgs(1),
+			RunE:    removeSecrets,
+			Example: "coder secrets rm mysql-password mysql-user",
 		},
 		&cobra.Command{
-			Use:   "view [secret_name]",
-			Short: "View a secret by name",
-			Args:  cobra.ExactArgs(1),
-			RunE:  viewSecret,
+			Use:     "view [secret_name]",
+			Short:   "View a secret by name",
+			Args:    cobra.ExactArgs(1),
+			RunE:    viewSecret,
+			Example: "coder secrets view mysql-password",
 		},
 	)
 	return cmd
@@ -55,6 +57,9 @@ func makeCreateSecret() *cobra.Command {
 		Use:   "create [secret_name]",
 		Short: "Create a new secret",
 		Long:  "Create a new secret object to store application secrets and access them securely from within your environments.",
+		Example: `coder secrets create mysql-password --from-literal 123password
+coder secrets create mysql-password --from-prompt
+coder secrets create aws-credentials --from-file ./credentials.json`,
 		Args: func(cmd *cobra.Command, args []string) error {
 			if len(args) < 1 {
 				return xerrors.Errorf("[secret_name] is a required argument")
diff --git a/cmd/coder/shell.go b/cmd/coder/shell.go
@@ -44,6 +44,7 @@ func makeShellCmd() *cobra.Command {
 		DisableFlagParsing: true,
 		ValidArgs:          getEnvsForCompletion(),
 		RunE:               shell,
+		Example:            "coder sh backend-env",
 	}
 }
 
diff --git a/cmd/coder/users.go b/cmd/coder/users.go
@@ -19,9 +19,11 @@ func makeUsersCmd() *cobra.Command {
 	lsCmd := &cobra.Command{
 		Use:   "ls",
 		Short: "list all user accounts",
-		RunE:  listUsers(&outputFmt),
+		Example: `coder users ls -o json
+coder users ls -o json | jq .[] | jq -r .email`,
+		RunE: listUsers(&outputFmt),
 	}
-	lsCmd.Flags().StringVarP(&outputFmt, "output", "0", "human", "human | json")
+	lsCmd.Flags().StringVarP(&outputFmt, "output", "o", "human", "human | json")
 
 	cmd.AddCommand(lsCmd)
 	return cmd

Original file line number	Diff line number	Diff line change
`@@ -13,6 +13,7 @@ import (`
`13`	`13`	`"golang.org/x/xerrors"`
`14`	`14`	`)`
`15`	`15`
	`16`	`+// binpath is populated during package initialization with a path to the coder binary`
`16`	`17`	`var binpath string`
`17`	`18`
`18`	`19`	`// initialize integration tests by building the coder-cli binary`
Original file line number	Diff line number	Diff line change
`@@ -44,6 +44,7 @@ func makeShellCmd() *cobra.Command {`
`44`	`44`	`DisableFlagParsing: true,`
`45`	`45`	`ValidArgs: getEnvsForCompletion(),`
`46`	`46`	`RunE: shell,`
	`47`	`+ Example: "coder sh backend-env",`
`47`	`48`	`}`
`48`	`49`	`}`
`49`	`50`