doc-sync-tool

Synchronize AGENTS.md, CLAUDE.md, and GEMINI.md across project folders.

184|31|Updated Oct 18, 2025
One-click install
npx skills add https://github.com/littleben/awesomeAgentskills --skill doc-sync-tool
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-sync-tool
Source: https://github.com/littleben/awesomeAgentskills/tree/main/doc-sync-tool
Command: npx skills add https://github.com/littleben/awesomeAgentskills --skill doc-sync-tool

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

这项技能自动在项目中同步 Agents.md、claude.md 和 gemini.md 三个文档的内容,确保它们保持一致,减少重复维护的工作负担。

Core Features & Use Cases

  • 自动发现并分组同一目录的三个目标文档
  • 以最新修改的文档作为源,复制内容到其他两个文件
  • 提供手动一次性同步和持续监听两种工作模式,用于开发和生产环境
  • Use case: 当一个文件更新时,自动同步到其他两个文件,确保文档一致性,适用于多语言或多代理场景。

Quick Start

  • 在文档根目录执行手动同步: ./run-sync.sh
  • 启动监听: ./run-watch.sh
  • 生产环境推荐: pm2 start watch.js --name doc-sync

Frequently Asked Questions about doc-sync-tool

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I keep AGENTS.md, CLAUDE.md, and GEMINI.md synchronized across a project?

To keep AGENTS.md, CLAUDE.md, and GEMINI.md synchronized, this tool copies content from the most recently edited file to the others. It groups files by folder and operates recursively across directories to ensure consistency.

Does the documentation sync tool support real-time file watching?

Yes, the documentation sync tool supports real-time file watching via the run-watch.sh script. It continuously monitors target files and automatically applies updates during development workflows.

What is the best way to run continuous markdown synchronization in a production environment?

The best way to run continuous markdown synchronization in production is using pm2 to manage the watch.js process. This ensures the real-time file watcher stays active and reliably syncs your documentation.

Do I need Node.js to sync markdown files across multiple directories?

Yes, you need Node.js version 14 or higher to run this markdown file sync tool. It relies on standard filesystem I/O operations to perform non-destructive merges across your project directories.

Can I exclude specific directories from the recursive documentation sync?

Yes, you can exclude specific directories from the recursive documentation sync by configuring the ignore lists. This prevents the tool from overwriting or merging files in paths you want to leave untouched.