Scaffold & CLI
Scaffold apps with create-velkin-app and wire MCP with velkin-mcp init.
Packages are in pre-release validation. Scaffold and install commands succeed after packages appear on npm; until then, use this page as a CLI preview.
Before you begin
- Node.js 18+ and npm (or another package manager)
- For MCP wiring: a Cursor (or other MCP) client that can load config under your project
Scaffold a new app
Generates a starter with theme provider, example UI, MCP config, and AGENTS.md. Pick the template for your stack:
npx create-velkin-app my-app --template vite # React + Vite
npx create-velkin-app my-app --template vue # Vue + Vite
npx create-velkin-app my-app --template next # React + Next.js
cd my-app && npm install && npm run devWire MCP into an existing app
Writes MCP config + AGENTS.md from @velkin/mcp templates. Pick your IDE client:
npx velkin-mcp init --client cursor # .cursor/mcp.json + skill
npx velkin-mcp init --client vscode # .vscode/mcp.json
npx velkin-mcp init --client claude # .mcp.json
npx velkin-mcp init --client all # all of the above
npx velkin-mcp --healthFull IDE / environment guide: MCP servers. Remote URL (no install): https://mcp.velkinui.com/mcp.
Install packages directly
Prefer the scaffold when starting fresh. For an existing app, install one wrapper package — @velkin/ui comes with it. See Installation.
npm install @velkin/reactCommon problems
| Symptom | Fix |
|---|---|
create-velkin-app / install fails | Confirm packages are published on npm; check Node version (18+) |
| MCP tools missing in Cursor | Re-run npx velkin-mcp init --client cursor and restart the client |
velkin-mcp --health fails | Confirm network access to the published package and mcp.velkinui.com/mcp |
Next steps
- Quick start — theme provider and first component
- Installation — framework wiring
- MCP servers — agent tool loop
- AGENTS.md — consumer contract