mirror of
https://github.com/harivansh-afk/sandbox-agent.git
synced 2026-04-15 17:01:02 +00:00
6a42f06342
- 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>
70 lines
1.4 KiB
Text
70 lines
1.4 KiB
Text
---
|
|
title: "Local"
|
|
description: "Run Sandbox Agent locally for development."
|
|
---
|
|
|
|
For local development, run Sandbox Agent directly on your machine.
|
|
|
|
## With the CLI
|
|
|
|
```bash
|
|
# Install
|
|
curl -fsSL https://releases.rivet.dev/sandbox-agent/0.3.x/install.sh | sh
|
|
|
|
# Run
|
|
sandbox-agent server --no-token --host 127.0.0.1 --port 2468
|
|
```
|
|
|
|
Or with npm/Bun:
|
|
|
|
<Tabs>
|
|
<Tab title="npx">
|
|
```bash
|
|
npx @sandbox-agent/cli@0.3.x server --no-token --host 127.0.0.1 --port 2468
|
|
```
|
|
</Tab>
|
|
<Tab title="bunx">
|
|
```bash
|
|
bunx @sandbox-agent/cli@0.3.x server --no-token --host 127.0.0.1 --port 2468
|
|
```
|
|
</Tab>
|
|
</Tabs>
|
|
|
|
## With the TypeScript SDK
|
|
|
|
The SDK can spawn and manage the server as a subprocess using the `local` provider:
|
|
|
|
```typescript
|
|
import { SandboxAgent } from "sandbox-agent";
|
|
import { local } from "sandbox-agent/local";
|
|
|
|
const sdk = await SandboxAgent.start({
|
|
sandbox: local(),
|
|
});
|
|
|
|
const session = await sdk.createSession({
|
|
agent: "claude",
|
|
});
|
|
|
|
await session.prompt([
|
|
{ type: "text", text: "Summarize this repository." },
|
|
]);
|
|
|
|
await sdk.destroySandbox();
|
|
```
|
|
|
|
This starts the server on an available local port and connects automatically.
|
|
|
|
Pass options to customize the local provider:
|
|
|
|
```typescript
|
|
const sdk = await SandboxAgent.start({
|
|
sandbox: local({
|
|
port: 3000,
|
|
log: "inherit",
|
|
env: {
|
|
ANTHROPIC_API_KEY: process.env.MY_ANTHROPIC_KEY,
|
|
},
|
|
}),
|
|
});
|
|
```
|