sync-skills-readmelisted
Install: claude install-skill karozi/awesome-product-management-skills
# Sync Skills README
Keep the repository's skills index derived from its skill packages while preserving every human-written section outside the generated catalog.
## Source of Truth
Treat each `skills/<category>/<skill>/SKILL.md` package as authoritative.
- Read the skill name and fallback summary from `SKILL.md` frontmatter.
- Prefer `agents/openai.yaml` values `display_name` and `short_description` for catalog copy when present.
- Derive the category label from the category directory name.
- Sort categories and skills alphabetically so repeated runs are deterministic.
The bundled generator owns only the content between these markers:
```markdown
<!-- BEGIN GENERATED SKILLS INDEX -->
<!-- Generated by sync-skills-readme. Do not edit inside these markers. -->
<!-- END GENERATED SKILLS INDEX -->
```
On its first run, it converts the existing `## Skills` section to a marked generated block. Later runs replace only that block. It stops on malformed markers, invalid frontmatter, folder/name mismatches, duplicate skill names, or an empty skills directory instead of guessing.
## Sync the Catalog
1. Locate the repository root. Inspect `README.md`, the skill tree, and local repository instructions before changing anything.
2. Run the bundled script with the target repository passed explicitly:
```bash
python3 <skill-root>/scripts/sync_skills_readme.py --repo-root <repository-root> --write
```
3. Review the README diff. Confirm that human-written content outside t