doc-sync-tool
Synchronize AI Agent Documentation Automatically
Maintaining identical configuration files for multiple AI agents is tedious and error-prone. This tool automatically keeps AGENTS.md, CLAUDE.md, and GEMINI.md files in sync across your entire project with real-time file watching or manual triggering.
تنزيل ZIP المهارة
رفع في Claude
اذهب إلى Settings → Capabilities → Skills → Upload skill
فعّل وابدأ الاستخدام
اختبرها
استخدام "doc-sync-tool". Run manual sync on a project with one existing CLAUDE.md file
النتيجة المتوقعة:
- 🚀 开始扫描文档...
- 📂 扫描路径：/path/to/project
- 📋 目标文件：AGENTS.md, CLAUDE.md, GEMINI.md
- ✓ 找到 1 个目录包含目标文件
- 📁 处理目录：/path/to/project
- 📄 源文件：CLAUDE.md (2025-11-27 10:30:45)
- ✨ 创建：AGENTS.md
- ✨ 创建：GEMINI.md
- 🎉 成功同步 2 个文件
- ✅ 同步完成！处理目录：1 个，更新文件：2 个，耗时：0.23s
استخدام "doc-sync-tool". File watcher detects a change to CLAUDE.md
النتيجة المتوقعة:
- [10:35:20] 📝 检测到文件变化：/path/to/CLAUDE.md
- 📁 处理目录：/path/to
- 📄 源文件：CLAUDE.md
- ✅ 更新：AGENTS.md
- 🎉 成功同步 1 个文件
التدقيق الأمني
مخاطر منخفضةStatic analysis flagged 254 external_commands patterns and 31 filesystem operations, but evaluation confirms these are false positives. The 'Ruby/shell backtick execution' findings are markdown documentation examples in EXAMPLES.md, INDEX.md, README.md, QUICKSTART.md, and SKILL.md - not executable code. The 'hex-encoded characters' and 'weak cryptographic algorithm' findings are ANSI terminal color codes (e.g., \x1b[32m for green). The tool performs legitimate file synchronization using Node.js fs module with proper path handling via path.join() and path.dirname(). One minor concern: rename-quick.js uses child_process.execSync with hardcoded 'find' commands, which is acceptable but should be noted.
مشكلات منخفضة المخاطر (1)
عوامل الخطر
📁 الوصول إلى نظام الملفات (5)
⚙️ الأوامر الخارجية (5)
درجة الجودة
ماذا يمكنك بناءه
New Project Setup
When starting a new project, create just one agent config file (e.g., CLAUDE.md) and let the tool automatically generate AGENTS.md and GEMINI.md with identical content.
Continuous Documentation Sync
Run the tool in watch mode during development to automatically propagate any agent configuration changes to all other agent files in real-time.
Bulk Synchronization
Execute manual sync across multiple project directories at once to ensure all agent documentation stays consistent after major updates.
جرّب هذه الموجهات
Set up automatic documentation sync for my project. I have a CLAUDE.md file and need to create matching AGENTS.md and GEMINI.md files.
Run the doc-sync-tool to synchronize all agent documentation files in the current project directory and show me which files were updated.
Start the file watcher in background mode using PM2 so my agent docs stay synchronized automatically. Show me how to verify it is running.
Help me modify the doc-sync-tool configuration to exclude additional directories and change the target file names to match my project conventions.
أفضل الممارسات
- Run the tool in watch mode during active development to keep all agent docs synchronized in real-time
- Use PM2 for production environments to ensure the file watcher survives system restarts
- Commit all three documentation files to version control for complete backup and history tracking
تجنب
- Do not manually edit multiple agent files simultaneously - let the sync tool handle propagation
- Avoid running multiple sync instances on the same directory to prevent race conditions
- Do not exclude directories that actually contain agent documentation you want synchronized