Skip to content

docs: document integration search/info/scaffold subcommands (#3174) #3194

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Noor-ul-ain001 wants to merge 1 commit into
base: main
Choose a base branch
from
+33 −0
Open

docs: document integration search/info/scaffold subcommands (#3174) #3194

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions docs/reference/integrations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,27 @@ Shows all available integrations, which one is currently installed, and whether
When multiple integrations are installed, the list marks the default integration separately from the other installed integrations.
The list also shows whether each built-in integration is declared multi-install safe.

## Search Available Integrations

```bash
specify integration search [query]
```

| Option | Description |
| ---------- | ------------------ |
| `--tag` | Filter by tag |
| `--author` | Filter by author |

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.

## Integration Info

```bash
specify integration info <integration_id>
```

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.

## Install an Integration

```bash
Expand Down Expand Up @@ -166,6 +187,18 @@ Example:
specify integration install generic --integration-options="--commands-dir .myagent/cmds"
```

## Scaffold a New Integration

```bash
specify integration scaffold <key>
```

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`).

| Option | Description |
| -------- | ---------------------------------------------------------------- |
| `--type` | Scaffold template to use: `markdown` (default), `skills`, `toml`, or `yaml` |

## FAQ

### Can I install multiple integrations in the same project?
Expand Down