convex-deploy

Automate Convex deployment workflows, environments, and CI/CD configurations.

Updated Jan 28, 2026
One-click install
npx skills add https://github.com/IgorWarzocha/realtime-dashboard-analytics-demo --skill convex-deploy
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: convex-deploy
Source: https://github.com/IgorWarzocha/realtime-dashboard-analytics-demo/tree/main/.opencode/skill/convex-deploy
Command: npx skills add https://github.com/IgorWarzocha/realtime-dashboard-analytics-demo --skill convex-deploy

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill centralizes and automates Convex deployment workflows, environments, and CI/CD configuration to streamline multi-stage backends.

Core Features & Use Cases

  • Deployment lifecycle management: production, development, and per-branch preview deployments with automated key handling and environment variables.
  • Local development support: local dev deployments and test runs with controlled access and safety checks.
  • Safe rollout and observability: schema/index safety, codegen, and bundling steps with clear guidance and rollback strategies.

Quick Start

Initialize a new Convex project for deployment automation, then run the deploy sequence described in the SKILL.md to establish environments and keys.

Frequently Asked Questions about convex-deploy

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I automate Convex deployments across multiple environments in CI/CD?

Automating Convex deployments involves orchestrating production, development, and preview environments using exact CLI commands and deploy key handling. It manages environment variables and safe rollout practices across multi-stage backend CI/CD pipelines.

When do I need to use deploy keys versus CONVEX_DEPLOYMENT environment variables for Convex?

Use deploy keys for authenticating automated CI/CD pipeline deployments, while CONVEX_DEPLOYMENT environment variables target specific deployment instances like preview branches. The Skill enforces exact CLI flags to distinguish between these two deployment authentication targets.

What side effects should I expect during a Convex backend deployment?

Convex backend deployments trigger side effects including codegen, bundling, and schema or index backfill. The Skill documents these operations and provides rollback strategies to ensure safe rollout and schema safety during the deployment lifecycle.

Can I run local Convex development and test deployments with controlled access?

Yes, local Convex development and test runs are supported with controlled access and safety checks. The Skill manages local dev deployments within the broader deployment lifecycle, ensuring local testing aligns with your configured environments before promoting to production.

What is the best way to handle safe rollbacks for Convex schema and index changes?

Handling safe rollbacks for Convex schema and index changes requires documenting side effects like index backfill and enforcing schema safety checks. The Skill provides guidance on rollback strategies to safely manage schema migrations during backend deployments.