Add modular extension system (#1551)

* Add modular extension system for Spec Kit Implement a complete extension system that allows third-party developers to extend Spec Kit functionality through plugins. ## Core Features - Extension discovery and loading from local and global directories - YAML-based extension manifest (extension.yml) with metadata and capabilities - Command extensions: custom slash commands with markdown templates - Hook system: pre/post hooks for generate, task, and sync operations - Extension catalog for discovering and installing community extensions - SPECKIT_CATALOG_URL environment variable for catalog URL override ## Installation Methods - Catalog install: `specify extension add <name>` - URL install: `specify extension add <name> --from <url>` - Dev install: `specify extension add --dev <path>` ## Implementation - ExtensionManager class for lifecycle management (load, enable, disable) - Support for extension dependencies and version constraints - Configuration layering (global → project → extension) - Hook conditions for conditional execution ## Documentation - RFC with design rationale and architecture decisions - API reference for extension developers - Development guide with examples - User guide for installing and managing extensions - Publishing guide for the extension catalog ## Included - Extension template for bootstrapping new extensions - Comprehensive test suite - Example catalog.json structure Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * Update Jira extension to v2.1.0 in catalog Adds 2-level mode support (Epic → Stories only). Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * Address PR review feedback - Fix Zip Slip vulnerability in ZIP extraction with path validation - Fix keep_config option to actually preserve config files on removal - Add URL validation for SPECKIT_CATALOG_URL (HTTPS required, localhost exception) - Add security warning when installing from custom URLs (--from flag) - Empty catalog.json so organizations can ship their own catalogs - Fix markdown linter errors (MD040: add language to code blocks) - Remove redundant import and fix unused variables in tests - Add comment explaining empty except clause for backwards compatibility Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * Add comprehensive organization catalog customization docs - Explain why default catalog is empty (org control) - Document how to create and host custom catalogs - Add catalog JSON schema reference - Include use cases: private extensions, curated catalogs, air-gapped environments - Add examples for combining catalog with direct installation Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * Fix test assertions for extension system data structures - Update test_config_backup_on_remove to use new subdirectory structure (.backup/test-ext/file.yml instead of .backup/test-ext-file.yml) - Update test_full_install_and_remove_workflow to handle registered_commands being a dict keyed by agent name instead of a flat list Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * Address Copilot review feedback - Fix localhost URL check to use parsed.hostname instead of netloc.startswith() This correctly handles URLs with ports like localhost:8080 - Fix YAML indentation error in config-template.yml (line 57) - Fix double space typo in example.md (line 172) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * Add catalog.example.json as reference for organizations The main catalog.json is intentionally empty so organizations can ship their own curated catalogs. This example file shows the expected schema and structure for creating organization-specific catalogs. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * Address remaining Copilot security and logic review feedback - Fix Zip Slip vulnerability by using relative_to() for safe path validation - Add HTTPS validation for extension download URLs - Backup both *-config.yml and *-config.local.yml files on remove - Normalize boolean values to lowercase for hook condition comparisons - Show non-default catalog warning only once per instance Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * Ignoring linter for extensions directory --------- Co-authored-by: iamaeroplane <michal.bachorik@gmail.com> Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com> Co-authored-by: Manfred Riem <manfred.riem@microsoft.com>
2026-03-17 02:43:08 +00:00 · 2026-02-10 21:27:20 +01:00
parent 36d97235ad
commit f14a47ea7d
24 changed files with 8925 additions and 2 deletions
--- a/extensions/template/.gitignore
+++ b/extensions/template/.gitignore
@@ -0,0 +1,39 @@
+# Local configuration overrides
+*-config.local.yml
+
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+env/
+venv/
+
+# Testing
+.pytest_cache/
+.coverage
+htmlcov/
+
+# IDEs
+.vscode/
+.idea/
+*.swp
+*.swo
+*~
+
+# OS
+.DS_Store
+Thumbs.db
+
+# Logs
+*.log
+
+# Build artifacts
+dist/
+build/
+*.egg-info/
+
+# Temporary files
+*.tmp
+.cache/
--- a/extensions/template/CHANGELOG.md
+++ b/extensions/template/CHANGELOG.md
@@ -0,0 +1,39 @@
+# Changelog
+
+All notable changes to this extension will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to  [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Planned
+
+- Feature ideas for future versions
+- Enhancements
+- Bug fixes
+
+## [1.0.0] - YYYY-MM-DD
+
+### Added
+
+- Initial release of extension
+- Command: `/speckit.my-extension.example` - Example command functionality
+- Configuration system with template
+- Documentation and examples
+
+### Features
+
+- Feature 1 description
+- Feature 2 description
+- Feature 3 description
+
+### Requirements
+
+- Spec Kit: >=0.1.0
+- External dependencies (if any)
+
+---
+
+[Unreleased]: https://github.com/your-org/spec-kit-my-extension/compare/v1.0.0...HEAD
+[1.0.0]: https://github.com/your-org/spec-kit-my-extension/releases/tag/v1.0.0
--- a/extensions/template/EXAMPLE-README.md
+++ b/extensions/template/EXAMPLE-README.md
@@ -0,0 +1,158 @@
+# EXAMPLE: Extension README
+
+This is an example of what your extension README should look like after customization.
+**Delete this file and replace README.md with content similar to this.**
+
+---
+
+# My Extension
+
+<!-- CUSTOMIZE: Replace with your extension description -->
+
+Brief description of what your extension does and why it's useful.
+
+## Features
+
+<!-- CUSTOMIZE: List key features -->
+
+- Feature 1: Description
+- Feature 2: Description
+- Feature 3: Description
+
+## Installation
+
+```bash
+# Install from catalog
+specify extension add my-extension
+
+# Or install from local development directory
+specify extension add --dev /path/to/my-extension
+```
+
+## Configuration
+
+1. Create configuration file:
+
+   ```bash
+   cp .specify/extensions/my-extension/config-template.yml \
+      .specify/extensions/my-extension/my-extension-config.yml
+   ```
+
+2. Edit configuration:
+
+   ```bash
+   vim .specify/extensions/my-extension/my-extension-config.yml
+   ```
+
+3. Set required values:
+   <!-- CUSTOMIZE: List required configuration -->
+   ```yaml
+   connection:
+     url: "https://api.example.com"
+     api_key: "your-api-key"
+
+   project:
+     id: "your-project-id"
+   ```
+
+## Usage
+
+<!-- CUSTOMIZE: Add usage examples -->
+
+### Command: example
+
+Description of what this command does.
+
+```bash
+# In Claude Code
+> /speckit.my-extension.example
+```
+
+**Prerequisites**:
+
+- Prerequisite 1
+- Prerequisite 2
+
+**Output**:
+
+- What this command produces
+- Where results are saved
+
+## Configuration Reference
+
+<!-- CUSTOMIZE: Document all configuration options -->
+
+### Connection Settings
+
+| Setting | Type | Required | Description |
+|---------|------|----------|-------------|
+| `connection.url` | string | Yes | API endpoint URL |
+| `connection.api_key` | string | Yes | API authentication key |
+
+### Project Settings
+
+| Setting | Type | Required | Description |
+|---------|------|----------|-------------|
+| `project.id` | string | Yes | Project identifier |
+| `project.workspace` | string | No | Workspace or organization |
+
+## Environment Variables
+
+Override configuration with environment variables:
+
+```bash
+# Override connection settings
+export SPECKIT_MY_EXTENSION_CONNECTION_URL="https://custom-api.com"
+export SPECKIT_MY_EXTENSION_CONNECTION_API_KEY="custom-key"
+```
+
+## Examples
+
+<!-- CUSTOMIZE: Add real-world examples -->
+
+### Example 1: Basic Workflow
+
+```bash
+# Step 1: Create specification
+> /speckit.spec
+
+# Step 2: Generate tasks
+> /speckit.tasks
+
+# Step 3: Use extension
+> /speckit.my-extension.example
+```
+
+## Troubleshooting
+
+<!-- CUSTOMIZE: Add common issues -->
+
+### Issue: Configuration not found
+
+**Solution**: Create config from template (see Configuration section)
+
+### Issue: Command not available
+
+**Solutions**:
+
+1. Check extension is installed: `specify extension list`
+2. Restart AI agent
+3. Reinstall extension
+
+## License
+
+MIT License - see LICENSE file
+
+## Support
+
+- **Issues**: <https://github.com/your-org/spec-kit-my-extension/issues>
+- **Spec Kit Docs**: <https://github.com/statsperform/spec-kit>
+
+## Changelog
+
+See [CHANGELOG.md](CHANGELOG.md) for version history.
+
+---
+
+*Extension Version: 1.0.0*
+*Spec Kit: >=0.1.0*
--- a/extensions/template/LICENSE
+++ b/extensions/template/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 [Your Name or Organization]
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
--- a/extensions/template/README.md
+++ b/extensions/template/README.md
@@ -0,0 +1,79 @@
+# Extension Template
+
+Starter template for creating a Spec Kit extension.
+
+## Quick Start
+
+1. **Copy this template**:
+
+   ```bash
+   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**:
+
+   ```bash
+   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
--- a/extensions/template/commands/example.md
+++ b/extensions/template/commands/example.md
@@ -0,0 +1,210 @@
+---
+description: "Example command that demonstrates extension functionality"
+# CUSTOMIZE: List MCP tools this command uses
+tools:
+  - 'example-mcp-server/example_tool'
+---
+
+# Example Command
+
+<!-- CUSTOMIZE: Replace this entire file with your command documentation -->
+
+This is an example command that demonstrates how to create commands for Spec Kit extensions.
+
+## Purpose
+
+Describe what this command does and when to use it.
+
+## Prerequisites
+
+List requirements before using this command:
+
+1. Prerequisite 1 (e.g., "MCP server configured")
+2. Prerequisite 2 (e.g., "Configuration file exists")
+3. Prerequisite 3 (e.g., "Valid API credentials")
+
+## User Input
+
+$ARGUMENTS
+
+## Steps
+
+### Step 1: Load Configuration
+
+<!-- CUSTOMIZE: Replace with your actual steps -->
+
+Load extension configuration from the project:
+
+``bash
+config_file=".specify/extensions/my-extension/my-extension-config.yml"
+
+if [ ! -f "$config_file" ]; then
+  echo "❌ Error: Configuration not found at $config_file"
+  echo "Run 'specify extension add my-extension' to install and configure"
+  exit 1
+fi
+
+# Read configuration values
+
+setting_value=$(yq eval '.settings.key' "$config_file")
+
+# Apply environment variable overrides
+
+setting_value="${SPECKIT_MY_EXTENSION_KEY:-$setting_value}"
+
+# Validate configuration
+
+if [ -z "$setting_value" ]; then
+  echo "❌ Error: Configuration value not set"
+  echo "Edit $config_file and set 'settings.key'"
+  exit 1
+fi
+
+echo "📋 Configuration loaded: $setting_value"
+``
+
+### Step 2: Perform Main Action
+
+<!-- CUSTOMIZE: Replace with your command logic -->
+
+Describe what this step does:
+
+``markdown
+Use MCP tools to perform the main action:
+
+- Tool: example-mcp-server example_tool
+- Parameters: { "key": "$setting_value" }
+
+This calls the MCP server tool to execute the operation.
+``
+
+### Step 3: Process Results
+
+<!-- CUSTOMIZE: Add more steps as needed -->
+
+Process the results and provide output:
+
+`` bash
+echo ""
+echo "✅ Command completed successfully!"
+echo ""
+echo "Results:"
+echo "  • Item 1: Value"
+echo "  • Item 2: Value"
+echo ""
+``
+
+### Step 4: Save Output (Optional)
+
+Save results to a file if needed:
+
+``bash
+output_file=".specify/my-extension-output.json"
+
+cat > "$output_file" <<EOF
+{
+  "timestamp": "$(date -u +"%Y-%m-%dT%H:%M:%SZ")",
+  "setting": "$setting_value",
+  "results": []
+}
+EOF
+
+echo "💾 Output saved to $output_file"
+``
+
+## Configuration Reference
+
+<!-- CUSTOMIZE: Document configuration options -->
+
+This command uses the following configuration from `my-extension-config.yml`:
+
+- **settings.key**: Description of what this setting does
+  - Type: string
+  - Required: Yes
+  - Example: `"example-value"`
+
+- **settings.another_key**: Description of another setting
+  - Type: boolean
+  - Required: No
+  - Default: `false`
+  - Example: `true`
+
+## Environment Variables
+
+<!-- CUSTOMIZE: Document environment variable overrides -->
+
+Configuration can be overridden with environment variables:
+
+- `SPECKIT_MY_EXTENSION_KEY` - Overrides `settings.key`
+- `SPECKIT_MY_EXTENSION_ANOTHER_KEY` - Overrides `settings.another_key`
+
+Example:
+``bash
+export SPECKIT_MY_EXTENSION_KEY="override-value"
+``
+
+## Troubleshooting
+
+<!-- CUSTOMIZE: Add common issues and solutions -->
+
+### "Configuration not found"
+
+**Solution**: Install the extension and create configuration:
+``bash
+specify extension add my-extension
+cp .specify/extensions/my-extension/config-template.yml \
+   .specify/extensions/my-extension/my-extension-config.yml
+``
+
+### "MCP tool not available"
+
+**Solution**: Ensure MCP server is configured in your AI agent settings.
+
+### "Permission denied"
+
+**Solution**: Check credentials and permissions in the external service.
+
+## Notes
+
+<!-- CUSTOMIZE: Add helpful notes and tips -->
+
+- This command requires an active connection to the external service
+- Results are cached for performance
+- Re-run the command to refresh data
+
+## Examples
+
+<!-- CUSTOMIZE: Add usage examples -->
+
+### Example 1: Basic Usage
+
+``bash
+
+# Run with default configuration
+>
+> /speckit.my-extension.example
+``
+
+### Example 2: With Environment Override
+
+``bash
+
+# Override configuration with environment variable
+
+export SPECKIT_MY_EXTENSION_KEY="custom-value"
+> /speckit.my-extension.example
+``
+
+### Example 3: After Core Command
+
+``bash
+
+# Use as part of a workflow
+>
+> /speckit.tasks
+> /speckit.my-extension.example
+``
+
+---
+
+*For more information, see the extension README or run `specify extension info my-extension`*
--- a/extensions/template/config-template.yml
+++ b/extensions/template/config-template.yml
@@ -0,0 +1,75 @@
+# Extension Configuration Template
+# Copy this to my-extension-config.yml and customize for your project
+
+# CUSTOMIZE: Add your configuration sections below
+
+# Example: Connection settings
+connection:
+  # URL to external service
+  url: ""  # REQUIRED: e.g., "https://api.example.com"
+
+  # API key or token
+  api_key: ""  # REQUIRED: Your API key
+
+# Example: Project settings
+project:
+  # Project identifier
+  id: ""  # REQUIRED: e.g., "my-project"
+
+  # Workspace or organization
+  workspace: ""  # OPTIONAL: e.g., "my-org"
+
+# Example: Feature flags
+features:
+  # Enable/disable main functionality
+  enabled: true
+
+  # Automatic synchronization
+  auto_sync: false
+
+  # Verbose logging
+  verbose: false
+
+# Example: Default values
+defaults:
+  # Labels to apply
+  labels: []  # e.g., ["automated", "spec-kit"]
+
+  # Priority level
+  priority: "medium"  # Options: "low", "medium", "high"
+
+  # Assignee
+  assignee: ""  # OPTIONAL: Default assignee
+
+# Example: Field mappings
+# Map internal names to external field IDs
+field_mappings:
+  # Example mappings
+  # internal_field: "external_field_id"
+  # status: "customfield_10001"
+
+# Example: Advanced settings
+advanced:
+  # Timeout in seconds
+  timeout: 30
+
+  # Retry attempts
+  retry_count: 3
+
+  # Cache duration in seconds
+  cache_duration: 3600
+
+# Environment Variable Overrides:
+# You can override any setting with environment variables  using this pattern:
+# SPECKIT_MY_EXTENSION_{SECTION}_{KEY}
+#
+# Examples:
+# - SPECKIT_MY_EXTENSION_CONNECTION_API_KEY: Override connection.api_key
+# - SPECKIT_MY_EXTENSION_PROJECT_ID: Override project.id
+# - SPECKIT_MY_EXTENSION_FEATURES_ENABLED: Override features.enabled
+#
+# Note: Use uppercase and replace dots with underscores
+
+# Local Overrides:
+# For local development, create my-extension-config.local.yml (gitignored)
+# to override settings without affecting the team configuration
--- a/extensions/template/extension.yml
+++ b/extensions/template/extension.yml
@@ -0,0 +1,97 @@
+schema_version: "1.0"
+
+extension:
+  # CUSTOMIZE: Change 'my-extension' to your extension ID (lowercase, hyphen-separated)
+  id: "my-extension"
+
+  # CUSTOMIZE: Human-readable name for your extension
+  name: "My Extension"
+
+  # CUSTOMIZE: Update version when releasing (semantic versioning: X.Y.Z)
+  version: "1.0.0"
+
+  # CUSTOMIZE: Brief description (under 200 characters)
+  description: "Brief description of what your extension does"
+
+  # CUSTOMIZE: Your name or organization name
+  author: "Your Name"
+
+  # CUSTOMIZE: GitHub repository URL (create before publishing)
+  repository: "https://github.com/your-org/spec-kit-my-extension"
+
+  # REVIEW: License (MIT is recommended for open source)
+  license: "MIT"
+
+  # CUSTOMIZE: Extension homepage (can be same as repository)
+  homepage: "https://github.com/your-org/spec-kit-my-extension"
+
+# Requirements for this extension
+requires:
+  # CUSTOMIZE: Minimum spec-kit version required
+  # Use >=X.Y.Z for minimum version
+  # Use >=X.Y.Z,<Y.0.0 for version range
+  speckit_version: ">=0.1.0"
+
+  # CUSTOMIZE: Add MCP tools or other dependencies
+  # Remove if no external tools required
+  tools:
+    - name: "example-mcp-server"
+      version: ">=1.0.0"
+      required: true
+
+# Commands provided by this extension
+provides:
+  commands:
+    # CUSTOMIZE: Define your commands
+    # Pattern: speckit.{extension-id}.{command-name}
+    - name: "speckit.my-extension.example"
+      file: "commands/example.md"
+      description: "Example command that demonstrates functionality"
+      # Optional: Add aliases for shorter command names
+      aliases: ["speckit.example"]
+
+    # ADD MORE COMMANDS: Copy this block for each command
+    # - name: "speckit.my-extension.another-command"
+    #   file: "commands/another-command.md"
+    #   description: "Another command"
+
+  # CUSTOMIZE: Define configuration files
+  config:
+    - name: "my-extension-config.yml"
+      template: "config-template.yml"
+      description: "Extension configuration"
+      required: true # Set to false if config is optional
+
+# CUSTOMIZE: Define hooks (optional)
+# Remove if no hooks needed
+hooks:
+  # Hook that runs after /speckit.tasks
+  after_tasks:
+    command: "speckit.my-extension.example"
+    optional: true # User will be prompted
+    prompt: "Run example command?"
+    description: "Demonstrates hook functionality"
+    condition: null # Future: conditional execution
+
+  # ADD MORE HOOKS: Copy this block for other events
+  # after_implement:
+  #   command: "speckit.my-extension.another"
+  #   optional: false  # Auto-execute without prompting
+  #   description: "Runs automatically after implementation"
+
+# CUSTOMIZE: Add relevant tags (2-5 recommended)
+# Used for discovery in catalog
+tags:
+  - "example"
+  - "template"
+  # ADD MORE: "category", "tool-name", etc.
+
+# CUSTOMIZE: Default configuration values (optional)
+# These are merged with user config
+defaults:
+  # Example default values
+  feature:
+    enabled: true
+    auto_sync: false
+
+  # ADD MORE: Any default settings for your extension