Skip to main content
skill CX Codex

sandbox-next — Claude Code skill: build apps on Cloudflare Sandbox SDK 1.0

Skill for building Cloudflare Sandbox apps on SDK 1.0 preview (@cloudflare/sandbox@next). Gives the agent rules for the new process and terminal APIs.

Apache-2.0 85,100 installs ★ 3,424 updated 2026-10-31

Install into Claude Code · Skills CLI (Vercel) All methods and platforms ↓
npx skills add cloudflare/skills --skill sandbox-next -a claude-code
Open on GitHub

What sandbox-next does

Cloudflare Sandbox runs isolated Linux environments on containers driven from Workers. The SDK 1.0 preview changed how process execution works: sandbox.exec(argv) now returns a handle when the process starts, and you collect results with output(), waitForExit(), waitForPort() methods. There is no implicit shell — shell syntax goes through an explicit shell like ["/bin/bash", "-lc", script]. Each launch is independent: a cd or export in one command is not visible to the next.

The skill checks that the Worker package and container image are on the same @next line (dependency shows @next, Dockerfile uses cloudflare/sandbox:next). If it finds the stable package without @next, it stops and asks to load sandbox-stable. Migrating from stable to preview requires a separate skill, sandbox-migrate-to-next. Before writing code, the agent opens the relevant doc page for the task — process handling, PTY terminals, interpreters, error handling, files and mounts.

What it helps with

  • build a Worker for Cloudflare Sandbox on SDK 1.0 preview
  • run a process in a container and wait for it to finish
  • open a PTY terminal in the browser from a Workers app
  • verify that dependency and image are on the same @next line
  • get stdout and exitCode of a command through the process handle

Example prompts for the agent

  • Create a Worker that runs python3 script.py in Sandbox on @next and returns stdout
  • Add the sandbox-next skill for Claude Code
  • Check that package.json and Dockerfile are on the same @next line

How to install sandbox-next

1Skills CLI (Vercel)

npx skills add cloudflare/skills --skill sandbox-next -a claude-code

2Manually: put the files in place

~/.claude/skills/sandbox-next/SKILL.md

Copy the whole skill folder; for one project use .claude/skills/sandbox-next/

Step by step, with commands for each platform: How to install skills in Claude Code: five ways

Questions about sandbox-next

How do I install sandbox-next in Claude Code?

Run npx skills add cloudflare/skills --skill sandbox-next -a claude-code, then the skill will be in ~/.claude/skills/sandbox-next/SKILL.md.

What does sandbox-next do?

It gives the agent rules for working with Cloudflare Sandbox SDK 1.0 preview: checks package and image versions, opens the right doc page for the task, prevents using stable-version APIs.

How does SDK 1.0 preview differ from the stable version?

exec returns a handle when the process starts, not a finished result. You collect the result with output(), waitForExit(), waitForPort() methods. No implicit shell and no stdin on processes. Interactive work requires terminals via createTerminal.

Source text

SKILL.md · Apache-2.0
---
name: sandbox-next
description: Build or maintain Cloudflare Sandbox apps on @cloudflare/sandbox@next (SDK 1.0 preview). Use sandbox-migrate-to-next when porting a stable app.
---

# Sandbox SDK — `@next` (1.0 preview)

Isolated Linux environments on [Cloudflare Containers](https://developers.cloudflare.com/containers/index.md), driven from Workers.

**Prefer preview docs and installed `@next` types over memory.** APIs change; this skill is a gate, a contract, and a retrieval map—not a full manual.

We recommend **new projects** on this line. Apps still on the default package use **`sandbox-stable`**. Port only when asked, via **`sandbox-migrate-to-next`**.

## 1. Gate — confirm the package line

Before writing code, inspect the app:

| Check | Must match |
| ----- | ---------- |
| npm dependency | `@cloudflare/sandbox@next` (or another preview tag) |
| Container image | Same line (e.g. `cloudflare/sandbox:next`, `next-python`) |

| If you find… | Action |
| ------------ | ------ |
| Default `@cloudflare/sandbox` (no `@next`) | **Stop.** Load **`sandbox-stable`**. Do not apply this skill’s APIs. |
| User wants to port stable → `@next` | **Stop.** Load **`sandbox-migrate-to-next`**. |
| Self-deployed **bridge** only | Bridge is **not** on the 1.0 preview line yet. Keep bridge on stable package + image. [Bridge (stable)](https://developers.cloudflare.com/sandbox/sdk/bridge/index.md) |

Never mix an `@next` Worker package with a stable container image (or the reverse).

Skills install: [Agent setup](https://developers.cloudflare.com/agent-setup/index.md) · [cloudflare/skills](https://github.com/cloudflare/skills)

## 2. Contract — non-negotiables

- `sandbox.exec(argv)` takes an **argv** list and resolves when the process **starts**. It returns a **handle**, not a finished command result.
- Collect results with handle methods: `output()`, `logs()`, `waitForExit()`, `waitForPort()`, `waitForLog()`, `kill(signal?)`.
- No implicit shell. Shell syntax needs an explicit shell, e.g. `["/bin/bash", "-lc", script]`.
- Each launch is independent. A `cd` / `export` in one `exec` is not visible to the next. Pass `cwd` and `env` per launch, or one shell script.
- Process handles have **no stdin**. Interactive use → terminals (`createTerminal` + `connect`).
- Local wait `timeout` / `AbortSignal` cancel the **wait only**. They do not kill the process. Use `kill` or `exec`’s remote `timeout`.
- `getProcess` / `listProcesses` / `getTerminal` / `listTerminals` do **not** start a container; they return `null` / `[]` when none is up.
- Process and terminal IDs belong to the **current container**, not forever to a sandbox ID. For work that must survive replace, store the full job (argv, cwd, env, app state)—not only an id.
- Non-secret config only in `setEnvVars` / launch `env`. Live credentials stay in the Worker; use outbound handlers when the sandbox calls external APIs.
- Do **not** invent removed stable APIs (`gitCheckout` on core, string-`exec` completion, session execution, `sandbox.terminal(request)`).
- Do **not** use one retry loop for every error (see Errors docs).

Minimal shape:

```ts
import { getSandbox, proxyToSandbox, Sandbox } from "@cloudflare/sandbox";

export { Sandbox };

const sandbox = getSandbox(env.Sandbox, "user-123");
const process = await sandbox.exec(["python3", "-c", "print(2 + 2)"]);
const result = await process.output({ encoding: "utf8" });
// result.stdout, result.exitCode
```

Task-specific API documentation: [references/api-quick-ref.md](references/api-quick-ref.md)

Examples index (`next` branch): [references/examples.md](references/examples.md)

## 3. Retrieve — open the doc for the task

Fetch the page before implementing. Installed `@next` types win over guesses.

| You need to… | Open |
| ------------ | ---- |
| Orient / choose preview | [1.0 preview overview](https://developers.cloudflare.com/sandbox/index.md) |
| First Worker, wrangler, Dockerfile | [Get started](https://developers.cloudflare.com/sandbox/index.md) |
| `exec`, handles, readiness, durability | [Process execution](https://developers.cloudflare.com/sandbox/index.md) |
| Process API signatures | [Processes API](https://developers.cloudflare.com/sandbox/index.md) |
| Sandbox ID vs container vs sleep/destroy | [Lifecycle](https://developers.cloudflare.com/sandbox/index.md) |
| `cwd` / `env` / `setEnvVars` | [Environment](https://developers.cloudflare.com/sandbox/index.md) |
| Interactive PTY / browser terminal | [Terminals](https://developers.cloudflare.com/sandbox/index.md) · [Terminals API](https://developers.cloudflare.com/sandbox/index.md) |
| Python/JS code interpreter | [Interpreter](https://developers.cloudflare.com/sandbox/index.md) · [Interpreter API](https://developers.cloudflare.com/sandbox/index.md) |
| Extensions model | [Extensions](https://developers.cloudflare.com/sandbox/index.md) |
| Error classes and recovery | [Errors](https://developers.cloudflare.com/sandbox/index.md) · [Errors API](https://developers.cloudflare.com/sandbox/index.md) |
| Common failures | [Troubleshooting](https://developers.cloudflare.com/sandbox/index.md) |
| API hub | [API reference](https://developers.cloudflare.com/sandbox/index.md) |
| Files, mounts, backups, ports, tunnels, `proxyToSandbox` | Main docs for shared surfaces (ignore stable-only session/transport/`sandbox.terminal`): [Files](https://developers.cloudflare.com/sandbox/sdk/api/files/index.md) · [Storage / mounts](https://developers.cloudflare.com/sandbox/sdk/api/storage/index.md) · [Ports](https://developers.cloudflare.com/sandbox/sdk/api/ports/index.md) · [Tunnels](https://developers.cloudflare.com/sandbox/sdk/api/tunnels/index.md) · [Backups](https://developers.cloudflare.com/sandbox/sdk/api/backups/index.md) · [Outbound traffic](https://developers.cloudflare.com/sandbox/sdk/guides/outbound-traffic/index.md) · [Expose services](https://developers.cloudflare.com/sandbox/sdk/guides/expose-services/index.md) · [Production](https://developers.cloudflare.com/sandbox/sdk/guides/preview-urls-custom-domain/index.md) |
| Example apps | [examples on `next`](https://github.com/cloudflare/sandbox-sdk/tree/next/examples) |
| Still on stable package | **`sandbox-stable`** · [Main Sandbox docs](https://developers.cloudflare.com/sandbox/index.md) |
| Porting an existing stable app | **`sandbox-migrate-to-next`** · [Migrate](https://developers.cloudflare.com/sandbox/sdk/migrate/index.md) |

## 4. Before you ship

- Lockfile and Dockerfile on the **same** `@next` line  
- Typecheck against installed `@next` types  
- No live secrets in sandbox env  
- Production preview hostnames need wildcard DNS on a custom domain when using those URL patterns  

## Skill feedback

If the user reports that this skill gave incorrect or outdated guidance, or is missing information, read [references/skill-feedback.md](references/skill-feedback.md).

© cloudflare · Apache-2.0 · cloudflare/skills

Similar skills

All skills for Agent setup: memory, context, orchestration →

From the same set23

The whole set →
cloudflare-one A skill for Claude Code, Codex, Cursor and other agents: designs, configures and troubleshoots Cloudflare One Zero Trust and SASE. Kicks in when a script or non-browser client hits a Cloudflare Access login wall instead of an API response. CX Codex +1 111,600installs turnstile-spin turnstile-spin sets up Cloudflare Turnstile bot verification across existing frontend and backend code, including widget embedding and server-side siteverify. CX Codex +1 110,900installs cloudflare-one-migrations cloudflare-one-migrations plans a migration from VPN, SWG or SASE to Cloudflare One: maps policies to Cloudflare resources, flags parity gaps and stages the rollout. CX Codex +1 107,100installs sandbox-stable The sandbox-stable skill helps build and maintain Cloudflare Sandbox apps on the stable @cloudflare/sandbox package. Use it when Workers need isolated Linux environments. CX Codex +1 85,900installs sandbox-migrate-to-next sandbox-migrate-to-next is a Claude Code skill that guides Cloudflare Sandbox apps from the stable package to @cloudflare/sandbox@next (SDK 1.0), preparing code for the future stable release. CX Codex +1 85,000installs nextjs-on-cloudflare nextjs-on-cloudflare — a skill for deploying Next.js apps to Cloudflare Workers via vinext. Use for new projects, migrating existing apps, or choosing between vinext and OpenNext. CX Codex +1 60,100installs k2 k2 is a Claude Code skill for setting up and troubleshooting Cloudflare K2 and K2 Streams. It covers stream creation, event production, retention settings, and subscription-based consumption. CX Codex +1 37,900installs basin Skill for building and troubleshooting Cloudflare Basin analytics. Stream data into R2 Iceberg tables, manage catalogs, and run distributed SQL queries from your IDE. CX Codex +1 37,800installs

Project sponsors

Companies that keep this analytics open