The full walkthrough: stand up Alloy on your repo
The long-form version of the Quick start - the same journey, with the reasoning: what each artifact means, how to judge the draft, and what the machinery guarantees. By the end your repo has its own knowledge base under .alloy/, built, validated, and stamped in place.
You drive it through your agent. Each step gives the utterance to say, with the commands the agent runs underneath so you can see the machinery:
- Survey your repo - ask your agent to survey the repo; it drafts the source config end to end.
- Review the draft - read what it proposed: units, kinds, exclusions.
- Understand the draft - how to judge it: right things, right grain.
- Adjust - tell the agent what to change; it edits and re-checks to green.
- Commit and install - the agent installs the draft into
.alloy/; you commit. - Run a campaign - document every unit, then explore the corpus in the console.
- Add curated docs - canonicalize the cross-cutting knowledge you name.
What you need first
- The prerequisites - the
@engineering11registry scope (Cloudsmith or GitHub Packages) and Node 22 - and the bootstrap command from the Quick start run once (it installs the CLI's skills into your repo). - A git repo you want to document, with a clean working tree.
- An agent harness (Claude Code or similar) restarted after the bootstrap so it sees the skills.
Commands are written alloy <cmd> throughout - that is npx @engineering11/alloy-cli <cmd>, runnable from anywhere inside the repo.
The split you should hold in your head
- The CLI is deterministic. It scaffolds, sniffs, assembles context bundles, validates, computes drift. It never calls an LLM.
- The agent is probabilistic. It reads the repo (or a bundle) and writes prose or drafts config. Only ever reviewable output.
- You close the loop. You review, you adjust, you merge. Nothing enters the corpus without a human.
What "done" looks like
A committed .alloy/ corpus, green under alloy validate, every generated doc stamped with provenance, and coverage with UNKNOWN driven to a decision. Optionally, CI keeps it honest as the code moves.
Start with step 1 - Survey your repo.