OpenParable
Skip to content
← Back to skills

Readme Sync

Documents
readme-sync

Readme Sync is an Agent Skill for documents published in the majiayu000/claude-skill-registry repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.

Synchronizes the list of Agent Skills in the root README.md with the actual skills present in the codebase.

View on GitHub ↗
QUICK START

How to use this skill

Bring this guide into your coding agent with a prompt tailored to the tool you use.

  1. Open your project in Codex.
  2. Copy and paste the prompt below.
  3. Review files and risks before approving any action.
Prompt to paste
Inspect the Agent Skill at https://github.com/majiayu000/claude-skill-registry/blob/HEAD/skills/data/readme-sync/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/readme-sync, but wait for my approval before writing files or running scripts.

Copying this prompt does not install or run the skill. Review third-party files before use.

README Sync

Purpose

Ensures that the ## Agents and ## Agent Skills sections in the root README.md accurately reflect all available agents in agents/ and skills in skills/.

Workflow

  1. Identify Items:
    • Locate all agents: Files ending in .md in agents/ (excluding .gitkeep).
    • Locate all skills: Directories in skills/ containing a SKILL.md file.
  2. Extract Information:
    • For skills: Use uv run skills-ref read-properties <skill-directory> to get the name and description.
    • For agents: Read the YAML frontmatter directly from the .md file to extract name and description.
  3. Generate Markdown: Format the collected information as sorted lists:
    • Format: - **[name](relative/path/to/item)**: description
    • Note: For agents, the link should point to the .md file. For skills, the link should point to the directory.
  4. Update README.md:
    • Replace content between <!-- START-AGENTS --> and <!-- END-AGENTS --> with the agents list.
    • Replace content between <!-- START-SKILLS --> and <!-- END-SKILLS --> with the skills list.

Implementation Notes

  • The skills-ref tool is used for skills in skills/.
  • For agents in agents/, extract the name and description from the YAML frontmatter (lines between ---).
  • Always maintain alphabetical order of the items in each section.
  • Ensure the relative paths in the markdown links correctly point to the items from the root.
  • Do not include items from .cursor/skills/ or .cursor/agents/.

Examples

Scenario: Updating README.md after adding a new skill

  1. Find all skills in the directory skills/.
  2. Get properties for each skill: uv run skills-ref read-properties skills/claude-code-cli.
  3. Update README.md within the <!-- START-SKILLS --> block.