Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 55 additions & 0 deletions data/sandbox-cli/docker_sandbox_create.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,14 @@ cname:
- docker sandbox create cagent
- docker sandbox create claude
- docker sandbox create codex
- docker sandbox create copilot
- docker sandbox create gemini
- docker sandbox create kiro
clink:
- docker_sandbox_create_cagent.yaml
- docker_sandbox_create_claude.yaml
- docker_sandbox_create_codex.yaml
- docker_sandbox_create_copilot.yaml
- docker_sandbox_create_gemini.yaml
- docker_sandbox_create_kiro.yaml
options:
Expand All @@ -25,6 +27,7 @@ options:
default_value: "false"
description: |
Load a locally built template image into the sandbox (useful for testing local changes)
details_url: '#load-local-template'
deprecated: false
hidden: false
experimental: false
Expand Down Expand Up @@ -57,6 +60,7 @@ options:
value_type: string
description: |
Container image to use for the sandbox (default: agent-specific image)
details_url: '#template'
deprecated: false
hidden: false
experimental: false
Expand Down Expand Up @@ -85,6 +89,57 @@ inherited_options:
experimentalcli: false
kubernetes: false
swarm: false
examples: |-
### Create a Claude sandbox

```console
$ docker sandbox create claude ~/my-project
```

### Create with a custom name

```console
$ docker sandbox create --name my-sandbox claude ~/my-project
```

### Use a custom base image (-t, --template) {#template}

```text
--template IMAGE
```

Specify a custom container image to use as the sandbox base:

```console
$ docker sandbox create --template python:3-alpine claude ~/my-project
```

By default, each agent uses a pre-configured image.

### Use locally built template (--load-local-template) {#load-local-template}

Load a locally built template image for testing:

```console
$ docker sandbox create --load-local-template claude ~/my-project
```

This is useful when developing or testing changes to sandbox templates.

### Create and run immediately

After creating a sandbox, use `run` to start the agent:

```console
$ docker sandbox create --name my-sandbox claude ~/my-project
$ docker sandbox run my-sandbox
```

Or use `docker sandbox run` directly to create and run in one step:

```console
$ docker sandbox run claude ~/my-project
```
deprecated: false
hidden: false
experimental: false
Expand Down
19 changes: 19 additions & 0 deletions data/sandbox-cli/docker_sandbox_create_cagent.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,25 @@ inherited_options:
experimentalcli: false
kubernetes: false
swarm: false
examples: |-
### Create a Cagent sandbox in the current directory

```console
$ docker sandbox create cagent .
```

### Create with an absolute path

```console
$ docker sandbox create cagent /home/user/my-project
```

### Create and then run

```console
$ docker sandbox create --name my-cagent cagent ~/my-project
$ docker sandbox run my-cagent
```
deprecated: false
hidden: false
experimental: false
Expand Down
19 changes: 19 additions & 0 deletions data/sandbox-cli/docker_sandbox_create_claude.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,25 @@ inherited_options:
experimentalcli: false
kubernetes: false
swarm: false
examples: |-
### Create a Claude sandbox in the current directory

```console
$ docker sandbox create claude .
```

### Create with an absolute path

```console
$ docker sandbox create claude /home/user/my-project
```

### Create and then run

```console
$ docker sandbox create --name my-claude claude ~/my-project
$ docker sandbox run my-claude
```
deprecated: false
hidden: false
experimental: false
Expand Down
19 changes: 19 additions & 0 deletions data/sandbox-cli/docker_sandbox_create_codex.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,25 @@ inherited_options:
experimentalcli: false
kubernetes: false
swarm: false
examples: |-
### Create a Codex sandbox in the current directory

```console
$ docker sandbox create codex .
```

### Create with an absolute path

```console
$ docker sandbox create codex /home/user/my-project
```

### Create and then run

```console
$ docker sandbox create --name my-codex codex ~/my-project
$ docker sandbox run my-codex
```
deprecated: false
hidden: false
experimental: false
Expand Down
19 changes: 19 additions & 0 deletions data/sandbox-cli/docker_sandbox_create_gemini.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,25 @@ inherited_options:
experimentalcli: false
kubernetes: false
swarm: false
examples: |-
### Create a Gemini sandbox in the current directory

```console
$ docker sandbox create gemini .
```

### Create with an absolute path

```console
$ docker sandbox create gemini /home/user/my-project
```

### Create and then run

```console
$ docker sandbox create --name my-gemini gemini ~/my-project
$ docker sandbox run my-gemini
```
deprecated: false
hidden: false
experimental: false
Expand Down
19 changes: 19 additions & 0 deletions data/sandbox-cli/docker_sandbox_create_kiro.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,25 @@ inherited_options:
experimentalcli: false
kubernetes: false
swarm: false
examples: |-
### Create a Kiro sandbox in the current directory

```console
$ docker sandbox create kiro .
```

### Create with an absolute path

```console
$ docker sandbox create kiro /home/user/my-project
```

### Create and then run

```console
$ docker sandbox create --name my-kiro kiro ~/my-project
$ docker sandbox run my-kiro
```
deprecated: false
hidden: false
experimental: false
Expand Down
63 changes: 63 additions & 0 deletions data/sandbox-cli/docker_sandbox_exec.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ options:
value_type: bool
default_value: "false"
description: 'Detached mode: run command in the background'
details_url: '#detach'
deprecated: false
hidden: false
experimental: false
Expand All @@ -33,6 +34,7 @@ options:
value_type: stringArray
default_value: '[]'
description: Set environment variables
details_url: '#env'
deprecated: false
hidden: false
experimental: false
Expand Down Expand Up @@ -85,6 +87,7 @@ options:
shorthand: u
value_type: string
description: 'Username or UID (format: <name|uid>[:<group|gid>])'
details_url: '#user'
deprecated: false
hidden: false
experimental: false
Expand All @@ -95,6 +98,7 @@ options:
shorthand: w
value_type: string
description: Working directory inside the container
details_url: '#workdir'
deprecated: false
hidden: false
experimental: false
Expand Down Expand Up @@ -123,6 +127,65 @@ inherited_options:
experimentalcli: false
kubernetes: false
swarm: false
examples: |-
### Execute a command in a sandbox

```console
$ docker sandbox exec my-sandbox ls -la
```

### Run an interactive shell

```console
$ docker sandbox exec -it my-sandbox /bin/bash
```

### Set environment variables (-e, --env) {#env}

```text
--env KEY=VALUE
```

Pass environment variables to the command:

```console
$ docker sandbox exec \
--env NODE_ENV=development \
--env DATABASE_URL=postgresql://localhost/myapp \
my-sandbox npm test
```

### Set working directory (-w, --workdir) {#workdir}

```text
--workdir PATH
```

Run the command in a specific directory:

```console
$ docker sandbox exec --workdir /app my-sandbox python script.py
```

### Run as specific user (-u, --user) {#user}

```text
--user USER[:GROUP]
```

Execute command as a different user:

```console
$ docker sandbox exec --user 1000:1000 my-sandbox id
```

### Run in background (-d, --detach) {#detach}

Run a long-running command in the background:

```console
$ docker sandbox exec -d my-sandbox python server.py
```
deprecated: false
hidden: false
experimental: false
Expand Down
16 changes: 16 additions & 0 deletions data/sandbox-cli/docker_sandbox_network.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,22 @@ inherited_options:
experimentalcli: false
kubernetes: false
swarm: false
examples: |-
### View network logs

```console
$ docker sandbox network log
```

### Configure proxy for a sandbox

```console
$ docker sandbox network proxy my-sandbox --block-host example.com
```

See the subcommands for more details:
- [`docker sandbox network log`](/reference/cli/docker/sandbox/network/log/) - Show network logs
- [`docker sandbox network proxy`](/reference/cli/docker/sandbox/network/proxy/) - Manage proxy configuration
deprecated: false
hidden: false
experimental: false
Expand Down
Loading