verapli
Sign inJoin free
Menu

Guides · database · Everyday developer services

Convex project and deploy keys

Run npx convex dev to log in with GitHub and create a Convex project and dev deployment, then generate a production deploy key for CI and hosting.

Researched · not yet run liveLast researched 25 October 2026 · Convex · provider site

Researched, not yet run live. Built from the provider’s official pages (linked below). A person hasn’t walked this flow end to end yet, so check each step against the source.
Do this with verapliJSON for agents

Who owns what

A Convex team owns projects; each project has a production deployment and per-developer dev deployments.

  • Convex account (GitHub login) personal owned by the person
  • Project project

Have ready

  • A GitHub account (npx convex dev prompts to log in with GitHub).

Steps

Steps marked “human step” are ones only you can do: verapli never signs in, submits, pays or accepts terms for you.

  1. Log in and create the project

    In the app folder run npx convex dev. It prompts the person to log in with GitHub, creates the project and dev deployment, writes CONVEX_DEPLOYMENT to .env.local and keeps syncing functions.

    • Guided by hand
    • Human step: You sign in

  2. Generate a production deploy key

    In the Convex dashboard open the production deployment, Settings, General, and click Generate Production Deploy Key. verapli captures it into CONVEX_DEPLOY_KEY for the host's build step (npx convex deploy --cmd 'npm run build').

    • verapli co-pilot
    • Human step: You press submit
    • After: Log in and create the project

    verapli captures CONVEX_DEPLOY_KEY here by plain code: encrypted in your browser, never shown to AI.

    Where: https://dashboard.convex.dev/

What you end up with

Env varSecretFormatWhat it is
CONVEX_DEPLOYMENTnot secretName of the developer's dev deployment, written to .env.local by npx convex dev.
NEXT_PUBLIC_CONVEX_URLnot secretDeployment URL the Next.js client connects to (public).
CONVEX_DEPLOY_KEYsecretProduction (or preview) deploy key used by npx convex deploy in CI.

Pricing

  • Free tier: 1-6 developers, 1M function calls, 0.5 GB database storage, 1 GB file storage, 40 deployments.
  • Costs: Pay as you go beyond free limits on Starter; Professional $25 per developer/month.

Source [4]

For agents

The same entry as JSON: /api/v1/entries/convex/project · requirements /api/v1/requirements/convex/project · terms /api/v1/terms/convex/project.

Remote MCP (read-only, no auth)
claude mcp add --transport http verapli https://verapli.com/mcp

> "What do I need for Convex project and deploy keys, and how long will it take?"
  → tools/call requirements { "provider_id": "convex/project" }

Sources

  1. Next.js quickstart npx convex dev prompts to log in with GitHub, create a project, saves deployment URLs, creates convex/ folder and keeps syncing; app reads NEXT_PUBLIC_CONVEX_URL. · accessed 25 October 2026 · official
  2. Convex CLI npx convex dev creates .env.local with CONVEX_DEPLOYMENT (dev deployment name); npx convex deploy targets the deployment of CONVEX_DEPLOY_KEY if set; preview deploy keys create preview deployments named from the Git branch. · accessed 25 October 2026 · official
  3. Using Convex with Vercel Generate Production Deploy Key on the production deployment's Settings, General tab; env var CONVEX_DEPLOY_KEY; build command npx convex deploy --cmd 'npm run build'; Generate Preview Deploy Key in project Settings. · accessed 25 October 2026 · official
  4. Convex pricing Free & Starter plan 1-6 developers, 1M function calls, 0.5 GB database storage, 1 GB file storage, 40 deployments, pay-as-you-go beyond; Professional $25 per developer/month. · accessed 25 October 2026 · official

Provider rules change. This page is generated from verapli registry version 2026.1025.316; spotted something out of date? Tell us. Convex is not affiliated with verapli.