Skip to content

Commit 4f3bee7

Browse files
docs: document integration search/info/scaffold subcommands (#3174)
docs/reference/integrations.md omitted three subcommands that exist in code, breaking parity with the extension/preset/bundle/workflow references which all document their search/info equivalents. Added sections for: - `specify integration search [query]` (--tag, --author) - `specify integration info <integration_id>` - `specify integration scaffold <key>` (--type: markdown/skills/toml/yaml) Content mirrors the command docstrings, arguments, and options in src/specify_cli/integrations/_query_commands.py and _scaffold_commands.py. Fixes #3174. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent d65f6bd commit 4f3bee7

1 file changed

Lines changed: 33 additions & 0 deletions

File tree

docs/reference/integrations.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,27 @@ Shows all available integrations, which one is currently installed, and whether
5454
When multiple integrations are installed, the list marks the default integration separately from the other installed integrations.
5555
The list also shows whether each built-in integration is declared multi-install safe.
5656

57+
## Search Available Integrations
58+
59+
```bash
60+
specify integration search [query]
61+
```
62+
63+
| Option | Description |
64+
| ---------- | ------------------ |
65+
| `--tag` | Filter by tag |
66+
| `--author` | Filter by author |
67+
68+
Searches the active catalog stack for integrations matching the query. Without a query, lists all available integrations. Must be run inside a Spec Kit project.
69+
70+
## Integration Info
71+
72+
```bash
73+
specify integration info <integration_id>
74+
```
75+
76+
Shows catalog details for a single integration, including its description, type (CLI-based or IDE-based), author, and tags. Must be run inside a Spec Kit project.
77+
5778
## Install an Integration
5879

5980
```bash
@@ -166,6 +187,18 @@ Example:
166187
specify integration install generic --integration-options="--commands-dir .myagent/cmds"
167188
```
168189

190+
## Scaffold a New Integration
191+
192+
```bash
193+
specify integration scaffold <key>
194+
```
195+
196+
Creates a minimal built-in integration package and a matching test skeleton, then prints the next steps for wiring it up. The `<key>` must be lowercase kebab-case (for example, `my-agent`).
197+
198+
| Option | Description |
199+
| -------- | ---------------------------------------------------------------- |
200+
| `--type` | Scaffold template to use: `markdown` (default), `skills`, `toml`, or `yaml` |
201+
169202
## FAQ
170203

171204
### Can I install multiple integrations in the same project?

0 commit comments

Comments
 (0)