convex-schema-validator

Validate Convex schemas against types, indexes, and migration rules.

Updated Feb 8, 2026

Search Tags:#validation #schema #migration #indexes #convex #typing

Ready to run

npx skills add https://github.com/gursheyss/styx --skill convex-schema-validator-gursheyss

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: convex-schema-validator
Source: https://github.com/gursheyss/styx/tree/main/.agents/skills/convex-schema-validator
Command: npx skills add https://github.com/gursheyss/styx --skill convex-schema-validator-gursheyss

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Convex Schema Validator helps developers ensure their Convex databases stay in sync with code by validating schemas, types, and migrations, reducing drift and errors.

Core Features & Use Cases

Enforces strict typing and index configurations in convex/schema.ts
Validates unions, optional fields, and migration strategies to minimize risky changes
Supports safe schema evolution through backfills and incremental updates across environments

Quick Start

Create or update your convex/schema.ts and run the validator to verify correctness and readiness for migration.

Frequently Asked Questions about convex-schema-validator

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

FAQPage Schema

How do I validate a Convex schema against defined types and indexes?▼

Validate a Convex schema by updating convex/schema.ts and running the validator to enforce strict typing, index configurations, and migration rules. This verifies schema correctness and readiness for deployment.

What is schema drift in Convex and how do I prevent it during development?▼

Schema drift in Convex occurs when the database schema falls out of sync with application code. Prevent it by validating schemas, types, and migrations to ensure data models remain reliable and auditable.

How do I safely evolve a Convex schema with backfills and optional field changes?▼

Safely evolve a Convex schema by validating migration strategies that support backfills and incremental updates across environments. This minimizes risky changes when modifying optional fields or applying unions.

Can I validate Convex schema unions and optional fields before deployment?▼

Yes, you can validate Convex schema unions and optional fields before deployment. The validator checks these schema constructs against migration rules to ensure reliable data models and minimize errors.

Does this schema validation approach work for ongoing schema evolution across environments?▼

Yes, this schema validation approach works for ongoing schema evolution across environments. It supports incremental updates and validates migration strategies to ensure safe, auditable data model changes.