Agent skill

Convex Migration Helper

by spokvulcan in spokvulcan/poker-planning

Plans Convex schema and data migrations with widen-migrate-narrow and @convex-dev/migrations.

MITAuto-check passedProduct & Project Management

Install Convex Migration Helper

skills CLI
$ npx skills add spokvulcan/poker-planning --skill convex-migration-helper -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install spokvulcan/poker-planning convex-migration-helper --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/spokvulcan/poker-planning.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.agents/skills/convex-migration-helper .claude/skills/convex-migration-helper && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
convex-migration-helper
GitHub stars
114
Used in
8 other repos
Token cost
~1.4k tokens
SKILL.md length
724 words
Files
5 (incl. references, assets)
Skills in repo
6
Repo updated
First seen
Licence
MIT

At a glance

Plans Convex schema and data migrations with widen-migrate-narrow and @convex-dev/migrations.

  • Works in 4 steps: Update schema to allow both old and new… → Update code to handle both formats when… → Update code to write the new format for… → …
  • Breaking schema changes
  • SKILL.md covers When to Use, When Not to Use, Key Concepts and Safe Changes (No Migration…, plus 5 more sections
  • Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md

What it does

Convex Migration Helper is an agent skill from spokvulcan/poker-planning. Plans Convex schema and data migrations with widen-migrate-narrow and @convex-dev/migrations. Use for breaking schema changes, backfills, table reshaping, or zero-downtime rollouts.

Its SKILL.md is about 1.4k tokens, which your agent loads only when the skill is triggered. The skill folder holds 7 other files, including reference files and assets (for example `agents/openai.yaml`, `references/migration-patterns.md` and `references/migrations-component.md`).

It sits in Product & Project Management, covering Sprint planning and agile. It works with Convex. The repository describes itself as: Free open-source planning poker for Scrum teams. No registration required. Real-time estimation for remote agile teams. The licence is MIT.

When your agent uses it

  • Breaking schema changes
  • Table reshaping
  • Zero-downtime rollouts

Example prompts

  • “Use the convex-migration-helper skill to plan Convex schema and data migrations with widen-migrate-narrow and @convex-dev/migrations”
  • “/convex-migration-helper”

Workflow steps

4 steps, taken from the first numbered list in SKILL.md.

  1. Update schema to allow both old and new formats (e.g., add optional new
  2. Update code to handle both formats when reading
  3. Update code to write the new format for new documents
  4. Deploy

What it can do on your machine

Read from SKILL.md and the folder at commit 665a13f. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    No scripts in the folder and no shell commands in SKILL.md (its code samples are typescript).

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    Links to these hosts (documentation or services it may open):

    • convex.dev

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Convex Migration Helper loads about 1.4k tokens when it runs, and up to ~4k if it reads all its reference files. Until then it costs about 51 tokens; SKILL.md has 724 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~51
When it runs · the whole SKILL.md, loaded when a task matches
~1.4k
With references · SKILL.md plus every file in references/, read only if the agent opens them
~4k

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from spokvulcan/poker-planning at commit 665a13f, republished under its MIT licence (© spokvulcan). 724 words, ~1,446 tokens.

Download SKILL.mdSave it as .claude/skills/convex-migration-helper/SKILL.md (or your agent's skills folder). This skill also uses 4 other files; get the full folder from GitHub.
name
convex-migration-helper
description
Plans Convex schema and data migrations with widen-migrate-narrow and @convex-dev/migrations. Use for breaking schema changes, backfills, table reshaping, or zero-downtime rollouts.

Convex Migration Helper

Safely migrate Convex schemas and data when making breaking changes.

When to Use

  • Adding new required fields to existing tables
  • Changing field types or structure
  • Splitting or merging tables
  • Renaming or deleting fields
  • Migrating from nested to relational data

When Not to Use

  • Greenfield schema with no existing data in production or dev
  • Adding optional fields that do not need backfilling
  • Adding new tables with no existing data to migrate
  • Adding or removing indexes with no correctness concern
  • Questions about Convex schema design without a migration need

Key Concepts

Schema Validation Drives the Workflow

Convex will not let you deploy a schema that does not match the data at rest. This is the fundamental constraint that shapes every migration:

  • You cannot add a required field if existing documents don't have it
  • You cannot change a field's type if existing documents have the old type
  • You cannot remove a field from the schema if existing documents still have it

This means migrations follow a predictable pattern: widen the schema, migrate the data, narrow the schema.

Online Migrations

Convex migrations run online, meaning the app continues serving requests while data is updated asynchronously in batches. During the migration window, your code must handle both old and new data formats.

Prefer New Fields Over Changing Types

When changing the shape of data, create a new field rather than modifying an existing one. This makes the transition safer and easier to roll back.

Don't Delete Data

Unless you are certain, prefer deprecating fields over deleting them. Mark the field as v.optional and add a code comment explaining it is deprecated and why it existed.

Safe Changes (No Migration Needed)

Adding Optional Field
typescript
// Before
users: defineTable({
  name: v.string(),
});

// After - safe, new field is optional
users: defineTable({
  name: v.string(),
  bio: v.optional(v.string()),
});
Adding New Table
typescript
posts: defineTable({
  userId: v.id("users"),
  title: v.string(),
}).index("by_user", ["userId"]);
Adding Index
typescript
users: defineTable({
  name: v.string(),
  email: v.string(),
}).index("by_email", ["email"]);

Breaking Changes: The Deployment Workflow

Every breaking migration follows the same multi-deploy pattern:

Deploy 1 - Widen the schema:

  1. Update schema to allow both old and new formats (e.g., add optional new field)
  2. Update code to handle both formats when reading
  3. Update code to write the new format for new documents
  4. Deploy

Between deploys - Migrate data:

  1. Run migration to backfill existing documents
  2. Verify all documents are migrated

Deploy 2 - Narrow the schema:

  1. Update schema to require the new format only
  2. Remove code that handles the old format
  3. Deploy

Using the Migrations Component

For any non-trivial migration, use the @convex-dev/migrations component. It handles batching, cursor-based pagination, state tracking, resume from failure, dry runs, and progress monitoring.

See references/migrations-component.md for installation, setup, defining and running migrations, dry runs, status monitoring, and configuration options.

Show full SKILL.md (299 more words)Show less

Common Migration Patterns

See references/migration-patterns.md for complete patterns with code examples covering:

  • Adding a required field
  • Deleting a field
  • Changing a field type
  • Splitting nested data into a separate table
  • Cleaning up orphaned documents
  • Zero-downtime strategies (dual write, dual read)
  • Small table shortcut (single internalMutation without the component)
  • Verifying a migration is complete

Common Pitfalls

  1. Making a field required before migrating data: Convex rejects the deploy because existing documents lack the field. Always widen the schema first.
  2. Using .collect() on large tables: Hits transaction limits or causes timeouts. Use the migrations component for proper batched pagination. .collect() is only safe for tables you know are small.
  3. Not writing the new format before migrating: Documents created during the migration window will be missed, leaving unmigrated data after the migration "completes."
  4. Skipping the dry run: Use dryRun: true to validate migration logic before committing changes to production data. Catches bugs before they touch real documents.
  5. Deleting fields prematurely: Prefer deprecating with v.optional and a comment. Only delete after you are confident the data is no longer needed and no code references it.
  6. Using crons for migration batches: The migrations component handles batching via recursive scheduling internally. Crons require manual cleanup and an extra deploy to remove.

Migration Checklist

  • Identify the breaking change and plan the multi-deploy workflow
  • Update schema to allow both old and new formats
  • Update code to handle both formats when reading
  • Update code to write the new format for new documents
  • Deploy widened schema and updated code
  • Define migration using the @convex-dev/migrations component
  • Test with dryRun: true
  • Run migration and monitor status
  • Verify all documents are migrated
  • Update schema to require new format only
  • Clean up code that handled old format
  • Deploy final schema and code
  • Remove migration code once confirmed stable

© spokvulcan, MIT. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

SKILL.md and 4 other files (references, assets) in .agents/skills/convex-migration-helper of spokvulcan/poker-planning.

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

Open the folder on GitHubat commit 665a13f

Used in 8 other repositories

We found 9 copies of this SKILL.md (exact, near-identical or edited) in other folders, from 8 other GitHub owners. This page covers the copy in spokvulcan/poker-planning, which our catalogue first saw on October 7, 2026.

Compare with similar skills

Convex Migration Helper next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Convex Migration Helper compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Convex Migration Helper this skillspokvulcan/poker-planning1148 repos~1.4kAutomated safety check: PassMIT
Agile Product Owneralirezarezvani/claude-skills28k3 repos~3.2kAutomated safety check: PassMIT
Walking Skeleton Roadmap Scopingprime-radiant-inc/iterative-development181—~1.7kAutomated safety check: PassApache-2.0
Triagejoa23/linear-cli144—~699Automated safety check: PassMIT
Tapd Iteration PlanTencentBlueKing/bk-bcs841—~1.6kAutomated safety check: PassCustom licence
Track Backlogcdiggins/plato106—~1kAutomated safety check: PassMIT

Similar skills

  • Agile Product Owner

    alirezarezvani/claude-skills

    Writes INVEST-checked user stories with acceptance criteria, splits epics, plans sprints from velocity and ranks the backlog with a weighted score.

    28k GitHub starsUsed in 3 repos~3.2k tokens
    Product & Project ManagementAuto-check passed
  • Walking Skeleton Roadmap Scoping

    prime-radiant-inc/iterative-development

    Turns extracted requirements into a roadmap by choosing a walking skeleton iteration with its first journey scenario and ordering the remaining work into follow-on iterations.

    181 GitHub stars~1.7k tokensUpdated 4 mo ago
    Product & Project ManagementAuto-check passed
  • Triage

    joa23/linear-cli

    Triage and prioritize Linear backlog issues using the linear CLI.

    144 GitHub stars~699 tokensUpdated 25 days ago
    Product & Project ManagementAuto-check passed
  • Tapd Iteration Plan

    TencentBlueKing/bk-bcs

    TAPD 迭代规划技能。基于"approved"状态的需求池,结合需求依赖关系、size 规模、 优先级进行全局编排,将合适规模的需求规划进入指定迭代。支持新建迭代和已有迭代 重入两种模式,自动控制迭代总规模上限(默认 1000),通过有向无环图(DAG)分析 保证依赖需求优先入迭代。

    841 GitHub stars~1.6k tokensUpdated yesterday
    Product & Project ManagementAuto-check passed
  • Track Backlog

    cdiggins/plato

    View and manage the tracker backlog — show in-progress work, current priorities, sprint contents; triage untriaged items; promote ideas to ready; plan a sprint (big rocks + little rocks…

    106 GitHub stars~1k tokensUpdated 12 days ago
    Product & Project ManagementAuto-check passed
  • Bmad Agent Sm

    paulpreibisch/AgentVibes

    Scrum master for sprint planning and story preparation. An agent skill from paulpreibisch/AgentVibes.

    155 GitHub starsUsed in 1 repo~769 tokens
    Product & Project ManagementAuto-check passed

More from spokvulcan/poker-planning

  • Convex Create Component

    spokvulcan/poker-planning

    Builds reusable Convex components with isolated tables and app-facing APIs.

    114 GitHub starsUsed in 8 repos~2.6k tokens
    Auto-check passed
  • Convex Setup Auth

    spokvulcan/poker-planning

    Sets up Convex auth, identity mapping, and access control. An agent skill from spokvulcan/poker-planning.

    114 GitHub starsUsed in 8 repos~1.8k tokens
    Auto-check passed
  • Convex Quickstart

    spokvulcan/poker-planning

    Creates or adds Convex to an app. An agent skill from spokvulcan/poker-planning.

    114 GitHub starsUsed in 6 repos~3.5k tokens
    Auto-check: notes
  • Convex Performance Audit

    spokvulcan/poker-planning

    Audits Convex performance for reads, subscriptions, write contention, and function limits.

    114 GitHub starsUsed in 7 repos~1.9k tokens
    Auto-check passed
  • Convex

    spokvulcan/poker-planning

    Routes general Convex requests to the right project skill. An agent skill from spokvulcan/poker-planning.

    114 GitHub starsUsed in 6 repos~399 tokens
    Auto-check passed

Works with

Questions about Convex Migration Helper

What does Convex Migration Helper do?

Plans Convex schema and data migrations with widen-migrate-narrow and @convex-dev/migrations. Convex Migration Helper is an agent skill from spokvulcan/poker-planning. Plans Convex schema and data migrations with widen-migrate-narrow and @convex-dev/migrations.

When should I use Convex Migration Helper?

Convex Migration Helper fits situations like: breaking schema changes; table reshaping; zero-downtime rollouts.

How do I install Convex Migration Helper in Claude Code?

Run `npx skills add spokvulcan/poker-planning --skill convex-migration-helper -a claude-code`. Or copy the skill folder (.agents/skills/convex-migration-helper in spokvulcan/poker-planning) into .claude/skills/convex-migration-helper in your project. Claude Code loads it when a task matches its description.

How do I install Convex Migration Helper in Codex?

Run `npx skills add spokvulcan/poker-planning --skill convex-migration-helper -a codex`. Or copy the skill folder (.agents/skills/convex-migration-helper in spokvulcan/poker-planning) into .agents/skills/convex-migration-helper in your project. Codex loads it when a task matches its description.

Can I use Convex Migration Helper in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add spokvulcan/poker-planning --skill convex-migration-helper -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/convex-migration-helper, .gemini/skills/convex-migration-helper, .github/skills/convex-migration-helper and .opencode/skills/convex-migration-helper in your project.

What does Convex Migration Helper need to run?

SKILL.md names no scripts, command-line tools or credentials: Convex Migration Helper is instructions for the agent only.

Does Convex Migration Helper access the network?

SKILL.md names 1 domain. As links in the text: convex.dev. This is read from the text; nothing was executed.

Is Convex Migration Helper safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does Convex Migration Helper use?

Convex Migration Helper is published under the MIT licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Convex Migration Helper use?

About 1.4k tokens (SKILL.md is roughly 5.8k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full. Its references folder adds about 2.6k tokens, read only when the agent opens those files.

What are the alternatives to Convex Migration Helper?

Skills that share tags, products or a category with Convex Migration Helper: Agile Product Owner (alirezarezvani/claude-skills, 28k stars), Walking Skeleton Roadmap Scoping (prime-radiant-inc/iterative-development, 181 stars), Triage (joa23/linear-cli, 144 stars) and Tapd Iteration Plan (TencentBlueKing/bk-bcs, 841 stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Convex Migration Helper?

spokvulcan (a GitHub user) maintains it in spokvulcan/poker-planning, which has 114 GitHub stars. The repository holds 6 skills in this directory. The repository was last updated on October 4, 2026.

Source: spokvulcan/poker-planning on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.