convex-migration-helper

Plans and executes safe Convex migrations using @convex-dev/migrations.

Updated Mar 20, 2026

Search Tags:#schema #migration #convex #backfill #batch-processing #dry-run #data-migration

Ready to run

npx skills add https://github.com/nickthelegend/crewkill --skill convex-migration-helper-nickthelegend

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: convex-migration-helper
Source: https://github.com/nickthelegend/crewkill/tree/main/frontend/.agents/skills/convex-migration-helper
Command: npx skills add https://github.com/nickthelegend/crewkill --skill convex-migration-helper-nickthelegend

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Convex migrations can be error-prone and risky during breaking changes. This skill provides a structured, safe workflow to widen the schema, migrate data in batches, and narrow schemas after verification, reducing downtime and data inconsistency.

Core Features & Use Cases

Online migrations with batch data processing and progress tracking
Backfilling existing documents to support new fields
Safe deployment strategy using the multi-deploy workflow
Real-world use case: migrate a users table to add a required field safely without service disruption

Quick Start

Plan and execute your first Convex migration by widening the schema, backing up and backfilling data, then narrowing the schema after verification.

Frequently Asked Questions about convex-migration-helper

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

FAQPage Schema

How do I safely execute Convex migrations during breaking schema changes?▼

To safely execute Convex migrations, widen the schema first, backfill data in batches, and narrow the schema after verification. This structured workflow reduces downtime and prevents data inconsistency during breaking changes.

What is the best way to backfill existing documents in Convex without service disruption?▼

The best way to backfill Convex documents is using online migrations with batch data processing and progress tracking. This allows you to migrate data safely and add required fields without disrupting your active services.

Can I perform a dry run of a Convex data migration before applying changes?▼

Yes, you can perform a dry run of your Convex data migration. The workflow supports dry runs and status monitoring, allowing you to validate batch processing and backfill operations before committing to the actual schema changes.

Do I need the @convex-dev/migrations component to run batch processing migrations?▼

Yes, you need the @convex-dev/migrations component to run these batch processing migrations. This component is required to facilitate the safe backfilling, batch processing, and status monitoring features during your deployment workflow.

How does the multi-deploy workflow handle schema narrowing after a backfill?▼

The multi-deploy workflow handles schema narrowing by providing a safe deployment strategy where you backfill and verify data first. After verification, you can safely narrow the schema across multiple deployments without losing data.