skills.rest
tygwan
tygwanCOMMUNITY
Explore all skills by this author →
GitHub

readme-sync

Scan the .claude directory and update README sections to match project components.

1|Updated Jan 9, 2026
Search Tags:#automation#documentation#markdown#repository#readme-sync#docs-maintenance
One-click install
npx skills add https://github.com/tygwan/AgenticREVIT --skill readme-sync
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: readme-sync
Source: https://github.com/tygwan/AgenticREVIT/tree/main/.claude/skills/readme-sync
Command: npx skills add https://github.com/tygwan/AgenticREVIT --skill readme-sync

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Automatically keeps README.md synchronized with actual project components. Scans the .claude directory structure and updates documentation to match reality.

Core Features & Use Cases

  • Section synchronization: Keeps Agents, Skills, Hooks, Commands sections up to date with actual files.
  • Incremental updates: Detects changes and updates only relevant parts.
  • Use Case: When you add a new skill or agent, run /readme-sync to refresh the README to reflect new components.

Quick Start

Use the readme-sync command to align README with current components.

Frequently Asked Questions about readme-sync

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

FAQPage Schema
How do I keep my README synchronized with project components?▼

README synchronization automatically updates your documentation to match actual project files. Run the readme-sync command to scan your .claude directory and refresh Agents, Skills, Hooks, and Commands sections without manual edits, ensuring documentation stays aligned with your current codebase.

Can I automate documentation updates when I add new agents or skills?▼

Yes. Documentation automation detects new components in your repository and updates only the relevant README sections. After adding a skill or agent, execute readme-sync to apply incremental updates that reflect the actual component presence without rewriting the entire file.

What does readme-sync actually scan to update documentation?▼

The skill scans the .claude directory structure to parse component metadata and frontmatter. It detects agents, skills, hooks, and commands present in your repository, then updates corresponding README sections deterministically based on what it finds.

How does incremental documentation updating work with readme-sync?▼

Incremental updating detects changes in your component directory and refreshes only affected README sections. Rather than full rewrites, it identifies which agents, skills, or commands have been added or modified, then applies targeted updates to keep documentation in sync.

Do I need to manually edit README sections after adding repository components?▼

No. Documentation maintenance is automated. The readme-sync skill eliminates manual README edits by detecting new components in the .claude directory and updating agent, skill, hook, and command sections automatically, keeping your documentation deterministic and current.

Related Skills

Explore More Software Engineering Skills→
masharrattmasharratt
14

cfn-agent-discovery

Scan .claude/agents directory and generate agents-registry.json with metadata.

Community
Intermediate
koki3141koki3141
2

readme-updater

Synchronize README updates from code changes using Git triggers.

Community
Intermediate
antoniocascaisantoniocascais
11

skill-creator

Generate a Claude Code skill scaffold with SKILL.md frontmatter and folder structure.

Community
Basic
pradyumnasagarpradyumnasagar
6

cross-reference-mapper

Generate and validate cross-references between ORS skills.

Community
Intermediate