sandbox-agent/factory/CONTRIBUTING.md

Contributing

Development Setup

1. Clone:

git clone https://github.com/rivet-dev/sandbox-agent-factory.git
cd sandbox-agent-factory

2. Install dependencies:

pnpm install

3. Build all packages:

pnpm -w build

Package Layout

• packages/shared: contracts/schemas
• packages/backend: RivetKit actors + DB + providers + integrations
• packages/cli: hf and hf tui (OpenTUI)

Local RivetKit Dependency

Build local RivetKit before backend changes that depend on Rivet internals:

cd ../rivet
pnpm build -F rivetkit

cd /path/to/sandbox-agent-factory
just sync-rivetkit

Validation

Run before opening a PR:

pnpm -w typecheck
pnpm -w build
pnpm -w test

Dev Backend (Docker Compose)

Start the dev backend (hot reload via bun --watch) and Vite frontend via Docker Compose:

just factory-dev

Stop it:

just factory-dev-down