mirror of
https://github.com/coder/coder.git
synced 2026-09-24 15:04:27 +08:00
feat(cli): unhide support bundle cmd (#12745)
* chore(cli): add another test to ensure no secret leakage * feat(cli): unhide support bundle cmd
This commit is contained in:
@@ -57,6 +57,7 @@ Coder — A tool for provisioning self-hosted development environments with Terr
|
||||
| [<code>stop</code>](./cli/stop.md) | Stop a workspace |
|
||||
| [<code>unfavorite</code>](./cli/unfavorite.md) | Remove a workspace from your favorites |
|
||||
| [<code>update</code>](./cli/update.md) | Will update and start a given workspace if it is out of date |
|
||||
| [<code>support</code>](./cli/support.md) | Commands for troubleshooting issues with a Coder deployment. |
|
||||
| [<code>server</code>](./cli/server.md) | Start a Coder server |
|
||||
| [<code>features</code>](./cli/features.md) | List Enterprise features |
|
||||
| [<code>licenses</code>](./cli/licenses.md) | Add, delete, and list licenses |
|
||||
|
||||
Generated
+17
@@ -0,0 +1,17 @@
|
||||
<!-- DO NOT EDIT | GENERATED CONTENT -->
|
||||
|
||||
# support
|
||||
|
||||
Commands for troubleshooting issues with a Coder deployment.
|
||||
|
||||
## Usage
|
||||
|
||||
```console
|
||||
coder support
|
||||
```
|
||||
|
||||
## Subcommands
|
||||
|
||||
| Name | Purpose |
|
||||
| ------------------------------------------ | --------------------------------------------------------------------------- |
|
||||
| [<code>bundle</code>](./support_bundle.md) | Generate a support bundle to troubleshoot issues connecting to a workspace. |
|
||||
Generated
+45
@@ -0,0 +1,45 @@
|
||||
<!-- DO NOT EDIT | GENERATED CONTENT -->
|
||||
|
||||
# support bundle
|
||||
|
||||
Generate a support bundle to troubleshoot issues connecting to a workspace.
|
||||
|
||||
## Usage
|
||||
|
||||
```console
|
||||
coder support bundle [flags] <workspace> [<agent>]
|
||||
```
|
||||
|
||||
## Description
|
||||
|
||||
```console
|
||||
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
|
||||
|
||||
### -y, --yes
|
||||
|
||||
| | |
|
||||
| ---- | ----------------- |
|
||||
| Type | <code>bool</code> |
|
||||
|
||||
Bypass prompts.
|
||||
|
||||
### -O, --output-file
|
||||
|
||||
| | |
|
||||
| ----------- | ---------------------------------------------- |
|
||||
| Type | <code>string</code> |
|
||||
| Environment | <code>$CODER_SUPPORT_BUNDLE_OUTPUT_FILE</code> |
|
||||
|
||||
File path for writing the generated support bundle. Defaults to coder-support-$(date +%s).zip.
|
||||
|
||||
### --url-override
|
||||
|
||||
| | |
|
||||
| ----------- | ----------------------------------------------- |
|
||||
| Type | <code>string</code> |
|
||||
| Environment | <code>$CODER_SUPPORT_BUNDLE_URL_OVERRIDE</code> |
|
||||
|
||||
Override the URL to your Coder deployment. This may be useful, for example, if you need to troubleshoot a specific Coder replica.
|
||||
@@ -900,6 +900,16 @@
|
||||
"description": "Stop a workspace",
|
||||
"path": "cli/stop.md"
|
||||
},
|
||||
{
|
||||
"title": "support",
|
||||
"description": "Commands for troubleshooting issues with a Coder deployment.",
|
||||
"path": "cli/support.md"
|
||||
},
|
||||
{
|
||||
"title": "support bundle",
|
||||
"description": "Generate a support bundle to troubleshoot issues connecting to a workspace.",
|
||||
"path": "cli/support_bundle.md"
|
||||
},
|
||||
{
|
||||
"title": "templates",
|
||||
"description": "Manage templates",
|
||||
|
||||
Reference in New Issue
Block a user