Score, fix, and generate production-ready CLAUDE.md files.
npx @vikassah/claudemd-lint ./CLAUDE.md
claudemd-lint is an npm tool for maintaining the quality of CLAUDE.md files — the project instruction files that Claude Code reads to understand your codebase and follow your conventions. It scores your CLAUDE.md on a 1–10 scale across seven quality dimensions: consistency, staleness, redundancy, scope, tokens, actionability, and maintainability.
Beyond scoring, it can auto-fix common problems — removing boilerplate, duplicate content blocks, and filler language that waste tokens without adding value. For projects that don't have a CLAUDE.md yet, the generate command deep-scans your codebase and produces a production-ready file from scratch, extracting architecture patterns, API endpoints, environment variables, development conventions, and known gotchas.
It integrates with CI/CD pipelines via GitHub Actions and supports monorepos through automatic CLAUDE.md discovery. A Shields.io badge can be generated to display your score in your README.
Rates your CLAUDE.md 1–10 across seven dimensions: consistency, staleness, redundancy, scope, tokens, actionability, and maintainability. Shows a per-dimension breakdown with specific issues.
Automatically removes boilerplate, duplicate content blocks, and filler language that inflate token count without helping Claude. Run with --fix — changes are written in place.
Run generate to deep-scan your project and produce a production-ready CLAUDE.md from scratch, including architecture, API endpoints, environment variables, and conventions.
GitHub Actions integration with configurable minimum score thresholds and exit codes. --discover finds and lints all CLAUDE.md files across monorepo subdirectories.
Run npx @vikassah/claudemd-lint ./CLAUDE.md. This prints a 1–10 score with a per-dimension breakdown and a list of specific issues found in your file.
Run npx @vikassah/claudemd-lint ./CLAUDE.md --fix to automatically remove boilerplate, duplicates, and filler. The fixed file is written in place.
Run npx @vikassah/claudemd-lint generate from your project root to produce a production-ready CLAUDE.md by scanning your codebase for architecture, endpoints, and conventions.
Add npx @vikassah/claudemd-lint ./CLAUDE.md --min-score 7 --fail to your GitHub Actions workflow. The pipeline blocks if the score falls below the configured threshold.
claudemd-lint is an npm tool that scores, fixes, and generates CLAUDE.md files — the project instruction files read by Claude Code. It rates your CLAUDE.md on a 1–10 scale across seven quality dimensions and can generate one from scratch by scanning your codebase. Available via npx @vikassah/claudemd-lint.
Run it directly with npx without installing: npx @vikassah/claudemd-lint ./CLAUDE.md. To install globally: npm install -g @vikassah/claudemd-lint. It also works as a Claude Code MCP plugin for direct in-session integration.
The 1–10 score rates your CLAUDE.md across seven dimensions: consistency (no contradictory instructions), staleness (no references to deleted or renamed files), redundancy (no duplicate content), scope (focused, relevant instructions), tokens (not bloated), actionability (rules Claude can actually follow), and maintainability (easy to keep up to date).
claudemd-lint detects contradictory instructions, references to deleted or renamed files, vague rules that Claude cannot follow, duplicate content blocks, excessive word count that wastes tokens, and missing documentation sections that Claude Code expects.
Yes. Run npx @vikassah/claudemd-lint generate from your project root. It deep-scans your codebase to extract architecture patterns, API endpoints, environment variables, development conventions, and known gotchas, then produces a production-ready CLAUDE.md tailored to your project.
Add this step to your GitHub Actions workflow: npx @vikassah/claudemd-lint ./CLAUDE.md --min-score 7 --fail. The --fail flag exits with code 1 if the score falls below the threshold, blocking the pipeline. Adjust --min-score to your quality bar.
Yes. Run npx @vikassah/claudemd-lint --discover to automatically find and lint all CLAUDE.md files across subdirectories in a monorepo. Each file is scored independently and results are summarized in aggregate.