|
| 1 | +# Vercel Plugin — AI Agent Instructions |
| 2 | + |
| 3 | +> Drop this file into any GitHub repo. AI coding agents (Claude Code, Codex, Cursor, Copilot, Grok Build) will pick it up automatically. |
| 4 | +
|
| 5 | +## Setup (one-time per machine) |
| 6 | + |
| 7 | +```bash |
| 8 | +npx plugins add vercel/vercel-plugin |
| 9 | +``` |
| 10 | + |
| 11 | +Requires Node.js 18+ and Bun. After install, session context is injected automatically for Vercel/Next.js projects. |
| 12 | + |
| 13 | +## Slash commands |
| 14 | + |
| 15 | +| Command | Purpose | |
| 16 | +|---|---| |
| 17 | +| `/vercel-plugin:bootstrap` | Link project, provision env vars, set up DB | |
| 18 | +| `/vercel-plugin:deploy` | Deploy preview; pass `prod` for production | |
| 19 | +| `/vercel-plugin:env` | List, pull, add, remove, diff env vars | |
| 20 | +| `/vercel-plugin:status` | Recent deployments and environment overview | |
| 21 | +| `/vercel-plugin:marketplace` | Discover and install Marketplace integrations | |
| 22 | + |
| 23 | +## Key skills (invoke on demand) |
| 24 | + |
| 25 | +- `nextjs` — App Router, Server Components, Server Actions, rendering strategies |
| 26 | +- `ai-sdk` — AI SDK v6: streaming, tool calling, agents, MCP, embeddings |
| 27 | +- `ai-gateway` — Unified API to 100+ models with failover and cost tracking |
| 28 | +- `vercel-functions` — Serverless, Edge, Fluid Compute, streaming, Cron Jobs |
| 29 | +- `vercel-storage` — Blob, Edge Config, Neon Postgres, Upstash Redis |
| 30 | +- `deployments-cicd` — Deploy, promote, rollback, `--prebuilt`, CI config |
| 31 | +- `env-vars` — `.env` files, `vercel env`, OIDC tokens |
| 32 | +- `routing-middleware` — Rewrites, redirects, personalization (Node.js/Edge/Bun) |
| 33 | +- `runtime-cache` — Per-region KV cache with tag-based invalidation |
| 34 | +- `shadcn` — shadcn/ui CLI, components, theming, Tailwind integration |
| 35 | +- `workflow` — Durable execution, DurableAgent, steps, pause/resume |
| 36 | +- `vercel-sandbox` — Ephemeral VMs for running untrusted/AI-generated code |
| 37 | +- `verification` — Browser, API, data, and response flow verification |
| 38 | + |
| 39 | +## Specialist agents |
| 40 | + |
| 41 | +- `deployment-expert` — CI/CD, deploy strategies, environment variables, rollbacks |
| 42 | +- `performance-optimizer` — Core Web Vitals, caching, rendering, asset optimization |
| 43 | +- `ai-architect` — AI app design, model selection, streaming, MCP integration |
| 44 | + |
| 45 | +## Platform defaults to assume |
| 46 | + |
| 47 | +- Framework: Next.js App Router |
| 48 | +- Compute: Fluid Compute (not legacy Edge Functions) |
| 49 | +- Node.js: 24 LTS (18 is deprecated) |
| 50 | +- Function timeout: 300s default |
| 51 | +- AI SDK: v6 with `"provider/model"` strings via AI Gateway |
| 52 | +- Config: `vercel.ts` preferred over `vercel.json` |
| 53 | +- Databases: Via Vercel Marketplace (Vercel Postgres/KV are retired) |
| 54 | + |
| 55 | +## Telemetry |
| 56 | + |
| 57 | +```bash |
| 58 | +export VERCEL_PLUGIN_TELEMETRY=off # disable |
| 59 | +export VERCEL_PLUGIN_LOG_LEVEL=debug # enable debug logs |
| 60 | +``` |
| 61 | + |
| 62 | +```bash |
| 63 | +npx vercel-plugin doctor # validate plugin health |
| 64 | +``` |
| 65 | + |
| 66 | +## Issues |
| 67 | + |
| 68 | +File bugs at <https://github.com/vercel/vercel-plugin/issues> with debug logs enabled. |
0 commit comments