bootstrap-agents-md

Installation
SKILL.md

Bootstrap AGENTS.md

Write the smallest root AGENTS.md that tells a capable coding agent what it cannot work out from the repository: project purpose and domain invariants, public boundaries, the exact checks that gate a change, delivery or migration risk, and conventions the code shows repeatedly but nothing enforces. Everything else belongs in the code, the tooling or a narrower file.

Output

  • Root AGENTS.md.
  • Root CLAUDE.md containing exactly @AGENTS.md and one trailing newline. Claude Code reads CLAUDE.md, and the import keeps one source of truth.
  • Create nothing else. Leave nested AGENTS.md files alone, since they take precedence in their directories, unless the user includes them. Keep unrelated working-tree changes untouched.

Run scripts/validate_agents_md.py <repo-root> afterwards. It checks the pair's structure, a 200-line and 1,200-word ceiling, and flags machine-local paths and unpaired prohibitions. It cannot judge whether the rules are true.

Deciding what to keep

Keep a rule when it applies project-wide, changes behaviour, is supported by repository evidence (repeated code, tests, CI configuration, design records), and will stay true. Existing root files are evidence of intent, not a template: write a coherent replacement instead of editing in place, and carry over supported intent, not structure.

Installs
44
GitHub Stars
57
First Seen
Jul 12, 2026