Skip to content

Commit b29b04b

Browse files
authored
Revise community extensions in README
Updated community extension details and removed outdated entries.
1 parent 9d0d6be commit b29b04b

File tree

1 file changed

+25
-53
lines changed

1 file changed

+25
-53
lines changed

extensions/README.md

Lines changed: 25 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -1,45 +1,59 @@
11
# Spec Kit Extensions
22

3+
34
Extension system for [Spec Kit](https://github.com/github/spec-kit) - add new functionality without bloating the core framework.
45

6+
57
## Extension Catalogs
68

9+
710
Spec Kit provides two catalog files with different purposes:
811

12+
913
### Your Catalog (`catalog.json`)
1014

15+
1116
- **Purpose**: Default upstream catalog of extensions used by the Spec Kit CLI
1217
- **Default State**: Empty by design in the upstream project - you or your organization populate a fork/copy with extensions you trust
1318
- **Location (upstream)**: `extensions/catalog.json` in the GitHub-hosted spec-kit repo
1419
- **CLI Default**: The `specify extension` commands use the upstream catalog URL by default, unless overridden
1520
- **Org Catalog**: Point `SPECKIT_CATALOG_URL` at your organization's fork or hosted catalog JSON to use it instead of the upstream default
1621
- **Customization**: Copy entries from the community catalog into your org catalog, or add your own extensions directly
1722

23+
1824
**Example override:**
1925
```bash
2026
# Override the default upstream catalog with your organization's catalog
2127
export SPECKIT_CATALOG_URL="https://your-org.com/spec-kit/catalog.json"
2228
specify extension search # Now uses your organization's catalog instead of the upstream default
2329
```
2430

31+
2532
### Community Reference Catalog (`catalog.community.json`)
2633

34+
2735
- **Purpose**: Browse available community-contributed extensions
2836
- **Status**: Active - contains extensions submitted by the community
2937
- **Location**: `extensions/catalog.community.json`
3038
- **Usage**: Reference catalog for discovering available extensions
3139
- **Submission**: Open to community contributions via Pull Request
3240

41+
3342
**How It Works:**
3443

44+
3545
## Making Extensions Available
3646

47+
3748
You control which extensions your team can discover and install:
3849

50+
3951
### Option 1: Curated Catalog (Recommended for Organizations)
4052

53+
4154
Populate your `catalog.json` with approved extensions:
4255

56+
4357
1. **Discover** extensions from various sources:
4458
- Browse `catalog.community.json` for community extensions
4559
- Find private/internal extensions in your organization's repos
@@ -50,82 +64,40 @@ Populate your `catalog.json` with approved extensions:
5064
- `specify extension search` shows your curated catalog
5165
- `specify extension add <name>` installs from your catalog
5266

67+
5368
**Benefits**: Full control over available extensions, team consistency, organizational approval workflow
5469

70+
5571
**Example**: Copy an entry from `catalog.community.json` to your `catalog.json`, then your team can discover and install it by name.
5672

73+
5774
### Option 2: Direct URLs (For Ad-hoc Use)
5875

76+
5977
Skip catalog curation - team members install directly using URLs:
6078

79+
6180
```bash
6281
specify extension add --from https://github.com/org/spec-kit-ext/archive/refs/tags/v1.0.0.zip
6382
```
6483

84+
6585
**Benefits**: Quick for one-off testing or private extensions
6686

87+
6788
**Tradeoff**: Extensions installed this way won't appear in `specify extension search` for other team members unless you also add them to your `catalog.json`.
6889

90+
6991
## Available Community Extensions
7092

93+
7194
The following community-contributed extensions are available in [`catalog.community.json`](catalog.community.json):
7295

96+
7397
| Extension | Purpose | URL |
7498
|-----------|---------|-----|
7599
| Azure DevOps Integration | Sync user stories and tasks to Azure DevOps work items using OAuth authentication | [spec-kit-azure-devops](https://github.com/pragya247/spec-kit-azure-devops) |
76100
| Cleanup Extension | Post-implementation quality gate that reviews changes, fixes small issues (scout rule), creates tasks for medium issues, and generates analysis for large issues | [spec-kit-cleanup](https://github.com/dsrednicki/spec-kit-cleanup) |
77-
| DocGuard — CDD Enforcement | Canonical-Driven Development enforcement. Generates, validates, scores, and traces project documentation against 51 automated checks with config-aware traceability, quality labels, and AI-ready fix prompts. Zero dependencies. | [spec-kit-docguard](https://github.com/raccioly/docguard) |
101+
| DocGuard — CDD Enforcement | Canonical-Driven Development enforcement. Generates, validates, scores, and traces project documentation against 92 automated checks with config-aware traceability, quality labels, and AI-ready fix prompts. Zero dependencies. | [spec-kit-docguard](https://github.com/raccioly/docguard) |
78102
| Fleet Orchestrator | Orchestrate a full feature lifecycle with human-in-the-loop gates across all SpecKit phases | [spec-kit-fleet](https://github.com/sharathsatish/spec-kit-fleet) |
79103
| Jira Integration | Create Jira Epics, Stories, and Issues from spec-kit specifications and task breakdowns with configurable hierarchy and custom field support | [spec-kit-jira](https://github.com/mbachorik/spec-kit-jira) |
80-
| Project Health Check | Diagnose a Spec Kit project and report health issues across structure, agents, features, scripts, extensions, and git | [spec-kit-doctor](https://github.com/KhawarHabibKhan/spec-kit-doctor) |
81-
| Ralph Loop | Autonomous implementation loop using AI agent CLI | [spec-kit-ralph](https://github.com/Rubiss/spec-kit-ralph) |
82-
| Retrospective Extension | Post-implementation retrospective with spec adherence scoring, drift analysis, and human-gated spec updates | [spec-kit-retrospective](https://github.com/emi-dm/spec-kit-retrospective) |
83-
| Review Extension | Post-implementation comprehensive code review with specialized agents for code quality, comments, tests, error handling, type design, and simplification | [spec-kit-review](https://github.com/ismaelJimenez/spec-kit-review) |
84-
| Spec Sync | Detect and resolve drift between specs and implementation. AI-assisted resolution with human approval | [spec-kit-sync](https://github.com/bgervin/spec-kit-sync) |
85-
| Understanding | Automated requirements quality analysis — 31 deterministic metrics against IEEE/ISO standards with experimental energy-based ambiguity detection | [understanding](https://github.com/Testimonial/understanding) |
86-
| V-Model Extension Pack | Enforces V-Model paired generation of development specs and test specs with full traceability | [spec-kit-v-model](https://github.com/leocamello/spec-kit-v-model) |
87-
| Verify Extension | Post-implementation quality gate that validates implemented code against specification artifacts | [spec-kit-verify](https://github.com/ismaelJimenez/spec-kit-verify) |
88-
89-
90-
## Adding Your Extension
91-
92-
### Submission Process
93-
94-
To add your extension to the community catalog:
95-
96-
1. **Prepare your extension** following the [Extension Development Guide](EXTENSION-DEVELOPMENT-GUIDE.md)
97-
2. **Create a GitHub release** for your extension
98-
3. **Submit a Pull Request** that:
99-
- Adds your extension to `extensions/catalog.community.json`
100-
- Updates this README with your extension in the Available Extensions table
101-
4. **Wait for review** - maintainers will review and merge if criteria are met
102-
103-
See the [Extension Publishing Guide](EXTENSION-PUBLISHING-GUIDE.md) for detailed step-by-step instructions.
104-
105-
### Submission Checklist
106-
107-
Before submitting, ensure:
108-
109-
- ✅ Valid `extension.yml` manifest
110-
- ✅ Complete README with installation and usage instructions
111-
- ✅ LICENSE file included
112-
- ✅ GitHub release created with semantic version (e.g., v1.0.0)
113-
- ✅ Extension tested on a real project
114-
- ✅ All commands working as documented
115-
116-
## Installing Extensions
117-
Once extensions are available (either in your catalog or via direct URL), install them:
118-
119-
```bash
120-
# From your curated catalog (by name)
121-
specify extension search # See what's in your catalog
122-
specify extension add <extension-name> # Install by name
123-
124-
# Direct from URL (bypasses catalog)
125-
specify extension add --from https://github.com/<org>/<repo>/archive/refs/tags/<version>.zip
126-
127-
# List installed extensions
128-
specify extension list
129-
```
130-
131-
For more information, see the [Extension User Guide](EXTENSION-USER-GUIDE.md).

0 commit comments

Comments
 (0)