Extension Template

Starter template for creating a Spec Kit extension.

Quick Start

1. Copy this template:

   bashCopy

   cp -r extensions/template my-extension
   cd my-extension
   

2. Customize extension.yml:

   • Change extension ID, name, description
   • Update author and repository
   • Define your commands

3. Create commands:

   • Add command files in commands/ directory
   • Use Markdown format with YAML frontmatter

4. Create config template:

   • Define configuration options
   • Document all settings

5. Write documentation:

   • Update README.md with usage instructions
   • Add examples

6. Test locally:

   bashCopy

   cd /path/to/spec-kit-project
   specify extension add --dev /path/to/my-extension
   

7. Publish (optional):

   • Create GitHub repository
   • Create release
   • Submit to catalog (see EXTENSION-PUBLISHING-GUIDE.md)

Files in This Template

• extension.yml - Extension manifest (CUSTOMIZE THIS)
• config-template.yml - Configuration template (CUSTOMIZE THIS)
• commands/example.md - Example command (REPLACE THIS)
• README.md - Extension documentation (REPLACE THIS)
• LICENSE - MIT License (REVIEW THIS)
• CHANGELOG.md - Version history (UPDATE THIS)
• .gitignore - Git ignore rules

Customization Checklist

• Update extension.yml with your extension details
• Change extension ID to your extension name
• Update author information
• Define your commands
• Create command files in commands/
• Update config template
• Write README with usage instructions
• Add examples
• Update LICENSE if needed
• Test extension locally
• Create git repository
• Create first release

Need Help?

• Development Guide: See EXTENSION-DEVELOPMENT-GUIDE.md
• API Reference: See EXTENSION-API-REFERENCE.md
• Publishing Guide: See EXTENSION-PUBLISHING-GUIDE.md
• User Guide: See EXTENSION-USER-GUIDE.md

Template Version

• Version: 1.0.0
• Last Updated: 2026-01-28
• Compatible with Spec Kit: >=0.1.0