# Sandbox SDK

> One TypeScript API for agent sandboxes. Files, commands, ports, snapshots, and a typed escape hatch across supported providers.

Swap one adapter import to target a provider and keep the rest of your agent loop the same. Each page below is plain markdown.

## Docs

- [Why a contract](https://sandbox-sdk.sh/why.md): the problem one small API across providers solves
- [Installation](https://sandbox-sdk.sh/installation.md): install core plus the adapter you run against
- [Quick start](https://sandbox-sdk.sh/quick-start.md): withSandbox gives a typed sandbox with safe cleanup
- [Adapters](https://sandbox-sdk.sh/adapters.md): the eight providers and how to configure each
- [Capabilities](https://sandbox-sdk.sh/capabilities.md): branch on normalized support instead of guessing
- [Files](https://sandbox-sdk.sh/files.md): read, stream, write, list, and remove
- [Processes](https://sandbox-sdk.sh/processes.md): one-shot exec and shell, plus streaming spawn handles
- [Ports](https://sandbox-sdk.sh/ports.md): expose a sandbox port and make provider-aware preview requests
- [Snapshots](https://sandbox-sdk.sh/snapshots.md): capability-gated state capture and restore
- [The Sandbox type](https://sandbox-sdk.sh/sandbox-type.md): the shape every adapter returns
- [Adapter authoring](https://sandbox-sdk.sh/adapter-authoring.md): build a stream-first, capability-honest provider adapter
- [Errors](https://sandbox-sdk.sh/errors.md): one SandboxError with a normalized code
- [Raw escape hatch](https://sandbox-sdk.sh/escape-hatch.md): drop down to the native provider client
- [AI tools](https://sandbox-sdk.sh/ai-tools.md): wrap a sandbox into agent framework tools
- [Verification](https://sandbox-sdk.sh/verification.md): every adapter is verified against the live provider
- [API reference](https://sandbox-sdk.sh/api.md): the full public surface and where to find every type

## Full

- [Complete documentation](https://sandbox-sdk.sh/llms-full.txt): every page concatenated into one file

## Links

- [Website](https://sandbox-sdk.sh)
- [GitHub](https://github.com/dancer/sandbox)