extensions/template/EXAMPLE-README.md
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.
Brief description of what your extension does and why it's useful.
# Install from catalog
specify extension add my-extension
# Or install from local development directory
specify extension add --dev /path/to/my-extension
Create configuration file:
cp .specify/extensions/my-extension/config-template.yml \
.specify/extensions/my-extension/my-extension-config.yml
Edit configuration:
vim .specify/extensions/my-extension/my-extension-config.yml
Set required values:
<!-- CUSTOMIZE: List required configuration -->connection:
url: "https://api.example.com"
api_key: "your-api-key"
project:
id: "your-project-id"
Description of what this command does.
# In Claude Code
> /speckit.my-extension.example
Prerequisites:
Output:
| Setting | Type | Required | Description |
|---|---|---|---|
connection.url | string | Yes | API endpoint URL |
connection.api_key | string | Yes | API authentication key |
| Setting | Type | Required | Description |
|---|---|---|---|
project.id | string | Yes | Project identifier |
project.workspace | string | No | Workspace or organization |
Override configuration with environment variables:
# Override connection settings
export SPECKIT_MY_EXTENSION_CONNECTION_URL="https://custom-api.com"
export SPECKIT_MY_EXTENSION_CONNECTION_API_KEY="custom-key"
# Step 1: Create specification
> /speckit.spec
# Step 2: Generate tasks
> /speckit.tasks
# Step 3: Use extension
> /speckit.my-extension.example
Solution: Create config from template (see Configuration section)
Solutions:
specify extension listMIT License - see LICENSE file
See CHANGELOG.md for version history.
Extension Version: 1.0.0 Spec Kit: >=0.1.0