内容
# 🌟 同步 vault
<p align="center">
<a href="./README_ZH.md">中文</a>
</p>
<p align="center">
<a href="https://github.com/abcamus/obsidian-sync-vault-ce"><img src="https://img.shields.io/github/stars/abcamus/obsidian-sync-vault-ce?style=social" alt="GitHub Stars"></a>
<a href="LICENSE"><img src="https://img.shields.io/badge/license-AGPL3.0-green?style=flat-square" alt="License"></a>
<a href="https://kqiu.top"><img src="https://img.shields.io/badge/Obsidian-Plugin-purple?style=flat-square&logo=obsidian" alt="Obsidian Plugin"></a>
<a href="https://github.com/abcamus/obsidian-sync-vault-ce/releases"><img src="https://img.shields.io/github/v/release/abcamus/obsidian-sync-vault-ce?include_prereleases&style=flat-square" alt="Latest Release"></a>
<a href="https://github.com/abcamus/obsidian-sync-vault-ce/releases"><img src="https://img.shields.io/github/downloads/abcamus/obsidian-sync-vault-ce/total?style=flat-square" alt="Total Downloads"></a>
<br>
<a href="https://kqiu.top"><img src="https://img.shields.io/badge/Official%20Site-Visit-blue?style=flat-square" alt="Official Site"></a>
<a href="https://discord.com/invite/J3JdQX7WTG"><img src="https://img.shields.io/badge/Discord-Join%20Community-7289DA?style=flat-square&logo=discord&logoColor=white" alt="Discord"></a>
</p>
<p align="center">
连接您的 10 TB 云存储与 AI 大脑的桥梁。跨设备访问、同步和链接所有文件——图片、PDF、音频、视频——无需占用本地存储。
</p>
## 主要功能
### 🔗 链接笔记和云资源
> 根据文件 ID 和路径生成链接，并在 Obsidian 笔记中渲染后集成。
- 使用 `[]()` 格式链接云资源。
- 使用 `![]()` 格式嵌入云资源。
### 🤖 MCP 服务器
内置 [模型上下文协议（MCP）](https://modelcontextprotocol.io/) 服务器，允许大型语言模型（LLM）/ AI 代理直接访问和操作云存储中的文件。
- 与 Claude Code 和 Cursor 等支持 MCP 的客户端兼容。
- 通过 SSE（服务器发送事件）提供实时上下文访问。
#### 🛠️ MCP 工具功能
| 工具名称 | 描述 | 备注 |
| :--- | :--- | :--- |
| `get_cloud_account_info` | 获取云账户和存储容量信息 | |
| `list_cloud_files` | 列出指定云路径下的文件和文件夹 | |
| `read_cloud_file` | 读取云文件内容（支持流式读取） | |
| `create_cloud_file` | 在云中创建新文件或文件夹 | |
| `delete_cloud_file` | 删除云文件或文件夹 | |
| `move_cloud_file` | 移动云文件或文件夹 | |
| `rename_cloud_file` | 重命名云文件或文件夹 | |
| `download_cloud_file` | 下载云文件到本地存储 | |
| `upload_cloud_file` | 上传本地文件到云 | |
| `semantic_search` | 基于语义的全局搜索 | 仅限百度网盘 |
| `sharelink_set` | 设置/创建共享链接 | 仅限百度网盘 |
| `upload_by_url` | 通过离线 URL 任务上传 | 仅限百度网盘 |
### 💻 CLI 命令（1.13.0）
同步 vault 提供 Obsidian CLI 命令，用于自动化脚本和 AI 代理工作流：
| 命令 | 用途 | 常用参数 |
| :--- | :--- | :--- |
| `sync-vault:help` | 显示 CLI 命令帮助 | `help=true` |
| `sync-vault:list` | 列出云目录文件（分页/筛选/递归） | `path` `cloud` `limit` `offset` `type` `minSize` `modifiedAfter` `recursive` |
| `sync-vault:search` | 搜索云文件（分页/类型筛选） | `query` `cloud` `limit` `offset` `path` `type` |
| `sync-vault:read` | 读取云文件内容 | `path` `cloud` `maxLength` |
| `sync-vault:info` | 获取账户和存储状态 | `cloud` |
| `sync-vault:doctor` | 诊断同步 vault 健康状态 | `cloud` |
常见示例：
```bash
obsidian sync-vault:list path=/ cloud=aliyun limit=100 offset=0
obsidian sync-vault:search query=obsidian cloud=quark type=markdown
obsidian sync-vault:read path=/Notes/Welcome.md cloud=onedrive maxLength=8192
obsidian sync-vault:info cloud=aliyun
obsidian sync-vault:doctor cloud=aliyun
```
> 提示：所有子命令都支持 `help=true` 以显示命令特定用法。
### ✨ 备份
[介绍](https://mp.weixin.qq.com/s/zct07eny-LcMTiYjb49k9w)
- 轻松将数据上传到各种云驱动器。
- 自由切换云 vault 并将数据备份到多个目录。
### 🔄 多设备自动同步
[百度网盘双向同步演示](https://github.com/user-attachments/assets/fbc8c22a-9de2-42c4-b676-753007e5e031)
- 支持双向和单向同步，自动识别文件删除和移动操作。
- 自动合并内容冲突。
- 文件删除可恢复。
- 忽略大文件，通过正则表达式按名称忽略文件。
- 同步第三方插件和主题。
- Markdown 文件端到端加密。
### 🤝 协同编辑
分布式协同编辑，[演示](https://github.com/user-attachments/assets/85d63239-2c5c-4d73-8774-f4ea2f93f426)。
## 📱 云服务功能
| 编号 | 云服务 | 支持的功能 |
| :-- | :------------ | :----------------- |
| 1 | 百度网盘 | 备份、同步、在线图片预览、在线 PDF 阅读、视频播放、音频播放、云链接 |
| 2 | OneDrive | 备份、同步、在线图片预览、在线 PDF 阅读、音频播放、视频播放、云链接 |
| 3 | 阿里云盘 | 备份、同步、在线图片预览、在线 PDF 阅读、音频播放、视频播放、云链接 |
| 4 | 115 网盘 | 在线图片预览、在线 PDF 阅读、音频播放、视频播放、云链接 |
| 5 | 夸克网盘 | 备份、同步、在线图片预览、在线 PDF 阅读、云链接 |
| 6 | 腾讯 COS | 备份、同步 |
| 7 | 奶牛存储 | 备份、同步 |
| 8 | InfiniCloud | 备份、同步 |
| 9 | 123 盘 | 备份、同步 |
## ⚙️ 安装和使用
### 从插件市场安装
在插件市场搜索 `sync vault ce`，或 [点击此处](https://obsidian.md/plugins?id=sync-vault-ce) 快速安装。
### 开始使用
1. 点击侧边栏的 ☁️ 图标打开仪表板，然后在快速操作卡中找到“新手指南”按钮。
2. 点击**新手指南**按钮，按照提示完成云驱动器登录和同步模式设置。
### 配置 MCP（SSE）
#### Claude Code CLI
在 `.claude/mcp.json` 中添加以下代码（注意：将 3000 更改为实际端口）：
```json
{
"mcpServers": {
"sync-vault-mcp": {
"type": "sse",
"url": "http://127.0.0.1:3000/sse"
}
}
}
```
#### Claude 桌面版
> 由于 Claude 桌面版仅支持 STDIO 方法连接 MCP 服务器，您可以选择一个桥接器连接同步 vault MCP。这里您可以选择 sse-bridge。
1. `npm install -g @mcpwizard/sse-bridge`
2. 在 Claude 桌面版的[设置] - [开发者]中，点击编辑配置按钮，复制并粘贴以下代码。
```json
{
"mcpServers": {
"sync-vault-mcp": {
"command": "npx",
"args": [
"@mcpwizard/sse-bridge",
"http://127.0.0.1:3000/sse"
]
}
}
}
```
#### Cursor/Trae
在 Cursor/Trae 的 MCP 设置中，选择手动添加 MCP 服务器（同步 vault MCP 默认值为 `http://127.0.0.1:3000/sse`）。
```json
{
"mcpServers": {
"sync-vault-mcp": {
"type": "sse",
"url": "http://127.0.0.1:3000/sse"
}
}
}
```
## 🗺️ 路线图
- 🌐 更多云服务
- 🏠 协同编辑
- 🎨 更好的用户体验
- ⎔ Zotero 支持
- 🤖 AI 基础设施
## 🔗 快速链接
- [💬 Discord](https://discord.gg/GT6B8keY)
- [📖 文档](https://kqiu.top/docs/)
- [💬 讨论](https://github.com/abcamus/obsidian-sync-vault-ce/discussions)
- [🐛 报告 bug](https://github.com/abcamus/obsidian-sync-vault-ce/issues/new?template=bug_report.md)
- [✨ 请求功能](https://github.com/abcamus/obsidian-sync-vault-ce/issues/new?template=feature_request.md)
- [🥂 定价](https://kqiu.top/product/sync-vault/)
## ❤️ 特别感谢
- [Obsidian](https://obsidian.md/)
- [React](https://react.dev/)
