Skip to content

Commit 00f6a80

Browse files
docs: document integration catalog subcommands (#3206)
* docs: document integration catalog subcommands the integration reference omits the 'specify integration catalog' subcommand group (list/add/remove) that exists in code, while the extension, preset, and workflow references all document their catalog equivalents. add a catalog management section matching that structure. * docs: address review feedback on integration catalog section - catalogs are consulted by the discovery commands (search/info), not install; install resolves from the built-in registry - 'catalog list' shows project sources as removable only when configured, otherwise active sources are non-removable
1 parent 4badf3b commit 00f6a80

1 file changed

Lines changed: 41 additions & 0 deletions

File tree

docs/reference/integrations.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -173,6 +173,47 @@ is `null` when no installed integration set can be evaluated, such as when the
173173
integration state is missing, unreadable, lacks a valid recorded integration
174174
list, or records no installed integrations.
175175

176+
## Catalog Management
177+
178+
Integration catalogs control where the discovery commands (`search` and `info`) look for integrations. Catalogs are checked in priority order.
179+
180+
### List Catalogs
181+
182+
```bash
183+
specify integration catalog list
184+
```
185+
186+
Shows the active catalog sources. Project-level sources (when configured) are removable by index; otherwise the active sources are shown as non-removable.
187+
188+
### Add a Catalog
189+
190+
```bash
191+
specify integration catalog add <url>
192+
```
193+
194+
| Option | Description |
195+
| --------------- | ----------------------------- |
196+
| `--name <name>` | Optional name for the catalog |
197+
198+
Adds a custom catalog URL to the project's `.specify/integration-catalogs.yml`. The URL must use HTTPS (except `http://localhost`, `http://127.0.0.1`, or `http://[::1]` for local testing).
199+
200+
### Remove a Catalog
201+
202+
```bash
203+
specify integration catalog remove <index>
204+
```
205+
206+
Removes a project catalog source by its 0-based index in `catalog list`.
207+
208+
### Catalog Resolution Order
209+
210+
Catalogs are resolved in this order (first match wins):
211+
212+
1. **Environment variable**`SPECKIT_INTEGRATION_CATALOG_URL` overrides all catalogs
213+
2. **Project config**`.specify/integration-catalogs.yml`
214+
3. **User config**`~/.specify/integration-catalogs.yml`
215+
4. **Built-in defaults** — official catalog + community catalog
216+
176217
## Integration-Specific Options
177218

178219
Some integrations accept additional options via `--integration-options`:

0 commit comments

Comments
 (0)