Install and initialize

This path gets a repository from no YarraMate files to a valid, queryable workspace.

1. Install the CLI

YarraMate requires Node.js 22 or newer.

npm install --global yarramate
yarramate --version

2. Initialize the repository

yarramate init

Run this from the repository root. Commit the native workspace under .yarramate/ with the code it describes.

3. Choose a workflow

For an existing codebase:

yarramate discover .yarramate/workspace.yaml

For a new system or deliberate redesign:

yarramate design .yarramate/workspace.yaml

Both workflows help you author native documents. They do not replace engineering judgment.

4. Validate the model

yarramate check .yarramate/workspace.yaml --json

A passing check means the documents are structurally valid and internally consistent; it does not prove that the architecture is complete or good.

5. Use the context

yarramate ask .yarramate/workspace.yaml
yarramate skill install --repo

ask provides a compact orientation. The repository skill guides supported coding agents through the same workflow.

Commit source, regenerate output

Treat .yarramate/ as the source of truth. Generated projections belong in .yarramate-out/ and should be reproducible rather than hand-edited.

Next: choose a workflow →

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