Back to Details

skills-readme-updater

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Skills README Updater

Skills README 更新工具

Automatically scan and update the skills README.md when skills are added, modified, or removed.
当技能被添加、修改或移除时，自动扫描并更新技能的README.md文件。

Usage

使用方法

After adding or modifying a skill, run the update script:
bash
python3 ~/.claude/skills/skills-readme-updater/scripts/update_readme.py
The script will:
  1. Scan all subdirectories in 
    ~/.claude/skills/
  2. Parse YAML frontmatter from each 
    SKILL.md
  3. Categorize skills based on predefined categories
  4. Generate an updated 
    README.md
    with:
    • Categorized skill tables
    • Directory structure
    • Usage instructions
    • Timestamp
添加或修改技能后，运行更新脚本：
bash
python3 ~/.claude/skills/skills-readme-updater/scripts/update_readme.py
该脚本将执行以下操作：
  1. 扫描
    ~/.claude/skills/
    中的所有子目录
  2. 解析每个
    SKILL.md
    文件中的YAML前置元数据
  3. 根据预定义类别对技能进行分类
  4. 生成更新后的
    README.md
    文件，包含：
    • 分类技能表格
    • 目录结构
    • 使用说明
    • 时间戳

Categories

分类

Skills are organized into these categories:
CategorySkills
云基础设施aws-cli, aws-cost-explorer, eksctl
Kubernetes & GitOpskubectl, 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
.
技能被归类到以下类别中：
分类技能
云基础设施aws-cli, aws-cost-explorer, eksctl
Kubernetes & GitOpskubectl, argocd-cli, kargo-cli, sync-to-prod
代码仓库github-cli, gitlab-cli, changelog-generator
开发工具justfile, skill-creator, skills-readme-updater
内容处理humanizer-zh, obsidian-dashboard
若要添加新类别或重新分配技能，请编辑
scripts/update_readme.py
中的
CATEGORIES
字典。

Workflow: Adding a New Skill

工作流程：添加新技能

  1. Create the skill using 
    skill-creator
  2. Edit 
    SKILL.md
    with proper metadata
  3. Run the README updater:
    bash
    python3 ~/.claude/skills/skills-readme-updater/scripts/update_readme.py
  4. Verify the README was updated correctly
  1. 使用
    skill-creator
    创建技能
  2. 编辑
    SKILL.md
    文件并添加正确的元数据
  3. 运行README更新工具：
    bash
    undefined
python3 ~/.claude/skills/skills-readme-updater/scripts/update_readme.py
4. 验证README是否已正确更新