MoShu - 魔书文档管理助手

一个 VSCode 扩展，用于将本地文件/文件夹与平台进行同步，支持拉取、推送和 Diff 对比功能。

功能特性

🔐 API 密钥认证

• 使用 API 密钥进行安全认证
• 密钥存储在 VSCode 的 Secret Storage 中，确保安全

📥 文档拉取 (Pull)

• 从平台拉取文档到本地
• 支持增量更新，智能对比差异
• 自动管理版本信息（.docsdata）
• 支持 ZIP 文件自动解压

📤 文档推送 (Push)

• 推送本地修改到平台
• 支持单文件或整个文件夹推送
• 支持创建新版本或更新现有版本
• 自动更新本地版本记录

🔍 Diff 对比

• 本地 Diff: 在 VSCode 中直接查看本地与远程文件的差异
• 在线 Diff: 生成在线差异对比链接，在浏览器中查看
• 支持右键菜单快速访问

安装

1. 克隆仓库
2. 安装依赖：pnpm install
3. 编译：pnpm run compile
4. 在 VSCode 中按 F5 调试运行

配置

首次使用需要配置：

1. 打开命令面板（Ctrl+Shift+P / Cmd+Shift+P）
2. 运行 MoShu: 配置
3. 输入平台的基础 URL（默认：https://ai-platform-test.zhenguanyu.com）
4. 输入您的 API 密钥

使用方法

🎯 简单易用的图形化操作

MoShu 专为非技术人员设计，完全零门槛操作：

✨ 方式 1: 文件浏览器右键菜单（最常用）

在 VSCode 左侧文件浏览器中：

• 右键点击文件夹 → 拉取文档 / 推送文档
• 右键点击文件 → 推送文件 / 对比差异 / 生成 Diff 链接

📝 方式 2: 编辑器右键菜单

在编辑器中编辑文件时，右键点击：

• 推送当前文件
• 对比远程最新版本
• 生成在线 Diff 链接

🔘 方式 3: 状态栏快速菜单

点击右下角 ☁️ MoShu 按钮，快速访问所有功能。

💡 提示：所有操作都只需点击鼠标，无需记忆任何命令！

拉取文档

右键点击文件夹 → MoShu: 拉取文档

或点击状态栏 ☁️ MoShu → 选择"拉取文档"

• 首次拉取：输入文档 ID
• 后续拉取：自动从 .docsdata 读取文档 ID
• 自动检测差异并提示选择需要更新的文件

推送文档

推送整个文件夹：

右键点击文件夹 → MoShu: 推送文档

推送单个文件：

右键点击文件 → MoShu: 推送当前文件

Diff 对比

本地对比：

右键点击文件 → MoShu: 对比远程最新版本

在 VSCode 内部直接显示差异

生成在线链接：

右键点击文件 → MoShu: 生成在线 Diff 链接

生成可在浏览器中查看的差异对比链接

文件说明

.docsdata

记录文档的版本信息，包括：

• 文件结构
• 版本号（changeLogId）
• 文档 ID
• 其他元数据

注意：不要手动编辑此文件，由插件自动管理。

工作流程

1. 初次使用

   • 在平台手动创建文档（如需要）
   • 使用 拉取文档 获取元数据和文件
   • 本地编辑文件

2. 日常使用

   • 使用 拉取文档 同步最新版本
   • 本地编辑
   • 使用 Diff 对比 查看差异
   • 使用 推送文档 或 推送当前文件 更新到平台

命令列表

提示：所有命令都可以通过右键菜单或状态栏按钮访问，无需记忆！

📚 文档

• 配置指南 - 详细的配置说明 ⭐️
• 开发调试指南 - 开发者必读 ⭐️
• 快速参考卡片 - 一页纸操作指南
• 快速开始 - 5 分钟上手指南
• 图形化操作指南 - 右键菜单使用说明
• 使用指南 - 详细使用说明
• 架构文档 - 项目架构设计
• 开发指南 - 开发者文档
• API 规范 - 平台 API 接口规范
• 项目概览 - 项目整体概况

技术栈

• TypeScript
• VSCode Extension API
• Webpack
• adm-zip (ZIP 文件处理)

开发

想要参与开发或自定义功能？查看 开发调试指南 ⭐️

快速开始调试：

# 1. 安装依赖
pnpm install

# 2. 编译代码
pnpm run compile

# 3. 按 F5 启动调试

详细的开发指南请参考 DEVELOPMENT.md

License

MIT