sync-claude

Validate and synchronize CLAUDE.md and SKILL.md documentation before commits.

24|3|Updated Mar 31, 2022

Search Tags:#documentation #validation #claude #pre-commit #docs #ci

Ready to run

npx skills add https://github.com/ionfury/homelab --skill sync-claude

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: sync-claude
Source: https://github.com/ionfury/homelab/tree/main/.claude/skills/sync-claude
Command: npx skills add https://github.com/ionfury/homelab --skill sync-claude

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires git, jq, perl, and includes scripts (resource) components.

What problem does it solve?

Synchronize and validate Claude documentation (CLAUDE.md files and skills) before commits to ensure documentation accuracy and alignment with codebase state.

Core Features & Use Cases

Discovery of Claude docs across CLAUDE.md, SKILL.md, and references.
Parallel validation via Haiku agents covering path, code, commands, and cross-reference checks.
Change-impact analysis to focus on impacted docs on the active branch.
Aggregated reporting with proposed edits to fix issues before commits.
Use Case: before creating a PR, run to ensure docs reflect current code state.

Quick Start

Run the sync-claude skill in your CI to validate and synchronize Claude docs and skills before commit.

Frequently Asked Questions about sync-claude

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

How do I validate Claude documentation before a git commit?▼

To validate Claude documentation before a git commit, you can run the sync-claude skill in your CI pipeline. It discovers and validates CLAUDE.md and SKILL.md files, checking paths, code, commands, and cross-references to ensure docs reflect the current codebase state.

What is the best way to keep CLAUDE.md files accurate with my codebase?▼

The best way to keep CLAUDE.md files accurate is to use a pre-commit validation skill like sync-claude. It performs change-impact analysis on your active branch and proposes aggregated edits to fix documentation alignment issues before they enter your repository.

Can I run documentation cross-reference checks only on changed files?▼

Yes, you can run documentation cross-reference checks on changed files using the changed mode. This performs change-impact analysis to focus validation only on the Claude docs and skills impacted by modifications on your active branch.

Do I need jq and perl to validate Claude skills in CI?▼

Yes, you need jq and perl installed along with git to run the sync-claude skill. These dependencies are required for the scripts that discover, parse, and validate your Claude documentation and skills during pre-commit checks.

How does parallel validation work for Claude documentation?▼

Parallel validation for Claude documentation works by deploying Haiku agents to check paths, code, commands, and cross-references simultaneously. An Opus-like aggregator then compiles these results into a single report with proposed edits.