Claude-MD-Validate Command - Comprehensive CLAUDE.md Quality Validation Framework
Validates CLAUDE.md files with comprehensive reference checking, template compliance, and quality scoring.
/plugin marketplace add jleechanorg/claude-commands/plugin install claude-commands@claude-commands-marketplaceWhen this command is invoked, YOU (Claude) must execute these steps immediately: This is NOT documentation - these are COMMANDS to execute right now. Use TodoWrite to track progress through multi-phase workflows.
Action Steps:
Action Steps:
1. **Directory Discovery**
- Scan for all CLAUDE.md files in directory tree
- Map inheritance relationships
- Identify validation scope (single directory vs. multi-directory)
- Initialize validation tracking structures
2. **Reference Cataloging**
- Extract all file references from CLAUDE.md content
- Catalog command references and cross-links
- Map relative path relationships
- Build comprehensive reference database
3. **Baseline Establishment**
- Document current validation baseline
- Set quality thresholds and targets
- Initialize scoring matrices
- Prepare validation report templates
Action Steps:
1. **File Reference Validation**
- Execute file existence checks for all references
- Validate command file mappings
- Test relative path resolution
- Verify script and tool accessibility
- Generate reference accuracy report
2. **Template Compliance Verification**
- Check structural hierarchy and organization
- Validate required section presence
- Verify formatting consistency
- Assess protocol symbol usage
- Generate compliance scorecard
3. **Cross-Directory Consistency Check**
- Validate inheritance chain integrity
- Test reference path resolution from all contexts
- Check content synchronization status
- Verify bidirectional reference accuracy
- Generate consistency assessment
4. **Content Quality Assessment**
- Score accuracy of technical information
- Evaluate completeness of coverage
- Assess clarity and readability
- Measure actionability of guidance
- Evaluate maintenance and currency
- Generate quality metrics report
Action Steps:
1. **Integration Compatibility**
- Test compatibility with `/fake3` infrastructure
- Verify git workflow hook integration
- Assess batch validation capabilities
- Check reporting system integration
2. **Deployment Readiness Evaluation**
- Calculate overall quality score
- Assess go/no-go criteria satisfaction
- Generate deployment recommendation
- Identify critical blocking issues
3. **Comprehensive Reporting**
- Generate JSON validation reports
- Create detailed markdown summaries
- Produce executive summary with scores
- Provide actionable fix recommendations
Action Steps:
Purpose: Automated quality validation framework for CLAUDE.md files with comprehensive file reference validation, template compliance checking, cross-directory consistency verification, and content quality assessment.
Usage: /claude-md-validate [--scope=<directory>] [--mode=<validation_mode>] [--output-format=<json|markdown|summary>] - Comprehensive validation with detailed reporting
Scope: Multi-directory validation with inheritance chain verification and reference integrity checking
Type: Pure LLM-orchestrated quality assurance command (integrates with existing /fake3 infrastructure)
The /claude-md-validate command provides enterprise-grade quality validation for CLAUDE.md documentation:
Critical Validation Points:
/command references map to existing .claude/commands/*.md filesValidation Process:
1. **Parse File References**
- Extract all file paths from CLAUDE.md content
- Identify command references (e.g., `/fake3`, `/orchestrate`)
- Catalog cross-references between directories
- Map inheritance relationships
2. **Verify Reference Accuracy**
- Check file existence: `test -f <path>` for each reference
- Validate command files: verify `.claude/commands/<command>.md` exists
- Test relative paths: resolve inheritance chains
- Confirm script executability: check permissions on referenced scripts
3. **Generate Reference Report**
- Total references found: [count]
- Valid references: [count]
- Broken references: [count] with specific file:line locations
- Reference accuracy: [percentage]
Template Standards Verification:
Compliance Checklist:
ā
Genesis Coder greeting protocol section present
ā
Mandatory branch header protocol section present
ā
Critical implementation rules section present
ā
File organization section with proper references
ā
Legend section with symbol definitions
ā
Meta-rules section with pre-action checkpoints
ā
Project overview section with accurate stack information
ā
Development guidelines with proper subsections
ā
Git workflow with critical rules highlighted
ā
Quick reference section with current commands
Inheritance Chain Validation:
Consistency Verification Process:
1. **Map Inheritance Hierarchy**
- Identify root CLAUDE.md location
- Map all child CLAUDE.md files
- Trace inheritance relationships
- Document override patterns
2. **Validate Reference Paths**
- Test relative path resolution from each directory
- Verify cross-references resolve correctly
- Check that inherited content remains accessible
- Confirm bidirectional reference integrity
3. **Content Synchronization Check**
- Compare inherited sections with source
- Identify content drift or staleness
- Flag outdated references or instructions
- Verify consistency of critical protocols
Quality Metrics and Scoring:
Content Quality Checklist:
**Accuracy Assessment:**
- Technical details match current implementation
- File paths and references are current
- Command syntax matches actual command definitions
- Code examples are functional and tested
**Completeness Assessment:**
- All critical workflows documented
- Edge cases and error scenarios covered
- Integration points clearly explained
- Prerequisites and dependencies listed
**Clarity Assessment:**
- Instructions are step-by-step and clear
- Technical jargon explained or avoided
- Examples provided for complex procedures
- Logical flow and organization
**Actionability Assessment:**
- Commands can be executed as documented
- Specific rather than vague guidance
- Clear success/failure criteria
- Troubleshooting information provided
**Maintenance Assessment:**
- Information is current and accurate
- No deprecated commands or procedures
- References to current tools and versions
- Regular update patterns evident
{
"validation_timestamp": "2025-01-XX-XXXXX",
"scope": "directory_path_or_multi_directory",
"overall_score": 9.2,
"status": "PASS|FAIL",
"thresholds": {
"reference_accuracy": ">= 95%",
"quality_score": ">= 9.0",
"compliance_score": ">= 90%"
},
"results": {
"file_references": {
"total_references": 156,
"valid_references": 151,
"broken_references": 5,
"accuracy_percentage": 96.8,
"status": "PASS",
"broken_reference_details": [
{
"file": "CLAUDE.md",
"line": 42,
"reference": ".claude/commands/nonexistent.md",
"error": "File does not exist",
"suggestion": "Check if command was renamed or moved"
}
]
},
"template_compliance": {
"score": 94,
"status": "PASS",
"required_sections_present": 18,
"required_sections_missing": 1,
"formatting_issues": 3,
"compliance_details": {
"structure_score": 95,
"formatting_score": 93,
"protocol_symbols_score": 96
}
},
"cross_directory_consistency": {
"inheritance_chains_valid": 4,
"inheritance_chains_broken": 0,
"reference_path_accuracy": 98.5,
"content_sync_score": 92,
"status": "PASS"
},
"content_quality": {
"overall_score": 9.1,
"accuracy_score": 9.3,
"completeness_score": 8.9,
"clarity_score": 9.2,
"actionability_score": 9.0,
"maintenance_score": 9.1,
"status": "PASS"
}
},
"deployment_recommendation": "APPROVED",
"critical_issues": [],
"recommendations": [
"Fix broken reference in CLAUDE.md line 42",
"Add missing 'Testing Protocol' section",
"Update command references to current versions"
]
}
# CLAUDE.md Validation Report
**Validation Date**: [timestamp]
**Scope**: [directory/multi-directory]
**Overall Score**: [score]/10
**Status**: [PASS/FAIL]
## šÆ Executive Summary
- **Reference Accuracy**: [percentage]% ([valid]/[total] references)
- **Template Compliance**: [score]%
- **Content Quality**: [score]/10
- **Deployment Status**: [APPROVED/BLOCKED/CONDITIONAL]
## š Detailed Results
### File Reference Validation
- ā
**Status**: [PASS/FAIL]
- š **Accuracy**: [percentage]%
- š **Issues Found**: [count]
[Detailed breakdown of broken references with file:line locations]
### Template Compliance
- ā
**Status**: [PASS/FAIL]
- š **Score**: [percentage]%
- š **Required Sections**: [present]/[total]
[Detailed compliance assessment]
### Cross-Directory Consistency
- ā
**Status**: [PASS/FAIL]
- š **Inheritance Chains**: [valid]/[total]
- š **Path Accuracy**: [percentage]%
[Detailed consistency assessment]
### Content Quality Assessment
- ā
**Overall Score**: [score]/10
- šÆ **Accuracy**: [score]/10
- š **Completeness**: [score]/10
- š” **Clarity**: [score]/10
- ā” **Actionability**: [score]/10
- š **Maintenance**: [score]/10
## šØ Critical Issues
[List of blocking issues that prevent deployment]
## š” Recommendations
[Prioritized list of improvements and fixes]
## š§ Integration Status
- ā
`/fake3` Infrastructure: [COMPATIBLE/INCOMPATIBLE]
- ā
Git Workflow Hooks: [INTEGRATED/PENDING]
- ā
Batch Validation: [SUPPORTED/LIMITED]
- ā
Reporting System: [OPERATIONAL/NEEDS_SETUP]
The command leverages advanced LLM capabilities for:
Integration with /fake3:
Git Workflow Integration:
# Pre-commit hook integration
.git/hooks/pre-commit:
#!/bin/bash
/claude-md-validate --scope=. --mode=pre-commit
if [ $? -ne 0 ]; then
echo "CLAUDE.md validation failed - commit blocked"
exit 1
fi
Batch Validation Support:
# Multi-directory validation
/claude-md-validate --scope=all --output-format=json > validation_report.json
# Directory-specific validation
/claude-md-validate --scope=mvp_site --mode=detailed
# CI/CD integration
/claude-md-validate --scope=. --mode=ci --output-format=json
--mode=comprehensive (default): Full validation across all frameworks--mode=quick: Essential validations only (references + critical compliance)--mode=references-only: File reference validation only--mode=quality-only: Content quality assessment only--mode=pre-commit: Optimized for git hook integration--mode=ci: Optimized for CI/CD pipeline integration--scope=. (default): Current directory only--scope=all: All directories with CLAUDE.md files--scope=<directory>: Specific directory path--scope=inheritance-chain: Follow complete inheritance chain--output-format=summary (default): Human-readable summary--output-format=json: Machine-readable JSON report--output-format=markdown: Detailed markdown report--output-format=metrics: Quality metrics onlyPASS Criteria:
ā
Reference accuracy ā„95%
ā
Template compliance ā„90%
ā
Content quality ā„9.0/10
ā
No critical blocking issues
ā
Integration compatibility confirmed
FAIL Criteria:
ā Reference accuracy <95%
ā Template compliance <90%
ā Content quality <9.0/10
ā Critical blocking issues present
ā Integration incompatibility detected
# Automatic validation before commits
git add CLAUDE.md
git commit -m "Update documentation"
# -> Triggers /claude-md-validate --mode=pre-commit
# -> Blocks commit if validation fails
# .github/workflows/claude-md-validation.yml
name: CLAUDE.md Validation
on: [push, pull_request]
jobs:
validate:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@sha
- name: Validate CLAUDE.md
run: /claude-md-validate --mode=ci --output-format=json
- name: Upload validation report
uses: actions/upload-artifact@sha
with:
name: claude-md-validation-report
path: validation_report.json
# Weekly quality assessment across all directories
/claude-md-validate --scope=all --mode=comprehensive --output-format=markdown > weekly_quality_report.md
# Quality trending analysis
/claude-md-validate --scope=all --mode=metrics --output-format=json >> quality_metrics_history.jsonl
The validation framework incorporates feedback through:
- Issue pattern learning from validation failures
- Quality metric refinement based on user feedback
- Template standard evolution tracking
- Integration enhancement based on workflow usage
This validation framework embodies the principle: "Comprehensive quality assurance through systematic validation, detailed reporting, and continuous improvement integration."