claudemd

command
v0.14.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 12, 2026 License: AGPL-3.0 Imports: 16 Imported by: 0

Documentation

Overview

Command claudemd holds the repo's docs to the conventions the root CLAUDE.md sets out. It fails on structure: line, byte and line-length budgets; self-deferring phrases; package files titled by their dir with every rule saying what guards it; a CLAUDE.md covering every Go package; local links that resolve; no orphan docs/claude guides; a skills list matching .claude/skills; code fences that close (an open one hides the rest of its file); no .claude/CLAUDE.md or .claude/rules/, which load without these checks; exemptions and idents.allow entries that still earn their place; and the identifiers it can check without false positives (repo paths, globs, file.go:Symbol, Go test names). With -idents it also reports other backticked symbols it can't find in source, which is advisory unless -strict.

It checks structure, not truth: a rule naming a symbol that moved can still pass. docs/claude/auditing-claude-md-currency.md is the audit for that.

go run ./tools/claudemd            # structure; exit 1 on a problem
go run ./tools/claudemd -v         # plus each CLAUDE.md's budget headroom
go run ./tools/claudemd -idents    # plus the advisory symbol report

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL