skills.rest
takuto277
takuto277COMMUNITY
Explore all skills by this author →
GitHub

skills-readme-sync

Synchronize the central README with skills under .cursor/skills by parsing SKILL.md entries.

1|Updated Mar 24, 2026
Search Tags:#automation#documentation#readme#repository-management#readme-update#skills-sync
One-click install
npx skills add https://github.com/takuto277/levelup-study --skill skills-readme-sync
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: skills-readme-sync
Source: https://github.com/takuto277/levelup-study/tree/main/.cursor/skills/skills-readme-sync
Command: npx skills add https://github.com/takuto277/levelup-study --skill skills-readme-sync

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill ensures the central README's Available Skills list accurately reflects the .cursor/skills, automatically syncing entries when skills are added, renamed, or removed.

Core Features & Use Cases

  • Keeps the README aligned with the live skill directory by updating the Available Skills section.
  • Facilitates maintenance when SKILL.md descriptions change or new skills are introduced.
  • Use Case: Add a new skill under .cursor/skills and run the sync to refresh the README.

Quick Start

Synchronize the README to reflect the current skill set.

Frequently Asked Questions about skills-readme-sync

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

FAQPage Schema
How do I automatically update a README file when skills are added or renamed?▼

To update a README automatically when skills change, this Skill parses each SKILL.md entry under .cursor/skills and synchronizes the central README's Available Skills list to reflect the live catalog.

What is the best way to keep a repository's skill catalog aligned with its documentation?▼

Keeping a repository's skill catalog aligned requires parsing .cursor/skills directories for valid SKILL.md frontmatter and running a deterministic script-based workflow to refresh the README entries.

How does frontmatter validation work when syncing a README to a skill directory?▼

Frontmatter validation works by checking each SKILL.md file for required name and description fields, enforcing validity before the central README is synchronized with the current skill set.

Do I need any external dependencies to sync a README with my .cursor/skills directory?▼

No external dependencies are needed to sync a README, as the Skill operates independently to parse SKILL.md entries and execute a script-based workflow to refresh the documentation.

When should I run a README sync for my repository's skill set?▼

You should run a README sync whenever skills are added, renamed, or removed, ensuring the README accurately reflects the live skill catalog under .cursor/skills.

Why does my README show outdated skill descriptions after modifying SKILL.md files?▼

A README shows outdated skill descriptions because the central documentation has not been refreshed; running the sync workflow parses the updated SKILL.md entries and overwrites the Available Skills list.

Related Skills

Explore More Content & Communication Skills→
andreaswasitaandreaswasita
33

writing-skills

Enforce consistent YAML frontmatter and structure in SKILL.md files.

Community
Basic
zapierzapier
373

Git Commit

Generate Conventional Commits with Jira context and push changes.

Official
Advanced
tecnologia-ibtechtecnologia-ibtech

audit-project

Audit Codex configuration for health, drift, and completeness issues.

Community
Advanced
brainbrewlabsbrainbrewlabs
7

doc-publishing

Publishes documentation to GitHub Pages, Vercel, or Netlify from source docs and build outputs.

Official
Intermediate