Skip to content

Commit b266800

Browse files
dvdksnclaude
andauthored
sbx: add diagnose command (#24758)
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com> --------- Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com> Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent c953aee commit b266800

File tree

3 files changed

+51
-0
lines changed

3 files changed

+51
-0
lines changed

content/manuals/ai/sandboxes/troubleshooting.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,23 @@ description: Resolve common issues when using Docker Sandboxes.
66

77
{{< summary-bar feature_name="Docker Sandboxes sbx" >}}
88

9+
## Run diagnostics
10+
11+
Before digging into a specific issue, run
12+
[`sbx diagnose`](/reference/cli/sbx/diagnose/) to check for common problems
13+
with your installation, such as a missing CLI binary, an unresponsive daemon,
14+
a CLI/daemon version mismatch, missing storage directories, or broken
15+
authentication.
16+
17+
```console
18+
$ sbx diagnose
19+
```
20+
21+
The command prints a summary of checks that passed, warned, or failed, along
22+
with suggested fixes. Use `--output json` to get machine-readable output, or
23+
`--output github-issue` to generate a Markdown snippet suitable for pasting
24+
into a GitHub issue.
25+
926
## Resetting sandboxes
1027

1128
If you hit persistent issues or corrupted state, run
@@ -155,3 +172,15 @@ Windows:
155172

156173
If you've exhausted the steps above and the problem persists, file a GitHub
157174
issue at [github.com/docker/sbx-releases/issues](https://github.com/docker/sbx-releases/issues).
175+
176+
To help the Docker team investigate, generate a diagnostics bundle and share
177+
it when reporting the issue:
178+
179+
```console
180+
$ sbx diagnose --upload
181+
```
182+
183+
The bundle contains daemon logs, diagnostic check results, and basic system
184+
information. When `--upload` is confirmed, the bundle is uploaded to Docker
185+
support and the command prints a diagnostics ID. Include this ID in your
186+
issue so the team can correlate it with the uploaded bundle.

data/sbx_cli/sbx.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ options:
1717
see_also:
1818
- sbx completion - Generate the autocompletion script for the specified shell
1919
- sbx create - Create a sandbox for an agent
20+
- sbx diagnose - Diagnose common issues with your sbx installation
2021
- sbx exec - Execute a command inside a sandbox
2122
- sbx login - Sign in to Docker
2223
- sbx logout - Sign out of Docker

data/sbx_cli/sbx_diagnose.yaml

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
name: sbx diagnose
2+
synopsis: Diagnose common issues with your sbx installation
3+
usage: sbx diagnose
4+
options:
5+
- name: help
6+
shorthand: h
7+
default_value: "false"
8+
usage: help for diagnose
9+
- name: output
10+
shorthand: o
11+
usage: 'Output format: "json" or "github-issue"'
12+
- name: upload
13+
default_value: "false"
14+
usage: Upload diagnostics to Docker support
15+
inherited_options:
16+
- name: debug
17+
shorthand: D
18+
default_value: "false"
19+
usage: Enable debug logging
20+
see_also:
21+
- sbx - Manage AI coding agent sandboxes.

0 commit comments

Comments
 (0)