Skills surrealkit

SurrealKit schema sync, rollout migrations, seeding, and declarative testing for SurrealDB apps. Part of the surreal-skills collection.

install

source · Clone the upstream repo

git clone https://github.com/openclaw/skills

Claude Code · Install into ~/.claude/skills/

T=$(mktemp -d) && git clone --depth=1 https://github.com/openclaw/skills "$T" && mkdir -p ~/.claude/skills && cp -r "$T/skills/24601/surrealdb/skills/surrealkit" ~/.claude/skills/clawdbot-skills-surrealkit && rm -rf "$T"

manifest: skills/24601/surrealdb/skills/surrealkit/SKILL.md

source content

SurrealKit -- Schema Management for SurrealDB Apps

SurrealKit manages SurrealDB application schemas as desired-state

.surql

files, with separate paths for disposable development databases and shared or production rollouts.

Quick Start

# Install
cargo install surrealkit

# Scaffold project structure
surrealkit init

# Reconcile local/disposable database to local schema files
surrealkit sync

# Generate and apply a reviewed rollout for shared/prod
surrealkit rollout plan --name add_customer_indexes
surrealkit rollout start 20260410120000__add_customer_indexes
surrealkit rollout complete 20260410120000__add_customer_indexes

Core Commands

Command	Use
`surrealkit sync`	Desired-state reconciliation for local, preview, or disposable DBs
`surrealkit sync --watch`	Local development loop with file watching
`surrealkit rollout baseline`	Establish rollout tracking on an existing shared DB
`surrealkit rollout plan --name <name>`	Create a reviewed manifest from current schema diff
`surrealkit rollout start <id>`	Apply the expansion phase
`surrealkit rollout complete <id>`	Apply the contract/destructive phase after cutover
`surrealkit rollout rollback <id>`	Roll back an in-flight rollout
`surrealkit rollout lint <id>`	Validate a rollout without mutating the DB
`surrealkit rollout status`	Inspect rollout state stored in the DB
`surrealkit seed`	Apply seed data
`surrealkit test`	Run declarative schema, permission, and API tests

When to Use It

Use
```
sync
```
when the database should mirror local files immediately.
Use
```
rollout
```
when changes need staging, review, rollback, or controlled cutover.
Use
```
seed
```
for deterministic fixture data.
Use
```
test
```
in CI to validate permissions, schema behavior, and API contracts.

Environment

SurrealKit reads these variables:

```
DATABASE_HOST
```
or
```
PUBLIC_DATABASE_HOST
```
```
DATABASE_NAME
```
or
```
PUBLIC_DATABASE_NAME
```

DATABASE_NAMESPACE

PUBLIC_DATABASE_NAMESPACE

```
DATABASE_USER
```
```
DATABASE_PASSWORD
```

Testing

Declarative suites in

database/tests/suites/*.toml

support:

```
sql_expect
```
```
permissions_matrix
```
```
schema_metadata
```
```
schema_behavior
```
```
api_request
```

Example:

surrealkit test --fail-fast --json-out artifacts/surrealkit-tests.json

Full Documentation

See the main skill rule for full operating guidance:

rules/surrealkit.md -- sync vs rollout strategy, env vars, seeds, declarative tests, and CI patterns
surrealdb/surrealkit -- upstream repository