Skip to content

Commit 5466862

Browse files
dvdksndvdksn
committed
cli: add reference docs for docker sandbox
Signed-off-by: David Karlsson <[email protected]>
1 parent 24ca6ef commit 5466862

File tree

12 files changed

+503
-0
lines changed

12 files changed

+503
-0
lines changed

‎content/reference/cli/docker/sandbox/_index.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
datafolder: sandbox-cli
3+
datafile: docker_sandbox
4+
title: docker sandbox
5+
layout: cli
6+
---

‎content/reference/cli/docker/sandbox/inspect.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
datafolder: sandbox-cli
3+
datafile: docker_sandbox_inspect
4+
title: docker sandbox inspect
5+
layout: cli
6+
---

‎content/reference/cli/docker/sandbox/ls.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
datafolder: sandbox-cli
3+
datafile: docker_sandbox_ls
4+
title: docker sandbox ls
5+
layout: cli
6+
---

‎content/reference/cli/docker/sandbox/rm.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
datafolder: sandbox-cli
3+
datafile: docker_sandbox_rm
4+
title: docker sandbox rm
5+
layout: cli
6+
---

‎content/reference/cli/docker/sandbox/run.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
datafolder: sandbox-cli
3+
datafile: docker_sandbox_run
4+
title: docker sandbox run
5+
layout: cli
6+
---

‎content/reference/cli/docker/sandbox/version.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
datafolder: sandbox-cli
3+
datafile: docker_sandbox_version
4+
title: docker sandbox version
5+
layout: cli
6+
---

‎data/sandbox-cli/docker_sandbox.yaml‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
command: docker sandbox
2+
short: Docker Sandbox
3+
long: Local sandbox environments for AI agents, using Docker.
4+
usage: docker sandbox
5+
pname: docker
6+
plink: docker.yaml
7+
cname:
8+
- docker sandbox inspect
9+
- docker sandbox ls
10+
- docker sandbox rm
11+
- docker sandbox run
12+
- docker sandbox version
13+
clink:
14+
- docker_sandbox_inspect.yaml
15+
- docker_sandbox_ls.yaml
16+
- docker_sandbox_rm.yaml
17+
- docker_sandbox_run.yaml
18+
- docker_sandbox_version.yaml
19+
options:
20+
- option: debug
21+
shorthand: D
22+
value_type: bool
23+
default_value: "false"
24+
description: Enable debug logging
25+
deprecated: false
26+
hidden: false
27+
experimental: false
28+
experimentalcli: false
29+
kubernetes: false
30+
swarm: false
31+
deprecated: false
32+
hidden: false
33+
experimental: false
34+
experimentalcli: false
35+
kubernetes: false
36+
swarm: false
37+

‎data/sandbox-cli/docker_sandbox_inspect.yaml‎

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
command: docker sandbox inspect
2+
short: Display detailed information on one or more sandboxes
3+
long: |-
4+
Display detailed information on one or more sandboxes.
5+
6+
This command retrieves and displays detailed information about the specified
7+
sandboxes using the Docker API. Each sandbox is identified by its unique ID or name.
8+
usage: docker sandbox inspect [OPTIONS] SANDBOX [SANDBOX...]
9+
pname: docker sandbox
10+
plink: docker_sandbox.yaml
11+
inherited_options:
12+
- option: debug
13+
shorthand: D
14+
value_type: bool
15+
default_value: "false"
16+
description: Enable debug logging
17+
deprecated: false
18+
hidden: false
19+
experimental: false
20+
experimentalcli: false
21+
kubernetes: false
22+
swarm: false
23+
examples: |-
24+
### Inspect a sandbox
25+
26+
```console
27+
$ docker sandbox inspect abc123def
28+
[
29+
{
30+
"id": "abc123def69b16c5c0dab4cf699e26f8d01e1ace3aeee06254e0999492e11647",
31+
"name": "claude-sandbox-2025-11-04-170333",
32+
"created_at": "2025-11-04T16:03:33.910642347Z",
33+
"status": "running",
34+
"template": "docker/sandbox-templates:claude-code",
35+
"labels": {
36+
"com.docker.sandbox.agent": "claude",
37+
"com.docker.sandbox.workingDirectory": "/Users/moby/code/docker/sandboxes",
38+
"com.docker.sandbox.workingDirectoryInode": "3041007",
39+
"com.docker.sandboxes": "templates",
40+
"com.docker.sandboxes.base": "ubuntu:questing",
41+
"com.docker.sandboxes.flavor": "claude-code",
42+
"com.docker.sdk": "true",
43+
"com.docker.sdk.client": "0.1.0-alpha011",
44+
"com.docker.sdk.container": "0.1.0-alpha012",
45+
"com.docker.sdk.lang": "go",
46+
"docker/sandbox": "true",
47+
"org.opencontainers.image.ref.name": "ubuntu",
48+
"org.opencontainers.image.version": "25.10"
49+
}
50+
}
51+
]
52+
```
53+
deprecated: false
54+
hidden: false
55+
experimental: false
56+
experimentalcli: false
57+
kubernetes: false
58+
swarm: false
59+

‎data/sandbox-cli/docker_sandbox_ls.yaml‎

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
command: docker sandbox ls
2+
aliases: docker sandbox ls, docker sandbox list
3+
short: List sandboxes
4+
long: |-
5+
List all sandboxes.
6+
7+
This command lists all sandboxes using the Docker API.
8+
usage: docker sandbox ls
9+
pname: docker sandbox
10+
plink: docker_sandbox.yaml
11+
options:
12+
- option: quiet
13+
shorthand: q
14+
value_type: bool
15+
default_value: "false"
16+
description: Only display sandbox IDs
17+
details_url: '#quiet'
18+
deprecated: false
19+
hidden: false
20+
experimental: false
21+
experimentalcli: false
22+
kubernetes: false
23+
swarm: false
24+
inherited_options:
25+
- option: debug
26+
shorthand: D
27+
value_type: bool
28+
default_value: "false"
29+
description: Enable debug logging
30+
deprecated: false
31+
hidden: false
32+
experimental: false
33+
experimentalcli: false
34+
kubernetes: false
35+
swarm: false
36+
examples: |-
37+
### List all sandboxes
38+
39+
```console
40+
$ docker sandbox ls
41+
SANDBOX ID NAME WORKSPACE CREATED
42+
abc123def my-project /home/user/my-project 2 hours ago
43+
def456ghi ml-work /home/user/ml-projects 1 day ago
44+
```
45+
46+
### Show only sandbox IDs (--quiet) {#quiet}
47+
48+
```text
49+
--quiet
50+
```
51+
52+
Output only sandbox IDs:
53+
54+
```console
55+
$ docker sandbox ls --quiet
56+
abc123def
57+
def456ghi
58+
```
59+
deprecated: false
60+
hidden: false
61+
experimental: false
62+
experimentalcli: false
63+
kubernetes: false
64+
swarm: false
65+

‎data/sandbox-cli/docker_sandbox_rm.yaml‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
command: docker sandbox rm
2+
short: Remove one or more sandboxes
3+
long: |-
4+
Remove one or more sandboxes by their IDs or names.
5+
6+
This command removes the specified sandboxes. Each sandbox is identified by its unique ID or name.
7+
usage: docker sandbox rm [OPTIONS] SANDBOX [SANDBOX...]
8+
pname: docker sandbox
9+
plink: docker_sandbox.yaml
10+
inherited_options:
11+
- option: debug
12+
shorthand: D
13+
value_type: bool
14+
default_value: "false"
15+
description: Enable debug logging
16+
deprecated: false
17+
hidden: false
18+
experimental: false
19+
experimentalcli: false
20+
kubernetes: false
21+
swarm: false
22+
examples: |-
23+
### Remove a sandbox
24+
25+
```console
26+
$ docker sandbox rm abc123def
27+
abc123def
28+
```
29+
30+
### Remove multiple sandboxes
31+
32+
```console
33+
$ docker sandbox rm abc123def def456ghi
34+
abc123def
35+
def456ghi
36+
```
37+
38+
### Remove all sandboxes
39+
40+
```console
41+
$ docker sandbox rm $(docker sandbox ls -q)
42+
```
43+
deprecated: false
44+
hidden: false
45+
experimental: false
46+
experimentalcli: false
47+
kubernetes: false
48+
swarm: false
49+

0 commit comments

Comments
 (0)