# Send surrealfs to your agent
Hand the extracted package to your coding agent with a concrete install brief instead of figuring it out manually.
## Fast path
- Download the package from Yavira.
- Extract it into a folder your agent can access.
- Paste one of the prompts below and point your agent at the extracted folder.
## Suggested prompts
### New install

```text
I downloaded a skill package from Yavira. Read SKILL.md from the extracted folder and install it by following the included instructions. Tell me what you changed and call out any manual steps you could not complete.
```
### Upgrade existing

```text
I downloaded an updated skill package from Yavira. Read SKILL.md from the extracted folder, compare it with my current installation, and upgrade it while preserving any custom configuration unless the package docs explicitly say otherwise. Summarize what changed and any follow-up checks I should run.
```
## Machine-readable fields
```json
{
  "schemaVersion": "1.0",
  "item": {
    "slug": "surrealfs",
    "name": "surrealfs",
    "source": "tencent",
    "type": "skill",
    "category": "AI 智能",
    "sourceUrl": "https://clawhub.ai/24601/surrealfs",
    "canonicalUrl": "https://clawhub.ai/24601/surrealfs",
    "targetPlatform": "OpenClaw"
  },
  "install": {
    "downloadUrl": "/downloads/surrealfs",
    "sourceDownloadUrl": "https://wry-manatee-359.convex.site/api/v1/download?slug=surrealfs",
    "sourcePlatform": "tencent",
    "targetPlatform": "OpenClaw",
    "packageFormat": "ZIP package",
    "primaryDoc": "SKILL.md",
    "includedAssets": [
      "SKILL.md"
    ],
    "downloadMode": "redirect",
    "sourceHealth": {
      "source": "tencent",
      "status": "healthy",
      "reason": "direct_download_ok",
      "recommendedAction": "download",
      "checkedAt": "2026-04-30T16:55:25.780Z",
      "expiresAt": "2026-05-07T16:55:25.780Z",
      "httpStatus": 200,
      "finalUrl": "https://wry-manatee-359.convex.site/api/v1/download?slug=network",
      "contentType": "application/zip",
      "probeMethod": "head",
      "details": {
        "probeUrl": "https://wry-manatee-359.convex.site/api/v1/download?slug=network",
        "contentDisposition": "attachment; filename=\"network-1.0.0.zip\"",
        "redirectLocation": null,
        "bodySnippet": null
      },
      "scope": "source",
      "summary": "Source download looks usable.",
      "detail": "Yavira can redirect you to the upstream package for this source.",
      "primaryActionLabel": "Download for OpenClaw",
      "primaryActionHref": "/downloads/surrealfs"
    },
    "validation": {
      "installChecklist": [
        "Use the Yavira download entry.",
        "Review SKILL.md after the package is downloaded.",
        "Confirm the extracted package contains the expected setup assets."
      ],
      "postInstallChecks": [
        "Confirm the extracted package includes the expected docs or setup files.",
        "Validate the skill or prompts are available in your target agent workspace.",
        "Capture any manual follow-up steps the agent could not complete."
      ]
    }
  },
  "links": {
    "detailUrl": "https://openagent3.xyz/skills/surrealfs",
    "downloadUrl": "https://openagent3.xyz/downloads/surrealfs",
    "agentUrl": "https://openagent3.xyz/skills/surrealfs/agent",
    "manifestUrl": "https://openagent3.xyz/skills/surrealfs/agent.json",
    "briefUrl": "https://openagent3.xyz/skills/surrealfs/agent.md"
  }
}
```
## Documentation

### SurrealFS -- Virtual Filesystem for AI Agents

SurrealFS provides a persistent, queryable virtual filesystem backed by SurrealDB.
Designed for AI agents that need durable file operations, hierarchical storage,
and content search across sessions.

### Components

ComponentCrate/PackageLanguagePurposeCore LibrarysurrealfsRustFilesystem operations, CLI REPL, SurrealDB storage layerAI Agentsurrealfs-aiPython (Pydantic AI)Agent interface with tool integration, HTTP hosting

### Rust Core -- Commands

The surrealfs crate provides a REPL with POSIX-like commands:

CommandDescriptionlsList directory contentscatDisplay file contentstailShow last lines of a filenlNumber lines of a filegrepSearch file contentstouchCreate empty filemkdirCreate directorywrite_fileWrite content to fileeditEdit file contentscpCopy filecdChange directorypwdPrint working directory

Supports piping from external commands: curl https://example.com > /pages/example.html

Storage backends:

Embedded RocksDB (local)
Remote SurrealDB via WebSocket

### Python AI Agent

Built on Pydantic AI with tools that mirror the filesystem commands.

from surrealfs_ai import build_chat_agent

# Create the agent (default LLM: Claude Haiku)
agent = build_chat_agent()

# Expose over HTTP
import uvicorn
app = agent.to_web()
uvicorn.run(app, host="127.0.0.1", port=7932)

Features:

Default LLM: Claude Haiku
Telemetry via Pydantic Logfire (OpenTelemetry) -- see Security section for opt-out
All filesystem operations available as agent tools
HTTP hosting (default port 7932, bound to 127.0.0.1)
Path normalization: virtual FS root / is isolated; paths cannot escape to host filesystem

### Quick Start

# Install the Rust core
cargo install surrealfs

# Start the REPL with embedded storage
surrealfs

# Or connect to a remote SurrealDB instance
surrealfs --endpoint ws://localhost:8000 --user root --pass root --ns agent --db workspace

# Install the Python agent
pip install surrealfs-ai

# Run the agent HTTP server
python -m surrealfs_ai --host 127.0.0.1 --port 7932

### Use Cases

Persistent workspace for AI agent sessions
Hierarchical document storage with metadata queries
Multi-agent shared file access with SurrealDB permissions
Content strategy and knowledge management
Project scaffolding and template management

### Security Considerations

Credentials: Remote SurrealDB connections require --user/--pass. Use
dedicated, least-privilege credentials scoped to a specific namespace/database.
Never use root credentials in shared or production environments.

Telemetry: The Python agent uses Pydantic Logfire (OpenTelemetry). To
disable telemetry, set: export LOGFIRE_SEND_TO_LOGFIRE=false or configure
Logfire with send_to_logfire=False in code. Audit telemetry endpoints before
enabling in environments with sensitive data.

HTTP binding: The agent binds to 127.0.0.1 by default. Do not expose to
0.0.0.0 or public networks without authentication and TLS. If running in a
container, use network isolation.

Pipe commands: The Rust core supports curl URL > /path syntax for content
ingress. This executes the pipe source command on the host. Use only with
trusted URLs in controlled environments. Do not allow untrusted input to
construct pipe commands.

Sandboxing: The virtual FS root (/) is a SurrealDB-backed abstraction,
not the host filesystem. Path traversal (e.g., ../../etc/passwd) is
normalized and rejected. However, pipe commands execute on the host -- run
in a container or sandbox if accepting untrusted agent input.

### Full Documentation

See the main skill's rule file for complete guidance:

rules/surrealfs.md -- architecture, Rust core API, Python agent setup, SurrealDB schema, multi-agent patterns, and deployment
surrealdb/surrealfs -- upstream repository
## Trust
- Source: tencent
- Verification: Indexed source record
- Publisher: 24601
- Version: 1.2.1
## Source health
- Status: healthy
- Source download looks usable.
- Yavira can redirect you to the upstream package for this source.
- Health scope: source
- Reason: direct_download_ok
- Checked at: 2026-04-30T16:55:25.780Z
- Expires at: 2026-05-07T16:55:25.780Z
- Recommended action: Download for OpenClaw
## Links
- [Detail page](https://openagent3.xyz/skills/surrealfs)
- [Send to Agent page](https://openagent3.xyz/skills/surrealfs/agent)
- [JSON manifest](https://openagent3.xyz/skills/surrealfs/agent.json)
- [Markdown brief](https://openagent3.xyz/skills/surrealfs/agent.md)
- [Download page](https://openagent3.xyz/downloads/surrealfs)