From ee014b0838ed397e61e5fbd014280e177dbe06b5 Mon Sep 17 00:00:00 2001 From: Nathan Flurry Date: Sun, 25 Jan 2026 15:42:19 -0800 Subject: [PATCH] docs: restore FAQ section to README --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/README.md b/README.md index e0d149c..c5b373d 100644 --- a/README.md +++ b/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.