spacedrive README

The project's README from github.com/spacedriveapp/spacedrive. As one markdown file: README.md.

Spacedrive

Spacedrive

One file manager for all your devices and clouds.
Powered by a Virtual Distributed File System, complete with apps for macOS, Windows, Linux, iOS and Android

v2.spacedrive.com • Discord • Getting Started


What is Spacedrive?

Spacedrive is a cross-device data platform. Index files, emails, notes, and external sources. Search everything. Sync via P2P. Keep AI agents safe with built-in screening.

Is this a replacement for Finder or Explorer?

No. Spacedrive sits above your OS file manager and adds capabilities Finder/Explorer lack:

You still use your OS for low-level file interactions. Spacedrive adds the cross-platform, cross-device, cloud-aware, and automation-friendly layer on top.

Data Archival

Spacedrive indexes external data sources via script-based adapters: Gmail, Apple Notes, Chrome bookmarks, Obsidian, Slack, GitHub, calendar events, contacts. Each source becomes a searchable repository alongside your files.

Adapters are a folder with an adapter.toml manifest and a sync script in any language. If it reads stdin and prints lines, it works.

Shipped adapters: Gmail, Apple Notes, Chrome Bookmarks, Chrome History, Safari History, Obsidian, OpenCode, Slack, macOS Contacts, macOS Calendar, GitHub.

Spacebot

Spacedrive integrates with Spacebot, an open source AI agent runtime. Spacebot runs as an optional separate process. Spacedrive provides the data, permission, and execution layer. Spacebot provides the intelligence.

Each Spacebot instance pairs with one Spacedrive node as its home device. That node authenticates the agent, maintains the device graph, resolves permissions, and forwards operations to peer devices. Every device in your library can reach Spacebot through the paired node over P2P (Iroh/QUIC) without direct network access. One agent runtime serves your entire device fleet.

When Spacebot spawns a worker, that worker can target any device in the library. File reads, shell commands, and operations proxy through Spacedrive to the target device. Talk to the agent from your phone while work executes on a server. Read files from a NAS, run commands on a workstation, report to a laptop — all in one task.

Every operation passes through Spacedrive's permission system: which devices the agent can access, which paths are readable or writable, which operations are allowed, and which require human confirmation. The paired node resolves effective policy before forwarding. One security model, one audit surface across all devices and clouds.

File System Intelligence

Spacedrive adds intelligence to your filesystem by combining three layers:

When an agent navigates through Spacedrive, it receives the file listing, subtree context, effective permissions, and summaries. Users can explain how they organize their system. Agents can add attributed notes. Jobs generate summaries from structure and activity. The intelligence stays attached to the filesystem, not buried in temporary session memory.

Safety Screening

When enabled, every record passes through a safety pipeline before becoming searchable:

No other local data tool screens indexed content before exposing it to AI.


Architecture

The core is built on four principles:

  1. Virtual Distributed Filesystem (VDFS) — files and folders become first-class objects with rich metadata, independent of physical location. Every file gets a universal address (SdPath) that works across devices.

  2. Content Identity System — adaptive hashing (BLAKE3 with strategic sampling for large files) creates a unique fingerprint for every piece of content. Enables deduplication, redundancy tracking, and content-based operations.

  3. Transactional Actions — every file operation can be previewed before execution. See space savings, conflicts, and estimated time, then approve or cancel. Operations become durable jobs that survive network interruptions and device restarts.

  4. Leaderless Sync — peer-to-peer synchronization without central coordinators. Device-specific data uses state replication. Shared metadata uses an HLC-ordered log with deterministic conflict resolution.

The implementation is a single Rust crate with CQRS/DDD architecture. Every operation (file copy, tag create, search query) is a registered action or query with type-safe input/output that auto-generates TypeScript types for the frontend.

Component Technology
Language Rust
Async runtime Tokio
Database SQLite (SeaORM + sqlx)
P2P Iroh (QUIC, hole-punching, local discovery)
Content hashing BLAKE3
Vector search LanceDB + FastEmbed
Cloud storage OpenDAL
Cryptography Ed25519, X25519, ChaCha20-Poly1305, AES-GCM
Media FFmpeg, libheif, Pdfium, Whisper
Desktop Tauri 2
Mobile React Native + Expo
Frontend React 19, Vite, TanStack Query, Tailwind CSS v4
Design system SpaceUI (shared component library)
Type generation Specta
spacedrive/
├── core/                  # Rust engine (CQRS/DDD)
├── apps/
│   ├── tauri/             # Desktop app (macOS, Windows, Linux)
│   ├── mobile/            # React Native (iOS, Android)
│   ├── cli/               # CLI and daemon
│   ├── server/            # Headless server
│   └── web/               # Browser client
├── packages/
│   ├── interface/         # Shared React UI
│   ├── ts-client/         # Auto-generated TypeScript client
│   ├── ui/                # Component library
│   └── assets/            # Icons, images, SVGs
├── crates/                # Standalone Rust crates (ffmpeg, crypto, etc.)
├── adapters/              # Script-based data source adapters
└── schemas/               # TOML data type schemas

Getting Started

Requires Rust 1.81+, Bun 1.3+, just, and Python 3.9+ (for adapters).

git clone https://github.com/spacedriveapp/spacedrive
cd spacedrive

just setup        # bun install + native deps + cargo config
just dev-desktop  # launch the desktop app (auto-starts daemon)
just test         # run all workspace tests

Privacy & Security

Spacedrive is local-first. Your data stays on your devices.

Optional cloud integration is available for backup and remote access, but it's never required. The cloud service runs unmodified Spacedrive core as a standard P2P device—no special privileges.


Contributing


License

FSL-1.1-ALv2 — Functional Source License, converting to Apache 2.0 after two years.

spacedrive (spacedriveapp/spacedrive)

Searching Database…

这是什么?Spacedrive 是一款跨平台的文件管理器,也是一个跨设备的数据平台。它可以索引文件、邮件、笔记和其他来源的数据,让你在一个地方搜索所有内容,并通过点对点连接在设备之间同步数据。
它是要取代我系统自带的访达或资源管理器吗?不是。Spacedrive 位于操作系统文件管理器之上,增加了跨设备搜索、内容识别、同步以及面向 AI 的安全访问等功能层,而不是取代底层的文件操作。
我该如何构建和运行 Spacedrive?README 中没有提供预构建的安装程序;你需要从源码构建,这需要 Rust 1.81+、Bun 1.3+、just,以及用于适配器的 Python 3.9+。
Spacedrive 现在是完全开源的吗?从传统意义上说还不是:每个版本都采用 FSL-1.1-ALv2(功能源代码许可证)授权,仅在两年后自动转换为 Apache 2.0。
它支持哪些设备和操作系统?它提供 macOS、Windows、Linux、iOS 和 Android 的原生应用,所有设备都通过同一个 P2P 网络同步。
我的数据会去哪里?会不会被追踪?Spacedrive 采用本地优先的设计:除非你选择同步,否则数据始终保存在你自己的设备上;它不收集遥测数据,你也可以自行搭建中继服务器。
什么是 Spacebot?Spacebot 是一个可选的独立 AI 智能体运行时,可与 Spacedrive 节点配合使用:Spacedrive 负责数据、权限和设备路由,而 Spacebot 提供实际的智能体能力。
Spacedrive 如何防止 AI 智能体访问不安全的内容?一个可选的安全流程会在已索引的内容上运行本地的 Prompt Guard 2 分类器,对邮件等不受信任的来源进行更严格的筛查,并隔离被标记的记录,使其不会出现在 AI 智能体的查询结果中。
什么是数据归档功能?它允许 Spacedrive 通过基于脚本的适配器索引 Gmail、Apple 备忘录、Chrome 书签、Slack 和 GitHub 等外部来源,并将每个来源变为一个可搜索的仓库,与你的文件并列存放。
Spacedrive 如何避免跨设备的重复文件?每个文件都会生成一个 BLAKE3 内容哈希值,因此同一文件在两台不同设备上会产生相同的哈希值,Spacedrive 据此跟踪你所有设备中的冗余和去重情况。
Size
275.1 MB
Stars
39.2K
Age
5y
Commits · 90 Days