skill-gen
v0.0.1
Published
Generate SKILL.md files for npm packages following Anthropic's Agent Skills specification
Maintainers
Readme
skillify
Generate SKILL.md files for npm packages following Anthropic's Agent Skills specification.
Install
npm install -g skillifyOr use directly:
npx skill-gen .Usage
# Current directory
npx skill-gen .
# Specific path
npx skill-gen ~/projects/my-package
# Print to stdout
npx skill-gen . --stdout
# Dry run (preview only)
npx skill-gen . --dry-run
# Custom output path
npx skill-gen . -o ./docs/SKILL.mdWhat it Does
- Reads
package.jsonfor name, description, keywords, bin, exports - Analyzes CLI entry point for flags/commands
- Extracts exported functions from main module
- Generates SKILL.md with:
- Proper YAML frontmatter (name, description)
- "When to Use" triggers
- Quick Start examples
- CLI Reference (if applicable)
- API Reference (if applicable)
Output Format
---
name: my-package
description: Does X and Y. Use when working with Z.
---
# my-package
## When to Use
...
## Quick Start
...Why SKILL.md?
SKILL.md is the Agent Skills standard for AI agent documentation:
- Discoverable: Agents find skills by name + description
- Progressive disclosure: Metadata loads first, details on-demand
- Portable: Works with Claude Code, Cursor, Copilot, Codex
Best Practices Applied
Based on Anthropic's guidelines:
- Third person descriptions ("Builds X" not "I build X")
- Includes "when to use" triggers
- Concrete examples over abstract descriptions
- Under 500 lines for optimal performance
Related
License
MIT
