Getting Started
First run
Start with the repository's ONBOARDING.md. It is the setup procedure for humans and agents. Run these commands from the repository root.
Public contributors can browse with a non-secret baseline and hosted APIs:
npm run setup -- --profile isolated
bun run dev:health -- prod
bun run dev -- prod
Team members use npm run setup -- --profile host, resolve shared credentials with
bun run env:sync only when .env is absent, check bun run dev:health, then start bun run dev.
Confirmed transactions affect live Arbitrum. Setup preserves an existing environment.
See Environment Management for credential and capability blockers.
The launcher prints local URLs; verify running services with bun run dev:smoke -- prod
for the public path or bun run dev:smoke for the team path.
Find the owner
| Goal | Start here |
|---|---|
| Protocol or deployment behavior | packages/contracts |
| Shared hooks, modules, providers, or UI foundations | packages/shared |
| Public website or installed PWA | packages/client |
| Steward cockpit | packages/admin |
| Bot, webhook, or public Agent API | packages/agent |
| Event-derived read models | packages/indexer |
Use the generated API index, persona surfaces, and deployment status for volatile inventories.
Validate
Run bun run check --plan -- --intent qa before selecting tests. Start with the
targeted proof it returns, then escalate only when a public contract, shared dependency, or critical
surface requires it.