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

docs: add CONTRIBUTING.md with dev quickstart

Browse source
This commit is contained in:
Nathan Flurry 2026-01-25 04:13:58 -08:00
parent a30793845a
commit 9d350feac8
1 changed files with 30 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

30
CONTRIBUTING.md Normal file
View file

@ -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
```