README Sync
Purpose
Ensures that the ## Agent Skills section in the root README.md accurately reflects all available skills in skills/.
Workflow
- •Identify Skills: Use
Globorfindto locate allSKILL.mdfiles inskills/and.cursor/skills/. - •Extract Information: For each skill found, use
uv run skills-ref read-properties <skill-directory>to get thenameanddescription. - •Generate Markdown: Format the collected information as a sorted list of markdown items:
- •Format:
- **[name](relative/path/to/skill/)**: description
- •Format:
- •Update README.md: Replace the content between
<!-- START-SKILLS -->and<!-- END-SKILLS -->markers in the rootREADME.mdwith the newly generated list.
Implementation Notes
- •The
skills-reftool is part of the project dependencies and can be run viauv run. - •Always maintain alphabetical order of the skills in the
README.mdlist. - •Ensure the relative paths in the markdown links correctly point to the skill directories from the root.
Examples
Scenario: Updating README.md after adding a new skill
- •Find all skills in the directory
skills/. - •Get properties for each skill:
uv run skills-ref read-properties skills/claude-code-cli. - •Update
README.mdwithin the<!-- START-SKILLS -->block.