mirror of
https://github.com/harivansh-afk/sandbox-agent.git
synced 2026-04-15 04:03:31 +00:00
docs: restore FAQ section to README
This commit is contained in:
parent
71ab40388c
commit
ee014b0838
1 changed files with 21 additions and 0 deletions
21
README.md
21
README.md
|
|
@ -14,6 +14,13 @@ Universal API for running Claude Code, Codex, OpenCode, and Amp inside sandboxes
|
|||
- Embedded (runs agents locally)
|
||||
- Sandboxed
|
||||
|
||||
## Components
|
||||
|
||||
- Server: TODO
|
||||
- SDK: TODO
|
||||
- Inspector: inspect.sandboxagent.dev
|
||||
- CLI: TODO
|
||||
|
||||
## Project Goals
|
||||
|
||||
This project aims to solve 3 problems with agents:
|
||||
|
|
@ -28,3 +35,17 @@ Features out of scope:
|
|||
- **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.
|
||||
|
||||
## FAQ
|
||||
|
||||
**Why not use PTY?**
|
||||
PTY-based approaches require parsing terminal escape sequences and dealing with interactive prompts. The agents we support all have machine-readable output modes (JSONL, HTTP APIs) that provide structured events, making integration more reliable.
|
||||
|
||||
**Why not use features that already exist on sandbox provider APIs?**
|
||||
Sandbox providers focus on infrastructure (containers, VMs, networking). This project focuses specifically on coding agent orchestration—session management, HITL (human-in-the-loop) flows, and universal event schemas. These concerns are complementary.
|
||||
|
||||
**Does it support [platform]?**
|
||||
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, Vercel Sandboxes, and Docker.
|
||||
|
||||
**Can I use this with my personal API keys?**
|
||||
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.
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue