About skills-readme-updater
A script-based skill that refreshes the skills README.md after skills are added, changed, or removed. It scans SKILL.md metadata, groups skills into predefined categories, and generates categorized tables, directory details, usage instructions, and a timestamp.
Key features
- 01Scans skill subdirectories
- 02Parses SKILL.md YAML frontmatter
- 03Groups skills into predefined categories
- 04Generates README tables and details
- 05Includes usage instructions and timestamp
Use cases
- 01Refreshing the skills index after adding a skill
- 02Rebuilding README listings after skill edits
- 03Updating categories and directory documentation
Install
Copy the command and run it in a terminal.
$
npx skills add https:/ / github.com/ oldwinter/ skills --skill skills-readme-updaterAfter installing, type/skills-readme-updaterin Claude Code to confirm it loaded.
Bundled filesscripts/update_readme.py
Details
From the project READMESkills README Updater
Automatically scan and update the skills README.md when skills are added, modified, or removed.
Usage
After adding or modifying a skill, run the update script:
python3 ~/.claude/skills/skills-readme-updater/scripts/update_readme.py
The script will:
- Scan all subdirectories in
~/.claude/skills/ - Parse YAML frontmatter from each
SKILL.md - Categorize skills based on predefined categories
- Generate an updated
README.mdwith:- Categorized skill tables
- Directory structure
- Usage instructions
- Timestamp
Categories
Skills are organized into these categories:
| Category | Skills |
|---|---|
| 云基础设施 | aws-cli, aws-cost-explorer, eksctl |
| Kubernetes & GitOps | kubectl, argocd-cli, kargo-cli, sync-to-prod |
| 代码仓库 | github-cli, gitlab-cli, changelog-generator |
| 开发工具 | justfile, skill-creator, skills-readme-updater |
| 内容处理 | humanizer-zh, obsidian-dashboard |
To add a new category or reassign skills, edit the CATEGORIES dict in scripts/update_readme.py.
Workflow: Adding a New Skill
- Create the skill using
skill-creator - Edit
SKILL.mdwith proper metadata - Run the README updater:
python3 ~/.claude/skills/skills-readme-updater/scripts/update_readme.py - Verify the README was updated correctly
Comments
Markdown supported