Skip to content

Rehearse Convex Schema Migrations

Test a Convex schema change and backfill on a snapshot-seeded preview before promoting it to prod.

Stars
9,546
Licence
MIT
Files
1 file

What it does

When you change the data shape of a live Convex app, the push can fail if existing records don't match the new schema. This skill tells the agent to copy production data into a temporary preview deployment, apply the schema change and data backfill there first, check that it works, and only then repeat the same steps on production. It also keeps a snapshot of the data so the team can roll back, and reminds the agent to delete the local copy of the real data afterward.

Great for

  • Developers maintaining a live Convex app who need to change a schema or backfill existing rows safely
  • Teams that want a rehearsal copy of production data before any prod change
  • Anyone who already understands Convex deploy keys and the optional-then-tighten migration pattern

Skip it if

  • Projects with no live data, where the plain migrate guidance is enough; this flow adds steps that are unnecessary without real data
  • Users without a Convex preview deploy key or paid tier, since the workflow depends on preview deployments (the skill offers a dev-deployment fallback but it is a weaker rehearsal)
  • Anyone who cannot accept a rollback that loses writes made after the snapshot, since the skill states this explicitly

Try asking

  • “Rehearse adding a required field to my users table on a preview with a prod snapshot, then promote it to prod”
  • “Backfill a new status field on orders using @convex-dev/migrations, test it on a preview first”
  • “Check whether my schema change would fail on existing production rows before I push it to prod”
Step-by-step guide: how to use Rehearse Convex Schema MigrationsInstall, first run, examples, tips and FAQs

Install in 3 steps

  1. 1

    Download the skill

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

    convex-migrate-rehearse.zip
  2. 2

    Add it to your agent

    Claude Code (all projects)

    mkdir -p ~/.claude/skills && unzip convex-migrate-rehearse.zip -d ~/.claude/skills/

    Claude Code / Agent SDK (this project only)

    mkdir -p .claude/skills && unzip convex-migrate-rehearse.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

  • Make sure the preview key is exported before starting, otherwise the agent will fall back to the personal dev deployment
  • Keep the window between the prod snapshot and the prod promote short, since writes made in between are lost on rollback
  • Review the deploy-guard confirmation carefully, since the prod promote requires an explicit yes

What's inside

  • 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.