Skip to content

Commit dc6a65a

Browse files
committed
fix(docs): update assistants index page for v2 schema sections
Update summary table with corrected hook event counts and replace plugin model bullet with component paths, extension model, and roadmap sections matching the new adoption spec structure.
1 parent 8eef940 commit dc6a65a

1 file changed

Lines changed: 40 additions & 0 deletions

File tree

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
title: "Assistants"
3+
description: "AI coding assistant adoption specifications for ccpkg cross-tool portability."
4+
---
5+
6+
# Assistant Adoption Specifications
7+
8+
ccpkg achieves cross-tool portability through a three-layer specification system:
9+
10+
1. **Core Specification** — Defines the universal packaging format, manifest schema, component types, and lifecycle operations. Tool-agnostic by design.
11+
12+
2. **[Adoption Meta-Specification](/specification/overview#relationship-to-assistant-adoption-specifications)** — Defines the contract for what an adoption spec must contain: identity fields, component support levels, hook event mappings, MCP integration details, and adapter operations.
13+
14+
3. **Individual Adoption Specs** — One JSON file per assistant, declaring exactly how that assistant integrates with ccpkg. Machine-validated against a JSON Schema.
15+
16+
## Reading an Adoption Spec
17+
18+
Each assistant page below documents:
19+
20+
- **Component Support** — Which ccpkg component types the assistant supports natively, via adapter, experimentally, or not at all.
21+
- **Instructions** — The filename and format the assistant uses for instruction injection.
22+
- **Hook Events** — How ccpkg canonical event names map to the assistant's native hook events, plus any host-specific events.
23+
- **MCP Integration** — Transport support, credential prefix, and configuration locations.
24+
- **Component Paths** — Where each component type is installed at user and project scope.
25+
- **Extension Model** — How the assistant discovers and loads extensions (bundle vs scatter).
26+
- **Roadmap** — Planned or in-progress changes to the assistant's ccpkg support.
27+
28+
## Contributing
29+
30+
To add support for a new assistant, create a JSON file in `spec/assistants/` following the [adoption specification format](/specification/overview#relationship-to-assistant-adoption-specifications). See the [Contributing Guide](https://github.com/zircote/ccpkg/blob/main/CONTRIBUTING.md) for details.
31+
32+
## Supported Assistants
33+
34+
| Assistant | Vendor | Instructions File | Hook Events | MCP |
35+
|---|---|---|---|---|
36+
| [Claude Code](/assistants/claude-code) | Anthropic | `CLAUDE.md` | 7 canonical + 10 host-specific | Native |
37+
| [Copilot CLI](/assistants/copilot-cli) | GitHub | `.github/copilot-instructions.md` | 6 canonical | Native |
38+
| [Codex CLI](/assistants/codex-cli) | OpenAI | `AGENTS.md` | 1 canonical + 1 host-specific | Native |
39+
| [Gemini CLI](/assistants/gemini-cli) | Google | `GEMINI.md` | 6 canonical + 5 host-specific | Native |
40+
| [OpenCode](/assistants/opencode) | sst | `AGENTS.md` | 4 canonical + 9 host-specific | Native |

0 commit comments

Comments
 (0)