fixup! fixup! feat(cli): add support command and accompanying unit tests

johnstcn · johnstcn · commit 68139593501a · 2024-03-01T13:16:21.000Z
diff --git a/cli/support.go b/cli/support.go
@@ -95,6 +95,7 @@ func (r *RootCmd) support() *clibase.Cmd {
 			}
 			return nil
 		},
+		Hidden: true, // TODO: un-hide
 	}
 	cmd.Options = clibase.OptionSet{
 		{
diff --git a/cli/testdata/coder_--help.golden b/cli/testdata/coder_--help.golden
@@ -46,7 +46,6 @@ SUBCOMMANDS:
     stat              Show resource usage for the current workspace.
     state             Manually manage Terraform state to fix broken workspaces
     stop              Stop a workspace
-    support           Generate a support bundle to troubleshoot issues.
     templates         Manage templates
     tokens            Manage personal access tokens
     unfavorite        Remove a workspace from your favorites
diff --git a/cli/testdata/coder_support_--help.golden b/cli/testdata/coder_support_--help.golden
@@ -1,13 +1,18 @@
 coder v0.0.0-devel
 
 USAGE:
-  coder support <workspace> [<agent>]
+  coder support [flags] <workspace> [<agent>]
 
   Generate a support bundle to troubleshoot issues.
 
   This command generates a file containing detailed troubleshooting information
   about the Coder deployment and workspace connections. You must specify a
   single workspace (and optionally an agent name).
 
+OPTIONS:
+  -o, --output string, $CODER_SUPPORT_BUNDLE_OUTPUT
+          Path to which to output the generated support bundle. Defaults to
+          coder-support-YYYYmmdd-HHMMSS.zip.
+
 ———
 Run `coder --help` for a list of global options.
diff --git a/docs/cli.md b/docs/cli.md
@@ -56,7 +56,6 @@ Coder — A tool for provisioning self-hosted development environments with Terr
 | [<code>stat</code>](./cli/stat.md)                     | Show resource usage for the current workspace.                                                        |
 | [<code>state</code>](./cli/state.md)                   | Manually manage Terraform state to fix broken workspaces                                              |
 | [<code>stop</code>](./cli/stop.md)                     | Stop a workspace                                                                                      |
-| [<code>support</code>](./cli/support.md)               | Generate a support bundle to troubleshoot issues.                                                     |
 | [<code>templates</code>](./cli/templates.md)           | Manage templates                                                                                      |
 | [<code>tokens</code>](./cli/tokens.md)                 | Manage personal access tokens                                                                         |
 | [<code>unfavorite</code>](./cli/unfavorite.md)         | Remove a workspace from your favorites                                                                |
diff --git a/docs/cli/support.md b/docs/cli/support.md
diff --git a/docs/manifest.json b/docs/manifest.json
@@ -880,11 +880,6 @@
           "description": "Stop a workspace",
           "path": "cli/stop.md"
         },
-        {
-          "title": "support",
-          "description": "Generate a support bundle to troubleshoot issues.",
-          "path": "cli/support.md"
-        },
         {
           "title": "templates",
           "description": "Manage templates",

Original file line number	Diff line number	Diff line change
`@@ -95,6 +95,7 @@ func (r RootCmd) support() clibase.Cmd {`
`95`	`95`	`}`
`96`	`96`	`return nil`
`97`	`97`	`},`
	`98`	`+ Hidden: true, // TODO: un-hide`
`98`	`99`	`}`
`99`	`100`	`cmd.Options = clibase.OptionSet{`
`100`	`101`	`{`