mcpField
C
convex-check-updates

convex-check-updates

github.com/get-convexDevelopment691.2k installsUpdated 1d ago
Repository

About convex-check-updates

convex-check-updates checks an app’s Convex components against the anteater registry and guides consent-based, one-at-a-time upgrades. It is for teams maintaining Convex apps, with build gates and smoke checks around each migration.

Key features

  1. 01Detects stale Convex components
  2. 02Shows installed and current refs
  3. 03Requires consent before upgrades
  4. 04Gates upgrades with typecheck and build
  5. 05Handles migrations one component at a time
  6. 06Provides smoke checks after upgrades

Use cases

  1. 01Check an app for outdated components
  2. 02Review version changes before upgrading
  3. 03Upgrade components with build validation

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/get-convex/agent-skills --skill convex-check-updates

After installing, type/convex-check-updatesin Claude Code to confirm it loaded.

Details

From the project README

check-updates

Detect stale Convex components in the current app against the anteater registry and, with explicit user consent, upgrade them one at a time behind a build gate (typecheck + next build). Each upgrade is gated and smoke-tested before the next.

Workflow

  1. Run curl -fsSL https://graceful-tiger-715.convex.site/check-updates.mjs -o /tmp/cu.mjs && node /tmp/cu.mjs from the project root.
  2. If COMPONENTS_UP_TO_DATE: tell the user; done.
  3. If COMPONENTS_STALE=: list each stale entry (component name, installed → current, summary, breaking flag) and ask the user before touching anything.
  4. On yes: install the new ref, apply each migration.steps change (delegate convex/ edits to convex-expert), run every migration.gate command.
  5. If any gate command fails: revert (git checkout -- . or reinstall old ref) and report; never leave the app half-migrated.
  6. Give the user the smoke check (migration.smoke) to run after each successful upgrade.
  7. Repeat for each stale component, one at a time.

Rules

  • Never upgrade without an explicit user yes — not even a minor version.
  • Gate each component individually before moving to the next.
  • breaking:true upgrades require a snapshot (commit or branch) before applying.
  • Do not auto-republish a live *.convex.app site after upgrading without user confirmation.

Comments

Markdown supported