mirror of
https://github.com/harivansh-afk/sandbox-agent.git
synced 2026-04-15 05:02:11 +00:00
docs: documentation overhaul and universal schema reference (#10)
* remove website .astro * fix default origin * docs: comprehensive documentation overhaul - Add quickstart with multi-platform examples (E2B, Daytona, Docker, local) - Add environment variables setup with platform-specific tabs - Add Python SDK page (coming soon) - Add local deployment guide - Update E2B/Daytona/Docker guides with TypeScript examples - Configure OpenAPI auto-generation for API reference - Add CORS configuration guide - Update manage-sessions with Rivet Actors examples - Fix SDK method names and URLs throughout - Add icons to main documentation pages - Remove outdated universal-api and http-api pages * docs: add universal schema and agent compatibility docs - Create universal-schema.mdx with full event/item schema reference - Create agent-compatibility.mdx mirroring README feature matrix - Rename glossary.md to universal-schema.mdx - Update CLAUDE.md with sync requirements for new docs - Add links in README to building-chat-ui, manage-sessions, universal-schema - Fix CLI docs link (rivet.dev -> sandboxagent.dev) * docs: add inspector page and daytona network limits warning
This commit is contained in:
Nathan Flurry
GitHub
parent
a6f77f3008
commit
08d299a3ef
40 changed files with 1996 additions and 1004 deletions
59
README.md
59
README.md
|
|
@ -9,11 +9,11 @@
|
|||
|
||||
- **Any coding agent**: Universal API to interact with all agents with full feature coverage
|
||||
- **Server or SDK mode**: Run as an HTTP server or with the TypeScript SDK
|
||||
- **Universal session schema**: Universal schema to store agent transcripts
|
||||
- **Universal session schema**: [Universal schema](https://sandboxagent.dev/docs/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
|
||||
- **Automatic agent installation**: Agents are installed on-demand when first used
|
||||
- **OpenAPI spec**: https://sandboxagent.dev/docs/api
|
||||
- **OpenAPI spec**: Well documented and easy to integrate
|
||||
|
||||
[Documentation](https://sandboxagent.dev/docs) — [Discord](https://rivet.dev/discord)
|
||||
|
||||
|
|
@ -37,7 +37,7 @@
|
|||
| MCP Tools | | ✓ | | |
|
||||
| Streaming Deltas | | ✓ | ✓ | |
|
||||
|
||||
* Claude headless CLI does not natively support tool calls/results or HITL questions/permissions yet; these are WIP.
|
||||
\* Coming imminently
|
||||
|
||||
Want support for another agent? [Open an issue](https://github.com/anthropics/sandbox-agent/issues/new) to request it.
|
||||
|
||||
|
|
@ -116,7 +116,7 @@ for await (const event of client.streamEvents("demo", { offset: 0 })) {
|
|||
}
|
||||
```
|
||||
|
||||
[Documentation](https://sandboxagent.dev/docs/sdks/typescript)
|
||||
[Documentation](https://sandboxagent.dev/docs/sdks/typescript) — [Building a Chat UI](https://sandboxagent.dev/docs/building-chat-ui) — [Managing Sessions](https://sandboxagent.dev/docs/manage-sessions)
|
||||
|
||||
### Server
|
||||
|
||||
|
|
@ -144,8 +144,7 @@ To disable auth locally:
|
|||
sandbox-agent server --no-token --host 127.0.0.1 --port 2468
|
||||
```
|
||||
|
||||
[Documentation](https://sandboxagent.dev/docs/quickstart)
|
||||
[Integration guides](https://sandboxagent.dev/docs/deployments)
|
||||
[Documentation](https://sandboxagent.dev/docs/quickstart) - [Integration guides](https://sandboxagent.dev/docs/deploy)
|
||||
|
||||
### CLI
|
||||
|
||||
|
|
@ -169,7 +168,23 @@ You can also use npx like:
|
|||
npx sandbox-agent --help
|
||||
```
|
||||
|
||||
[Documentation](https://rivet.dev/docs/cli)
|
||||
[Documentation](https://sandboxagent.dev/docs/cli)
|
||||
|
||||
### Inspector
|
||||
|
||||
Debug sessions and events with the [Inspector UI](https://inspect.sandboxagent.dev).
|
||||
|
||||
|
||||
|
||||
[Documentation](https://sandboxagent.dev/docs/inspector)
|
||||
|
||||
### OpenAPI Specification
|
||||
|
||||
[Explore API](https://sandboxagent.dev/docs/api-reference) — [View Specification](https://github.com/rivet-dev/sandbox-agent/blob/main/docs/openapi.json)
|
||||
|
||||
### Universal Schema
|
||||
|
||||
All events follow a [universal schema](https://sandboxagent.dev/docs/universal-schema) that normalizes differences between agents.
|
||||
|
||||
### Tip: Extract credentials
|
||||
|
||||
|
|
@ -183,33 +198,47 @@ This prints environment variables for your OpenAI/Anthropic/etc API keys to test
|
|||
|
||||
## FAQ
|
||||
|
||||
**Does this replace the Vercel AI SDK?**
|
||||
<details>
|
||||
<summary><strong>Does this replace the Vercel AI SDK?</strong></summary>
|
||||
|
||||
No, they're complementary. AI SDK is for building chat interfaces and calling LLMs. This SDK is for controlling autonomous coding agents that write code and run commands. Use AI SDK for your UI, use this when you need an agent to actually code.
|
||||
</details>
|
||||
|
||||
**Which coding agents are supported?**
|
||||
<details>
|
||||
<summary><strong>Which coding agents are supported?</strong></summary>
|
||||
|
||||
Claude Code, Codex, OpenCode, and Amp. The SDK normalizes their APIs so you can swap between them without changing your code.
|
||||
</details>
|
||||
|
||||
**How is session data persisted?**
|
||||
<details>
|
||||
<summary><strong>How is session data persisted?</strong></summary>
|
||||
|
||||
This SDK does not handle persisting session data. Events stream in a universal JSON schema that you can persist anywhere. Consider using Postgres or [Rivet Actors](https://rivet.gg) for data persistence.
|
||||
This SDK does not handle persisting session data. Events stream in a universal JSON schema that you can persist anywhere. See [Managing Sessions](https://sandboxagent.dev/docs/manage-sessions) for patterns using Postgres or [Rivet Actors](https://rivet.gg).
|
||||
</details>
|
||||
|
||||
**Can I run this locally or does it require a sandbox provider?**
|
||||
<details>
|
||||
<summary><strong>Can I run this locally or does it require a sandbox provider?</strong></summary>
|
||||
|
||||
Both. Run locally for development, deploy to E2B, Daytona, or Vercel Sandboxes for production.
|
||||
</details>
|
||||
|
||||
**Does it support [platform]?**
|
||||
<details>
|
||||
<summary><strong>Does it support [platform]?</strong></summary>
|
||||
|
||||
The server is a single Rust binary that runs anywhere with a curl install. If your platform can run Linux binaries (Docker, VMs, etc.), it works. See the deployment guides for E2B, Daytona, and Vercel Sandboxes.
|
||||
</details>
|
||||
|
||||
**Can I use this with my personal API keys?**
|
||||
<details>
|
||||
<summary><strong>Can I use this with my personal API keys?</strong></summary>
|
||||
|
||||
Yes. Use `sandbox-agent credentials extract-env` to extract API keys from your local agent configs (Claude Code, Codex, OpenCode, Amp) and pass them to the sandbox environment.
|
||||
</details>
|
||||
|
||||
**Why Rust and not [language]?**
|
||||
<details>
|
||||
<summary><strong>Why Rust and not [language]?</strong></summary>
|
||||
|
||||
Rust gives us a single static binary, fast startup, and predictable memory usage. That makes it easy to run inside sandboxes or in CI without shipping a large runtime, such as Node.js.
|
||||
</details>
|
||||
|
||||
## Project Goals
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue