📦

doc-sync-tool

Name: doc-sync-tool
Author: ZhanlinCui

Risque faible 📁 Accès au système de fichiers⚙️ Commandes externes

Synchroniser automatiquement la documentation des agents IA

La maintenance de fichiers de configuration identiques pour plusieurs agents IA est fastidieuse et sujette aux erreurs. Cet outil garde automatiquement les fichiers AGENTS.md, CLAUDE.md et GEMINI.md synchronisés dans l'ensemble de votre projet avec une surveillance des fichiers en temps réel ou un déclenchement manuel.

Prend en charge: Claude Codex Code(CC)

📊 71 Adéquat

Télécharger le ZIP du skill

Importer dans Claude

Allez dans Paramètres → Capacités → Skills → Importer un skill

Activez et commencez à utiliser

Tester

Utilisation de "doc-sync-tool". Exécuter une synchronisation manuelle sur un projet avec un fichier CLAUDE.md existant

Résultat attendu:

🚀 开始扫描文档...
📂 扫描路径：/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

Utilisation de "doc-sync-tool". Le surveillanceur de fichiers détecte un changement sur CLAUDE.md

Résultat attendu:

[10:35:20] 📝 检测到文件变化：/path/to/CLAUDE.md
📁 处理目录：/path/to
📄 源文件：CLAUDE.md
✅ 更新：AGENTS.md
🎉 成功同步 1 个文件

Audit de sécurité

Risque faible

v1 • 2/24/2026

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.

Fichiers analysés

1,754

Lignes analysées

résultats

Total des audits

Problèmes à risque faible (1)

rename-quick.js:14 rename-quick.js:33

Shell Command Execution in Helper Script

The rename-quick.js helper script uses child_process.execSync to run 'find' commands for file discovery. While the arguments are hardcoded and not user-controllable, this represents a minor security consideration for a helper utility.

Facteurs de risque

📁 Accès au système de fichiers (5)

sync.js:31 sync.js:79-101 watch.js:63 rename-quick.js:24 rename-quick.js:43

⚙️ Commandes externes (5)

rename-quick.js:14 rename-quick.js:33 run-sync.sh:6 run-watch.sh:6 test.sh:8-9

Audité par: claude

Score de qualité

Architecture

100

Maintenabilité

Contenu

Communauté

Sécurité

Conformité aux spécifications

Ce que vous pouvez construire

Configuration d'un nouveau projet

Lors du démarrage d'un nouveau projet, créez un seul fichier de configuration d'agent (par exemple CLAUDE.md) et laissez l'outil générer automatiquement AGENTS.md et GEMINI.md avec un contenu identique.

Synchronisation continue de la documentation

Exécutez l'outil en mode watch pendant le développement pour propager automatiquement tout changement de configuration d'agent vers tous les autres fichiers d'agent en temps réel.

Synchronisation en masse

Exécutez la synchronisation manuelle sur plusieurs répertoires de projet à la fois pour assurer la cohérence de toute la documentation des agents après des mises à jour majeures.

Essayez ces prompts

Configuration de base

Configurez la synchronisation automatique de la documentation pour mon projet. J'ai un fichier CLAUDE.md et je dois créer les fichiers AGENTS.md et GEMINI.md correspondants.

Exécution de synchronisation manuelle

Exécutez le doc-sync-tool pour synchroniser tous les fichiers de documentation des agents dans le répertoire du projet actuel et montrez-moi quels fichiers ont été mis à jour.

Surveillance en arrière-plan

Démarrez le surveillanceur de fichiers en mode arrière-plan avec PM2 pour que mes docs d'agent restent synchronisées automatiquement. Montrez-moi comment vérifier qu'il fonctionne.

Personnalisation de la configuration

Aidez-moi à modifier la configuration du doc-sync-tool pour exclure des répertoires supplémentaires et changer les noms des fichiers cibles pour correspondre aux conventions de mon projet.

Bonnes pratiques

Exécutez l'outil en mode watch pendant le développement actif pour garder tous les docs d'agent synchronisées en temps réel
Utilisez PM2 pour les environnements de production pour assurer que le surveillanceur de fichiers survives aux redémarrages système
Validez les trois fichiers de documentation dans le contrôle de version pour une sauvegarde complète et un suivi de l'historique

Éviter

N'éditer pas manuellement plusieurs fichiers d'agent simultanément - laissez l'outil de synchronisation gérer la propagation
Évitez d'exécuter plusieurs instances de synchronisation sur le même répertoire pour prévenir les conditions de course
N'excluez pas les répertoires qui contiennent réellement de la documentation d'agent que vous voulez synchroniser

Foire aux questions

Quels fichiers cet outil synchronise-t-il ?

L'outil synchronise trois fichiers : AGENTS.md (ou Agents.md), CLAUDE.md (ou claude.md) et GEMINI.md (ou gemini.md). Il fait correspondre les fichiers sans tenir compte de la casse dans le même répertoire.

Comment l'outil décide-t-il quel fichier est la source ?

L'outil utilise l'heure de modification (mtime) pour déterminer la source. Le fichier le plus récemment modifié devient la source, et son contenu est copié vers les autres fichiers.

Puis-je personnaliser quels fichiers sont synchronisés ?

Oui. Modifiez le tableau targetFiles dans sync.js pour changer quels noms de fichiers sont synchronisés. La valeur par défaut est ['AGENTS.md', 'CLAUDE.md', 'GEMINI.md'].

Le mode watch consomme-t-il beaucoup de ressources système ?

Non. Le mode watch utilise fs.watch natif de Node.js avec surveillance récursive. Il consomme moins de 50MB de mémoire et quasi-zero CPU au repos.

Comment arrêter le surveillanceur de fichiers ?

Appuyez sur Ctrl+C dans le terminal pour arrêter. Si exécuté via PM2, utilisez 'pm2 stop doc-sync' ou 'pm2 delete doc-sync' pour arrêter et supprimer le service.

Que se passe-t-il si deux fichiers sont modifiés en même temps ?

L'outil inclut du debouncing pour gérer les changements rapides. Il utilisera whichever file has the most recent modification timestamp after the debounce period completes.