CONTRIBUTING.md at the repo root; it covers setup (pnpm install, pnpm dev), branching, the commands CI runs, and the no-feature-flags reality (every subsystem ships on). This index is the conceptual companion: it explains why the code is shaped the way it is.
Architecture at a glance
Clawboo is a TypeScript monorepo managed by pnpm workspaces and TurboRepo. The workspace globs (packages/*, packages/adapters/*, apps/*, docs) split the tree into two layers. Packages (packages/**) hold the pure, reusable substrate: the durable board (@clawboo/db), the RuntimeAdapter trait and normalized event union (@clawboo/executor), the Gateway client and same-origin proxy, the MCP servers, governance and observability primitives, the per-runtime adapters under packages/adapters/*, and the design-token UI kit. Apps (apps/**) compose them: apps/web is the Vite SPA plus the Express API and the server-side orchestration runner (apps/web/server/lib/executorRunner.ts), apps/cli is the npx clawboo installer, and docs/ is the hand-edited Mintlify docs site. Dependencies flow strictly one way, packages never import apps, and every @clawboo/* library is private: true. The only artifact published to npm is the clawboo CLI, which inlines the libraries into its own bundle. The whole system is wired together by a handful of seams: a RuntimeAdapter makes any runtime (OpenClaw, native, Claude Code, Codex, Hermes) a uniform teammate; an AgentSource makes SQLite the registry of record while keeping the Gateway as one source among many; and multiplexer traits (CapabilitySource, ScheduleSource) fan many providers into one stream.
The internals map
The pages below go in rough reading order, from the build and the core traits down to the subsystem internals.These pages explain the internals. For the factual surface, every package’s public API, every REST route, every database table, see the Reference section. For the conceptual model of a subsystem (what the board is, what verification means), see Core concepts.
Where to start by task
- Adding a runtime → The RuntimeAdapter trait, then The executor runner.
- Touching coordination/state → Board internals and AgentSource.
- Working on the Gateway/event path → The event pipeline.
- Changing the build or a package boundary → Monorepo and build.
- Shipping a release → Release process.
These docs describe Clawboo v0.3.1, the current release.
See also
CONTRIBUTING.md, setup, branching, commands, the PR checklist- How it works, the end-to-end architecture overview
- Architecture invariants, the rules a change must not break
- Package reference, the per-package API pages and dependency graph
- Glossary, canonical term definitions