For AI agents: the complete documentation index is available at /mbzoo/docs/llms.txt, the full documentation bundle is available at /mbzoo/docs/llms-full.txt, and this page is available as Markdown at /mbzoo/docs/guide/development.md.

Development

Requirements

  • Bun ≥ 1.4 (package manager, test runner, CLI runtime)
  • Node 20+ — the Playwright runner is invoked through it
  • bunx playwright install for E2E browsers

Commands

CommandPurpose
bun installinstall workspace dependencies
bun run dev:viewerVite dev server for the viewer
bun run buildbuild all packages (viewer outputs static dist/)
bun run preview:viewerserve the production build locally
bun test packages apps fixturesunit tests (bun:test)
bun run test:e2ePlaywright specs against the built viewer
bun run cli -- <file.mbz>inspect a backup from the terminal
bun run lint / formatBiome check/fix
bun run typecheckstrict TypeScript across workspaces
bun run research:indexesregenerate research indexes
bun run research:validatevalidate research records + index freshness
bun run checkthe full local CI equivalent

Layout

See docs/ARCHITECTURE.md. Parser work has extra invariants — load .agents/skills/mbz-parser/SKILL.md first.

Fixtures

Regenerate with bun run fixtures/scripts/generate-fixture.ts; checksums live in fixtures/manifest.yaml. Never commit real backups.

Deployment

The viewer is a static site. Pushes to main build and deploy it to GitHub Pages via .github/workflows/deploy-pages.yml.