|
2 | 2 |
|
3 | 3 | ## Getting Started |
4 | 4 |
|
| 5 | +### Supported Tools |
| 6 | + |
| 7 | +| Tool | Status | |
| 8 | +|------|--------| |
| 9 | +| [Claude Code](https://docs.anthropic.com/en/docs/claude-code) | Supported | |
| 10 | +| [Cursor](https://www.cursor.com) | Supported | |
| 11 | +| [OpenAI Codex](https://openai.com/index/codex/) | Coming soon | |
| 12 | + |
5 | 13 | ### Prerequisites |
6 | 14 |
|
7 | | -- An AI coding agent that supports plugins (e.g. [Claude Code](https://docs.anthropic.com/en/docs/claude-code)) |
| 15 | +- One of the supported AI coding tools listed above |
8 | 16 | - Node.js 18+ |
9 | 17 | - [Bun](https://bun.sh) |
10 | 18 |
|
11 | | -### Option 1: Install with `npx add-plugin` (recommended) |
| 19 | +### Installation |
12 | 20 |
|
13 | 21 | ```bash |
14 | 22 | npx plugins add vercel-labs/vercel-plugin |
15 | 23 | ``` |
16 | 24 |
|
17 | 25 | That's it. The plugin activates automatically — no setup, no commands to learn. |
18 | 26 |
|
19 | | -### Option 2: Clone and build manually |
20 | | - |
21 | | -```bash |
22 | | -git clone https://github.com/vercel-labs/vercel-plugin.git |
23 | | -cd vercel-plugin |
24 | | -bun install |
25 | | -bun run build |
26 | | -``` |
27 | | - |
28 | | -Then point your AI agent at the plugin directory (e.g. `claude --plugin-dir /path/to/vercel-plugin` for Claude Code). The plugin activates automatically — no setup, no commands to learn. |
29 | | - |
30 | | -#### Updating |
31 | | - |
32 | | -```bash |
33 | | -cd /path/to/vercel-plugin |
34 | | -git pull |
35 | | -bun install |
36 | | -bun run build |
37 | | -``` |
38 | | - |
39 | 27 | ## What It Does |
40 | 28 |
|
41 | 29 | This plugin pre-loads AI agents with a **relational knowledge graph** of the entire Vercel ecosystem — every product, library, CLI, API, and service — showing how they relate, when to use each, and providing deep guidance through bundled skills. |
@@ -113,26 +101,21 @@ A text-form relational graph covering: |
113 | 101 |
|
114 | 102 | ### Hooks |
115 | 103 |
|
116 | | -Currently implemented as [Claude Code hooks](https://docs.anthropic.com/en/docs/claude-code/hooks). We're actively working on making all hooks available to other major AI coding platforms. |
| 104 | +Lifecycle hooks that run automatically during your session: |
117 | 105 |
|
118 | | -- **SessionStart context injection** — Injects `vercel.md` (ecosystem graph + conventions) into every session |
119 | | -- **SessionStart repo profiler** — Scans config files and dependencies to pre-prime skill matching for faster first tool call |
120 | | -- **PreToolUse skill injection** — Matches tool calls to skills and injects relevant guidance with dedup |
| 106 | +- **Session start context injection** — Injects `vercel.md` (ecosystem graph + conventions) into every session |
| 107 | +- **Session start repo profiler** — Scans config files and dependencies to pre-prime skill matching for faster first tool call |
| 108 | +- **Pre-tool-use skill injection** — Matches tool calls to skills and injects relevant guidance with dedup |
121 | 109 | - **Pre-write/edit validation** — Catches deprecated patterns before they're written (sunset packages, old API names, renamed files) |
122 | 110 |
|
123 | 111 | ## Usage |
124 | 112 |
|
125 | | -```bash |
126 | | -# Claude Code example |
127 | | -claude --plugin-dir ./vercel-plugin |
| 113 | +After installing, skills and context are injected automatically. You can also invoke skills directly via slash commands: |
128 | 114 |
|
129 | | -# Invoke skills via slash commands |
| 115 | +``` |
130 | 116 | /vercel-plugin:nextjs |
131 | 117 | /vercel-plugin:ai-sdk |
132 | 118 | /vercel-plugin:deploy prod |
133 | | - |
134 | | -# vercel.md is injected at session start, |
135 | | -# giving the agent full Vercel context automatically. |
136 | 119 | ``` |
137 | 120 |
|
138 | 121 | ## Architecture |
|
0 commit comments