2024-03-25 15:14:27 +00:00
|
|
|
coder v0.0.0-devel
|
|
|
|
|
|
|
|
|
|
USAGE:
|
2026-04-22 17:21:28 +03:00
|
|
|
coder support bundle [flags] [<workspace>] [<agent>]
|
2024-03-25 15:14:27 +00:00
|
|
|
|
|
|
|
|
Generate a support bundle to troubleshoot issues connecting to a workspace.
|
|
|
|
|
|
|
|
|
|
This command generates a file containing detailed troubleshooting information
|
2026-04-22 17:21:28 +03:00
|
|
|
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:
|
|
|
|
|
-O, --output-file string, $CODER_SUPPORT_BUNDLE_OUTPUT_FILE
|
|
|
|
|
File path for writing the generated support bundle. Defaults to
|
|
|
|
|
coder-support-$(date +%s).zip.
|
|
|
|
|
|
2026-01-20 10:28:52 +11:00
|
|
|
--pprof bool, $CODER_SUPPORT_BUNDLE_PPROF
|
|
|
|
|
Collect pprof profiling data from the Coder server and agent. Requires
|
|
|
|
|
Coder server version 2.28.0 or newer.
|
|
|
|
|
|
|
|
|
|
--template string, $CODER_SUPPORT_BUNDLE_TEMPLATE
|
|
|
|
|
Template name to include in the support bundle. Use
|
|
|
|
|
org_name/template_name if template name is reused across multiple
|
|
|
|
|
organizations.
|
|
|
|
|
|
2024-03-25 15:14:27 +00:00
|
|
|
--url-override string, $CODER_SUPPORT_BUNDLE_URL_OVERRIDE
|
|
|
|
|
Override the URL to your Coder deployment. This may be useful, for
|
|
|
|
|
example, if you need to troubleshoot a specific Coder replica.
|
|
|
|
|
|
2026-07-16 13:00:32 +03:00
|
|
|
--workspace-file string-array, $CODER_SUPPORT_BUNDLE_WORKSPACE_FILE
|
|
|
|
|
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
|
|
|
--workspaces-total-cap int, $CODER_SUPPORT_BUNDLE_WORKSPACES_TOTAL_CAP
|
|
|
|
|
Maximum number of workspaces to include in the support bundle. Set to
|
|
|
|
|
0 or negative value to disable the cap. Defaults to 10.
|
|
|
|
|
|
2024-03-25 15:14:27 +00:00
|
|
|
-y, --yes bool
|
2026-01-16 18:04:57 -08:00
|
|
|
Bypass confirmation prompts.
|
2024-03-25 15:14:27 +00:00
|
|
|
|
|
|
|
|
———
|
|
|
|
|
Run `coder --help` for a list of global options.
|