agentleFS
Sign inStart free
AsixaAsixa/codemap-skill/AGENTS.md

codemap-skill

AGENTS.md8 starsChanged 5 months agoMITView on GitHub

This repository is the codemap tool: it builds and incrementally maintains an interactive architecture map + per-module code-quality audit for any codebase. It is a Claude Code skill, but the engine is tool-agnostic — Codex, Cursor, Aider, or any agent that can read instructions and spawn sub-tasks can drive it. Use query.py (--format ids|paths|findings) to target work without reading the whole modules.json. Only scoring / fixing / test-writing need the model; everything else is a plain script call.

  • Where files are headingNew AGENTS.md files have more rules about keeping secrets out of the code, and fewer about code style.

    Of the AGENTS.md files we read, the 31,843 first seen in the last six months, against the older ones: the kind of rule that gained most share, and the kind that lost most. About files like this in general, not this one, and an estimate, since a kind is a pattern in the words.

  • In this repositoryOne other file it gives its agents.

The file

We split this AGENTS.md into the rules it gives an agent

1 rule. About 0 are common, 0 are distinctive, and 1 is very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈0

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 1

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Use query.py (--format ids|paths|findings) to target work without reading the whole modules.json.

    line 33

≈ “Common” is an estimate: at least 1 in 5 of the 40,246 AGENTS.md files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
AGENTS.md

codemap — agent instructions

This repository is the codemap tool: it builds and incrementally maintains an interactive architecture map + per-module code-quality audit for any codebase. It is a Claude Code skill, but the engine is tool-agnostic — Codex, Cursor, Aider, or any agent that can read instructions and spawn sub-tasks can drive it.

Read these first

  • SKILL.md — the full workflow and the init / check / update / test / fix commands. Follow it exactly.
  • reference/STANDARDS.md — the fixed scoring rubric, smell taxonomy (with per-language equivalents), severity levels, and the exact per-module audit prompt.
  • reference/DATA_MODEL.md — the modules.json schema (the source of truth).

Non-negotiable rules

  1. modules.json is the source of truth. The HTML and MD are generated by scripts/render.py — never hand-edit them.
  2. Every module's score comes from a separate, independent sub-task (one module per sub-task), using the prompt in reference/STANDARDS.md. Never score many modules in one pass; never reuse one module's score for another.
  3. For fix: keep the four roles separate — test-author, fixer, acceptance/verifier, auditor. A fix is accepted only when an independent acceptance step shows the pre-fix green tests are still green and the build is clean.

The scripts (deterministic, Python 3 stdlib, no install)

python scripts/scan.py       --root <proj> --state <state> [--write]   # LoC + hash + staleness
python scripts/query.py      --state <state> --max-grade C --format ids # pick targets cheaply
python scripts/apply_audit.py --state <state> --id <id> --json '<result>'
python scripts/render.py     --state <state> --template assets/template.html \
                             --out-html <html> --out-md <md>

Use query.py (--format ids|paths|findings) to target work without reading the whole modules.json. Only scoring / fixing / test-writing need the model; everything else is a plain script call.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free