convex-quickstart

Scaffold a new Convex project or integrate Convex into an existing frontend app.

Claude Code

What it does

Starting a brand new project with Convex
Adding Convex to an existing React, Next.js, Vue, Svelte, or other app
Scaffolding a Convex app for prototyping
The project already has Convex installed and convex/ exists - just start
You only need to add auth to an existing Convex app - use the
Provisions an anonymous local Convex backend bound to 127.0.0.1. No
Writes CONVEXDEPLOYMENT and the framework's CONVEXURL variables to

Requirements & configuration

You only need to add auth to an existing Convex app - use the
simple apps or nextjs-shadcn for apps that need SSR or API routes.
The env var name depends on the framework:

Configuration: CONVEX_DEPLOYMENTCONVEX_AGENT_MODEVITE_CONVEX_URLNEXT_PUBLIC_CONVEX_URLCONVEX_URLEXPO_PUBLIC_CONVEX_URL

Derived from the skill's own SKILL.md documentation · extracted 2026-07-23

Scaffold a new Convex project or integrate Convex into an existing frontend app.

Source

Repository: https://github.com/get-convex/agent-skills

convex-quickstart FAQ

What does the convex-quickstart skill do?

Creates or adds Convex to an app. Use for new Convex projects, npm create convex@latest, frontend setup, env vars, or the first npx convex dev run. Starting a brand new project with Convex Adding Convex to an existing React, Next.js, Vue, Svelte, or other app

What does convex-quickstart require?

You only need to add auth to an existing Convex app - use the simple apps or nextjs-shadcn for apps that need SSR or API routes. The env var name depends on the framework: Configuration keys: CONVEX_DEPLOYMENT, CONVEX_AGENT_MODE, VITE_CONVEX_URL, NEXT_PUBLIC_CONVEX_URL, CONVEX_URL, EXPO_PUBLIC_CONVEX_URL.

How do I install convex-quickstart?

Run: npx -y skills add https://github.com/get-convex/agent-skills --skill convex-quickstart --agent claude-code — the source lives at github.com/get-convex/agent-skills.

Maintain convex-quickstart?

Let people know it's listed here — add the badge (live metrics, light/dark aware) or a plain link to your README or docs.

[![convex-quickstart on getagentictools](https://getagentictools.com/badge/skills/get-convex-agent-skills-convex-quickstart.svg)](https://getagentictools.com/skills/get-convex-agent-skills-convex-quickstart?ref=badge)

npx agentictools info skills/get-convex-agent-skills-convex-quickstart

The second line is the CLI lookup for this page — handy in READMEs and docs.