ReboFiles文档
开始3
什么是 ReboFiles
快速开始
可运行的演示
集成到你的应用6
React 组件
Headless:你自己的界面
不使用框架
样式与主题
键盘与无障碍
语言
文件9
上传
预览与查看器
搜索
实时更改与大文件夹
评论
星标与字段
版本、回收站与空间
打包下载 .zip
Word 文档
服务器14
路由
框架与登录
谁可以做什么
存储:S3、GCS、Azure 与磁盘
检查上传
元数据:SQLite 与 Postgres
数据库结构
共享与链接
动态与通知
钩子、日志与限制
保留、法律保留与导出
桌面端与其他来源
同步文件夹
上线生产环境
协作1
AI 助手(MCP)
参考5
包
组件与 hooks
客户端 API
HTTP 路由
状态与路线图
↑↓ 移动↵ 打开Esc 关闭38 个页面

参考 包

包

所有包都处于同一版本 0.12.0,并一起更新。除了 core 以及注明的可选对等依赖 Rebodocs 之外,它们没有其他依赖。
从这里开始

我该安装哪个?

  • React 应用:页面使用 @rebofiles/react,路由使用 @rebofiles/server。
  • 不使用 React 的页面:@rebofiles/drive,再加上服务器。
  • 在自己的后台任务中修改网盘:@rebofiles/core。
  • AI 助手:@rebofiles/mcp,放在服务器旁边。
React 18+

@rebofiles/react

以 <FileDrive> 形式提供的完整网盘、构建它所用的 headless hooks,以及用于链接的 <SharedLink>。

FileDrive, SharedLink, DriveProvider, useEntries, useEntry, useActions, useUploads, useSettings, useComments, useActivity, useTextSearch, useNotifications, useRequests, usePeople, useExpiring, useWithField, useDrive, createMemoryClient · 它的 README

任意浏览器

@rebofiles/drive

不依赖框架的完整网盘,挂载到一个元素上;路由客户端;在页面中完成的上传、压缩包和图片处理。

mountDrive, mountSharedLink, createDriveClient, createLinkClient, createMemoryClient, createUploads, refusalText, lookInDrive, downloadZip, writeZip, textOf, hashOf, CSS, TEXTS · 它的 README

Node 22.12+

@rebofiles/server

路由、authorize()、签名地址、存放在 S3 或磁盘上的文件内容,以及存放在内存、SQLite 或 Postgres 中的元数据。

createDriveHandler, nodeHandler, byRoles, everyone, s3Storage, s3OptionsFrom, diskStorage, memoryMetadata, sqliteMetadata, postgresMetadata, checkType, clamav, Refused, openTelemetry, deriveAll · 它的 README

任意环境,无 DOM

@rebofiles/core

以纯函数形式提供的网盘模型:目录树、名称、回收站、版本、共享、搜索、动态记录。零依赖。

emptyDrive, createFolder, addFile, move, rename, moveToTrash, addVersion, share, addLink, search, textMatch, activityOf, changes · 它的 README

Node 22.12+

@rebofiles/mcp

供 AI 助手使用的工具,通过 HTTP 或 stdio,权限与用户本人一致;配合 Rebodocs 编辑其中的 Word 文档,每次修改都是一个版本。

createMcpHandler, serveStdio, TOOLS, allTools, documentTools, driveAt · 它的 README

Node 22.12+,或桌面应用

@rebofiles/sync

让磁盘上的文件夹与网盘文件夹双向保持一致:发送和接收更改,冲突时两份都保留,跟随移动。用于桌面应用,也可作为命令行使用。

syncOnce, watchSync, nodeFolder, loadState, saveState, rebofiles-sync · 它的 README

Apps

应用

可运行的演示:playground、演示、真实存储桶、桌面端和本网站,每个都是 apps/ 下的一个文件夹。