Skip to content

Commit dd55b66

Browse files
dvdksnclaude
andcommitted
docs: rename the agent kit kind to sandbox
Rename the spec.yaml kind: agent value to kind: sandbox and the "agent kit" concept to "sandbox kit" across the overview, spec reference, examples, index, and FAQ. Update the "Agent kits" heading and its #agent-kits anchor to "Sandbox kits"/#sandbox-kits, and repoint inbound links. The agent: block and the build-an-agent.md tutorial keep their existing names. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent 87168bd commit dd55b66

6 files changed

Lines changed: 35 additions & 35 deletions

File tree

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -40,12 +40,12 @@ dependencies — anything you'd rather not reinstall on every sandbox start.
4040

4141
A kit is a YAML artifact applied at sandbox creation. The kit can run
4242
install commands, drop files into the sandbox, declare network and
43-
credential rules, and (for agent kits) define which template image the
43+
credential rules, and (for sandbox kits) define which template image the
4444
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. An agent kit's `agent.image` field
48+
Templates and kits work together. A sandbox kit's `agent.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
@@ -58,7 +58,7 @@ each time something changes.
5858
| Pre-install tools and packages into a reusable base image | [Template](templates.md) |
5959
| Capture a configured running sandbox for reuse | [Saved template](templates.md#saving-a-sandbox-as-a-template) |
6060
| Add a tool, credential, or config to agent runs via YAML | [Kit (mixin)](kits.md) |
61-
| Define a new agent from scratch | [Kit (agent)](kits.md#define-an-agent) |
61+
| Define a new agent from scratch | [Kit (sandbox)](kits.md#define-an-agent) |
6262

6363
Templates and kits can be used together. A template bakes heavy tools into
6464
the image for fast sandbox startup; a kit layered on top adds per-run
@@ -67,4 +67,4 @@ credentials, config, or extra capabilities.
6767
## Tutorials
6868

6969
- [Build your own agent kit](build-an-agent.md) — step-by-step walkthrough
70-
for packaging [Amp](https://ampcode.com/) as an agent kit.
70+
for packaging [Amp](https://ampcode.com/) as a sandbox kit.

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ attaches.
7272

7373
```yaml {title="amp/spec.yaml"}
7474
schemaVersion: "1"
75-
kind: agent
75+
kind: sandbox
7676
name: amp
7777
displayName: Amp
7878
description: The frontier coding agent.
@@ -176,7 +176,7 @@ Putting it all together:
176176

177177
```yaml {title="amp/spec.yaml"}
178178
schemaVersion: "1"
179-
kind: agent
179+
kind: sandbox
180180
name: amp
181181
displayName: Amp
182182
description: The frontier coding agent.

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Kit examples
33
linkTitle: Examples
4-
description: Copy-and-adapt spec.yaml snippets for common mixin and agent kit patterns — static files, install commands, background services, initFiles, Claude Code skills, and agent forks.
4+
description: Copy-and-adapt spec.yaml snippets for common mixin and sandbox kit patterns — static files, install commands, background services, initFiles, Claude Code skills, and agent forks.
55
keywords: sandboxes, sbx, kits, mixins, examples, patterns, skills
66
weight: 25
77
---
@@ -253,15 +253,15 @@ idempotent. The heredoc pattern overwrites cleanly each time.
253253
254254
## Fork an existing agent
255255
256-
Agent kits (`kind: agent`) define a full agent from scratch. The most
256+
Sandbox kits (`kind: sandbox`) define a full agent from scratch. The most
257257
common variant is a fork of a built-in agent — same image and
258258
credentials, but a different entrypoint. This example reproduces the
259259
built-in `claude` agent but drops `--dangerously-skip-permissions` so
260260
every tool call prompts for approval:
261261

262262
```yaml {title="claude-safe/spec.yaml"}
263263
schemaVersion: "1"
264-
kind: agent
264+
kind: sandbox
265265
name: claude-safe
266266
displayName: Claude Code (with approval prompts)
267267
description: Claude Code without --dangerously-skip-permissions
@@ -296,7 +296,7 @@ Launch with the kit's `name:` as the agent argument to `sbx run`:
296296
$ sbx run claude-safe --kit ./claude-safe
297297
```
298298

299-
For a step-by-step walkthrough of building a new agent kit from
299+
For a step-by-step walkthrough of building a new sandbox kit from
300300
scratch, see [Build an agent](build-an-agent.md).
301301

302302
## More examples

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

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -31,21 +31,21 @@ my-kit/
3131

3232
```yaml
3333
schemaVersion: "1"
34-
kind: <mixin | agent>
34+
kind: <mixin | sandbox>
3535
name: <name>
3636
displayName: <name>
3737
description: <text>
3838
```
3939
40-
| Field | Required | Description |
41-
| --------------- | -------- | ------------------------------------------------------------------------ |
42-
| `schemaVersion` | Yes | Spec schema version. Set to `"1"`. |
43-
| `kind` | Yes | `mixin` for kits that extend an agent; `agent` for kits that define one. |
44-
| `name` | Yes | Unique identifier. Lowercase, alphanumeric, hyphens. |
45-
| `displayName` | No | Human-readable name. |
46-
| `description` | No | Short description. |
40+
| Field | Required | Description |
41+
| --------------- | -------- | -------------------------------------------------------------------------- |
42+
| `schemaVersion` | Yes | Spec schema version. Set to `"1"`. |
43+
| `kind` | Yes | `mixin` for kits that extend an agent; `sandbox` for kits that define one. |
44+
| `name` | Yes | Unique identifier. Lowercase, alphanumeric, hyphens. |
45+
| `displayName` | No | Human-readable name. |
46+
| `description` | No | Short description. |
4747

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

5151
## Credentials
@@ -271,11 +271,11 @@ agentContext: |
271271
<markdown>
272272
```
273273

274-
Top-level field. Available in both mixin and agent kits. Markdown
274+
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-
agent kit sets [`agent.aiFilename`](#agent-block).
278+
sandbox kit sets [`agent.aiFilename`](#agent-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
@@ -295,7 +295,7 @@ across files instead of being concatenated into the main one:
295295

296296
## Agent block
297297

298-
Required for `kind: agent`.
298+
Required for `kind: sandbox`.
299299

300300
```yaml
301301
agent:

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

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -29,11 +29,11 @@ and enforces them at runtime. Credentials stay on the host and go through
2929
a proxy instead of entering the VM, and outbound traffic is restricted to
3030
the domains permitted by the kit's network rules.
3131

32-
A kit is either a mixin or an agent:
32+
A kit is either a mixin or a sandbox:
3333

3434
- Mixin kits (`kind: mixin`) extend an existing agent with extra
3535
capabilities. Stack several on the same sandbox.
36-
- Agent kits (`kind: agent`) define a full agent from scratch: its image,
36+
- Sandbox kits (`kind: sandbox`) define a full agent from scratch: its image,
3737
entrypoint, network policies, and everything else the agent needs.
3838

3939
## What kits can do
@@ -208,8 +208,8 @@ agentContext: |
208208
Shared config lives at `/workspace/ruff.toml`.
209209
```
210210

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

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

232232
### Define an agent
233233

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

237237
```yaml
@@ -241,7 +241,7 @@ agent:
241241
run: [my-agent, "--yolo"]
242242
```
243243
244-
See [Agent kits](#agent-kits) for use cases and an example.
244+
See [Sandbox kits](#sandbox-kits) for use cases and an example.
245245
246246
## Mixin kits
247247
@@ -307,17 +307,17 @@ To apply the mixin to a sandbox that's already running, use
307307
[`sbx kit add`](#local) instead. The `--kit` flag only takes effect when a
308308
sandbox is created.
309309

310-
## Agent kits
310+
## Sandbox kits
311311

312-
An agent kit defines a full agent from scratch — image, entrypoint, and
312+
A sandbox kit defines a full agent from scratch — image, entrypoint, and
313313
everything the agent needs. Common use cases:
314314

315315
- Package a custom agent you've built so others can run it
316316
- Ship a team-internal agent with defaults baked in
317317
- Run a fork of an existing agent with your own config
318318
- Prototype a new agent integration
319319

320-
Agent kits declare everything a mixin kit can, plus an
320+
Sandbox kits declare everything a mixin kit can, plus an
321321
[`agent:` block](kit-reference.md#agent-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).
@@ -330,7 +330,7 @@ with network, credentials, environment, and commands:
330330

331331
```yaml {title="claude/spec.yaml"}
332332
schemaVersion: "1"
333-
kind: agent
333+
kind: sandbox
334334
name: claude
335335
agent:
336336
image: "docker/sandbox-templates:claude-code-docker"

content/manuals/ai/sandboxes/faq.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -111,13 +111,13 @@ startup. In Claude Code, use the `/permissions` command to change the mode
111111
interactively.
112112

113113
To make approval prompts the default for every session, define a custom
114-
agent kit that overrides the agent's entrypoint to drop the
114+
sandbox kit that overrides the agent's entrypoint to drop the
115115
permission-skipping flag. For example, a kit that launches Claude Code
116116
without `--dangerously-skip-permissions`:
117117

118118
```yaml {title="claude-safe/spec.yaml"}
119119
schemaVersion: "1"
120-
kind: agent
120+
kind: sandbox
121121
name: claude-safe
122122
agent:
123123
image: "docker/sandbox-templates:claude-code-docker"
@@ -126,7 +126,7 @@ agent:
126126
```
127127
128128
Run it with `sbx run claude-safe --kit ./claude-safe/`. See
129-
[Agent kits](customize/kits.md#agent-kits) for the full pattern.
129+
[Sandbox kits](customize/kits.md#sandbox-kits) for the full pattern.
130130

131131
## How do I know if my agent is running in a sandbox?
132132

0 commit comments

Comments
 (0)