claude-md-check
npx machina-cli add skill claude-world/director-mode-lite/claude-md-check --openclawFiles (1)
SKILL.md
1.2 KB
CLAUDE.md Validator
Validate the project's CLAUDE.md file for completeness and best practices.
Validation Checklist
Required Sections (Must Have)
- Project Overview - Brief description
- Tech Stack - Languages, frameworks, tools
- Commands - dev, test, build commands
Recommended Sections (Should Have)
- Conventions - Coding standards
- Key Files - Important files
- Architecture - Directory structure
Quality Checks
- No secrets - No API keys in file
- Correct commands - Listed commands work
- Up to date - Matches actual dependencies
Output Format
## CLAUDE.md Validation Report
### Status: PASS / NEEDS IMPROVEMENT / MISSING
### Required Sections
| Section | Status | Notes |
|---------|--------|-------|
| Project Overview | | |
| Tech Stack | | |
| Commands | | |
### Issues Found
1. [Issue and how to fix]
### Suggestions
1. [Improvement]
Auto-Fix
If issues found, offer to:
- Add missing sections with placeholders
- Update tech stack from package.json
- Verify and correct commands
Source
git clone https://github.com/claude-world/director-mode-lite/blob/main/skills/claude-md-check/SKILL.mdView on GitHub Overview
Validates CLAUDE.md for completeness against a defined checklist. It ensures required sections, recommended sections, and quality checks are present and accurate.
How This Skill Works
The validator parses CLAUDE.md, verifies the presence of required sections (Project Overview, Tech Stack, Commands) and recommended sections (Conventions, Key Files, Architecture), and runs quality checks (no secrets, correct commands, up-to-date dependencies). If issues are found, it suggests an Auto-Fix path to add placeholders and align the tech stack with package.json, then re-checks for accuracy.
When to Use It
- Creating or auditing a new CLAUDE.md for a project
- Preparing a PR to ensure documentation meets standards
- Onboarding new contributors who maintain CLAUDE.md
- After dependency updates to verify tech stack accuracy
- Before releasing a project to verify documentation quality
Quick Start
- Step 1: Run claude-md-check on CLAUDE.md
- Step 2: Review the Validation Report for missing sections and issues
- Step 3: Apply Auto-Fix if needed and re-run to confirm completeness
Best Practices
- Verify all required sections exist and are up-to-date
- Keep Tech Stack aligned with package.json
- Ensure listed commands are functional in the project environment
- Regularly scan CLAUDE.md for secrets or sensitive data
- Use Auto-Fix to scaffold missing sections when initializing or updating docs
Example Use Cases
- Audit a fresh CLAUDE.md to confirm required sections (Overview, Tech Stack, Commands) are present
- Update CLAUDE.md after adding new dependencies to keep Tech Stack accurate
- Repair a CLAUDE.md missing Architecture and Key Files by applying placeholders
- Validate CLAUDE.md before a major release to ensure documentation quality
- Run Auto-Fix to scaffold missing sections based on the SKILL.md guidelines
Frequently Asked Questions
Add this skill to your agents
