agentleFS
timothywarner-orgtimothywarner-org/claude-code/.claude/skills/claude-md-audit/SKILL.md

claude-md-audit

Skill223 starsChanged 4 months agoMITView on GitHub

Audit the CLAUDE.md hierarchy in a repo for drift between what each CLAUDE.md claims and what's actually on disk. Validates that referenced file paths still exist, flags voice violations (em dashes, "ask" as a noun), and checks the ground-truth facts block for stale tokens (MCP spec date, transports, model lineup). Use when the user asks to audit, validate, check, or verify CLAUDE.md files, says "is my CLAUDE.md still accurate", flags possible doc drift, or wants to sanity-check the docs before a course recording or release.

3 other projects use a version of this.

Adopted by

Most recently taken up by

The file

We split this skill into the rules it gives an agent

2 rules. 0 are common, 2 are distinctive, and 0 are very specific to this project.

  • 0

    Common

    Most of the 3 edited versions we read keep these.

  • 2

    Distinctive

    This author's own choices. Worth a look.

  • 0

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    No em dashes. Hyphens with spaces, commas, or periods only.

    line 38
  2. Distinctive:

    Never use "ask" as a noun.

    line 39

“Common” is measured: kept by at least 6 in 10 of the 3 edited versions of this file we could read. “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
SKILL.md

CLAUDE.md hierarchy audit

This skill validates the five-scope CLAUDE.md teaching artifact that Segment 2 of this course centers on. The Python audit script does the heavy lifting; this prompt orchestrates and interprets.

Run the audit

python "${CLAUDE_SKILL_DIR}/scripts/audit_claude_md.py" $ARGUMENTS

How to interpret results

The script outputs JSON. Read the status field first:

  • clean (exit 0): every CLAUDE.md file exists, every referenced path resolves, ground-truth facts block matches expected values. Report a one-line "all clean" and stop.
  • drift (exit 1): one or more findings. Read each entry in the findings array. Each has file, severity (high/medium/low), category, and message.
  • error (exit 2): hard failure (missing repo root, script bug). Report the error and stop.

When drift is found

  1. Load references/CLAUDE_MD_PATTERNS.md - it documents the five canonical patterns and the common drift modes. Read it only when needed (progressive disclosure).
  2. Group findings by severity. Address high first.
  3. For each finding, propose the minimal correction. Cite the file and line.
  4. If the user passed --fix, the script already corrected obvious path typos. Re-run without --fix to confirm.

Voice rules for any rewrites you propose

This is a Tim Warner course repo. Match the voice in segment_4_hero/CLAUDE.md:

  • Bold key terms.
  • No em dashes. Hyphens with spaces, commas, or periods only.
  • Never use "ask" as a noun.
  • Sentence-case headings.
  • First-principles, plain-spoken, mildly irreverent. No corporate-speak.

What the script does NOT check

  • Whether the lesson prose in each CLAUDE.md is pedagogically sound. That's a human judgment.
  • Whether new files added to the repo should be mentioned in a CLAUDE.md. Suggest additions only when the diff is obvious.

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.