mirror of
https://github.com/harivansh-afk/sandbox-agent.git
synced 2026-04-15 08:03:46 +00:00
52 lines
2.5 KiB
Markdown
52 lines
2.5 KiB
Markdown
# Sandbox Agent SDK
|
|
|
|
Universal API for running Claude Code, Codex, OpenCode, and Amp inside sandboxes.
|
|
|
|
- **Any coding agent**: Universal API to interact with all agents with full feature coverage
|
|
- **Server Mode**: Run as HTTP server from any sandbox provider or as TypeScript & Python SDK
|
|
- **Universal session schema**: Universal schema to store agent transcripts
|
|
- **Supports your sandbox provider**: Daytona, E2B, Vercel Sandboxes, and more
|
|
- **Lightweight, portable Rust binary**: Install anywhere with 1 curl command
|
|
|
|
Documentation lives in `docs/` (Mintlify). Start with:
|
|
|
|
- `docs/index.mdx` for the overview
|
|
- `docs/quickstart.mdx` to run the daemon
|
|
- `docs/http-api.mdx` and `docs/cli.mdx` for API references
|
|
|
|
Quickstart (local dev):
|
|
|
|
```bash
|
|
sandbox-agent --token "$SANDBOX_TOKEN" --host 127.0.0.1 --port 2468
|
|
```
|
|
|
|
Extract API keys from local agent configs (Claude Code, Codex, OpenCode, Amp):
|
|
|
|
```bash
|
|
# Print env vars
|
|
sandbox-agent credentials extract-env
|
|
|
|
# Export to current shell
|
|
eval "$(sandbox-agent credentials extract-env --export)"
|
|
```
|
|
|
|
Run the web console (includes all dependencies):
|
|
|
|
```bash
|
|
pnpm dev -F @sandbox-agent/web
|
|
```
|
|
|
|
## Project Scope
|
|
|
|
This project aims to solve 3 problems with agents:
|
|
|
|
- **Universal Agent API**: Claude Code, Codex, Amp, and OpenCode all have put a lot of work in to the agent scaffold. Each have respective pros and cons and need to be easy to be swapped between.
|
|
- **Agent Transcript**: Maintaining agent transcripts is difficult since the agent manages its own sessions. This provides a simpler way to read and retrieve agent transcripts in your system.
|
|
- **Agents In Sandboxes**: There are many complications with running agents inside of sandbox providers. This lets you run a simple curl command to spawn an HTTP server for using any agent from within the sandbox.
|
|
|
|
Features out of scope:
|
|
|
|
- **Storage of sessions on disk**: Sessions are already stored by the respective coding agents on disk. It's assumed that the consumer is streaming data from this machine to an external storage, such as Postgres, ClickHouse, or Rivet.
|
|
- **Direct LLM wrappers**: Use the [Vercel AI SDK](https://ai-sdk.dev/docs/introduction) if you want to implement your own agent from scratch.
|
|
- **Git Repo Management**: Just use git commands or the features provided by your sandbox provider of choice.
|
|
- **Sandbox Provider API**: Sandbox providers have many nuanced differences in their API, it does not make sense for us to try to provide a custom layer. Instead, we opt to provide guides that let you integrate this project with sandbox providers.
|