Skip to content
Get packs

Convex Migration Helper

Plans safe Convex schema and data migrations for breaking changes without downtime

Source Download skill
Repository
openclaw/clawhub
Stars
9,546
Licence
MIT
Files
4 files

What it does

When you change the structure of data in a Convex app (for example adding a required field, changing a field type, or splitting a table), this skill guides the agent through a safe multi-step plan. It explains the widen, migrate, then narrow approach: first make the database schema accept both old and new data, backfill existing records in batches, then tighten the schema again. It also points to a migrations library and common code patterns for the work.

Great for

  • Developers maintaining a live Convex app who need to change a schema without breaking existing data
  • Teams planning zero-downtime rollouts or backfills on production tables
  • Anyone who wants a checklist and dry-run approach before touching real records

Skip it if

  • Brand-new projects or tables with no existing data, because the extra deploy steps add no value
  • Simple additions of optional fields or indexes, which the skill itself says need no migration
  • Non-Convex databases, since the guidance and code examples are specific to Convex

Try asking

  • “Help me plan a migration to make the email field required on the users table in my Convex app”
  • “I want to split a nested address object into its own table. Walk me through the deploy steps”
  • “Write a dry-run migration using @convex-dev/migrations to backfill a new status field”
  • “Review my schema change and tell me whether it needs a widen-migrate-narrow workflow”
Step-by-step guide: how to use Convex Migration HelperInstall, first run, examples, tips and FAQs

Install in 3 steps

  1. 1

    Download the skill

    The ZIP contains the 4 original files, the MIT licence and an attribution note.

    convex-migration-helper.zip
  2. 2

    Add it to your agent

    Claude Code (all projects)

    mkdir -p ~/.claude/skills && unzip convex-migration-helper.zip -d ~/.claude/skills/

    Claude Code / Agent SDK (this project only)

    mkdir -p .claude/skills && unzip convex-migration-helper.zip -d .claude/skills/

    Claude apps (web/desktop): Settings → Capabilities → Skills → Upload skill, and choose the ZIP.

  3. 3

    Ask for the task

    No special command needed — the agent reads the skill's description and loads it when your request matches. Try one of the prompts above.

Get better results

  • Ask the agent to run the dry run (dryRun: true) before any real migration and review the output
  • Deploy the widened schema and code that reads both formats before running the backfill, so new writes are not missed
  • Only remove deprecated fields after confirming no code or data still depends on them

What's inside

  • agents/openai.yaml
  • references/migration-patterns.md
  • references/migrations-component.md
  • SKILL.md

Redistributed unmodified from openclaw/clawhub under the MIT licence. The assessment was drafted with AI from the skill's files on 2026-10-29. Skills can instruct your agent to run code — read SKILL.md and any scripts before installing.