feat: add 4 universal skills from cli-ai-skills
- Add audio-transcriber skill (v1.2.0): Transform audio to Markdown with Whisper - Add youtube-summarizer skill (v1.2.0): Generate summaries from YouTube videos - Update prompt-engineer skill: Enhanced with 11 optimization frameworks - Update skill-creator skill: Improved automation workflow All skills are zero-config, cross-platform (Claude Code, Copilot CLI, Codex) and follow Quality Bar V4 standards. Source: https://github.com/ericgandrade/cli-ai-skills
This commit is contained in:
Eric Andrade
270
skills/skill-creator/README.md
Normal file
270
skills/skill-creator/README.md
Normal file
@@ -0,0 +1,270 @@
|
||||
# skill-creator
|
||||
|
||||
**Automate CLI skill creation with best practices built-in.**
|
||||
|
||||
## What It Does
|
||||
|
||||
The skill-creator automates the entire workflow of creating new CLI skills for GitHub Copilot CLI and Claude Code. It guides you through brainstorming, applies standardized templates, validates content quality, and handles installation—all while following Anthropic's official best practices.
|
||||
|
||||
## Key Features
|
||||
|
||||
- **🎯 Interactive Brainstorming** - Collaborative session to define skill purpose and scope
|
||||
- **✨ Template Automation** - Automatic file generation with zero manual configuration
|
||||
- **🔍 Quality Validation** - Built-in checks for YAML, content quality, and writing style
|
||||
- **📦 Flexible Installation** - Choose repository-only, global, or hybrid installation
|
||||
- **📊 Visual Progress Bar** - Real-time progress indicator showing completion status (e.g., `[████████████░░░░░░] 60% - Step 3/5`)
|
||||
- **🔗 Prompt Engineer Integration** - Optional enhancement using prompt-engineer skill
|
||||
|
||||
## When to Use
|
||||
|
||||
Use this skill when you want to:
|
||||
- Create a new CLI skill following official standards
|
||||
- Extend CLI functionality with custom capabilities
|
||||
- Package domain knowledge into a reusable skill format
|
||||
- Automate repetitive CLI tasks with a custom skill
|
||||
- Install skills locally or globally across your system
|
||||
|
||||
## Installation
|
||||
|
||||
### Prerequisites
|
||||
|
||||
This skill is part of the `cli-ai-skills` repository. To use it:
|
||||
|
||||
```bash
|
||||
# Clone the repository
|
||||
git clone https://github.com/yourusername/cli-ai-skills.git
|
||||
cd cli-ai-skills
|
||||
```
|
||||
|
||||
### Install Globally (Recommended)
|
||||
|
||||
Install via symlinks to make the skill available everywhere:
|
||||
|
||||
```bash
|
||||
# For GitHub Copilot CLI
|
||||
ln -sf "$(pwd)/.github/skills/skill-creator" ~/.copilot/skills/skill-creator
|
||||
|
||||
# For Claude Code
|
||||
ln -sf "$(pwd)/.claude/skills/skill-creator" ~/.claude/skills/skill-creator
|
||||
```
|
||||
|
||||
**Benefits of global installation:**
|
||||
- Works in any directory
|
||||
- Auto-updates when you `git pull` the repository
|
||||
- No configuration files needed
|
||||
|
||||
### Repository-Only Installation
|
||||
|
||||
If you prefer to use the skill only within this repository, no installation is needed. The skill will be available when working in the `cli-ai-skills` directory.
|
||||
|
||||
## Usage
|
||||
|
||||
### Basic Skill Creation
|
||||
|
||||
Simply ask the CLI to create a new skill:
|
||||
|
||||
```bash
|
||||
# GitHub Copilot CLI
|
||||
gh copilot "create a new skill for debugging Python errors"
|
||||
|
||||
# Claude Code
|
||||
claude "create a skill that helps with git workflows"
|
||||
```
|
||||
|
||||
The skill will guide you through with visual progress tracking:
|
||||
1. **Brainstorming** (20%) - Define purpose, triggers, and type
|
||||
2. **Prompt Enhancement** (40%, optional) - Enhance with prompt-engineer skill
|
||||
3. **File Generation** (60%) - Create files from templates
|
||||
4. **Validation** (80%) - Check quality and standards
|
||||
5. **Installation** (100%) - Choose local, global, or both
|
||||
|
||||
Each phase displays a progress bar:
|
||||
```
|
||||
[████████████░░░░░░] 60% - Step 3/5: File Generation
|
||||
```
|
||||
|
||||
### Advanced Usage
|
||||
|
||||
#### Create Code Generation Skill
|
||||
|
||||
```bash
|
||||
"Create a code skill that generates React components from descriptions"
|
||||
```
|
||||
|
||||
The skill will:
|
||||
- Use the specialized `code-skill-template.md`
|
||||
- Ask about specific frameworks (React, Vue, etc.)
|
||||
- Include code examples in the `examples/` folder
|
||||
|
||||
#### Create Documentation Skill
|
||||
|
||||
```bash
|
||||
"Build a skill that writes API documentation from code"
|
||||
```
|
||||
|
||||
The skill will:
|
||||
- Use `documentation-skill-template.md`
|
||||
- Ask about documentation formats
|
||||
- Set up references for style guides
|
||||
|
||||
#### Install for Specific Platform
|
||||
|
||||
```bash
|
||||
"Create a skill for Copilot only that analyzes TypeScript errors"
|
||||
```
|
||||
|
||||
The skill will:
|
||||
- Generate files only in `.github/skills/`
|
||||
- Skip Claude-specific installation
|
||||
- Validate against Copilot requirements
|
||||
|
||||
## Example Walkthrough
|
||||
|
||||
Here's what creating a skill looks like:
|
||||
|
||||
```
|
||||
You: "create a skill for database schema migrations"
|
||||
|
||||
[████░░░░░░░░░░░░░░] 20% - Step 1/5: Brainstorming & Planning
|
||||
|
||||
What should this skill do?
|
||||
> Helps users create and manage database schema migrations safely
|
||||
|
||||
When should it trigger? (3-5 phrases)
|
||||
> "create migration", "generate schema change", "migrate database"
|
||||
|
||||
What type of skill?
|
||||
> [×] General purpose
|
||||
|
||||
Which platforms?
|
||||
> [×] Both (Copilot + Claude)
|
||||
|
||||
[... continues through all phases ...]
|
||||
|
||||
🎉 Skill created successfully!
|
||||
|
||||
📦 Skill Name: database-migration
|
||||
📁 Location: .github/skills/database-migration/
|
||||
🔗 Installed: Global (Copilot + Claude)
|
||||
```
|
||||
|
||||
## File Structure
|
||||
|
||||
When you create a skill, this structure is generated:
|
||||
|
||||
```
|
||||
.github/skills/your-skill-name/
|
||||
├── SKILL.md # Main skill instructions (1.5-2k words)
|
||||
├── README.md # User-facing documentation (this file)
|
||||
├── references/ # Detailed guides (2k-5k words each)
|
||||
│ └── (empty, ready for extended docs)
|
||||
├── examples/ # Working code samples
|
||||
│ └── (empty, ready for examples)
|
||||
└── scripts/ # Executable utilities
|
||||
└── (empty, ready for automation)
|
||||
```
|
||||
|
||||
## Configuration
|
||||
|
||||
**No configuration needed!** This skill uses runtime discovery to:
|
||||
- Detect installed platforms (Copilot CLI, Claude Code)
|
||||
- Find repository root automatically
|
||||
- Extract author info from git config
|
||||
- Determine optimal file locations
|
||||
|
||||
## Validation
|
||||
|
||||
Every skill created is automatically validated for:
|
||||
- ✅ **YAML Frontmatter** - Required fields and format
|
||||
- ✅ **Description Format** - Third-person, trigger phrases
|
||||
- ✅ **Word Count** - 1,500-2,000 ideal, under 5,000 max
|
||||
- ✅ **Writing Style** - Imperative form, no second-person
|
||||
- ✅ **Progressive Disclosure** - Proper content organization
|
||||
|
||||
## Frameworks Used
|
||||
|
||||
This skill leverages several established methodologies:
|
||||
|
||||
- **Progressive Disclosure** - 3-level content hierarchy (metadata → SKILL.md → bundled resources)
|
||||
- **Bundled Resources Pattern** - References, examples, and scripts as separate files
|
||||
- **Anthropic Best Practices** - Official skill development standards
|
||||
- **Zero-Config Design** - Runtime discovery, no hardcoded values
|
||||
- **Template-Driven Generation** - Consistent structure across all skills
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### "Template not found" Error
|
||||
|
||||
Ensure you're in the `cli-ai-skills` repository or have cloned it:
|
||||
|
||||
```bash
|
||||
git clone https://github.com/yourusername/cli-ai-skills.git
|
||||
cd cli-ai-skills
|
||||
```
|
||||
|
||||
### "Platform not detected" Warning
|
||||
|
||||
If platforms aren't detected:
|
||||
1. Choose "Repository only" installation
|
||||
2. Manually specify platform during setup
|
||||
3. Install globally later using provided commands
|
||||
|
||||
### Validation Failures
|
||||
|
||||
If validation finds issues:
|
||||
- Review suggestions in the output
|
||||
- Choose automatic fixes for common problems
|
||||
- Manually edit files for complex issues
|
||||
- Re-run validation: `scripts/validate-skill-yaml.sh .github/skills/your-skill`
|
||||
|
||||
## Advanced Features
|
||||
|
||||
### Prompt Engineer Integration
|
||||
|
||||
Enhance your skill descriptions with AI:
|
||||
1. Enable during Phase 2 (Prompt Refinement)
|
||||
2. Skill will invoke `prompt-engineer` automatically
|
||||
3. Review enhanced output before proceeding
|
||||
|
||||
### Bundled Resources
|
||||
|
||||
For complex skills, use bundled resources:
|
||||
- **references/** - Detailed documentation (no word limit)
|
||||
- **examples/** - Working code samples users can run
|
||||
- **scripts/** - Automation utilities loaded on demand
|
||||
|
||||
### Version Management
|
||||
|
||||
Update existing skills:
|
||||
```bash
|
||||
scripts/update-skill-version.sh your-skill-name 1.1.0
|
||||
```
|
||||
|
||||
## Contributing
|
||||
|
||||
Created a useful skill? Share it:
|
||||
1. Ensure validation passes
|
||||
2. Add usage examples
|
||||
3. Update main README.md
|
||||
4. Submit a pull request
|
||||
|
||||
## Resources
|
||||
|
||||
- **Writing Style Guide:** `resources/templates/writing-style-guide.md`
|
||||
- **Anthropic Official Guide:** https://github.com/anthropics/claude-plugins-official
|
||||
- **Templates Directory:** `resources/templates/`
|
||||
- **Validation Scripts:** `scripts/validate-*.sh`
|
||||
|
||||
## Support
|
||||
|
||||
For issues or questions:
|
||||
- Check existing skills in `.github/skills/` for examples
|
||||
- Review `resources/skills-development.md` for methodology
|
||||
- Open an issue in the repository
|
||||
|
||||
---
|
||||
|
||||
**Version:** 1.1.0
|
||||
**Platform:** GitHub Copilot CLI, Claude Code
|
||||
**Author:** Eric Andrade
|
||||
**Last Updated:** 2026-02-01
|
||||
@@ -1,356 +1,593 @@
|
||||
---
|
||||
name: skill-creator
|
||||
description: Guide for creating effective skills. This skill should be used when users want to create a new skill (or update an existing skill) that extends Claude's capabilities with specialized knowledge, workflows, or tool integrations.
|
||||
license: Complete terms in LICENSE.txt
|
||||
description: "This skill should be used when the user asks to create a new skill, build a skill, make a custom skill, develop a CLI skill, or wants to extend the CLI with new capabilities. Automates the entire skill creation workflow from brainstorming to installation."
|
||||
version: 1.3.0
|
||||
author: Eric Andrade
|
||||
created: 2025-02-01
|
||||
updated: 2026-02-04
|
||||
platforms: [github-copilot-cli, claude-code, codex]
|
||||
category: meta
|
||||
tags: [automation, scaffolding, skill-creation, meta-skill]
|
||||
risk: safe
|
||||
---
|
||||
|
||||
# Skill Creator
|
||||
# skill-creator
|
||||
|
||||
This skill provides guidance for creating effective skills.
|
||||
## Purpose
|
||||
|
||||
## About Skills
|
||||
To create new CLI skills following Anthropic's official best practices with zero manual configuration. This skill automates brainstorming, template application, validation, and installation processes while maintaining progressive disclosure patterns and writing style standards.
|
||||
|
||||
Skills are modular, self-contained packages that extend Claude's capabilities by providing
|
||||
specialized knowledge, workflows, and tools. Think of them as "onboarding guides" for specific
|
||||
domains or tasks—they transform Claude from a general-purpose agent into a specialized agent
|
||||
equipped with procedural knowledge that no model can fully possess.
|
||||
## When to Use This Skill
|
||||
|
||||
### What Skills Provide
|
||||
This skill should be used when:
|
||||
- User wants to extend CLI functionality with custom capabilities
|
||||
- User needs to create a skill following official standards
|
||||
- User wants to automate repetitive CLI tasks with a reusable skill
|
||||
- User needs to package domain knowledge into a skill format
|
||||
- User wants both local and global skill installation options
|
||||
|
||||
1. Specialized workflows - Multi-step procedures for specific domains
|
||||
2. Tool integrations - Instructions for working with specific file formats or APIs
|
||||
3. Domain expertise - Company-specific knowledge, schemas, business logic
|
||||
4. Bundled resources - Scripts, references, and assets for complex and repetitive tasks
|
||||
## Core Capabilities
|
||||
|
||||
## Core Principles
|
||||
1. **Interactive Brainstorming** - Collaborative session to define skill purpose and scope
|
||||
2. **Prompt Enhancement** - Optional integration with prompt-engineer skill for refinement
|
||||
3. **Template Application** - Automatic file generation from standardized templates
|
||||
4. **Validation** - YAML, content, and style checks against Anthropic standards
|
||||
5. **Installation** - Local repository or global installation with symlinks
|
||||
6. **Progress Tracking** - Visual gauge showing completion status at each step
|
||||
|
||||
### Concise is Key
|
||||
## Step 0: Discovery
|
||||
|
||||
The context window is a public good. Skills share the context window with everything else Claude needs: system prompt, conversation history, other Skills' metadata, and the actual user request.
|
||||
|
||||
**Default assumption: Claude is already very smart.** Only add context Claude doesn't already have. Challenge each piece of information: "Does Claude really need this explanation?" and "Does this paragraph justify its token cost?"
|
||||
|
||||
Prefer concise examples over verbose explanations.
|
||||
|
||||
### Set Appropriate Degrees of Freedom
|
||||
|
||||
Match the level of specificity to the task's fragility and variability:
|
||||
|
||||
**High freedom (text-based instructions)**: Use when multiple approaches are valid, decisions depend on context, or heuristics guide the approach.
|
||||
|
||||
**Medium freedom (pseudocode or scripts with parameters)**: Use when a preferred pattern exists, some variation is acceptable, or configuration affects behavior.
|
||||
|
||||
**Low freedom (specific scripts, few parameters)**: Use when operations are fragile and error-prone, consistency is critical, or a specific sequence must be followed.
|
||||
|
||||
Think of Claude as exploring a path: a narrow bridge with cliffs needs specific guardrails (low freedom), while an open field allows many routes (high freedom).
|
||||
|
||||
### Anatomy of a Skill
|
||||
|
||||
Every skill consists of a required SKILL.md file and optional bundled resources:
|
||||
|
||||
```
|
||||
skill-name/
|
||||
├── SKILL.md (required)
|
||||
│ ├── YAML frontmatter metadata (required)
|
||||
│ │ ├── name: (required)
|
||||
│ │ └── description: (required)
|
||||
│ └── Markdown instructions (required)
|
||||
└── Bundled Resources (optional)
|
||||
├── scripts/ - Executable code (Python/Bash/etc.)
|
||||
├── references/ - Documentation intended to be loaded into context as needed
|
||||
└── assets/ - Files used in output (templates, icons, fonts, etc.)
|
||||
```
|
||||
|
||||
#### SKILL.md (required)
|
||||
|
||||
Every SKILL.md consists of:
|
||||
|
||||
- **Frontmatter** (YAML): Contains `name` and `description` fields. These are the only fields that Claude reads to determine when the skill gets used, thus it is very important to be clear and comprehensive in describing what the skill is, and when it should be used.
|
||||
- **Body** (Markdown): Instructions and guidance for using the skill. Only loaded AFTER the skill triggers (if at all).
|
||||
|
||||
#### Bundled Resources (optional)
|
||||
|
||||
##### Scripts (`scripts/`)
|
||||
|
||||
Executable code (Python/Bash/etc.) for tasks that require deterministic reliability or are repeatedly rewritten.
|
||||
|
||||
- **When to include**: When the same code is being rewritten repeatedly or deterministic reliability is needed
|
||||
- **Example**: `scripts/rotate_pdf.py` for PDF rotation tasks
|
||||
- **Benefits**: Token efficient, deterministic, may be executed without loading into context
|
||||
- **Note**: Scripts may still need to be read by Claude for patching or environment-specific adjustments
|
||||
|
||||
##### References (`references/`)
|
||||
|
||||
Documentation and reference material intended to be loaded as needed into context to inform Claude's process and thinking.
|
||||
|
||||
- **When to include**: For documentation that Claude should reference while working
|
||||
- **Examples**: `references/finance.md` for financial schemas, `references/mnda.md` for company NDA template, `references/policies.md` for company policies, `references/api_docs.md` for API specifications
|
||||
- **Use cases**: Database schemas, API documentation, domain knowledge, company policies, detailed workflow guides
|
||||
- **Benefits**: Keeps SKILL.md lean, loaded only when Claude determines it's needed
|
||||
- **Best practice**: If files are large (>10k words), include grep search patterns in SKILL.md
|
||||
- **Avoid duplication**: Information should live in either SKILL.md or references files, not both. Prefer references files for detailed information unless it's truly core to the skill—this keeps SKILL.md lean while making information discoverable without hogging the context window. Keep only essential procedural instructions and workflow guidance in SKILL.md; move detailed reference material, schemas, and examples to references files.
|
||||
|
||||
##### Assets (`assets/`)
|
||||
|
||||
Files not intended to be loaded into context, but rather used within the output Claude produces.
|
||||
|
||||
- **When to include**: When the skill needs files that will be used in the final output
|
||||
- **Examples**: `assets/logo.png` for brand assets, `assets/slides.pptx` for PowerPoint templates, `assets/frontend-template/` for HTML/React boilerplate, `assets/font.ttf` for typography
|
||||
- **Use cases**: Templates, images, icons, boilerplate code, fonts, sample documents that get copied or modified
|
||||
- **Benefits**: Separates output resources from documentation, enables Claude to use files without loading them into context
|
||||
|
||||
#### What to Not Include in a Skill
|
||||
|
||||
A skill should only contain essential files that directly support its functionality. Do NOT create extraneous documentation or auxiliary files, including:
|
||||
|
||||
- README.md
|
||||
- INSTALLATION_GUIDE.md
|
||||
- QUICK_REFERENCE.md
|
||||
- CHANGELOG.md
|
||||
- etc.
|
||||
|
||||
The skill should only contain the information needed for an AI agent to do the job at hand. It should not contain auxilary context about the process that went into creating it, setup and testing procedures, user-facing documentation, etc. Creating additional documentation files just adds clutter and confusion.
|
||||
|
||||
### Progressive Disclosure Design Principle
|
||||
|
||||
Skills use a three-level loading system to manage context efficiently:
|
||||
|
||||
1. **Metadata (name + description)** - Always in context (~100 words)
|
||||
2. **SKILL.md body** - When skill triggers (<5k words)
|
||||
3. **Bundled resources** - As needed by Claude (Unlimited because scripts can be executed without reading into context window)
|
||||
|
||||
#### Progressive Disclosure Patterns
|
||||
|
||||
Keep SKILL.md body to the essentials and under 500 lines to minimize context bloat. Split content into separate files when approaching this limit. When splitting out content into other files, it is very important to reference them from SKILL.md and describe clearly when to read them, to ensure the reader of the skill knows they exist and when to use them.
|
||||
|
||||
**Key principle:** When a skill supports multiple variations, frameworks, or options, keep only the core workflow and selection guidance in SKILL.md. Move variant-specific details (patterns, examples, configuration) into separate reference files.
|
||||
|
||||
**Pattern 1: High-level guide with references**
|
||||
|
||||
```markdown
|
||||
# PDF Processing
|
||||
|
||||
## Quick start
|
||||
|
||||
Extract text with pdfplumber:
|
||||
[code example]
|
||||
|
||||
## Advanced features
|
||||
|
||||
- **Form filling**: See [FORMS.md](FORMS.md) for complete guide
|
||||
- **API reference**: See [REFERENCE.md](REFERENCE.md) for all methods
|
||||
- **Examples**: See [EXAMPLES.md](EXAMPLES.md) for common patterns
|
||||
```
|
||||
|
||||
Claude loads FORMS.md, REFERENCE.md, or EXAMPLES.md only when needed.
|
||||
|
||||
**Pattern 2: Domain-specific organization**
|
||||
|
||||
For Skills with multiple domains, organize content by domain to avoid loading irrelevant context:
|
||||
|
||||
```
|
||||
bigquery-skill/
|
||||
├── SKILL.md (overview and navigation)
|
||||
└── reference/
|
||||
├── finance.md (revenue, billing metrics)
|
||||
├── sales.md (opportunities, pipeline)
|
||||
├── product.md (API usage, features)
|
||||
└── marketing.md (campaigns, attribution)
|
||||
```
|
||||
|
||||
When a user asks about sales metrics, Claude only reads sales.md.
|
||||
|
||||
Similarly, for skills supporting multiple frameworks or variants, organize by variant:
|
||||
|
||||
```
|
||||
cloud-deploy/
|
||||
├── SKILL.md (workflow + provider selection)
|
||||
└── references/
|
||||
├── aws.md (AWS deployment patterns)
|
||||
├── gcp.md (GCP deployment patterns)
|
||||
└── azure.md (Azure deployment patterns)
|
||||
```
|
||||
|
||||
When the user chooses AWS, Claude only reads aws.md.
|
||||
|
||||
**Pattern 3: Conditional details**
|
||||
|
||||
Show basic content, link to advanced content:
|
||||
|
||||
```markdown
|
||||
# DOCX Processing
|
||||
|
||||
## Creating documents
|
||||
|
||||
Use docx-js for new documents. See [DOCX-JS.md](DOCX-JS.md).
|
||||
|
||||
## Editing documents
|
||||
|
||||
For simple edits, modify the XML directly.
|
||||
|
||||
**For tracked changes**: See [REDLINING.md](REDLINING.md)
|
||||
**For OOXML details**: See [OOXML.md](OOXML.md)
|
||||
```
|
||||
|
||||
Claude reads REDLINING.md or OOXML.md only when the user needs those features.
|
||||
|
||||
**Important guidelines:**
|
||||
|
||||
- **Avoid deeply nested references** - Keep references one level deep from SKILL.md. All reference files should link directly from SKILL.md.
|
||||
- **Structure longer reference files** - For files longer than 100 lines, include a table of contents at the top so Claude can see the full scope when previewing.
|
||||
|
||||
## Skill Creation Process
|
||||
|
||||
Skill creation involves these steps:
|
||||
|
||||
1. Understand the skill with concrete examples
|
||||
2. Plan reusable skill contents (scripts, references, assets)
|
||||
3. Initialize the skill (run init_skill.py)
|
||||
4. Edit the skill (implement resources and write SKILL.md)
|
||||
5. Package the skill (run package_skill.py)
|
||||
6. Iterate based on real usage
|
||||
|
||||
Follow these steps in order, skipping only if there is a clear reason why they are not applicable.
|
||||
|
||||
### Step 1: Understanding the Skill with Concrete Examples
|
||||
|
||||
Skip this step only when the skill's usage patterns are already clearly understood. It remains valuable even when working with an existing skill.
|
||||
|
||||
To create an effective skill, clearly understand concrete examples of how the skill will be used. This understanding can come from either direct user examples or generated examples that are validated with user feedback.
|
||||
|
||||
For example, when building an image-editor skill, relevant questions include:
|
||||
|
||||
- "What functionality should the image-editor skill support? Editing, rotating, anything else?"
|
||||
- "Can you give some examples of how this skill would be used?"
|
||||
- "I can imagine users asking for things like 'Remove the red-eye from this image' or 'Rotate this image'. Are there other ways you imagine this skill being used?"
|
||||
- "What would a user say that should trigger this skill?"
|
||||
|
||||
To avoid overwhelming users, avoid asking too many questions in a single message. Start with the most important questions and follow up as needed for better effectiveness.
|
||||
|
||||
Conclude this step when there is a clear sense of the functionality the skill should support.
|
||||
|
||||
### Step 2: Planning the Reusable Skill Contents
|
||||
|
||||
To turn concrete examples into an effective skill, analyze each example by:
|
||||
|
||||
1. Considering how to execute on the example from scratch
|
||||
2. Identifying what scripts, references, and assets would be helpful when executing these workflows repeatedly
|
||||
|
||||
Example: When building a `pdf-editor` skill to handle queries like "Help me rotate this PDF," the analysis shows:
|
||||
|
||||
1. Rotating a PDF requires re-writing the same code each time
|
||||
2. A `scripts/rotate_pdf.py` script would be helpful to store in the skill
|
||||
|
||||
Example: When designing a `frontend-webapp-builder` skill for queries like "Build me a todo app" or "Build me a dashboard to track my steps," the analysis shows:
|
||||
|
||||
1. Writing a frontend webapp requires the same boilerplate HTML/React each time
|
||||
2. An `assets/hello-world/` template containing the boilerplate HTML/React project files would be helpful to store in the skill
|
||||
|
||||
Example: When building a `big-query` skill to handle queries like "How many users have logged in today?" the analysis shows:
|
||||
|
||||
1. Querying BigQuery requires re-discovering the table schemas and relationships each time
|
||||
2. A `references/schema.md` file documenting the table schemas would be helpful to store in the skill
|
||||
|
||||
To establish the skill's contents, analyze each concrete example to create a list of the reusable resources to include: scripts, references, and assets.
|
||||
|
||||
### Step 3: Initializing the Skill
|
||||
|
||||
At this point, it is time to actually create the skill.
|
||||
|
||||
Skip this step only if the skill being developed already exists, and iteration or packaging is needed. In this case, continue to the next step.
|
||||
|
||||
When creating a new skill from scratch, always run the `init_skill.py` script. The script conveniently generates a new template skill directory that automatically includes everything a skill requires, making the skill creation process much more efficient and reliable.
|
||||
|
||||
Usage:
|
||||
Before starting skill creation, gather runtime information:
|
||||
|
||||
```bash
|
||||
scripts/init_skill.py <skill-name> --path <output-directory>
|
||||
# Detect available platforms
|
||||
COPILOT_INSTALLED=false
|
||||
CLAUDE_INSTALLED=false
|
||||
CODEX_INSTALLED=false
|
||||
|
||||
if command -v gh &>/dev/null && gh copilot --version &>/dev/null 2>&1; then
|
||||
COPILOT_INSTALLED=true
|
||||
fi
|
||||
|
||||
if [[ -d "$HOME/.claude" ]]; then
|
||||
CLAUDE_INSTALLED=true
|
||||
fi
|
||||
|
||||
if [[ -d "$HOME/.codex" ]]; then
|
||||
CODEX_INSTALLED=true
|
||||
fi
|
||||
|
||||
# Determine working directory
|
||||
REPO_ROOT=$(git rev-parse --show-toplevel 2>/dev/null || pwd)
|
||||
SKILLS_REPO="$REPO_ROOT"
|
||||
|
||||
# Check if in cli-ai-skills repository
|
||||
if [[ ! -d "$SKILLS_REPO/.github/skills" ]]; then
|
||||
echo "⚠️ Not in cli-ai-skills repository. Creating standalone skill."
|
||||
STANDALONE=true
|
||||
fi
|
||||
|
||||
# Get user info from git config
|
||||
AUTHOR=$(git config user.name || echo "Unknown")
|
||||
EMAIL=$(git config user.email || echo "")
|
||||
```
|
||||
|
||||
The script:
|
||||
**Key Information Needed:**
|
||||
- Which platforms to target (Copilot, Claude, Codex, or all three)
|
||||
- Installation preference (local, global, or both)
|
||||
- Skill name and purpose
|
||||
- Skill type (general, code, documentation, analysis)
|
||||
|
||||
- Creates the skill directory at the specified path
|
||||
- Generates a SKILL.md template with proper frontmatter and TODO placeholders
|
||||
- Creates example resource directories: `scripts/`, `references/`, and `assets/`
|
||||
- Adds example files in each directory that can be customized or deleted
|
||||
## Main Workflow
|
||||
|
||||
After initialization, customize or remove the generated SKILL.md and example files as needed.
|
||||
### Progress Tracking Guidelines
|
||||
|
||||
### Step 4: Edit the Skill
|
||||
Throughout the workflow, display a visual progress bar before starting each phase to keep the user informed. The progress bar format is:
|
||||
|
||||
When editing the (newly-generated or existing) skill, remember that the skill is being created for another instance of Claude to use. Include information that would be beneficial and non-obvious to Claude. Consider what procedural knowledge, domain-specific details, or reusable assets would help another Claude instance execute these tasks more effectively.
|
||||
```
|
||||
[████████████░░░░░░] 60% - Step 3/5: Creating SKILL.md
|
||||
```
|
||||
|
||||
#### Learn Proven Design Patterns
|
||||
**Format specifications:**
|
||||
- 20 characters wide (use █ for filled, ░ for empty)
|
||||
- Percentage based on current step (Step 1=20%, Step 2=40%, Step 3=60%, Step 4=80%, Step 5=100%)
|
||||
- Step counter showing current/total (e.g., "Step 3/5")
|
||||
- Brief description of current phase
|
||||
|
||||
Consult these helpful guides based on your skill's needs:
|
||||
**Display the progress bar using:**
|
||||
```bash
|
||||
echo "[████░░░░░░░░░░░░░░] 20% - Step 1/5: Brainstorming & Planning"
|
||||
```
|
||||
|
||||
- **Multi-step processes**: See references/workflows.md for sequential workflows and conditional logic
|
||||
- **Specific output formats or quality standards**: See references/output-patterns.md for template and example patterns
|
||||
### Phase 1: Brainstorming & Planning
|
||||
|
||||
These files contain established best practices for effective skill design.
|
||||
**Progress:** Display before starting this phase:
|
||||
```bash
|
||||
echo "[████░░░░░░░░░░░░░░] 20% - Step 1/5: Brainstorming & Planning"
|
||||
```
|
||||
|
||||
#### Start with Reusable Skill Contents
|
||||
Display progress:
|
||||
```
|
||||
╔══════════════════════════════════════════════════════════════╗
|
||||
║ 🛠️ SKILL CREATOR - Creating New Skill ║
|
||||
╠══════════════════════════════════════════════════════════════╣
|
||||
║ → Phase 1: Brainstorming [10%] ║
|
||||
║ ○ Phase 2: Prompt Refinement ║
|
||||
║ ○ Phase 3: File Generation ║
|
||||
║ ○ Phase 4: Validation ║
|
||||
║ ○ Phase 5: Installation ║
|
||||
╠══════════════════════════════════════════════════════════════╣
|
||||
║ Progress: ███░░░░░░░░░░░░░░░░░░░░░░░░░░░ 10% ║
|
||||
╚══════════════════════════════════════════════════════════════╝
|
||||
```
|
||||
|
||||
To begin implementation, start with the reusable resources identified above: `scripts/`, `references/`, and `assets/` files. Note that this step may require user input. For example, when implementing a `brand-guidelines` skill, the user may need to provide brand assets or templates to store in `assets/`, or documentation to store in `references/`.
|
||||
**Ask the user:**
|
||||
|
||||
Added scripts must be tested by actually running them to ensure there are no bugs and that the output matches what is expected. If there are many similar scripts, only a representative sample needs to be tested to ensure confidence that they all work while balancing time to completion.
|
||||
1. **What should this skill do?** (Free-form description)
|
||||
- Example: "Help users debug Python code by analyzing stack traces"
|
||||
|
||||
2. **When should it trigger?** (Provide 3-5 trigger phrases)
|
||||
- Example: "debug Python error", "analyze stack trace", "fix Python exception"
|
||||
|
||||
Any example files and directories not needed for the skill should be deleted. The initialization script creates example files in `scripts/`, `references/`, and `assets/` to demonstrate structure, but most skills won't need all of them.
|
||||
3. **What type of skill is this?**
|
||||
- [ ] General purpose (default template)
|
||||
- [ ] Code generation/modification
|
||||
- [ ] Documentation creation/maintenance
|
||||
- [ ] Analysis/investigation
|
||||
|
||||
#### Update SKILL.md
|
||||
4. **Which platforms should support this skill?**
|
||||
- [ ] GitHub Copilot CLI
|
||||
- [ ] Claude Code
|
||||
- [ ] Codex
|
||||
- [ ] All three (recommended)
|
||||
|
||||
**Writing Guidelines:** Always use imperative/infinitive form.
|
||||
5. **Provide a one-sentence description** (will appear in metadata)
|
||||
- Example: "Analyzes Python stack traces and suggests fixes"
|
||||
|
||||
##### Frontmatter
|
||||
**Capture responses and prepare for next phase.**
|
||||
|
||||
Write the YAML frontmatter with `name` and `description`:
|
||||
### Phase 2: Prompt Enhancement (Optional)
|
||||
|
||||
- `name`: The skill name
|
||||
- `description`: This is the primary triggering mechanism for your skill, and helps Claude understand when to use the skill.
|
||||
- Include both what the Skill does and specific triggers/contexts for when to use it.
|
||||
- Include all "when to use" information here - Not in the body. The body is only loaded after triggering, so "When to Use This Skill" sections in the body are not helpful to Claude.
|
||||
- Example description for a `docx` skill: "Comprehensive document creation, editing, and analysis with support for tracked changes, comments, formatting preservation, and text extraction. Use when Claude needs to work with professional documents (.docx files) for: (1) Creating new documents, (2) Modifying or editing content, (3) Working with tracked changes, (4) Adding comments, or any other document tasks"
|
||||
**Progress:** Display before starting this phase:
|
||||
```bash
|
||||
echo "[████████░░░░░░░░░░] 40% - Step 2/5: Prompt Enhancement"
|
||||
```
|
||||
|
||||
Do not include any other fields in YAML frontmatter.
|
||||
Update progress:
|
||||
```
|
||||
╔══════════════════════════════════════════════════════════════╗
|
||||
║ ✓ Phase 1: Brainstorming ║
|
||||
║ → Phase 2: Prompt Refinement [30%] ║
|
||||
╠══════════════════════════════════════════════════════════════╣
|
||||
║ Progress: █████████░░░░░░░░░░░░░░░░░░░░░ 30% ║
|
||||
╚══════════════════════════════════════════════════════════════╝
|
||||
```
|
||||
|
||||
##### Body
|
||||
**Ask the user:**
|
||||
"Would you like to refine the skill description using the prompt-engineer skill?"
|
||||
- [ ] Yes - Use prompt-engineer to enhance clarity and structure
|
||||
- [ ] No - Proceed with current description
|
||||
|
||||
Write instructions for using the skill and its bundled resources.
|
||||
If **Yes**:
|
||||
1. Check if prompt-engineer skill is available
|
||||
2. Invoke with current description as input
|
||||
3. Review enhanced output with user
|
||||
4. Ask: "Accept enhanced version or keep original?"
|
||||
|
||||
### Step 5: Packaging a Skill
|
||||
If **No** or prompt-engineer unavailable:
|
||||
- Proceed with original user input
|
||||
|
||||
Once development of the skill is complete, it must be packaged into a distributable .skill file that gets shared with the user. The packaging process automatically validates the skill first to ensure it meets all requirements:
|
||||
### Phase 3: File Generation
|
||||
|
||||
**Progress:** Display before starting this phase:
|
||||
```bash
|
||||
echo "[████████████░░░░░░] 60% - Step 3/5: File Generation"
|
||||
```
|
||||
|
||||
Update progress:
|
||||
```
|
||||
╔══════════════════════════════════════════════════════════════╗
|
||||
║ ✓ Phase 1: Brainstorming ║
|
||||
║ ✓ Phase 2: Prompt Refinement ║
|
||||
║ → Phase 3: File Generation [50%] ║
|
||||
╠══════════════════════════════════════════════════════════════╣
|
||||
║ Progress: ███████████████░░░░░░░░░░░░░░░ 50% ║
|
||||
╚══════════════════════════════════════════════════════════════╝
|
||||
```
|
||||
|
||||
**Generate skill structure:**
|
||||
|
||||
```bash
|
||||
scripts/package_skill.py <path/to/skill-folder>
|
||||
# Convert skill name to kebab-case
|
||||
SKILL_NAME=$(echo "$USER_INPUT" | tr '[:upper:]' '[:lower:]' | tr ' ' '-')
|
||||
|
||||
# Create directories
|
||||
if [[ "$PLATFORM" =~ "copilot" ]]; then
|
||||
mkdir -p ".github/skills/$SKILL_NAME"/{references,examples,scripts}
|
||||
fi
|
||||
|
||||
if [[ "$PLATFORM" =~ "claude" ]]; then
|
||||
mkdir -p ".claude/skills/$SKILL_NAME"/{references,examples,scripts}
|
||||
fi
|
||||
|
||||
if [[ "$PLATFORM" =~ "codex" ]]; then
|
||||
mkdir -p ".codex/skills/$SKILL_NAME"/{references,examples,scripts}
|
||||
fi
|
||||
```
|
||||
|
||||
Optional output directory specification:
|
||||
**Apply templates:**
|
||||
|
||||
1. **SKILL.md** - Use appropriate template:
|
||||
- `skill-template-copilot.md`, `skill-template-claude.md`, or `skill-template-codex.md`
|
||||
- Substitute placeholders:
|
||||
- `{{SKILL_NAME}}` → kebab-case name
|
||||
- `{{DESCRIPTION}}` → one-line description
|
||||
- `{{TRIGGERS}}` → comma-separated trigger phrases
|
||||
- `{{PURPOSE}}` → detailed purpose from brainstorming
|
||||
- `{{AUTHOR}}` → from git config
|
||||
- `{{DATE}}` → current date (YYYY-MM-DD)
|
||||
- `{{VERSION}}` → "1.0.0"
|
||||
|
||||
2. **README.md** - Use `readme-template.md`:
|
||||
- User-facing documentation (300-500 words)
|
||||
- Include installation instructions
|
||||
- Add usage examples
|
||||
|
||||
3. **References/** (optional but recommended):
|
||||
- Create `detailed-guide.md` for extended documentation (2k-5k words)
|
||||
- Move lengthy content here to keep SKILL.md under 2k words
|
||||
|
||||
**File creation commands:**
|
||||
|
||||
```bash
|
||||
scripts/package_skill.py <path/to/skill-folder> ./dist
|
||||
# Apply template with substitution
|
||||
sed "s/{{SKILL_NAME}}/$SKILL_NAME/g; \
|
||||
s/{{DESCRIPTION}}/$DESCRIPTION/g; \
|
||||
s/{{AUTHOR}}/$AUTHOR/g; \
|
||||
s/{{DATE}}/$(date +%Y-%m-%d)/g" \
|
||||
resources/templates/skill-template-copilot.md \
|
||||
> ".github/skills/$SKILL_NAME/SKILL.md"
|
||||
|
||||
# Create README
|
||||
sed "s/{{SKILL_NAME}}/$SKILL_NAME/g" \
|
||||
resources/templates/readme-template.md \
|
||||
> ".github/skills/$SKILL_NAME/README.md"
|
||||
|
||||
# Apply template for Codex if selected
|
||||
if [[ "$PLATFORM" =~ "codex" ]]; then
|
||||
sed "s/{{SKILL_NAME}}/$SKILL_NAME/g; \
|
||||
s/{{DESCRIPTION}}/$DESCRIPTION/g; \
|
||||
s/{{AUTHOR}}/$AUTHOR/g; \
|
||||
s/{{DATE}}/$(date +%Y-%m-%d)/g" \
|
||||
resources/templates/skill-template-codex.md \
|
||||
> ".codex/skills/$SKILL_NAME/SKILL.md"
|
||||
|
||||
sed "s/{{SKILL_NAME}}/$SKILL_NAME/g" \
|
||||
resources/templates/readme-template.md \
|
||||
> ".codex/skills/$SKILL_NAME/README.md"
|
||||
fi
|
||||
```
|
||||
|
||||
The packaging script will:
|
||||
**Display created structure:**
|
||||
```
|
||||
✅ Created:
|
||||
.github/skills/your-skill-name/ (if Copilot selected)
|
||||
.claude/skills/your-skill-name/ (if Claude selected)
|
||||
.codex/skills/your-skill-name/ (if Codex selected)
|
||||
├── SKILL.md (832 lines)
|
||||
├── README.md (347 lines)
|
||||
├── references/
|
||||
├── examples/
|
||||
└── scripts/
|
||||
```
|
||||
|
||||
1. **Validate** the skill automatically, checking:
|
||||
### Phase 4: Validation
|
||||
|
||||
- YAML frontmatter format and required fields
|
||||
- Skill naming conventions and directory structure
|
||||
- Description completeness and quality
|
||||
- File organization and resource references
|
||||
**Progress:** Display before starting this phase:
|
||||
```bash
|
||||
echo "[████████████████░░] 80% - Step 4/5: Validation"
|
||||
```
|
||||
|
||||
2. **Package** the skill if validation passes, creating a .skill file named after the skill (e.g., `my-skill.skill`) that includes all files and maintains the proper directory structure for distribution. The .skill file is a zip file with a .skill extension.
|
||||
Update progress:
|
||||
```
|
||||
╔══════════════════════════════════════════════════════════════╗
|
||||
║ ✓ Phase 3: File Generation ║
|
||||
║ → Phase 4: Validation [70%] ║
|
||||
╠══════════════════════════════════════════════════════════════╣
|
||||
║ Progress: █████████████████████░░░░░░░░░ 70% ║
|
||||
╚══════════════════════════════════════════════════════════════╝
|
||||
```
|
||||
|
||||
If validation fails, the script will report the errors and exit without creating a package. Fix any validation errors and run the packaging command again.
|
||||
**Run validation scripts:**
|
||||
|
||||
### Step 6: Iterate
|
||||
```bash
|
||||
# Validate YAML frontmatter
|
||||
scripts/validate-skill-yaml.sh ".github/skills/$SKILL_NAME"
|
||||
|
||||
After testing the skill, users may request improvements. Often this happens right after using the skill, with fresh context of how the skill performed.
|
||||
# Validate content quality
|
||||
scripts/validate-skill-content.sh ".github/skills/$SKILL_NAME"
|
||||
```
|
||||
|
||||
**Iteration workflow:**
|
||||
**Expected output:**
|
||||
```
|
||||
🔍 Validating YAML frontmatter...
|
||||
✅ YAML frontmatter valid!
|
||||
|
||||
1. Use the skill on real tasks
|
||||
2. Notice struggles or inefficiencies
|
||||
3. Identify how SKILL.md or bundled resources should be updated
|
||||
4. Implement changes and test again
|
||||
🔍 Validating content...
|
||||
✅ Word count excellent: 1847 words
|
||||
✅ Content validation complete!
|
||||
```
|
||||
|
||||
**If validation fails:**
|
||||
- Display specific errors
|
||||
- Offer to fix automatically (common issues)
|
||||
- Ask user to manually correct complex issues
|
||||
|
||||
**Common auto-fixes:**
|
||||
- Convert second-person to imperative form
|
||||
- Reformat description to third-person
|
||||
- Add missing required fields
|
||||
|
||||
### Phase 5: Installation
|
||||
|
||||
**Progress:** Display before starting this phase:
|
||||
```bash
|
||||
echo "[████████████████████] 100% - Step 5/5: Installation"
|
||||
```
|
||||
|
||||
Update progress:
|
||||
```
|
||||
╔══════════════════════════════════════════════════════════════╗
|
||||
║ ✓ Phase 4: Validation ║
|
||||
║ → Phase 5: Installation [90%] ║
|
||||
╠══════════════════════════════════════════════════════════════╣
|
||||
║ Progress: ██████████████████████████░░░░░ 90% ║
|
||||
╚══════════════════════════════════════════════════════════════╝
|
||||
```
|
||||
|
||||
**Ask the user:**
|
||||
"How would you like to install this skill?"
|
||||
|
||||
- [ ] **Repository only** - Files created in `.github/skills/` (works when in repo)
|
||||
- [ ] **Global installation** - Create symlinks in `~/.copilot/skills/` (works everywhere)
|
||||
- [ ] **Both** - Repository + global symlinks (recommended, auto-updates with git pull)
|
||||
- [ ] **Skip installation** - Just create files
|
||||
|
||||
**If global installation selected:**
|
||||
|
||||
```bash
|
||||
# Detect which platforms to install for
|
||||
INSTALL_TARGETS=()
|
||||
|
||||
if [[ "$COPILOT_INSTALLED" == "true" ]] && [[ "$PLATFORM" =~ "copilot" ]]; then
|
||||
INSTALL_TARGETS+=("copilot")
|
||||
fi
|
||||
|
||||
if [[ "$CLAUDE_INSTALLED" == "true" ]] && [[ "$PLATFORM" =~ "claude" ]]; then
|
||||
INSTALL_TARGETS+=("claude")
|
||||
fi
|
||||
|
||||
if [[ "$CODEX_INSTALLED" == "true" ]] && [[ "$PLATFORM" =~ "codex" ]]; then
|
||||
INSTALL_TARGETS+=("codex")
|
||||
fi
|
||||
|
||||
# Ask user to confirm detected platforms
|
||||
echo "Detected platforms: ${INSTALL_TARGETS[*]}"
|
||||
echo "Install for these platforms? [Y/n]"
|
||||
```
|
||||
|
||||
**Installation process:**
|
||||
|
||||
```bash
|
||||
# GitHub Copilot CLI
|
||||
if [[ " ${INSTALL_TARGETS[*]} " =~ " copilot " ]]; then
|
||||
ln -sf "$SKILLS_REPO/.github/skills/$SKILL_NAME" \
|
||||
"$HOME/.copilot/skills/$SKILL_NAME"
|
||||
echo "✅ Installed for GitHub Copilot CLI"
|
||||
fi
|
||||
|
||||
# Claude Code
|
||||
if [[ " ${INSTALL_TARGETS[*]} " =~ " claude " ]]; then
|
||||
ln -sf "$SKILLS_REPO/.claude/skills/$SKILL_NAME" \
|
||||
"$HOME/.claude/skills/$SKILL_NAME"
|
||||
echo "✅ Installed for Claude Code"
|
||||
fi
|
||||
|
||||
# Codex
|
||||
if [[ " ${INSTALL_TARGETS[*]} " =~ " codex " ]]; then
|
||||
ln -sf "$SKILLS_REPO/.codex/skills/$SKILL_NAME" \
|
||||
"$HOME/.codex/skills/$SKILL_NAME"
|
||||
echo "✅ Installed for Codex"
|
||||
fi
|
||||
```
|
||||
|
||||
**Verify installation:**
|
||||
|
||||
```bash
|
||||
# Check symlinks
|
||||
ls -la ~/.copilot/skills/$SKILL_NAME 2>/dev/null
|
||||
ls -la ~/.claude/skills/$SKILL_NAME 2>/dev/null
|
||||
ls -la ~/.codex/skills/$SKILL_NAME 2>/dev/null
|
||||
```
|
||||
|
||||
### Phase 6: Completion
|
||||
|
||||
**Progress:** Display completion message:
|
||||
```bash
|
||||
echo "[████████████████████] 100% - ✓ Skill created successfully!"
|
||||
```
|
||||
|
||||
Update progress:
|
||||
```
|
||||
╔══════════════════════════════════════════════════════════════╗
|
||||
║ ✓ Phase 5: Installation ║
|
||||
║ ✅ SKILL CREATION COMPLETE! ║
|
||||
╠══════════════════════════════════════════════════════════════╣
|
||||
║ Progress: ██████████████████████████████ 100% ║
|
||||
╚══════════════════════════════════════════════════════════════╝
|
||||
```
|
||||
|
||||
**Display summary:**
|
||||
|
||||
```
|
||||
🎉 Skill created successfully!
|
||||
|
||||
📦 Skill Name: your-skill-name
|
||||
📁 Location: .github/skills/your-skill-name/
|
||||
🔗 Installed: Global (Copilot + Claude)
|
||||
|
||||
📋 Files Created:
|
||||
✅ SKILL.md (1,847 words)
|
||||
✅ README.md (423 words)
|
||||
✅ references/ (empty, ready for extended docs)
|
||||
✅ examples/ (empty, ready for code samples)
|
||||
✅ scripts/ (empty, ready for utilities)
|
||||
|
||||
🚀 Next Steps:
|
||||
1. Test the skill: Try trigger phrases in CLI
|
||||
2. Add examples: Create working code samples in examples/
|
||||
3. Extend docs: Add detailed guides to references/
|
||||
4. Commit changes: git add .github/skills/your-skill-name && git commit
|
||||
5. Share: Push to repository for team use
|
||||
|
||||
💡 Pro Tips:
|
||||
- Keep SKILL.md under 2,000 words (currently: 1,847)
|
||||
- Move detailed content to references/ folder
|
||||
- Add executable scripts to scripts/ folder
|
||||
- Update README.md with real usage examples
|
||||
- Run validation before committing: scripts/validate-skill-yaml.sh
|
||||
```
|
||||
|
||||
## Error Handling
|
||||
|
||||
### Platform Detection Issues
|
||||
|
||||
If platforms cannot be detected:
|
||||
```
|
||||
⚠️ Unable to detect GitHub Copilot CLI or Claude Code
|
||||
|
||||
Would you like to:
|
||||
1. Install for repository only (works when in repo)
|
||||
2. Specify platform manually
|
||||
3. Skip installation
|
||||
```
|
||||
|
||||
### Template Not Found
|
||||
|
||||
If templates are missing:
|
||||
```
|
||||
❌ Error: Template not found at resources/templates/
|
||||
|
||||
This skill requires the cli-ai-skills repository structure.
|
||||
|
||||
Options:
|
||||
1. Clone cli-ai-skills: git clone <repo-url>
|
||||
2. Create minimal skill structure manually
|
||||
3. Exit and set up templates first
|
||||
```
|
||||
|
||||
### Validation Failures
|
||||
|
||||
If content doesn't meet standards:
|
||||
```
|
||||
⚠️ Validation Issues Found:
|
||||
|
||||
1. YAML: Description not in third-person format
|
||||
Expected: "This skill should be used when..."
|
||||
Found: "Use this skill when..."
|
||||
|
||||
2. Content: Word count too high (5,342 words, max 5,000)
|
||||
Suggestion: Move detailed sections to references/
|
||||
|
||||
Fix automatically? [Y/n]
|
||||
```
|
||||
|
||||
### Installation Conflicts
|
||||
|
||||
If symlink already exists:
|
||||
```
|
||||
⚠️ Skill already installed at ~/.copilot/skills/your-skill-name
|
||||
|
||||
Options:
|
||||
1. Overwrite existing installation
|
||||
2. Rename new skill
|
||||
3. Skip installation
|
||||
4. Install to different location
|
||||
```
|
||||
|
||||
## Bundled Resources
|
||||
|
||||
This skill includes additional resources in subdirectories:
|
||||
|
||||
### references/
|
||||
|
||||
Detailed documentation loaded when needed:
|
||||
- `anthropic-best-practices.md` - Official Anthropic skill development guidelines
|
||||
- `writing-style-guide.md` - Writing standards and examples
|
||||
- `progressive-disclosure.md` - Content organization patterns
|
||||
- `validation-checklist.md` - Pre-commit quality checks
|
||||
|
||||
### examples/
|
||||
|
||||
Working examples demonstrating skill usage:
|
||||
- `basic-skill-creation.md` - Simple skill creation walkthrough
|
||||
- `advanced-skill-bundled-resources.md` - Complex skill with references/
|
||||
- `global-installation.md` - Installing skills system-wide
|
||||
|
||||
### scripts/
|
||||
|
||||
Executable utilities for skill maintenance:
|
||||
- `validate-all-skills.sh` - Batch validation of all skills in repository
|
||||
- `update-skill-version.sh` - Bump version and update changelog
|
||||
- `generate-skill-index.sh` - Auto-generate skills catalog
|
||||
|
||||
## Technical Implementation Notes
|
||||
|
||||
**Template Substitution:**
|
||||
- Use `sed` for simple replacements
|
||||
- Preserve YAML formatting exactly
|
||||
- Handle multi-line descriptions with proper escaping
|
||||
|
||||
**Symlink Strategy:**
|
||||
- Always use absolute paths: `ln -sf /full/path/to/source ~/.copilot/skills/name`
|
||||
- Verify symlink before considering installation complete
|
||||
- Benefits: Auto-updates when repository is pulled
|
||||
|
||||
**Validation Integration:**
|
||||
- Run validation before installation
|
||||
- Block installation if critical errors found
|
||||
- Warnings are informational only
|
||||
|
||||
**Git Integration:**
|
||||
- Extract author from `git config user.name`
|
||||
- Use repository root detection: `git rev-parse --show-toplevel`
|
||||
- Respect `.gitignore` patterns
|
||||
|
||||
## Quality Standards
|
||||
|
||||
**SKILL.md Requirements:**
|
||||
- 1,500-2,000 words (ideal)
|
||||
- Under 5,000 words (maximum)
|
||||
- Third-person description format
|
||||
- Imperative/infinitive writing style
|
||||
- Progressive disclosure pattern
|
||||
|
||||
**README.md Requirements:**
|
||||
- 300-500 words
|
||||
- User-facing language
|
||||
- Clear installation instructions
|
||||
- Practical usage examples
|
||||
|
||||
**Validation Checks:**
|
||||
- YAML frontmatter completeness
|
||||
- Description format (third-person)
|
||||
- Word count limits
|
||||
- Writing style (no second-person)
|
||||
- Required fields present
|
||||
|
||||
## References
|
||||
|
||||
- **Anthropic Official Skill Development Guide:** https://github.com/anthropics/claude-plugins-official/blob/main/plugins/plugin-dev/skills/skill-development/SKILL.md
|
||||
- **Repository:** https://github.com/yourusername/cli-ai-skills
|
||||
- **Writing Style Guide:** `resources/templates/writing-style-guide.md`
|
||||
- **Progress Tracker Template:** `resources/templates/progress-tracker.md`
|
||||
|
||||
Reference in New Issue
Block a user