← 返回 Skills 市场
SurrealDB 3
作者
Basit Mustafa
· GitHub ↗
· v1.3.1
· MIT-0
808
总下载
3
收藏
1
当前安装
8
版本数
在 OpenClaw 中安装
/install surrealdb
功能描述
Expert SurrealDB 3 architect and developer skill. SurrealQL mastery, multi-model data modeling (document, graph, vector, time-series, geospatial), schema des...
安全使用建议
This skill appears to do what it says: SurrealDB tooling and agent-facing documentation/scripts. Before installing, verify you will use scoped, least-privilege SURREAL_USER/SURREAL_PASS credentials (avoid root/root on production), and only point the scripts at endpoints you control. Review scripts if you plan to run them against production (schema export, doctor checks) and confirm you explicitly opt in before allowing onboard.py to write a .env. Installing via Homebrew is preferable; if you must install from other sources, verify the upstream repository and formulas first. If you use check_upstream.py, note it invokes gh (GitHub CLI) and may query GitHub; install gh only if you trust that behavior and be mindful of any configured gh auth token on your machine.
功能分析
Type: OpenClaw Skill
Name: surrealdb
Version: 1.3.1
The SurrealDB skill bundle is a highly professional, well-documented, and secure toolkit for database architecture and development. The included Python scripts (doctor.py, schema.py, onboard.py) follow security best practices, such as using a dedicated sanitization function (_sanitize_identifier in schema.py) to prevent SurrealQL injection and requiring explicit user confirmation before writing sensitive files like .env. Network activity is strictly limited to user-defined SurrealDB endpoints and official GitHub APIs for version tracking. The skill explicitly declares its security properties and provides clear warnings regarding the use of default credentials, demonstrating a strong focus on safe operation within AI agent environments.
能力标签
能力评估
Purpose & Capability
Name/description (SurrealDB architect/developer) match the declared binaries (surreal, python3, uv), the SURREAL_* environment variables, and the shipped scripts (doctor.py, schema.py, onboard.py, schema tooling). Optional tooling (docker, gh) is documented as optional and aligns with deployment and repo-checking use-cases.
Instruction Scope
SKILL.md instructs the agent to run local health checks, schema introspection, and onboarding scripts that connect only to a user-specified SurrealDB endpoint (WebSocket/HTTP). Scripts that perform network calls or write files are documented (doctor.py/schema.py connect to endpoint; schema.py can export files; onboard.py may write a .env only after user confirmation). There are no instructions that require reading or exfiltrating unrelated system files or secrets.
Install Mechanism
Install uses Homebrew formulas (surrealdb/tap/surreal and uv). Homebrew is an auditable package manager; no remote download-and-extract or opaque binary blobs are used. The install spec is proportionate to the skill's needs (providing the SurrealDB CLI and the uv runner).
Credentials
Required environment variables are SURREAL_ENDPOINT, SURREAL_USER, SURREAL_PASS, SURREAL_NS, SURREAL_DB — all directly relevant to connecting to a SurrealDB instance. Sensitive flags are applied to user/password. No unrelated tokens or broad credentials are requested.
Persistence & Privilege
The skill is not force-included (always: false) and does not request elevated platform privileges. It may write schema export files or a local .env only in the narrow, documented cases. It does not modify other skills or system-wide agent settings.
如何使用
- 确保已安装 OpenClaw（本地或 Docker 部署）
- 在对话框中输入安装命令：
/install surrealdb - 安装完成后，直接呼叫该 Skill 的名称或使用
/surrealdb触发 - 根据 Skill 的参数说明提供必要输入，即可获得结构化输出
版本历史
v1.3.1
## [1.3.1] - 2026-04-10
### Fixed
- ClawHub registry metadata now declares the skill's required binaries and `SURREAL_*` environment variables under `metadata.openclaw`, matching the documented publish contract and eliminating the `metadata: null` registry state from `1.3.0`
- Root `SKILL.md` now carries an explicit top-level `version` field in addition to the repo-local metadata block for better registry compatibility
- Release workflow now publishes through the supported `clawhub` CLI flow instead of the dead `api.clawhub.ai/v1/skills/publish` endpoint
### Changed
- Version metadata bumped to `1.3.1` across the root manifest, sub-skills, AGENTS.md, README badge, and SOURCES.json
v1.3.0
## [1.3.0] - 2026-04-10
### Major
- SurrealDB v3.0.5: documented `REMOVE CONFIG`, wider `ALTER` coverage, planner pushdown fixes, `$parent` fixes, computed field fixes, edge query ordering fixes, GraphQL literal fields, and related patch work
- SurrealKit v0.5.0 added as a first-class part of the skill: desired-state schema sync, rollout-based migrations, seeding, and declarative database/API tests
- Release and CI workflows hardened: explicit least-privilege permissions, version-consistency validation, smoke tests, and no in-workflow manifest mutation before publish
### Fixed
- `scripts/check_upstream.py`: short baseline SHAs now compare correctly against full GitHub commit SHAs
- `scripts/check_upstream.py`: falls back to latest Git tag when a repo does not publish GitHub Releases
- `scripts/doctor.py` and `scripts/schema.py`: normalize user-facing HTTP endpoints to SurrealDB WebSocket RPC URLs before connecting
- `scripts/schema.py`: restored the documented `introspect`, `tables`, and `table` commands
- `scripts/onboard.py`: version now comes from root `SKILL.md`, and the agent manifest now reflects live prerequisites and the full script/rule set
### Changed
- README, AGENTS.md, SKILL.md, and SOURCES.json synced to upstream state as of 2026-04-10
- Added `rules/surrealkit.md` and `skills/surrealkit/SKILL.md`
- Surrealist docs updated to v3.7.4; JavaScript SDK docs updated to v2.0.3
- Security metadata corrected: file writes are declared accurately, remote shell installer references removed from active documentation, and publish workflow now validates repository content instead of editing it at release time
v1.2.1
- Updated docs and rules for SurrealDB ecosystem tools: SurrealSync, Surrealist, and SDKs.
- Added and clarified agent integration instructions and capabilities briefing in documentation.
- Improved coverage and structure for data modeling, SurrealQL, and operational best practices.
- Updated metadata and snapshot date to reflect latest changes (v1.2.1, March 13, 2026).
v1.2.0
SurrealDB v3.0.2, Go SDK v1.4.0, full upstream sync, security audit pass.
v1.1.1
Python SDK corrected to v2.0.0-alpha.1, None-on-missing-record behavior change, full upstream sync, security audit pass.
v1.1.0
JS SDK v2.0.0 GA, Python SDK v2.0.0, SurrealDB v3.0.1, full upstream sync, security hardening.
v1.0.6
SurrealDB v3.0.1 support, JS SDK v2.0.0-beta.2, full upstream sync, security hardening, native Copilot agent skills.
v1.0.3
Expert SurrealDB 3 skill for AI coding agents. SurrealQL, multi-model data modeling, graph queries, vector search, security, deployment, performance, 9+ SDKs, WASM extensions, Surrealist, Surreal-Sync, SurrealFS.
元数据
常见问题
SurrealDB 3 是什么？
Expert SurrealDB 3 architect and developer skill. SurrealQL mastery, multi-model data modeling (document, graph, vector, time-series, geospatial), schema des... 它是一个面向 Claude Code / OpenClaw 的 AI Agent Skill 插件，目前累计下载 808 次。
如何安装 SurrealDB 3？
在 OpenClaw 或 Claude Code 对话框中运行命令「/install surrealdb」即可一键安装，无需额外配置。
SurrealDB 3 是免费的吗？
是的，SurrealDB 3 完全免费，采用 MIT-0 许可证，可自由下载、安装和使用。
SurrealDB 3 支持哪些平台？
SurrealDB 3 跨平台运行，可在任意部署了 OpenClaw / Claude Code 的环境中使用（cross-platform）。
谁开发了 SurrealDB 3？
由 Basit Mustafa（@24601）开发并维护，当前版本 v1.3.1。
推荐 Skills