suaveplan/packages/devtools/tooling/install-agent-skills/assets/skills/surrealdb/SKILL.md

name: surrealdb description: Use when implementing or debugging code that uses @suaveplan/surrealdb: Universal SurrealDB client wrapper implementing DatabaseAdapter: connection lifecycle, singleton registry, typed CRUD, schema discovery, initialisation, version detection, OTel instrumentation, retry integration, and structured SURREAL.

@suaveplan/surrealdb

Universal SurrealDB client wrapper for Suaveplan. Implements @suaveplan/db's DatabaseAdapter interface with connection lifecycle management, typed CRUD, schema discovery, database initialisation, version detection, structured SURREAL.* error codes, and OTel instrumentation.

When to use this skill

• Implementing or debugging code that imports @suaveplan/surrealdb.
• The task touches: see package README.
• You need API guidance for this package's exports.

Quick reference

import { /* see API Reference below */ } from "@suaveplan/surrealdb";

Dependencies

Workspace dependencies: @suaveplan/db, @suaveplan/error, @suaveplan/retry, @suaveplan/types

Where to read more

This skill is intentionally short. The package's own documentation is the authoritative source — read these in order:

1. packages/database/surrealdb/README.md — overview, install, quick-start, module index
2. packages/database/surrealdb/src/**/*.md — co-located docs per implementation file (Purpose, Features, Basic + Advanced examples, full API reference, Implementation notes — all packages ship ≥200 words per module)
3. packages/database/surrealdb/package.json exports map — every subpath you can import from

When the user asks an API question, read the relevant co-located .md first; do not answer from training-data memory.

See also

• @suaveplan/db
• @suaveplan/error
• @suaveplan/retry
• @suaveplan/types

---

This SKILL.md is auto-generated by suaveplan-skills/scripts/generate-skills.ts from the package's README. Do not edit by hand — re-run the generator after the README changes.