claudear

Reference

Development

Local setup, repo layout, build/test workflows, and contributing guide.

Prerequisites

The README documents the primary development prerequisites:

  • Rust 1.93+
  • Bun (dashboard tooling)
  • Docker (optional)

Build commands

make build              # Debug build
make build-release      # Release build with embedded dashboard
make install            # Install to /usr/local/bin

Test commands

make test               # Rust tests
make test-all           # Rust + dashboard tests
make test-prod-e2e      # Real production E2E smoke (requires credentials)
make check              # Format + lint + test

Production E2E smoke test env vars

The README documents required credentials for the live E2E path (issue source, SCM, and agent credentials). Use a dedicated test repo/environment.

Dashboard frontend development

make dashboard          # Install dependencies
make dashboard-dev      # Dev server on :5173
make dashboard-build    # Build dashboard for production
make dashboard-test     # Dashboard tests

High-signal repository layout

Runtime and backend

  • src/main.rs: CLI command wiring and app entry
  • src/config.rs: configuration model and parsing
  • src/watcher.rs: orchestration core
  • src/source/*: issue source integrations
  • src/webhook/*: webhook server + provider handlers
  • src/runner/*: agent provider adapters
  • src/repo/*: repo discovery, indexing, relationships, code index
  • src/api/*: dashboard API and static serving
  • src/notifier/*: notifier channels and ask orchestration
  • src/regression/*, src/release/*, src/reports/*: post-fix monitoring/reporting
  • src/learning/*, src/feedback/*, src/prioritisation/*: learning and prioritisation
  • src/ipc/*: daemon IPC protocol and control server/client

Frontend and website

  • dashboard/: React dashboard app
  • website/: landing page + generated docs output
  • scripts/docs/generate-website-docs.ts: Bun docs site generator

E2E and scripts

  • src/bin/e2e/: E2E helper binary + scenarios
  • scripts/prod-e2e-smoke.sh: production smoke automation helper
  • scripts/screenshots/: dashboard screenshot tooling

Prompt customization and conventions

Claudear supports per-repo AGENT.md files and config-level agent instructions. When changing prompt construction behavior, test both paths (repo-specific and global).

Practical debugging workflow for contributors

  • run claudear dry-run after config changes
  • use foreground claudear poll when debugging source behavior
  • use dashboard/API endpoints to inspect analytics/attempt data
  • use claudear activity and claudear diag ... for runtime diagnostics

Packaging and release-sensitive changes

The project publishes binaries, Docker images, Homebrew, and APT packages. Changes to CLI flags, embedded dashboard behavior, or health endpoints can affect packaging and release automation, so validate CI/release assumptions early.

Regenerating docs after changes

bun scripts/docs/generate-website-docs.ts

Then verify:

  • website/docs/*.html regenerated
  • website/docs/assets/* updated if needed
  • landing page docs links point to docs/
Previous CLI commands
Claudear documentation