A policy is your guardrail layer: it decides which commands and capabilities the in-sandbox agent may run outright, must ask about first, or can never run. defineSandboxPolicy() describes those rules once, portably, and each provider's harness adapter maps them onto its own native permission system. You attach a policy to a sandbox via defineSandbox({ policy }), where it guards the commands the workspace setup and bridged tools run.
import { defineSandboxPolicy, defineSandbox } from '@tanstack/ai-sandbox'
import { dockerSandbox } from '@tanstack/ai-sandbox-docker'
const policy = defineSandboxPolicy({
commands: {
allow: ['pnpm test', 'pnpm typecheck', 'git diff'],
ask: ['pnpm install', 'curl *'],
deny: ['sudo *', 'rm -rf *'],
},
capabilities: { fileWrite: 'allow', network: 'ask' },
default: 'ask',
})
const sandbox = defineSandbox({
id: 'repo-agent',
provider: dockerSandbox({ image: 'node:22' }),
policy,
})Every command or capability resolves to one of three decisions:
| Decision | Meaning |
|---|---|
| allow | The agent runs it without interruption. |
| ask | The agent pauses; the harness emits an approval request the client answers before the action proceeds. |
| deny | The action is blocked outright. The agent cannot run it. |
commands holds three lists of command patterns: allow, ask and deny. A pattern matches against the command the agent is about to run:
import { defineSandboxPolicy } from '@tanstack/ai-sandbox'
const policy = defineSandboxPolicy({
commands: {
allow: ['pnpm test', 'pnpm typecheck', 'git diff'],
ask: ['pnpm install', 'curl *'],
deny: ['sudo *', 'rm -rf *'],
},
})Patterns support * globs, so you can gate a whole family of commands with one entry. curl * matches any curl invocation; sudo * matches anything run through sudo. An exact string like pnpm test matches only that command. Prefer the named workspace scripts (pnpm test, pnpm build) in your allow list. They give the policy stable names to match rather than freeform shell.
capabilities applies the same allow / ask / deny decisions to coarse-grained abilities rather than individual commands, for example filesystem writes or outbound network access:
import { defineSandboxPolicy } from '@tanstack/ai-sandbox'
const policy = defineSandboxPolicy({
capabilities: {
fileWrite: 'allow', // let the agent edit the working tree freely
network: 'ask', // pause for approval before any outbound request
},
})This is the broad backstop: even if a specific network command isn't in your commands lists, network: 'ask' still forces an approval for anything that reaches out.
Some providers also enforce network at create time when network: 'deny'. See Providers for that mapping.
Most providers leave capabilities.network to the harness. sbxSandbox() also enforces it on the host HTTP/HTTPS proxy (networkPolicy: true).
sbx policy can allow or deny hosts. It has no ask. Deny wins over allow, so network: 'deny' is an allowlist, not a full deny.
| TanStack capabilities.network | What sbxSandbox() writes |
|---|---|
| No policy and no allowNetwork / denyNetwork | If the policy list is empty, sbxSandbox() runs sbx policy init deny-all. A known adapter (grok-build, claude-code, codex) then writes its model API host and localhost as a per-sandbox allow on top of that deny-all. Unknown adapters stay on the machine preset. |
| No policy and allowNetwork | Per-sandbox allow of the model API host (when the adapter is known), localhost, and allowNetwork, then apply denyNetwork. |
| No policy and denyNetwork only | Per-sandbox deny of those hosts. Allow stays empty. No auto hosts and no localhost. This is additive deny on the machine preset. |
| allow | Allow **, then apply denyNetwork. |
| deny | Allow the model API host, localhost, and allowNetwork, then apply denyNetwork. |
| ask (or the policy default when network is unset) | Same allowlist as deny. The harness still asks for tools and commands. |
Auto-allowed model hosts:
If the allowlist would be empty under deny or ask, create throws. Pass allowNetwork, or use grokBuildText / claudeCodeText / codexText.
The guest still dials host.docker.internal for the tool bridge. The sbx proxy rewrites that host to localhost before the policy match. sbxSandbox() adds localhost when it writes a real allowlist. It does not add localhost for denyNetwork only.
import { sbxSandbox } from '@tanstack/ai-sandbox-docker'
import { defineSandbox, defineSandboxPolicy } from '@tanstack/ai-sandbox'
const sandbox = defineSandbox({
id: 'repo-agent',
provider: sbxSandbox({
allowNetwork: ['*.npmjs.org', 'registry.npmjs.org'],
}),
policy: defineSandboxPolicy({
capabilities: { network: 'deny' },
commands: { allow: ['pnpm test'], deny: ['sudo *'] },
}),
})Command rules and fileWrite stay with the harness. sbx does not see command lines.
When more than one rule could match an action, the strictest wins. The order is deny > ask > allow:
import { defineSandboxPolicy } from '@tanstack/ai-sandbox'
const policy = defineSandboxPolicy({
commands: {
// `curl` is allowed broadly…
allow: ['curl *'],
// …but `deny` wins, so this specific host is always blocked.
deny: ['curl * internal.example.com*'],
},
default: 'deny',
})This means you can paint with a broad allow and carve exceptions out with narrower ask / deny patterns, confident the exceptions take priority.
default is the decision for anything none of your rules match. Set it to the posture you want at the edges:
When omitted, treat the default as ask so unforeseen actions surface rather than silently running.
An ask decision is not a guess the SDK makes, it's a question routed back to you. When the agent attempts an ask-gated action, the harness pauses it and emits an approval request into the run stream. Your client answers that request (approve or reject), and the harness either lets the action proceed or blocks it based on the answer. Until the client responds, the action is held.
This is why ask is the right choice for actions that are usually fine but occasionally dangerous (pnpm install pulling a new dependency, an outbound curl): the human stays in the loop without you having to enumerate every safe command up front.
A policy is portable. Each harness adapter translates the same allow / ask / deny description into its own native permission system:
Where a harness can't express a particular rule, it degrades rather than failing the run, the unsupported rule is skipped (with a warning) instead of throwing. Because the mapping is the adapter's job, you write the policy once and it behaves consistently no matter which provider or harness runs the sandbox.
A deny-only list with default: 'allow' stays permissive on Grok Build and Codex. Those harnesses keep auto-approve. They do not enforce commands.deny. Isolation is the outer sandbox. Use Claude Code when you need command-level deny.
Some providers run as a non-root user, so package installs in setup need sudo. Do not deny sudo * on those providers. See Providers for the list, and Workspace for how to write setup commands.
A policy does nothing on its own, it takes effect when you attach it to a sandbox. Pass it as policy on defineSandbox; from there it guards every run that uses that sandbox, including the workspace setup commands and any host tools bridged into the agent.
import { defineSandboxPolicy, defineSandbox, defineWorkspace, githubRepo } from '@tanstack/ai-sandbox'
import { dockerSandbox } from '@tanstack/ai-sandbox-docker'
const policy = defineSandboxPolicy({
commands: {
allow: ['pnpm test', 'pnpm typecheck', 'git diff'],
ask: ['pnpm install', 'curl *'],
deny: ['sudo *', 'rm -rf *'],
},
capabilities: { fileWrite: 'allow', network: 'ask' },
default: 'ask',
})
const sandbox = defineSandbox({
id: 'repo-agent',
provider: dockerSandbox({ image: 'node:22' }),
workspace: defineWorkspace({
source: githubRepo({ repo: 'owner/app' }),
setup: ['corepack enable', 'pnpm install'],
}),
policy,
})