Skip to content

Commit 44ee131

Browse files
committed
docs(plugin): document Claude Code plugin install + skill inventory
1 parent acef370 commit 44ee131

1 file changed

Lines changed: 33 additions & 0 deletions

File tree

README.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -193,6 +193,39 @@ Here are a few useful resources to help you get started:
193193

194194
- Want to contribute but not sure how? [Join our Discord](https://discord.gg/6dffbvGU3D) and we'll help you out!
195195

196+
## Install as a Claude Code plugin
197+
198+
The CopilotKit monorepo doubles as a Claude Code pluginall 9 skills (3 package meta-skills + 6 lifecycle journey skills) are available once installed.
199+
200+
Add the repo as a Claude Code marketplace:
201+
202+
```bash
203+
claude plugin marketplace add https://github.com/CopilotKit/CopilotKit
204+
claude plugin install copilotkit
205+
```
206+
207+
Skills are discovered from `skills/<slug>/SKILL.md` at the repo root. The three package meta-skills (`runtime`, `react-core`, `a2ui-renderer`) are **generated mirrors** of the source-of-truth files at `packages/<pkg>/skills/<pkg>/`do not edit the mirror directly. To update content, edit the source under `packages/*/skills/` and run:
208+
209+
```bash
210+
pnpm sync:plugin-skills
211+
```
212+
213+
A lefthook pre-commit check (`pnpm check:plugin-skills`) rejects commits that drift the mirror. The plugin version is pinned to `packages/runtime/package.json` and is also kept in sync by the same script.
214+
215+
### Skill inventory
216+
217+
| Slug | Type | Source |
218+
| --- | --- | --- |
219+
| `runtime` | core | `packages/runtime/skills/runtime/` |
220+
| `react-core` | framework | `packages/react-core/skills/react-core/` |
221+
| `a2ui-renderer` | framework | `packages/a2ui-renderer/skills/a2ui-renderer/` |
222+
| `0-to-working-chat` | lifecycle | `skills/0-to-working-chat/` |
223+
| `spa-without-runtime` | lifecycle | `skills/spa-without-runtime/` |
224+
| `go-to-production` | lifecycle | `skills/go-to-production/` |
225+
| `scale-to-multi-agent` | lifecycle | `skills/scale-to-multi-agent/` |
226+
| `v1-to-v2-migration` | lifecycle | `skills/v1-to-v2-migration/` |
227+
| `debug-and-troubleshoot` | lifecycle | `skills/debug-and-troubleshoot/` |
228+
196229
## 📄 License
197230

198231
This repository's source code is available under the [MIT License](https://github.com/CopilotKit/CopilotKit/blob/main/LICENSE).

0 commit comments

Comments
 (0)