A guide to SurrealKit, a command-line tool for managing SurrealDB database schemas and migrations. It covers development synchronisation, controlled production rollouts, rollback, type generation, seeding, and declarative tests.

Use it to create SurrealDB projects, sync development schemas, plan or run production migrations, generate JSON or TypeScript types, seed data, and test schemas, permissions, or API endpoints.

It helps keep database definitions consistent across files and environments while reducing the risk of applying production changes incorrectly.

surrealkit — Skill for Claude Code and Codex by surrealdb/agent-skills

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

Any agent

npx skills add surrealdb/agent-skills --skill surrealkit

Clone the repo

git clone --depth 1 https://github.com/surrealdb/agent-skills

Made for: Claude Code, Codex.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

README.md

[![agentmods](https://agentmods.dev/badge/skills/surrealdb/agent-skills/surrealkit/github.svg)](https://agentmods.dev/skills/surrealdb/agent-skills/surrealkit)

Your own site

<a href="https://agentmods.dev/skills/surrealdb/agent-skills/surrealkit"><img src="https://agentmods.dev/badge/skills/surrealdb/agent-skills/surrealkit/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

Your own site · 80×15

<a href="https://agentmods.dev/skills/surrealdb/agent-skills/surrealkit"><img src="https://agentmods.dev/badge/skills/surrealdb/agent-skills/surrealkit.svg" alt="Reviewed on agentmods" width="80" height="20"></a>

Per session 101 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.

When invoked 2,994 The whole file, excluding the scripts and references it only reads on demand.

Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.

Origin original No closer match found in the catalogue.

Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

Model	Per session	Once invoked
Fable 5.1	$0.00101	$0.02994
Opus 5.5	$0.00040	$0.01198
Sonnet 5.5	$0.00020	$0.00599
Haiku 4.5	$0.00010	$0.00299

Measured 1mo ago against content hash d713fea832d0, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

surrealkit scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 1mo ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

skills/surrealkit/SKILL.md · 180 lines

How it starts

The opening of the file, as written. The whole thing — 180 lines — stays where its author put it; the contents beside it link to each section on GitHub.

SurrealKit

A skill for driving SurrealKit, SurrealDB's schema-management and migration CLI. Written against SurrealKit 1.0 (currently 1.0.0-beta.3).

SurrealKit keeps a SurrealDB database in sync with .surql schema files. It provides two complementary workflows — a fast declarative sync for development and controlled, phased rollouts for shared and production databases — plus seeding, static analysis, type generation, and a declarative testing framework.

When to use this skill

Reference these guidelines when:

Scaffolding a new SurrealDB project (surrealkit init) or authoring templates
Applying schema changes in development (surrealkit sync)
Planning, executing, or rolling back production migrations (surrealkit rollout)
Adopting SurrealKit on a database that already exists (surrealkit rollout baseline)
Splitting a schema into independently tracked modules, or applying it to several databases
Statically checking SurrealQL against the schema without a database (surrealkit check)
Generating JSON or TypeScript types from a live schema (surrealkit typegen)
Writing or running declarative tests for schemas, permissions, or API endpoints (surrealkit test)

This skill covers the SurrealKit tool itself. To write the actual schema, seed, and query statements that go in .surql files, use the surrealql skill.

Installation

Method	Command
`cargo binstall` (recommended)	`cargo binstall surrealkit`
Cargo (from source)	`cargo install surrealkit`
Docker	`docker pull ghcr.io/surrealdb/surrealkit:latest`
Prebuilt tarball	GitHub Releases

Building from source needs a C compiler and cmake. Static analysis is on by default and adds tree-sitter (~7.5 MiB, ~100s of build time); drop it with cargo install surrealkit --no-default-features --features kv-mem,cli — that binary has no check, generate, or watch. Prebuilt binaries and cargo binstall always include analysis.

Read the full file on GitHub · 180 lines

Files

What ships with it

6 files beside SKILL.md in the same directory: the scripts, references and assets a skill reads on demand. Not counted in the per-session cost; read them before you install if any of them is executable.

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

1mo ago Changed · +50 lines · +8 tokens per session d713fea832d0
2mo ago First seen · 130 lines · 93 tokens per session scan A 2caf862980cc

Subscribe to this mod's changes

surrealkit is a skill published in the GitHub repository surrealdb/agent-skills (28 stars, last pushed 1mo ago), licensed MIT. It adds 101 tokens to every session and 2,994 once invoked, about $0.0004 per session on Opus 5.5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.

Databases DevOps and cloud

surrealkit next to 6 skills from other repositories
Mod	Type	Stars	Last push	Licence	Scan	Tokens	Works with
surrealkitsurrealdb/agent-skills	Skill	28	1mo ago	MIT	A	101	Claude Code, Codex
create-prprisma/orm	Skill	48k	yesterday	Apache-2.0	A	48	Claude Code, Codex
schema-explorationlangchain-ai/deepagents	Skill	31k	yesterday	MIT	A	57	Claude Code, Codex
atlas-mssqlariga/atlas	Skill	8.8k	yesterday	Apache-2.0	A	163	Claude Code
ha-data-storesshiwenwen/hope-agent	Skill	1.9k	yesterday	MIT	A	115	Claude Code, Codex
nornicdb-cypher-queriesorneryd/NornicDB	Skill	923	yesterday	MIT	A	79	Claude Code, Codex
volcengine-rds-postgresqlbytedance/agentkit-samples	Skill	484	today	Apache-2.0	A	63	Claude Code, Codex