mirror of
https://github.com/harivansh-afk/sandbox-agent.git
synced 2026-04-15 04:03:31 +00:00
* SDK sandbox provisioning: built-in providers, docs restructure, and quickstart overhaul - Add built-in sandbox providers (local, docker, e2b, daytona, vercel, cloudflare) to the TypeScript SDK so users import directly instead of passing client instances - Restructure docs: rename architecture to orchestration-architecture, add new architecture page for server overview, improve getting started flow - Rewrite quickstart to be TypeScript-first with provider CodeGroup and custom provider accordion - Update all examples to use new provider APIs - Update persist drivers and foundry for new SDK surface Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * Fix SDK typecheck errors and update persist drivers for insertEvent signature - Fix insertEvent call in client.ts to pass sessionId as first argument - Update Daytona provider create options to use Partial type (image has default) - Update StrictUniqueSessionPersistDriver in tests to match new insertEvent signature - Sync persist packages, openapi spec, and docs with upstream changes Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * Add Modal and ComputeSDK built-in providers, update examples and docs - Add `sandbox-agent/modal` provider using Modal SDK with node:22-slim image - Add `sandbox-agent/computesdk` provider using ComputeSDK's unified sandbox API - Update Modal and ComputeSDK examples to use new SDK providers - Update Modal and ComputeSDK deploy docs with provider-based examples - Add Modal to quickstart CodeGroup and docs.json navigation - Add provider test entries for Modal and ComputeSDK - Remove old standalone example files (modal.ts, computesdk.ts) Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * Fix Modal provider: pre-install agents in image, fire-and-forget exec for server - Pre-install agents in Dockerfile commands so they are cached across creates - Use fire-and-forget exec (no wait) to keep server alive in Modal sandbox - Add memoryMiB option (default 2GB) to avoid OOM during agent install Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * Sync upstream changes: multiplayer docs, logos, openapi spec, foundry config Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * SDK: Add ensureServer() for automatic server recovery Add ensureServer() to SandboxProvider interface to handle cases where the sandbox-agent server stops or goes to sleep. The SDK now calls this method after 3 consecutive health-check failures, allowing providers to restart the server if needed. Most built-in providers (E2B, Daytona, Vercel, Modal, ComputeSDK) implement this. Docker and Cloudflare manage server lifecycle differently, and Local uses managed child processes. Also update docs for quickstart, architecture, multiplayer, and session persistence; mark persist-* packages as deprecated; and add ensureServer implementations to all applicable providers. Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com> * wip --------- Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
87 lines
2.3 KiB
Text
87 lines
2.3 KiB
Text
---
|
|
title: "Docker"
|
|
description: "Build and run Sandbox Agent in a Docker container."
|
|
---
|
|
|
|
<Warning>
|
|
Docker is not recommended for production isolation of untrusted workloads. Use dedicated sandbox providers (E2B, Daytona, etc.) for stronger isolation.
|
|
</Warning>
|
|
|
|
## Quick start
|
|
|
|
Run the published full image with all supported agents pre-installed:
|
|
|
|
```bash
|
|
docker run --rm -p 3000:3000 \
|
|
-e ANTHROPIC_API_KEY="$ANTHROPIC_API_KEY" \
|
|
-e OPENAI_API_KEY="$OPENAI_API_KEY" \
|
|
rivetdev/sandbox-agent:0.3.2-full \
|
|
server --no-token --host 0.0.0.0 --port 3000
|
|
```
|
|
|
|
The `0.3.2-full` tag pins the exact version. The moving `full` tag is also published for contributors who want the latest full image.
|
|
|
|
## TypeScript with the Docker provider
|
|
|
|
```bash
|
|
npm install sandbox-agent@0.3.x dockerode get-port
|
|
```
|
|
|
|
```typescript
|
|
import { SandboxAgent } from "sandbox-agent";
|
|
import { docker } from "sandbox-agent/docker";
|
|
|
|
const sdk = await SandboxAgent.start({
|
|
sandbox: docker({
|
|
env: [
|
|
`ANTHROPIC_API_KEY=${process.env.ANTHROPIC_API_KEY}`,
|
|
`OPENAI_API_KEY=${process.env.OPENAI_API_KEY}`,
|
|
].filter(Boolean),
|
|
}),
|
|
});
|
|
|
|
try {
|
|
const session = await sdk.createSession({ agent: "codex" });
|
|
await session.prompt([{ type: "text", text: "Summarize this repository." }]);
|
|
} finally {
|
|
await sdk.destroySandbox();
|
|
}
|
|
```
|
|
|
|
The `docker` provider uses the `rivetdev/sandbox-agent:0.3.2-full` image by default. Override with `image`:
|
|
|
|
```typescript
|
|
docker({ image: "my-custom-image:latest" })
|
|
```
|
|
|
|
## Building a custom image with everything preinstalled
|
|
|
|
If you need to extend your own base image, install Sandbox Agent and preinstall every supported agent in one step:
|
|
|
|
```dockerfile
|
|
FROM node:22-bookworm-slim
|
|
|
|
RUN apt-get update && apt-get install -y --no-install-recommends \
|
|
bash ca-certificates curl git && \
|
|
rm -rf /var/lib/apt/lists/*
|
|
|
|
RUN curl -fsSL https://releases.rivet.dev/sandbox-agent/0.3.x/install.sh | sh && \
|
|
sandbox-agent install-agent --all
|
|
|
|
RUN useradd -m -s /bin/bash sandbox
|
|
USER sandbox
|
|
WORKDIR /home/sandbox
|
|
|
|
EXPOSE 2468
|
|
ENTRYPOINT ["sandbox-agent"]
|
|
CMD ["server", "--host", "0.0.0.0", "--port", "2468"]
|
|
```
|
|
|
|
## Building from source
|
|
|
|
```bash
|
|
docker build -f docker/release/linux-x86_64.Dockerfile -t sandbox-agent-build .
|
|
docker run --rm -v "$PWD/artifacts:/artifacts" sandbox-agent-build
|
|
```
|
|
|
|
Binary output: `./artifacts/sandbox-agent-x86_64-unknown-linux-musl`.
|