surrealkit

Automate SurrealDB schema synchronization, migration rollouts, seeding, and testing.

34|2|Updated Feb 20, 2026
One-click install
npx skills add https://github.com/24601/surreal-skills --skill surrealkit
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: surrealkit
Source: https://github.com/24601/surreal-skills/tree/main/skills/surrealkit
Command: npx skills add https://github.com/24601/surreal-skills --skill surrealkit

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires surrealdb, surrealkit, and includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill streamlines the management of SurrealDB application schemas, enabling efficient schema synchronization, migration rollouts, seeding, and testing.

Core Features & Use Cases

  • Schema Management: Automate schema synchronization and management with .surql files.
  • Rollout Management: Plan, execute, and rollback schema changes with controlled rollouts.
  • Seed Data: Apply seed data for consistent testing and development environments.
  • Declarative Testing: Validate schema, permissions, and API contracts with declarative tests.
  • Use Case: When you need to manage complex SurrealDB schemas across development, staging, and production environments, this Skill helps ensure consistency and reliability.

Quick Start

Use the surrealkit skill to sync your local schema files with the database.

Frequently Asked Questions about surrealkit

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

FAQPage Schema
How do I manage SurrealDB schema migrations across multiple environments?

SurrealDB schema management uses declarative `.surql` files to define database structures. This Skill automates synchronization and version control of these schema files to maintain consistency across different database environments.

What is the best way to automate SurrealDB schema synchronization?

Automating SurrealDB schema synchronization is best handled by applying version-controlled `.surql` files. This Skill automates the synchronization process, ensuring your database schema matches your defined files reliably.

How do I rollback SurrealDB schema changes during a deployment?

Rolling back SurrealDB schema changes during deployment is handled through controlled rollout management. This Skill allows you to plan, execute, and rollback schema changes to maintain data integrity if issues occur.

Can I apply seed data to SurrealDB for consistent testing environments?

Applying seed data to SurrealDB provides consistent testing and development environments. This Skill supports applying seed data alongside schema synchronization to ensure your declarative tests run against a known state.

Do I need SurrealDB installed to use schema management and declarative testing?

You need both SurrealDB and SurrealKit installed to use this schema management and declarative testing functionality. These dependencies are required to manage database schema changes, rollouts, and validate permissions.

How does declarative testing validate SurrealDB schema and permissions?

Declarative testing validates SurrealDB schemas by checking permissions and API contracts against defined expectations. This ensures your database schema maintains data integrity and enforces correct access controls.