-
Notifications
You must be signed in to change notification settings - Fork 0
Repo Layout
The top-level layout of agentm on disk. For why this shape, see How the pieces fit, the AgentM HLD, and the Foundations HLD.
| Question | Answer |
|---|---|
| Where does a phase spec live? | Not in agentm — the phase loop (/setup /plan /work /review /release /bugfix) ships in the crickets developer-workflows plugin since the V5 unbundling (the AgentM HLD). agentm owns the durable state substrate the phases run on, not the specs. |
| Where does an adapter live? |
adapters/<host>/ — claude-code, antigravity (the two supported hosts). |
| Where does the install scaffold live? |
templates/ — state files, hooks, wiki scaffold. |
| Where does the test infra live? |
scripts/ — never propagated to target projects. |
| Where does this wiki get copied from on install? | Nowhere. Target projects get templates/wiki/ (an empty scaffold), not this one — see the Foundations HLD. |
| Where do personal customizations live? |
crickets — the sibling toolkit repo (since v2.0.0 / Foundations HLD). |
| Where does the shared install plumbing live? |
lib/install/ — byte-identical to crickets/lib/install/; synced via scripts/sync-lib.sh, parity-gated in CI. |
| Where does the vault-less mode signal live? | Two on-host layers — the device-level state_mode in <install-prefix>/.agentm-config.json and the higher-precedence per-repo <repo>/.harness/.project-mode. See Single-repo state mode. |
agentm/
├── install.sh # POSIX installer (bash)
├── install.ps1 # Windows installer (PowerShell 7+)
├── README.md # the pitch + install instructions
├── AGENTS.md # universal agent entry point
├── CLAUDE.md # Claude Code entry (links back to AGENTS.md)
├── CHANGELOG.md # Keep-a-Changelog format; written by ship-release
├── LICENSE # MIT
├── harness/ # canonical specs (source of truth)
│ ├── agents/ # canonical sub-agent specs (see roster below)
│ ├── skills/ # canonical skill specs (see roster below)
│ ├── principles.md # the design calls behind the harness
│ ├── documentation.md # the wiki + GitHub Projects/Issues convention
│ ├── hooks.md # hook design (PostToolUse / PreCompact / SessionStart)
│ ├── telemetry.md # telemetry signals + thresholds
│ └── verification.md # deterministic-gate definitions
├── adapters/ # per-host shims that point at harness/ specs
│ ├── claude-code/ # commands + agents + skills (→ .claude/)
│ ├── antigravity/ # workflows + skills + rules (→ .agents/)
│ └── gemini/ # dropped host (v2.4.0) — vestigial dir, see Compatibility
├── lib/ # shared install plumbing (byte-identical to crickets/lib/)
│ └── install/ # cp_managed, cp_user, ensure_boundary_src, sync_managed_parents
├── templates/ # what install.sh drops into a target project
│ ├── PLAN.md, features.json, progress.md, init.sh, verify.{sh,ps1}
│ ├── hooks/ # hook scripts + settings-fragment JSON (bash + pwsh)
│ ├── scripts/ # cross-review.{sh,ps1}, telemetry.sh, etc.
│ └── wiki/ # the wiki scaffold installed into target projects
├── scripts/ # test infra — NEVER propagated by install.sh
│ ├── smoke-install-{bash.sh,pwsh.ps1}
│ ├── check-parity.sh, check-references.py, check-wiki.py
│ ├── check-lib-parity.sh # byte-identity gate for lib/install/
│ ├── check-no-pii.sh # PII regex scanner (gitleaks also gates CI)
│ ├── sync-lib.sh # one-shot lib/install/ sync agentm → ../crickets
│ └── validate-adapters.py
├── wiki/ # THIS wiki — dogfood docs for the harness repo itself
│ ├── Home.md, _Sidebar.md, architecture.yml
│ └── how-to/ reference/ architecture/ designs/ explanation/ decisions/
└── .github/workflows/
├── tests-linux.yml, tests-mac.yml, tests-windows.yml # CI (never propagated)
└── wiki-sync.yml # (also shipped as a template)
Since the V5 unbundling (the AgentM HLD) each adapter ships only agentm's own surfaces — the phase-gated dev loop and the review sub-agents moved to the crickets developer-workflows / code-review plugins, so there is nothing to parity-check there (their absence is pinned by scripts/test_devloop_slim_retired.py). scripts/check-parity.sh asserts what remains matches across hosts.
| Adapter | Ships (agentm's own surfaces) |
|---|---|
adapters/claude-code/ |
the recent-wiki-changes utility command (.claude/commands/) · the doctor skill (.claude/skills/doctor/) |
adapters/antigravity/ |
the always-on rules — operating contract + vault context (.agents/rules/{harness,agentmemory-context}.md); the workflows/ + skills/ dirs were removed in the slim |
A third directory, adapters/gemini/, remains in the tree but is not a supported host — Gemini CLI was dropped in v2.4.0 (Compatibility). Its removal is pending reconciliation.
Canonical sub-agents (harness/agents/): adapt-evaluator, memory-idea-researcher — the memory-engine pair. The review sub-agents (explorer, adversarial-reviewer, adversarial-reviewer-cross) and documenter are crickets-provided (code-review / developer-workflows / wiki-maintenance plugins) since the V5 unbundling (the AgentM HLD).
Canonical skills (harness/skills/): design, doctor, memory, ship-release, wiki-author. Wiki authoring's diataxis-author is provided by crickets' wiki-maintenance plugin (graceful-skip if crickets is not paired), recommended by name like dependabot-fixer / pii-scrubber.
- How the pieces fit — how phases / adapters / templates / scripts interact.
- Installer CLI — flags and the owned-vs-managed tree.
- CI gates — what each workflow proves.
- Compatibility — the supported hosts and dropped hosts.
- Foundations HLD — Documentation convention — why this wiki is never installed into target projects.
🔧 How-to
- Installer CLI
- Detection rules
- Project config
- Migration tool
- CI gates
- Repo layout
- Vault lint checks
- Note relatedness signals
- Vault write protocol
- Queue status lite
- AgentMemory context payload
- Process seam
- Storage seam
- Auto-orchestration config
- Capability resolver
- Design governance
- Compatibility
- Completed features
- Memory MCP tools