72 lines
1.4 KiB
Markdown
72 lines
1.4 KiB
Markdown
# Local
|
|
|
|
> Source: `docs/deploy/local.mdx`
|
|
> Canonical URL: https://sandboxagent.dev/docs/deploy/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.4.x/install.sh | sh
|
|
|
|
# Run
|
|
sandbox-agent server --no-token --host 127.0.0.1 --port 2468
|
|
```
|
|
|
|
Or with npm/Bun:
|
|
|
|
#### npx
|
|
|
|
```bash
|
|
npx @sandbox-agent/cli@0.4.x server --no-token --host 127.0.0.1 --port 2468
|
|
```
|
|
|
|
#### bunx
|
|
|
|
```bash
|
|
bunx @sandbox-agent/cli@0.4.x server --no-token --host 127.0.0.1 --port 2468
|
|
```
|
|
|
|
## 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,
|
|
},
|
|
}),
|
|
});
|
|
```
|