背景
在使用多个 AI 编程工具(Claude Code、Codex、Gemini CLI 等)开发项目时,每个工具都需要一个项目配置文档来了解项目结构和工作指令。但手动维护多个相同的配置文档既繁琐又容易出错。
于是我开发了 doc-sync-tool,一个轻量级的文档同步工具。
核心功能
- 自动发现:递归扫描项目文件夹,查找
AGENTS.md、CLAUDE.md、GEMINI.md文档 - 智能同步:以最新修改的文件为准,自动创建/更新其他文件
- 实时监听:文件变化时自动触发同步
- 零依赖:只需 Node.js 14+,无需额外安装包
使用场景
场景 1: 新项目初始化
在项目中创建一个 CLAUDE.md,工具会自动生成 AGENTS.md 和 GEMINI.md。
场景 2: 更新配置
修改任意一个配置文件,保存后自动同步到其他两个文件。开启监听模式后,编辑一次,到处生效。
场景 3: 多项目批量同步
对所有项目的配置文档进行一键同步,确保所有 AI Agent 都使用最新的项目配置。
快速开始
手动同步(单次执行)
node path/to/doc-sync-tool/sync.js
自动监听(持续运行)
node path/to/doc-sync-tool/watch.js
监听服务会在后台持续运行,自动检测文件变化并触发同步。
技术实现
工具使用 Node.js 的 fs.watch API 实现文件监听,采用递归监听模式,只需监听根目录即可覆盖所有子目录。为了避免短时间内重复触发,使用了防抖机制。
核心逻辑很简单:
- 扫描项目,找到所有配置文档
- 按目录分组
- 选择最新修改的作为源文件
- 将内容同步到其他文件
开源地址
工具已开源,欢迎使用和贡献:
完整文档包含使用示例、配置选项和故障排除,欢迎 Star ⭐
总结
这个工具解决了我在多 AI Agent 开发中遇到的实际痛点。虽然功能简单,但确实提升了效率。如果你也在使用多个 AI 编程工具,不妨试试这个小工具。
Happy coding! 🚀