Practical patterns, starters & CLI tools for loop engineering with AI coding agents. Design systems that prompt and orchestrate agents (inspired by Addy Osmani and Boris Cherny). Includes loop-audit, loop-init, loop-cost.
TypeScript agentic-aiai-agentsai-codinganthropicautomationclaudeclaude-codecodexcoding-agentsdevops-automationdevtoolsgithub-actionsgrokllmloop-engineeringmcpprompt-engineering
docs: add loop-sync subsection to QUICKSTART (#263)
chenshiyange0e7182c77ac
diff --git a/docs/QUICKSTART.md b/docs/QUICKSTART.mdindex d719784..2ec897c 100644--- a/docs/QUICKSTART.md+++ b/docs/QUICKSTART.md@@ -72,6 +72,35 @@ Scores 0–100 with concrete next steps. Re-run after each improvement. Paste anpx @cobusgreyling/loop-audit . --badge```+### Catch drift before you schedule (`loop-sync`)++`loop-audit` scores readiness; `loop-sync` checks that your `STATE.md` and `LOOP.md` still agree. When they drift — you edit `LOOP.md` to add a loop but never wire it into `STATE.md`, or a starter update leaves one file behind — a scheduled loop can run against stale instructions.++```bash+npx @cobusgreyling/loop-sync .+```++Sample output on a fresh daily-triage scaffold:++```+Loop Sync Report+══════════════════════════════════════════════════+Score: 80/100 (healthy)++Found 2 issue(s):++⚠️ Warnings:+ - LOOP.md: LOOP.md does not reference STATE.md+ - STATE.md ↔ LOOP.md: Low structural similarity between STATE.md and LOOP.md++💡 Suggestions:+ - Review STATE.md and LOOP.md for consistency+```++Read it top-down: the **score** (70+ healthy, 40–69 warning, below 40 needs attention) is the headline, then each **warning** names the two files that disagree and how. Here, `LOOP.md` describes loops that never point back at `STATE.md` — expected right after scaffolding, worth fixing once you customize either file.++**When to run it:** after editing `LOOP.md`, and again before you schedule an L2 loop — so an unattended run never fires on stale state. Full checks, options, and score bands: [tools/loop-sync/README.md](../tools/loop-sync/README.md).+### Optional: MCP runtime lookupAgents can query patterns, skills, and state on demand instead of stuffing docs into every prompt. Copy the config stub from [examples/mcp/loop-engineering.mcp.json](../examples/mcp/loop-engineering.mcp.json) into your MCP client settings.@@ -202,6 +231,9 @@ npx @cobusgreyling/loop-audit . --suggest# Optional badge for your READMEnpx @cobusgreyling/loop-audit . --badge+# Check STATE.md ↔ LOOP.md drift (run after editing LOOP.md, before scheduling L2)+npx @cobusgreyling/loop-sync .+# Optional MCP runtime lookup (patterns, skills, state on demand)LOOP_PROJECT_ROOT=. npx @cobusgreyling/loop-mcp-server