surrealfs

Provide a persistent, queryable virtual filesystem backed by SurrealDB.

34|2|Updated Feb 20, 2026
One-click install
npx skills add https://github.com/24601/surreal-skills --skill surrealfs
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: surrealfs
Source: https://github.com/24601/surreal-skills/tree/main/skills/surrealfs
Command: npx skills add https://github.com/24601/surreal-skills --skill surrealfs

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires surrealfs, surrealfs-ai, and includes scripts (resource) and references (resource) and assets (resource) components.

What problem does it solve?

This Skill provides a persistent and queryable virtual filesystem for AI agents, enabling durable file operations and hierarchical storage backed by SurrealDB.

Core Features & Use Cases

  • Persistent Storage: Ensures file operations persist across sessions.
  • Queryable Filesystem: Enables searching and querying file content and metadata.
  • Use Case: Use SurrealFS as a workspace for AI agents, allowing them to create, manage, and query files in a structured, searchable way.

Quick Start

Initialize SurrealFS with an embedded database and run the Rust core REPL.

cargo install surrealfs
surrealfs

Frequently Asked Questions about surrealfs

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I set up a persistent filesystem for AI agents?

You can set up a persistent filesystem for AI agents by installing the SurrealFS core library via Cargo and initializing an embedded database, which provides durable, queryable file operations across sessions.

Can I query file content and metadata in a virtual filesystem?

Yes, querying file content and metadata is supported by the virtual filesystem. It is backed by SurrealDB, enabling structured search and hierarchical storage for AI agent workspaces.

What do I need to run SurrealFS for AI agent data storage?

To run SurrealFS for AI agent data storage, you need the Rust core library and the Python agent library. File operations then execute directly on the host system or within containers.

How does SurrealDB compare to other databases for AI agent file operations?

Unlike standard databases, SurrealDB backs a queryable virtual filesystem that provides hierarchical, persistent file operations specifically designed for AI agent workspaces and durable data storage.

Why use a queryable virtual filesystem over standard file operations?

A queryable virtual filesystem provides persistent storage that survives across sessions, allowing AI agents to create, manage, and search file content and metadata in a structured way that standard file operations lack.

Are there limitations when running file operations on the host system with SurrealFS?

SurrealFS executes file operations on the host system or within containers. It requires both the Rust core and Python agent libraries, meaning your environment must support these dependencies for durable data storage.