sandbox-agent/CLAUDE.md
2026-01-25 04:13:33 -08:00

2.4 KiB

Instructions

Agent Schemas

Agent schemas (Claude Code, Codex, OpenCode, Amp) are available for reference in resources/agent-schemas/dist/.

Research on how different agents operate (CLI flags, streaming formats, HITL patterns, etc.) is in research/agents/. When adding or making changes to agent docs, follow the same structure as existing files.

Universal schema guidance:

  • The universal schema should cover the full feature set of all agents.
  • Conversions must be best-effort overlap without being lossy; preserve raw payloads when needed.

Spec Tracking

  • Update todo.md as work progresses; add new tasks as they arise.
  • Keep CLI subcommands in sync with every HTTP endpoint.
  • Update CLAUDE.md to keep CLI endpoints in sync with HTTP API changes.
  • When changing the HTTP API, update the TypeScript SDK and CLI together.
  • Do not make breaking changes to API endpoints.

CLI ⇄ HTTP endpoint map (keep in sync)

  • sandbox-agent agents listGET /v1/agents
  • sandbox-agent agents installPOST /v1/agents/{agent}/install
  • sandbox-agent agents modesGET /v1/agents/{agent}/modes
  • sandbox-agent sessions listGET /v1/sessions
  • sandbox-agent sessions createPOST /v1/sessions/{sessionId}
  • sandbox-agent sessions send-messagePOST /v1/sessions/{sessionId}/messages
  • sandbox-agent sessions events / get-messagesGET /v1/sessions/{sessionId}/events
  • sandbox-agent sessions events-sseGET /v1/sessions/{sessionId}/events/sse
  • sandbox-agent sessions reply-questionPOST /v1/sessions/{sessionId}/questions/{questionId}/reply
  • sandbox-agent sessions reject-questionPOST /v1/sessions/{sessionId}/questions/{questionId}/reject
  • sandbox-agent sessions reply-permissionPOST /v1/sessions/{sessionId}/permissions/{permissionId}/reply

Default port references (update when CLI default changes)

  • frontend/packages/web/src/App.tsx
  • README.md
  • docs/cli.mdx
  • docs/frontend.mdx
  • docs/index.mdx
  • docs/quickstart.mdx
  • docs/typescript-sdk.mdx
  • docs/deployments/cloudflare-sandboxes.mdx
  • docs/deployments/daytona.mdx
  • docs/deployments/docker.mdx
  • docs/deployments/e2b.mdx
  • docs/deployments/vercel-sandboxes.mdx

Git Commits

  • Do not include any co-authors in commit messages (no Co-Authored-By lines)
  • Use conventional commits style (e.g., feat:, fix:, docs:, chore:, refactor:)
  • Keep commit messages to a single line