Skip to main content

Examples

The examples surface is part of the product, not filler. These paths mirror the reference examples in the current source repository. They are available from a source checkout; they are not included in the current public npm registry package.

Current supported examples:

  • local: single-repo local execution
  • distributed: controller plus worker topology
  • semantic: retrieval-aware context assembly
  • regulated: approval-gated and policy-constrained flow

Choose the smallest example first

Start with local, validate it offline, and move to distributed or regulated only when the single-repository flow is understood.

The distributed example has separate controller and worker configs. The regulated example demonstrates approval and policy behavior; it is not a hosted compliance service or a certification.

Validate examples without live services

All example configs can be validated with:

npm run harness -- doctor --config examples/local/harness.config.json --skip-model-endpoint --skip-agent-brain

Swap the config path for the distributed, semantic, or regulated examples as needed. The global --config option may be placed after the command as shown above.

Why this matters

The examples are smoke-covered so they do not silently drift away from the shipped config schema.