fixup! feat: replace coder sh implementation to shell out to ssh

coder · cmoog · Mar 17, 2021 · Mar 17, 2021 · Mar 17, 2021 · Mar 17, 2021
commit 672ce07537839ce543e81070542aca37233f62c1
diff --git a/docs/coder.md b/docs/coder.md
@@ -17,7 +17,7 @@ coder provides a CLI for working with an existing Coder Enterprise installation
 * [coder images](coder_images.md)	 - Manage Coder images
 * [coder login](coder_login.md)	 - Authenticate this client for future operations
 * [coder logout](coder_logout.md)	 - Remove local authentication credentials if any exist
-* [coder sh](coder_sh.md)	 - Open a shell and execute commands in a Coder environment
+* [coder ssh](coder_ssh.md)	 - Enter a shell of execute a command over SSH into a Coder environment
 * [coder sync](coder_sync.md)	 - Establish a one way directory sync to a Coder environment
 * [coder tokens](coder_tokens.md)	 - manage Coder API tokens for the active user
 * [coder urls](coder_urls.md)	 - Interact with environment DevURLs

diff --git a/docs/coder_sh.md b/docs/coder_sh.md
diff --git a/docs/coder_ssh.md b/docs/coder_ssh.md
@@ -0,0 +1,31 @@
+## coder ssh
+
+Enter a shell of execute a command over SSH into a Coder environment
+
+```
+coder ssh [environment_name] [flags]
+```
+
+### Examples
+
+```
+coder ssh my-dev
+coder ssh my-dev pwd
+```
+
+### Options
+
+```
+  -h, --help   help for ssh
+```
+
+### Options inherited from parent commands
+
+```
+  -v, --verbose   show verbose output
+```
+
+### SEE ALSO
+
+* [coder](coder.md)	 - coder provides a CLI for working with an existing Coder Enterprise installation
+
diff --git a/internal/cmd/shell.go b/internal/cmd/shell.go
diff --git a/internal/cmd/ssh.go b/internal/cmd/ssh.go
@@ -21,9 +21,13 @@ var (
 
 func sshCmd() *cobra.Command {
 	cmd := cobra.Command{
-		Use:  "sh",
-		Args: shValidArgs,
-		RunE: shell,
+		Use:   "ssh [environment_name]",
+		Short: "Enter a shell of execute a command over SSH into a Coder environment",
+		Args:  shValidArgs,
+		Example: `coder ssh my-dev
+coder ssh my-dev pwd`,
+		Aliases: []string{"sh"},
+		RunE:    shell,
 	}
 	return &cmd
 }
@@ -83,7 +87,8 @@ func shell(cmd *cobra.Command, args []string) error {
 // special handling for the common case of "coder sh" input without a positional argument.
 func shValidArgs(cmd *cobra.Command, args []string) error {
 	ctx := cmd.Context()
-	if err := cobra.MinimumNArgs(1)(cmd, args); err != nil {
+	err := cobra.MinimumNArgs(1)(cmd, args)
+	if err != nil {
 		client, err := newClient(ctx)
 		if err != nil {
 			return clog.Error("missing [environment_name] argument")