convex-migration-helper

Plan and execute Convex migrations using the widen-narrow workflow.

Updated Feb 25, 2026
One-click install
npx skills add https://github.com/ludicroushq/vertex --skill convex-migration-helper-ludicroushq
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: convex-migration-helper
Source: https://github.com/ludicroushq/vertex/tree/main/.agents/skills/convex-migration-helper
Command: npx skills add https://github.com/ludicroushq/vertex --skill convex-migration-helper-ludicroushq

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Safely migrate Convex schemas and data during breaking changes by guiding a widen-then-narrow deployment and orchestrating data backfill with the @convex-dev/migrations component, reducing downtime and rollback risk.

Core Features & Use Cases

  • Online, zero-downtime migrations using a widen-narrow workflow that lets apps continue serving while data is migrated.
  • Use cases include adding/removing fields, changing field types, splitting tables, and migrating nested data to relational structures.
  • Leverages the migrations component for batched, resumable migrations, with dry runs and status monitoring to confirm success before finalizing.

Quick Start

Plan and start a migration by outlining the breaking change, preparing a widen-narrow plan, and running the migrations workflow.

Frequently Asked Questions about convex-migration-helper

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

FAQPage Schema
How do I run zero-downtime Convex schema migrations for breaking changes?

The widen-narrow workflow lets you safely add, remove, or change field types while keeping apps online. You widen the schema to accept both old and new formats, backfill data, then narrow it to the final structure.

What is the best way to backfill Convex data without taking the app offline?

Use the migrations component to orchestrate batched, resumable online data backfill. It coordinates the process so your deployment continues serving traffic while data is migrated in the background.

Can I split tables or migrate nested data to relational structures in Convex?

Yes, you can split tables and migrate nested data to relational structures. The migration helper plans these table restructures using the widen-narrow workflow and the migrations component to coordinate the transition.

Does the Convex migrations component support dry runs and status monitoring?

Yes, the Convex migrations component supports dry runs and status monitoring. You can run a dry migration first and monitor its status to confirm success before finalizing the schema changes.

When do I need a widen-narrow deployment for Convex migrations?

You need a widen-narrow deployment when making breaking changes like adding or removing fields, changing field types, or restructuring tables. It allows apps to continue serving while data is migrated.