{"registry_version":"2026.1025.387","generated_at":"2026-10-25T06:27:00Z","content_sha256":"089d16f627d9365e3d0663cc8069203706d7cb23a76c332226e29686968811a5","signed":true,"signature":{"key_id":"ed25519:74ca19268e364242","algorithm":"ed25519","expires_at":"2026-11-24T06:27:09Z","expired":false,"manifest":"/registry/manifest.json"},"id":"convex/project","name":"Convex project and deploy keys","vendor":"Convex","status":"researched","last_verified":null,"last_researched":"2026-10-25","summary":"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.","account_model":{"summary":"A Convex team owns projects; each project has a production deployment and per-developer dev deployments.","accounts":[{"name":"Convex account (GitHub login)","kind":"personal","owned_by":"the person","required":true},{"name":"Project","kind":"project","required":true}]},"prerequisites":[{"need":"A GitHub account (npx convex dev prompts to log in with GitHub)."}],"identity_requires":[],"have_ready":[],"steps":[{"id":"dev-setup","title":"Log in and create the project","summary":"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.","route":"guided","gate":"human_login","human_only":true,"gate_label":"You sign in","depends_on":[],"optional":false,"url":null,"lead_time":null,"preflight":[],"captures":null},{"id":"production-deploy-key","title":"Generate a production deploy key","summary":"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').","route":"copilot","gate":"human_submit","human_only":true,"gate_label":"You press submit","depends_on":["dev-setup"],"optional":false,"url":"https://dashboard.convex.dev/","lead_time":null,"preflight":[],"captures":"CONVEX_DEPLOY_KEY"}],"gates":[{"step":"dev-setup","gate":"human_login","label":"You sign in"},{"step":"production-deploy-key","gate":"human_submit","label":"You press submit"}],"lead_times":[],"outputs":[{"name":"CONVEX_DEPLOYMENT","description":"Name of the developer's dev deployment, written to .env.local by npx convex dev.","secret":false,"example_format":null,"environments":["development"]},{"name":"NEXT_PUBLIC_CONVEX_URL","description":"Deployment URL the Next.js client connects to (public).","secret":false,"example_format":null,"environments":null},{"name":"CONVEX_DEPLOY_KEY","description":"Production (or preview) deploy key used by npx convex deploy in CI.","secret":true,"example_format":null,"environments":["production"]}],"renewals":[],"estimated_minutes":null,"guide_url":"https://verapli.com/guides/convex/project"}