doc-sync-tool
自动同步项目中的 Agents.md、claude.md 和 gemini.md 文件,保持内容一致性。支持自动监听和手动触发。
Security Assessment
Detected risks:
About doc-sync-tool
The 'doc-sync-tool' is a tool designed to automate the synchronization of AI agent configuration files within a project. Specifically, it ensures that the contents of the 'Agents.md', 'claude.md', and 'gemini.md' files are always consistent across a project. This tool eliminates the need for manual updates, making it ideal for projects where multiple AI agents need to share the same configurations. By automating this synchronization process, the tool saves time and reduces the risk of errors that may arise from maintaining multiple similar documents.
The tool features several core capabilities that make it highly efficient. It can automatically detect the required configuration files in the project directory, ensuring that all relevant documents are synchronized. Additionally, it can monitor files in real-time, syncing changes as soon as they occur. Users can also manually trigger synchronization if needed. The tool offers flexibility by supporting both automatic and manual synchronization modes, catering to different user needs. It also allows for seamless background operation, making it ideal for long-term use without manual intervention.
The 'doc-sync-tool' is primarily useful for AI development teams or anyone working with multiple agents requiring consistent configuration files. It is designed to help teams streamline their workflow, ensure that all agents work with the same instructions, and prevent inconsistencies. Additionally, it is valuable for teams looking to avoid the complexity of manually maintaining multiple versions of configuration files, especially when working in collaborative environments or when frequent updates are necessary.
FAQ
How do I manually trigger synchronization?
You can manually trigger synchronization by running the command `node /path/to/sync.js` in the project root directory, or by using the npm script `pnpm run sync`.
Can I run this tool continuously in the background?
Yes, you can run the tool continuously by using the 'watch' mode. To do this, execute `node /path/to/watch.js` or use the npm script `pnpm run watch`. For background execution, it is recommended to use PM2 for process management.
What versions of Node.js are supported?
The tool requires Node.js version 14 or higher.
Are there any directories that are excluded from scanning?
Yes, the tool automatically excludes directories such as 'node_modules', '.git', '.next', and 'dist' from being scanned.
What should I do if I face issues with dependency installation?
If you encounter dependency installation issues, try removing the 'node_modules' folder and 'package-lock.json' file, and then run `pnpm install` again.
All Files
14 filesInstall doc-sync-tool
Quick Setup:
- Copy the skill folder to
.claude/skills/ - Claude will automatically detect and use the skill
Repository
littleben/awesomeAgentskills