2026-08-11 11:22:55 -04:00
---
# Code generated by make gen. DO NOT EDIT.
2026-09-28 15:44:10 -04:00
title : "`coder support bundle`"
2026-08-11 11:22:55 -04:00
description : Generate a support bundle to troubleshoot issues connecting to a workspace.
---
2024-03-25 15:14:27 +00:00
<!-- DO NOT EDIT | GENERATED CONTENT -->
Generate a support bundle to troubleshoot issues connecting to a workspace.
## Usage
```console
2026-04-22 17:21:28 +03:00
coder support bundle [flags] [<workspace>] [<agent>]
2024-03-25 15:14:27 +00:00
```
## Description
```console
2026-04-22 17:21:28 +03:00
This command generates a file containing detailed troubleshooting information about the Coder deployment and workspace connections. You may specify a single workspace (and optionally an agent name). When run inside a workspace, the workspace and agent are inferred from the environment if not provided.
2024-03-25 15:14:27 +00:00
```
## Options
### -y, --yes
2026-10-21 10:58:04 -07:00
| Property | Value |
|----------|-------------------|
| Type | <code>bool</code> |
2024-03-25 15:14:27 +00:00
2026-01-16 18:04:57 -08:00
Bypass confirmation prompts.
2024-03-25 15:14:27 +00:00
### -O, --output-file
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|------------------------------------------------|
2024-03-25 15:14:27 +00:00
| 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
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|-------------------------------------------------|
2024-03-25 15:14:27 +00:00
| 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.
2026-01-20 10:28:52 +11:00
### --workspaces-total-cap
2026-10-21 10:58:04 -07:00
| Property | Value |
2026-01-20 10:28:52 +11:00
|-------------|---------------------------------------------------------|
| Type | <code>int</code> |
| Environment | <code>$CODER_SUPPORT_BUNDLE_WORKSPACES_TOTAL_CAP</code> |
Maximum number of workspaces to include in the support bundle. Set to 0 or negative value to disable the cap. Defaults to 10.
### --template
2026-10-21 10:58:04 -07:00
| Property | Value |
2026-01-20 10:28:52 +11:00
|-------------|---------------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_SUPPORT_BUNDLE_TEMPLATE</code> |
Template name to include in the support bundle. Use org_name/template_name if template name is reused across multiple organizations.
2026-07-16 13:00:32 +03:00
### --workspace-file
2026-10-21 10:58:04 -07:00
| Property | Value |
2026-07-16 13:00:32 +03:00
|-------------|---------------------------------------------------|
| Type | <code>string-array</code> |
| Environment | <code>$CODER_SUPPORT_BUNDLE_WORKSPACE_FILE</code> |
File path or glob to collect from inside the remote workspace. Environment variables are expanded in the workspace; paths must then be absolute or start with ~/, which resolves against the agent user's home directory. Files local to the machine running this command are not collected. Can be specified multiple times.
2026-01-20 10:28:52 +11:00
### --pprof
2026-10-21 10:58:04 -07:00
| Property | Value |
2026-01-20 10:28:52 +11:00
|-------------|------------------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_SUPPORT_BUNDLE_PPROF</code> |
Collect pprof profiling data from the Coder server and agent. Requires Coder server version 2.28.0 or newer.