Handbook - Reference

Commands

Run commands from the repository root unless a command says otherwise.

On this page

Run commands from the repository root unless a command says otherwise.

Local Development

PurposeCommand
Install dependenciesbun install
Prepare local token routingbun run setup:local
Start NATS and SurrealDBbun run dev:infra
Start local app stackbun run dev:all
Stop stale local app processesbun run dev:clean
Start BFF/frontend devbun run dev
Seed development telemetrybun run dev:seed
Seed continuous live telemetrybun run dev:seed:live
Reset local infrastructure datadocker compose --env-file .env down -v

Release Compose

PurposeCommand
Start release stack./cloudgrid-local.sh up
Start release stack from checkoutdeploy/compose/cloudgrid-local.sh up
Pull release images./cloudgrid-local.sh pull
Stop release stack./cloudgrid-local.sh down
Reset release stack data./cloudgrid-local.sh reset

Verification

PurposeCommand
Default verificationbun run verify
Full local verificationbun run verify:full
Format checkbun run format:check
Typecheckbun run typecheck
Lintbun run lint
Bun testsbun run test
Contract checkbun run contracts:check
Generate contractsbun run contracts:generate
Backend coveragebun run coverage:backend
Frontend smokebun run smoke:frontend
Go workspace testsbun run go:test
Docker-backed integrationbun run integration:local
Local benchmark probebun run bench:local
Local read benchmark probebun run bench:read
Local ingest benchmark probebun run bench:ingest
Production-like benchmark probebun run bench:production
Production-like read benchmark probebun run bench:production:read
Production-like ingest benchmark probebun run bench:production:ingest

bun run verify:full includes smoke:frontend and git diff --check after the default verification chain. Any GraphQL, AsyncAPI, UI contract, BFF bridge, or Go message contract change must keep bun run contracts:check passing.

Manual Service Startup

StepServiceCommand
1storage-writego run -tags surrealdb ./core/storage-write/cmd/storage-write
2storage-readgo run -tags surrealdb ./core/storage-read/cmd/storage-read
3control-planego run ./core/control-plane/cmd/control-plane
4BFF and frontendbun run dev
5OTLP collectorgo run ./core/otlp-collector/cmd/otlp-collector

Start NATS and SurrealDB before manual service startup:

bun run dev:infra

Benchmark commands skip unless CLOUDGRID_ENABLE_BENCHMARKS=true. Production-like benchmark commands also require CLOUDGRID_BENCH_DEPLOYMENT_PROFILE=production-like and explicit target URLs.

AI Evaluation Runner Scaffold

cd core/ai-eval-runner
GOWORK=off go test ./...

Use this only for runner-only scaffolding when the root Go workspace does not include core/ai-eval-runner.

Last updated .