From 9d350feac82eb681aabb0e7993ffcab15a8a19fa Mon Sep 17 00:00:00 2001 From: Nathan Flurry Date: Sun, 25 Jan 2026 04:13:58 -0800 Subject: [PATCH] docs: add CONTRIBUTING.md with dev quickstart --- CONTRIBUTING.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..bc742ee --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,30 @@ +# Contributing + +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 +``` +