Skip to content

Commit 530d1ce

Browse files
mnriemmnriem
authored
docs: consolidate integration documentation into docs/integrations.md (#2241)
- New docs/integrations.md: canonical reference for supported agents table (with keys), list/install/uninstall/switch/upgrade commands, file preservation behavior, and integration-specific options - README.md: replace inline agents table with summary + link to new page; normalize heading to 'Supported AI Coding Agent Integrations' - docs/toc.yml: add top-level 'Reference' section with Integrations page - docs/upgrade.md: fix broken cross-reference, update terminology - CONTRIBUTING.md: update anchor link to new heading
1 parent c717cbb commit 530d1ce

File tree

5 files changed

+134
-37
lines changed

5 files changed

+134
-37
lines changed

‎CONTRIBUTING.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ These are one time installations required to be able to test your changes locall
1111
1. Install [Python 3.11+](https://www.python.org/downloads/)
1212
1. Install [uv](https://docs.astral.sh/uv/) for package management
1313
1. Install [Git](https://git-scm.com/downloads)
14-
1. Have an [AI coding agent available](README.md#-supported-ai-agents)
14+
1. Have an [AI coding agent available](README.md#-supported-ai-coding-agent-integrations)
1515

1616
<details>
1717
<summary><b>💡 Hint if you are using <code>VSCode</code> or <code>GitHub Codespaces</code> as your IDE</b></summary>

‎README.md‎

Lines changed: 7 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
- [🎨 Community Presets](#-community-presets)
2727
- [🚶 Community Walkthroughs](#-community-walkthroughs)
2828
- [🛠️ Community Friends](#️-community-friends)
29-
- [🤖 Supported AI Agents](#-supported-ai-agents)
29+
- [🤖 Supported AI Coding Agent Integrations](#-supported-ai-coding-agent-integrations)
3030
- [🔧 Specify CLI Reference](#-specify-cli-reference)
3131
- [🧩 Making Spec Kit Your Own: Extensions & Presets](#-making-spec-kit-your-own-extensions--presets)
3232
- [📚 Core Philosophy](#-core-philosophy)
@@ -314,38 +314,11 @@ Community projects that extend, visualize, or build on Spec Kit:
314314

315315
- **[SpecKit Companion](https://marketplace.visualstudio.com/items?itemName=alfredoperez.speckit-companion)** — A VS Code extension that brings a visual GUI to Spec Kit. Browse specs in a rich markdown viewer with clickable file references, create specifications with image attachments, comment and refine each step inline (GitHub-style review), track your progress through the SDD workflow with a visual phase stepper, and manage steering documents like constitutions and templates.
316316

317-
## 🤖 Supported AI Agents
318-
| Agent | Support | Notes |
319-
| ------------------------------------------------------------------------------------ | ------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
320-
| [Qoder CLI](https://qoder.com/cli) | ✅ | |
321-
| [Kiro CLI](https://kiro.dev/docs/cli/) | ✅ | Use `--ai kiro-cli` (alias: `--ai kiro`) |
322-
| [Amp](https://ampcode.com/) | ✅ | |
323-
| [Auggie CLI](https://docs.augmentcode.com/cli/overview) | ✅ | |
324-
| [Claude Code](https://www.anthropic.com/claude-code) | ✅ | Installs skills in `.claude/skills`; invoke spec-kit as `/speckit-constitution`, `/speckit-plan`, etc. |
325-
| [CodeBuddy CLI](https://www.codebuddy.ai/cli) | ✅ | |
326-
| [Codex CLI](https://github.com/openai/codex) | ✅ | Requires `--ai-skills`. Codex recommends [skills](https://developers.openai.com/codex/skills) and treats [custom prompts](https://developers.openai.com/codex/custom-prompts) as deprecated. Spec-kit installs Codex skills into `.agents/skills` and invokes them as `$speckit-<command>`. |
327-
| [Cursor](https://cursor.sh/) | ✅ | |
328-
| [Forge](https://forgecode.dev/) | ✅ | CLI tool: `forge` |
329-
| [Gemini CLI](https://github.com/google-gemini/gemini-cli) | ✅ | |
330-
| [Goose](https://block.github.io/goose/) | ✅ | Uses YAML recipe format in `.goose/recipes/` with slash command support |
331-
| [GitHub Copilot](https://code.visualstudio.com/) | ✅ | |
332-
| [IBM Bob](https://www.ibm.com/products/bob) | ✅ | IDE-based agent with slash command support |
333-
| [Jules](https://jules.google.com/) | ✅ | |
334-
| [Kilo Code](https://github.com/Kilo-Org/kilocode) | ✅ | |
335-
| [opencode](https://opencode.ai/) | ✅ | |
336-
| [Pi Coding Agent](https://pi.dev) | ✅ | Pi doesn't have MCP support out of the box, so `taskstoissues` won't work as intended. MCP support can be added via [extensions](https://github.com/badlogic/pi-mono/tree/main/packages/coding-agent#extensions) |
337-
| [Qwen Code](https://github.com/QwenLM/qwen-code) | ✅ | |
338-
| [Roo Code](https://roocode.com/) | ✅ | |
339-
| [SHAI (OVHcloud)](https://github.com/ovh/shai) | ✅ | |
340-
| [Tabnine CLI](https://docs.tabnine.com/main/getting-started/tabnine-cli) | ✅ | |
341-
| [Mistral Vibe](https://github.com/mistralai/mistral-vibe) | ✅ | |
342-
| [Kimi Code](https://code.kimi.com/) | ✅ | |
343-
| [iFlow CLI](https://docs.iflow.cn/en/cli/quickstart) | ✅ | |
344-
| [Windsurf](https://windsurf.com/) | ✅ | |
345-
| [Junie](https://junie.jetbrains.com/) | ✅ | |
346-
| [Antigravity (agy)](https://antigravity.google/) | ✅ | Requires `--ai-skills` |
347-
| [Trae](https://www.trae.ai/) | ✅ | |
348-
| Generic | ✅ | Bring your own agent — use `--ai generic --ai-commands-dir <path>` for unsupported agents |
317+
## 🤖 Supported AI Coding Agent Integrations
318+
319+
Spec Kit works with 30+ AI coding agents — both CLI tools and IDE-based assistants. See the full list with notes and usage details in the [Supported AI Coding Agent Integrations](docs/integrations.md) guide.
320+
321+
Run `specify integration list` to see all available integrations in your installed version.
349322

350323
## Available Slash Commands
351324

@@ -611,7 +584,7 @@ Our research and experimentation focus on:
611584
## 🔧 Prerequisites
612585

613586
- **Linux/macOS/Windows**
614-
- [Supported](#-supported-ai-agents) AI coding agent.
587+
- [Supported](#-supported-ai-coding-agent-integrations) AI coding agent.
615588
- [uv](https://docs.astral.sh/uv/) for package management
616589
- [Python 3.11+](https://www.python.org/downloads/)
617590
- [Git](https://git-scm.com/downloads)

0 commit comments

Comments
 (0)