harivansh-afk/sandbox-agent
1
0
Fork 0
mirror of https://github.com/harivansh-afk/sandbox-agent.git synced 2026-04-17 08:01:03 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: simplify README

Browse source
This commit is contained in:
Nathan Flurry 2026-01-25 04:13:47 -08:00
parent 967b015059
commit a30793845a
1 changed files with 1 additions and 29 deletions
Download patch file Download diff file Expand all files Collapse all files

30
README.md
View file

@ -8,35 +8,7 @@ Universal API for running Claude Code, Codex, OpenCode, and Amp inside sandboxes
- **Supports your sandbox provider**: Daytona, E2B, Vercel Sandboxes, and more - **Supports your sandbox provider**: Daytona, E2B, Vercel Sandboxes, and more
- **Lightweight, portable Rust binary**: Install anywhere with 1 curl command - **Lightweight, portable Rust binary**: Install anywhere with 1 curl command
Documentation lives in `docs/` (Mintlify). Start with: ## Project Goals
- `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: This project aims to solve 3 problems with agents: