Architecture context that stays useful

YarraMate keeps a versioned model of your software in the repository, then lets people and coding agents inspect and verify the same architecture context.

Use these guides to install YarraMate, understand its files, and choose the workflow that fits your repository.

Choose your starting point

• Existing repository: install and initialize, then discover the system from evidence.
• New system or redesign: use the design workflow before implementation fixes expensive boundaries.
• Coding agents: set up integrations so supported harnesses follow the same repository workflow.

The core loop

init → design → discover → check → ask → project → reconcile

Most teams begin with init, then use discover for an existing system or design for a new one. check keeps the result valid, while ask makes it useful in day-to-day work.

What lives where

• Your repository: canonical YAML under .yarramate/.
• Generated output: disposable views derived from that YAML.
• This website: task-focused guidance for evaluation and adoption.
• The product repository: normative specifications, ADRs, and maintainer documentation.

Understand the model and files →

These adoption guides are maintained by the website team. Read the normative product documentation →