commandby softaworks
Sync Skills Readme
Sync root README.md with current skills inventory from skills/ directory
Installs: 0
Used in: 1 repos
Updated: 0mo ago
$
npx ai-builder add command softaworks/sync-skills-readmeInstalls to .claude/commands/sync-skills-readme.md
# Sync Skills README Update the root README.md "Available Skills" table with all skills currently in the `skills/` directory. This command scans skills, reads their metadata, categorizes them, and regenerates the table. ## Workflow ### 1. Scan Skills Directory Use Bash to list all skill directories: ```bash ls -1 skills/ ``` For each skill directory found, proceed to step 2. ### 2. Extract Skill Metadata For each skill, read the SKILL.md frontmatter to extract: - `name:` field (skill identifier) - `description:` field (what the skill does) Use the Read tool to read `skills/[skill-name]/SKILL.md` and extract the YAML frontmatter between the `---` markers. **Example:** ```yaml --- name: codex description: Use when the user asks to run Codex CLI for code analysis... --- ``` Extract both fields for table generation. ### 3. Categorize Skills Assign each skill to a category based on its purpose. Use this mapping: | Category | Emoji | Keywords in name/description | |----------|-------|------------------------------| | AI Tools | ๐ค | codex, gemini, perplexity, ai, llm, model | | Meta | ๐ฎ | command-creator, plugin-forge, plugin, command | | Documentation | ๐ | docs, documentation, handoff, requirements, diagram, mermaid, draw, excalidraw, marp, slide, c4-architecture | | Development | ๐ ๏ธ | session, handoff, entropy, development, workflow, database, dependency | | Design & Frontend | ๐จ | design, frontend, ui, openapi, typescript, system | | Utilities | ๐ง | domain, meme, web-to-markdown, utility, tool, datadog | | Planning | ๐ฏ | plan, planning, spec, forge, gepetto, requirements, clarity, game-changing, features | | Professional | ๐ | professional, communication, career, soft-skill, feedback, conversation | | Testing | ๐งช | test, testing, qa, quality | | Git | ๐ฆ | commit, git, branch, pr, pull-request | **Categorization logic:** 1. Check the skill name and description (case-insensitive) 2. Match against keywords in the table above 3. Assign to the first matching category 4. If no match, default to "Utilities" (๐ง) ### 4. Generate Compact Table Create a markdown table with this exact format: ```markdown ## ๐ Available Skills | Category | Skill | Description | |----------|-------|-------------| | ๐ค AI Tools | [codex](skills/codex/README.md) | Advanced code analysis with GPT-5.2 | | ๐ค AI Tools | [gemini](skills/gemini/README.md) | Large-scale review (200k+ context) | ... ``` **Table structure:** - Column 1: Category emoji + name (e.g., "๐ค AI Tools") - Column 2: Skill name as markdown link to its README - Column 3: Short description (max ~50 chars, extracted from SKILL.md description field) **Sorting:** - Group by category (AI Tools first, then Meta, Documentation, Design & Frontend, Development, Planning, Professional, Testing, Git, Utilities last) - Within each category, sort skills alphabetically by name **Description shortening:** - If description is longer than 50 characters, create a shortened version - Keep it concise and action-oriented - Examples: - "Use when the user asks to run Codex CLI for code analysis, refactoring, or automated editing" โ "Advanced code analysis with GPT-5.2" - "Create comprehensive API handoff documentation for frontend developers after backend implementation" โ "API handoff docs for frontend" ### 5. Update README.md Use the Edit tool to replace the "Available Skills" section in the root README.md. **Find and replace:** 1. Locate the section starting with `## ๐ Available Skills` 2. Find the end of the table (marked by the next `---` separator or next `##` heading) 3. Replace everything between those markers with the newly generated table **Important:** - Preserve the `---` separator after the table - Do NOT modify other sections (Quick Navigation, Installation, etc.) - Only replace the table content, keep the section heading ### 6. Report Results After updating README.md, report to the user: ``` โ README.md updated successfully ๐ Summary: - Total skills: [count] - Categories: [list of categories with counts] - Skills added/updated: [list if any changes detected] The Available Skills table in README.md now reflects all skills in the skills/ directory. ``` ## Error Handling **If a skill directory doesn't have SKILL.md:** - Skip that skill - Warn the user: "โ ๏ธ Skipped [skill-name]: No SKILL.md found" **If SKILL.md doesn't have required frontmatter:** - Skip that skill - Warn: "โ ๏ธ Skipped [skill-name]: Missing name or description in frontmatter" **If README.md section not found:** - Error and stop: "โ Could not find '## ๐ Available Skills' section in README.md" ## Tools to Use - **Bash** - List skills directory - **Read** - Read SKILL.md files for metadata extraction - **Edit** - Update README.md with new table - **DO NOT use Grep** - Read files directly for accurate frontmatter parsing ## Success Criteria - All valid skills from skills/ directory appear in the table - Skills are correctly categorized with appropriate emojis - Table maintains compact format (3 columns) - Descriptions are concise and readable - README.md is updated without breaking other sections
Quick Install
$
npx ai-builder add command softaworks/sync-skills-readmeDetails
- Type
- command
- Author
- softaworks
- Slug
- softaworks/sync-skills-readme
- Created
- 0mo ago