Skip to content

Commit 2167dc4

Browse files
dvdksnclaude
andcommitted
docs: rename the agent kit block to sandbox
Rename the spec.yaml agent: block to sandbox: and its field paths (agent.image, agent.aiFilename, agent.entrypoint) to sandbox.*. Update the "Agent block" reference heading and its #agent-block anchor to "Sandbox block"/#sandbox-block, repoint cross-links, and rename the tutorial's "Write the agent block" section. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent dd55b66 commit 2167dc4

6 files changed

Lines changed: 26 additions & 26 deletions

File tree

content/manuals/ai/sandboxes/customize/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ agent runs in. Use kits for things that vary per agent or per team:
4545
shared linter config, project-specific install steps, credential
4646
injection for a service the agent talks to.
4747

48-
Templates and kits work together. A sandbox kit's `agent.image` field
48+
Templates and kits work together. A sandbox kit's `sandbox.image` field
4949
points at a template: the template provides the base environment, the
5050
kit layers config, secrets, and runtime behavior on top. A team can ship
5151
one heavy template and several thin kits without rebuilding the image

content/manuals/ai/sandboxes/customize/build-an-agent.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -65,9 +65,9 @@ substitutes the real key on outbound requests to the API host, so the
6565
secret never enters the sandbox. A later section walks through the
6666
specific command for storing the key.
6767

68-
## Write the agent block
68+
## Write the sandbox block
6969

70-
The `agent:` block tells the sandbox how to launch Amp when the user
70+
The `sandbox:` block tells the sandbox how to launch Amp when the user
7171
attaches.
7272

7373
```yaml {title="amp/spec.yaml"}
@@ -77,7 +77,7 @@ name: amp
7777
displayName: Amp
7878
description: The frontier coding agent.
7979

80-
agent:
80+
sandbox:
8181
image: "docker/sandbox-templates:shell-docker"
8282
aiFilename: AGENTS.md
8383
entrypoint:
@@ -181,7 +181,7 @@ name: amp
181181
displayName: Amp
182182
description: The frontier coding agent.
183183

184-
agent:
184+
sandbox:
185185
image: "docker/sandbox-templates:shell-docker"
186186
aiFilename: AGENTS.md
187187
entrypoint:

content/manuals/ai/sandboxes/customize/kit-examples.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -266,7 +266,7 @@ name: claude-safe
266266
displayName: Claude Code (with approval prompts)
267267
description: Claude Code without --dangerously-skip-permissions
268268
269-
agent:
269+
sandbox:
270270
image: "docker/sandbox-templates:claude-code-docker"
271271
aiFilename: CLAUDE.md
272272
entrypoint:

content/manuals/ai/sandboxes/customize/kit-reference.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Kit spec reference
33
linkTitle: Spec reference
4-
description: Field-by-field reference for a kit's spec.yaml — credentials, network rules, environment, commands, files, agent context, and the agent block.
4+
description: Field-by-field reference for a kit's spec.yaml — credentials, network rules, environment, commands, files, agent context, and the sandbox block.
55
keywords: sandboxes, sbx, kits, spec.yaml, reference, schema, fields
66
weight: 22
77
---
@@ -45,8 +45,8 @@ description: <text>
4545
| `displayName` | No | Human-readable name. |
4646
| `description` | No | Short description. |
4747

48-
The sections below apply to both kinds. Sandbox kits also declare an
49-
[`agent:` block](#agent-block).
48+
The sections below apply to both kinds. Sandbox kits also declare a
49+
[`sandbox:` block](#sandbox-block).
5050

5151
## Credentials
5252

@@ -275,7 +275,7 @@ Top-level field. Available in both mixin and sandbox kits. Markdown
275275
appended to the agent's memory file at sandbox creation. The agent reads
276276
this content at startup. Write it as instructions or notes the agent
277277
should follow when working in the sandbox. Applied only when the active
278-
sandbox kit sets [`agent.aiFilename`](#agent-block).
278+
sandbox kit sets [`sandbox.aiFilename`](#sandbox-block).
279279

280280
The file is written to the parent of the workspace path inside the
281281
sandbox, not to the workspace itself. For a workspace mounted at
@@ -293,25 +293,25 @@ across files instead of being concatenated into the main one:
293293
`<!-- sbx:kits-section start -->` and `<!-- sbx:kits-section end -->`
294294
markers so it can be regenerated when kits are added or removed.
295295

296-
## Agent block
296+
## Sandbox block
297297

298298
Required for `kind: sandbox`.
299299

300300
```yaml
301-
agent:
301+
sandbox:
302302
image: <image-ref>
303303
aiFilename: <filename>
304304
entrypoint:
305305
run: [<argv>, ...]
306306
args: [<arg>, ...]
307307
```
308308

309-
| Field | Required | Description |
310-
| ----------------------- | -------- | ----------------------------------------------------------------------------------------------------------- |
311-
| `agent.image` | Yes | Docker image reference. See [Base image requirements](#base-image-requirements). |
312-
| `agent.aiFilename` | No | Memory filename (for example, `AGENTS.md`). Appends top-level [`agentContext`](#agent-context) at creation. |
313-
| `agent.entrypoint.run` | No | Command and args as a string array. Replaces the image's entrypoint. |
314-
| `agent.entrypoint.args` | No | Args appended to the image's existing entrypoint. |
309+
| Field | Required | Description |
310+
| ------------------------- | -------- | ----------------------------------------------------------------------------------------------------------- |
311+
| `sandbox.image` | Yes | Docker image reference. See [Base image requirements](#base-image-requirements). |
312+
| `sandbox.aiFilename` | No | Memory filename (for example, `AGENTS.md`). Appends top-level [`agentContext`](#agent-context) at creation. |
313+
| `sandbox.entrypoint.run` | No | Command and args as a string array. Replaces the image's entrypoint. |
314+
| `sandbox.entrypoint.args` | No | Args appended to the image's existing entrypoint. |
315315

316316
### Base image requirements
317317

content/manuals/ai/sandboxes/customize/kits.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -209,7 +209,7 @@ agentContext: |
209209
```
210210

211211
Both mixin and sandbox kits can declare `agentContext:`. The content is written
212-
only when the active sandbox kit sets [`agent.aiFilename`](kit-reference.md#agent-block),
212+
only when the active sandbox kit sets [`sandbox.aiFilename`](kit-reference.md#sandbox-block),
213213
which determines the memory file's name.
214214

215215
When more than one loaded kit declares an `agentContext:` block, each kit's
@@ -231,11 +231,11 @@ See [`agentContext`](kit-reference.md#agent-context) in the spec reference for t
231231

232232
### Define an agent
233233

234-
Sandbox kits declare an `agent:` block with the image the agent runs in and
234+
Sandbox kits declare a `sandbox:` block with the image the agent runs in and
235235
the command the user attaches to when they launch the sandbox:
236236

237237
```yaml
238-
agent:
238+
sandbox:
239239
image: "my-registry/my-agent:latest"
240240
entrypoint:
241241
run: [my-agent, "--yolo"]
@@ -318,21 +318,21 @@ everything the agent needs. Common use cases:
318318
- Prototype a new agent integration
319319

320320
Sandbox kits declare everything a mixin kit can, plus an
321-
[`agent:` block](kit-reference.md#agent-block) that tells the sandbox how to launch the
321+
[`sandbox:` block](kit-reference.md#sandbox-block) that tells the sandbox how to launch the
322322
agent. For a step-by-step walkthrough, see
323323
[Build your own agent kit](build-an-agent.md).
324324

325325
### Example: the built-in `claude` agent
326326

327327
The `claude` agent you get from `sbx run claude` is defined as a kit. Here
328-
is an abbreviated version of its spec, showing how the agent block combines
328+
is an abbreviated version of its spec, showing how the sandbox block combines
329329
with network, credentials, environment, and commands:
330330

331331
```yaml {title="claude/spec.yaml"}
332332
schemaVersion: "1"
333333
kind: sandbox
334334
name: claude
335-
agent:
335+
sandbox:
336336
image: "docker/sandbox-templates:claude-code-docker"
337337
aiFilename: CLAUDE.md
338338
entrypoint:
@@ -460,7 +460,7 @@ Docker credential store, so pushing to a private registry requires a prior
460460

461461
For a field-by-field reference of every `spec.yaml` block — top-level
462462
fields, credentials, network, environment, commands, static files,
463-
agent context, and the agent block — see [Kit spec reference](kit-reference.md).
463+
agent context, and the sandbox block — see [Kit spec reference](kit-reference.md).
464464

465465
## Debugging
466466

content/manuals/ai/sandboxes/faq.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ without `--dangerously-skip-permissions`:
119119
schemaVersion: "1"
120120
kind: sandbox
121121
name: claude-safe
122-
agent:
122+
sandbox:
123123
image: "docker/sandbox-templates:claude-code-docker"
124124
entrypoint:
125125
run: [claude]

0 commit comments

Comments
 (0)