Convex Quickstart

Set up a working Convex project as fast as possible.

When to Use

• 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

When Not to Use

• The project already has Convex installed and convex/ exists - just start building
• You only need to add auth to an existing Convex app - use the convex-setup-auth skill

Workflow

1. Determine the starting point: new project or existing app
2. If new project, pick a template and scaffold with npm create convex@latest
3. If existing app, install convex and wire up the provider
4. Run npx convex dev to connect a deployment and start the dev loop
5. Verify the setup works

Path 1: New Project (Recommended)

Use the official scaffolding tool. It creates a complete project with the frontend framework, Convex backend, and all config wired together.

Pick a template

Template	Stack
react-vite-shadcn	React + Vite + Tailwind + shadcn/ui
nextjs-shadcn	Next.js App Router + Tailwind + shadcn/ui
react-vite-clerk-shadcn	React + Vite + Clerk auth + shadcn/ui
nextjs-clerk	Next.js + Clerk auth
nextjs-convexauth-shadcn	Next.js + Convex Auth + shadcn/ui
nextjs-lucia-shadcn	Next.js + Lucia auth + shadcn/ui
bare	Convex backend only, no frontend

If the user has not specified a preference, default to react-vite-shadcn for simple apps or nextjs-shadcn for apps that need SSR or API routes.

You can also use any GitHub repo as a template:

npm create convex@latest my-app -- -t owner/repo
npm create convex@latest my-app -- -t owner/repo#branch

Scaffold the project

Always pass the project name and template flag to avoid interactive prompts:

npm create convex@latest my-app -- -t react-vite-shadcn
cd my-app
npm install

The scaffolding tool creates files but does not run npm install, so you must run it yourself.

To scaffold in the current directory (if it is empty):

npm create convex@latest . -- -t react-vite-shadcn
npm install

Start the dev loop

npx convex dev is a long-running watcher process that syncs backend code to a Convex deployment on every save. It also requires authentication on first run (browser-based OAuth). Both of these make it unsuitable for an agent to run directly.

Ask the user to run this themselves:

Tell the user to run npx convex dev in their terminal. On first run it will prompt them to log in or develop anonymously. Once running, it will:

• Create a Convex project and dev deployment
• Write the deployment URL to .env.local
• Create the convex/ directory with generated types
• Watch for changes and sync continuously

The user should keep npx convex dev running in the background while you work on code. The watcher will automatically pick up any files you create or edit in convex/.

Exception - cloud or headless agents: Environments that cannot open a browser for interactive login should use Agent Mode (see below) to run anonymously without user interaction.

Start the frontend

The user should also run the frontend dev server in a separate terminal:

npm run dev

Vite apps serve on http://localhost:5173, Next.js on http://localhost:3000.

What you get

After scaffolding, the project structure looks like:

my-app/
  convex/           # Backend functions and schema
    _generated/     # Auto-generated types (check this into git)
    schema.ts       # Database schema (if template includes one)
  src/              # Frontend code (or app/ for Next.js)
  package.json
  .env.local        # CONVEX_URL / VITE_CONVEX_URL / NEXT_PUBLIC_CONVEX_URL

The template already has:

• ConvexProvider wired into the app root
• Correct env var names for the framework
• Tailwind and shadcn/ui ready (for shadcn templates)
• Auth provider configured (for auth templates)

Proceed to adding schema, functions, and UI.

Path 2: Add Convex to an Existing App

Use this when the user already has a frontend project and wants to add Convex as the backend.

Install

npm install convex

Initialize and start dev loop

Ask the user to run npx convex dev in their terminal. This handles login, creates the convex/ directory, writes the deployment URL to .env.local, and starts the file watcher. See the notes in Path 1 about why the agent should not run this directly.

Wire up the provider

The Convex client must wrap the app at the root. The setup varies by framework.

Create the ConvexReactClient at module scope, not inside a component:

// Bad: re-creates the client on every render
function App() {
  const convex = new ConvexReactClient(import.meta.env.VITE_CONVEX_URL as string);
  return <ConvexProvider client={convex}>...</ConvexProvider>;
}

// Good: created once at module scope
const convex = new ConvexReactClient(import.meta.env.VITE_CONVEX_URL as string);
function App() {
  return <ConvexProvider client={convex}>...</ConvexProvider>;
}

React (Vite)

// src/main.tsx
import { StrictMode } from "react";
import { createRoot } from "react-dom/client";
import { ConvexProvider, ConvexReactClient } from "convex/react";
import App from "./App";

const convex = new ConvexReactClient(import.meta.env.VITE_CONVEX_URL as string);

createRoot(document.getElementById("root")!).render(
  <StrictMode>
    <ConvexProvider client={convex}>
      <App />
    </ConvexProvider>
  </StrictMode>,
);

Next.js (App Router)

// app/ConvexClientProvider.tsx
"use client";

import { ConvexProvider, ConvexReactClient } from "convex/react";
import { ReactNode } from "react";

const convex = new ConvexReactClient(process.env.NEXT_PUBLIC_CONVEX_URL!);

export function ConvexClientProvider({ children }: { children: ReactNode }) {
  return <ConvexProvider client={convex}>{children}</ConvexProvider>;
}

// app/layout.tsx
import { ConvexClientProvider } from "./ConvexClientProvider";

export default function RootLayout({ children }: { children: React.ReactNode }) {
  return (
    <html lang="en">
      <body>
        <ConvexClientProvider>{children}</ConvexClientProvider>
      </body>
    </html>
  );
}

Other frameworks

For Vue, Svelte, React Native, TanStack Start, Remix, and others, follow the matching quickstart guide:

• Vue
• Svelte
• React Native
• TanStack Start
• Remix
• Node.js (no frontend)

Environment variables

The env var name depends on the framework:

Framework

Variable

Vite how to use convex-quickstart CursorClaude CodeClineCodexWindsurfGooseGitHub CopilotVS CodeGemini CLIKiloOpencodeKimi CLIRoo ClineAiderContinueZedBolt.newLovablev0Replit AgentSweepSmol DeveloperDevinCavemanAmpAntigravity How to use convex-quickstart on Cursor AI-first code editor with Composer 1 Prerequisites Before installing skills in Cursor, ensure your development environment meets these requirements: ›Cursor installed and configured on your development machine ›Node.js version 16.0+ with npm package manager (verify with node --version) ›Active project directory or workspace where you want to add convex-quickstart 2 Execute installation command Execute the skills CLI command in your project's root directory to begin installation: $npx skills add https://github.com/get-convex/agent-skills --skill convex-quickstartcopy The skills CLI fetches convex-quickstart from GitHub repository get-convex/agent-skills and configures it for Cursor. 3 Select Cursor when prompted The CLI will show a list of available agents. Use arrow keys to navigate and space to select Cursor: ◆ Which agents do you want to install to? │ │ ── Universal (.agents/skills) ── always included ──── │ • Amp │ • Antigravity │ • Cline │ • Codex │ ●Cursor(selected) │ • Cursor │ • Windsurf 4 Verify installation Confirm successful installation by checking the skill directory location: .cursor/skills/convex-quickstart Reload or restart Cursor to activate convex-quickstart. Access the skill through slash commands (e.g., /convex-quickstart) or your agent's skill management interface. ⚠ Security & Verification Notice We perform automated surface-level scans (Gen AI Scanner, Socket, Snyk) during installation. These checks detect common vulnerabilities but do not guarantee complete security. Always review skill source code and verify the publisher's reputation before production use. Skills execute code in your development environment. Always verify the publisher's identity, review recent commits, and test in isolated environments before production deployment. Additional Resources ›View source code on GitHub›Skills CLI documentation›Learn more about Cursor›What are agent skills? List & Monetize Your Skill Submit your Claude Code skill and start earning GET_STARTED → Use Cases▌ Task Automation & Efficiency Automate repetitive workflows and reduce manual effort Example Generate reports, summarize documents, draft communications ✓ Save 3-5 hours per week on routine tasks Knowledge Enhancement Learn new skills, understand complex topics, get expert guidance Example Explain concepts, provide examples, suggest learning resources ✓ Accelerate learning and skill development by 2x Quality Improvement Enhance output quality through reviews, suggestions, and refinements Example Review drafts, suggest improvements, catch errors ✓ Improve work quality by 30-40% with less effort Implementation Guide▌ Prerequisites ›Claude Desktop or compatible AI client with skill support ›Clear understanding of task or problem to solve ›Willingness to iterate and refine outputs Time Estimate 15-45 minutes depending on use case complexity Installation Steps 1.Install skill using provided installation command 2.Test with simple use case relevant to your work 3.Evaluate output quality and relevance 4.Iterate on prompts to improve results 5.Integrate into regular workflow if valuable Common Pitfalls ⚠Expecting perfect results without iteration ⚠Not providing enough context in prompts ⚠Using skill for tasks outside its intended scope ⚠Accepting outputs without review and validation Best Practices▌ ✓ Do +Start with clear, specific prompts +Provide relevant context and constraints +Review and refine all outputs before using +Iterate to improve output quality +Document successful prompt patterns ✗ Don't −Don't use without understanding skill limitations −Don't skip validation of outputs −Don't share sensitive information in prompts −Don't expect skill to replace human judgment 💡 Pro Tips ★Be specific about desired format and style ★Ask for multiple options to choose from ★Request explanations to understand reasoning ★Combine AI efficiency with human expertise When to Use This▌ ✓ Use When Use when skill capabilities match your task, clear ROI on time saved, and you can validate outputs. Best for repetitive tasks, learning, and quality improvement. ✗ Avoid When Avoid when task requires deep expertise you can't validate, involves sensitive decisions, or when learning process is more valuable than speed of completion. Learning Path▌ 1Familiarize yourself with skill capabilities and limitations 2Start with low-risk, non-critical tasks 3Progress to more complex and valuable use cases 4Build expertise through regular use and experimentation Discussion Product Hunt–style comments (not star reviews) post comment No comments yet — start the thread. general reviews Ratings 4.8★★★★★75 reviews ★★★★★Isabella Patel· Dec 24, 2024 I recommend convex-quickstart for anyone iterating fast on agent tooling; clear intent and a small, reviewable surface area. ★★★★★Dhruvi Jain· Dec 16, 2024 convex-quickstart has been reliable in day-to-day use. Documentation quality is above average for community skills. ★★★★★Amina Srinivasan· Dec 12, 2024 Solid pick for teams standardizing on skills: convex-quickstart is focused, and the summary matches what you get after install. ★★★★★Amina Dixit· Dec 12, 2024 convex-quickstart fits our agent workflows well — practical, well scoped, and easy to wire into existing repos. ★★★★★Chen Thompson· Dec 12, 2024 convex-quickstart reduced setup friction for our internal harness; good balance of opinion and flexibility. ★★★★★Li Mehta· Dec 8, 2024 I recommend convex-quickstart for anyone iterating fast on agent tooling; clear intent and a small, reviewable surface area. ★★★★★Harper Malhotra· Nov 27, 2024 convex-quickstart fits our agent workflows well — practical, well scoped, and easy to wire into existing repos. ★★★★★Mei Mensah· Nov 19, 2024 Useful defaults in convex-quickstart — fewer surprises than typical one-off scripts, and it plays nicely with `npx skills` flows. ★★★★★Amina Shah· Nov 15, 2024 convex-quickstart fits our agent workflows well — practical, well scoped, and easy to wire into existing repos. ★★★★★Amina Gill· Nov 11, 2024 convex-quickstart is among the better-maintained entries we tried; worth keeping pinned for repeat workflows. showing 1-10 of 75 prev1 / 8next bookmarkshare