doc-sync-tool
自动同步项目中的 Agents.md、claude.md 和 gemini.md 文件,保持内容一致性。支持自动监听和手动触发。
Best use case
doc-sync-tool is best used when you need a repeatable AI agent workflow instead of a one-off prompt. It is especially useful for teams working in multi. 自动同步项目中的 Agents.md、claude.md 和 gemini.md 文件,保持内容一致性。支持自动监听和手动触发。
自动同步项目中的 Agents.md、claude.md 和 gemini.md 文件,保持内容一致性。支持自动监听和手动触发。
Users should expect a more consistent workflow output, faster repeated execution, and less time spent rewriting prompts from scratch.
Practical example
Example input
Use the "doc-sync-tool" skill to help with this workflow task. Context: 自动同步项目中的 Agents.md、claude.md 和 gemini.md 文件,保持内容一致性。支持自动监听和手动触发。
Example output
A structured workflow result with clearer steps, more consistent formatting, and an output that is easier to reuse in the next run.
When to use this skill
- Use this skill when you want a reusable workflow rather than writing the same prompt again and again.
When not to use this skill
- Do not use this when you only need a one-off answer and do not need a reusable workflow.
- Do not use it if you cannot install or maintain the related files, repository context, or supporting tools.
Installation
Claude Code / Cursor / Codex
Manual Installation
- Download SKILL.md from GitHub
- Place it in
.claude/skills/doc-sync-tool/SKILL.mdinside your project - Restart your AI agent — it will auto-discover the skill
How doc-sync-tool Compares
| Feature / Agent | doc-sync-tool | Standard Approach |
|---|---|---|
| Platform Support | Not specified | Limited / Varies |
| Context Awareness | High | Baseline |
| Installation Complexity | Unknown | N/A |
Frequently Asked Questions
What does this skill do?
自动同步项目中的 Agents.md、claude.md 和 gemini.md 文件,保持内容一致性。支持自动监听和手动触发。
Where can I find the source code?
You can find the source code on GitHub using the link provided at the top of the page.
SKILL.md Source
# 文档同步工具 (Doc Sync Tool)
## 功能说明
这个工具用于自动同步项目中的 AI Agent 配置文档,确保 `Agents.md`、`claude.md` 和 `gemini.md` 三个文件内容保持一致。
### 核心功能
1. **自动发现**: 递归扫描当前目录下所有文件夹,查找这三个文档
2. **智能同步**: 发现任意一个文档时,自动创建/更新其余两个
3. **文件监听**: 实时监听文件变化,自动同步最新内容
4. **手动触发**: 支持命令行手动执行同步
## 使用场景
- 在多个 AI Agent 之间共享相同的项目配置
- 自动保持不同 AI 的工作指令一致
- 避免手动维护多个相同文档的麻烦
## 使用方法
### 安装依赖
```bash
cd /Users/ben/Downloads/go\ to\ wild/auto-website-system/_skills/doc-sync-tool
pnpm install
```
### 手动同步(单次执行)
```bash
# 在项目根目录执行
node /Users/ben/Downloads/go\ to\ wild/auto-website-system/_skills/doc-sync-tool/sync.js
# 或者使用 npm script
pnpm run sync
```
### 自动监听(持续运行)
```bash
# 启动文件监听服务
node /Users/ben/Downloads/go\ to\ wild/auto-website-system/_skills/doc-sync-tool/watch.js
# 或者使用 npm script
pnpm run watch
```
### 后台运行(推荐)
```bash
# 使用 PM2 在后台运行
pm2 start /Users/ben/Downloads/go\ to\ wild/auto-website-system/_skills/doc-sync-tool/watch.js --name doc-sync
# 查看状态
pm2 status
# 停止服务
pm2 stop doc-sync
```
## 工作原理
1. **扫描阶段**: 递归遍历指定目录,查找 `Agents.md`、`claude.md`、`gemini.md` 文件
2. **分组阶段**: 将同一文件夹下的这三个文件归为一组
3. **同步阶段**:
- 如果某组只有一个文件,复制内容创建其余两个
- 如果某组有多个文件,选择最新修改的作为源,同步到其他文件
4. **监听阶段** (watch 模式): 持续监听文件变化,触发同步
## 配置选项
可以在 `sync.js` 中修改以下配置:
```javascript
const CONFIG = {
targetFiles: ['Agents.md', 'claude.md', 'gemini.md'], // 目标文件列表
scanPath: process.cwd(), // 扫描路径(默认当前目录)
excludeDirs: ['node_modules', '.git', '.next', 'dist'] // 排除目录
};
```
## 注意事项
- 工具会自动跳过 `node_modules`、`.git`、`.next`、`dist` 等目录
- 同步时会保留文件的原始格式和内容
- 建议在 Git 仓库中使用,方便追踪文件变化
- 监听模式会持续运行,建议使用 PM2 管理进程
## 故障排除
### 权限问题
```bash
chmod +x sync.js watch.js
```
### Node.js 版本要求
需要 Node.js 14+ 版本
### 依赖安装失败
```bash
rm -rf node_modules package-lock.json
pnpm install
```Related Skills
security-scanning-tools
This skill should be used when the user asks to "perform vulnerability scanning", "scan networks for open ports", "assess web application security", "scan wireless networks", "detect malware", "check cloud security", or "evaluate system compliance". It provides comprehensive guidance on security scanning tools and methodologies.
scanning-tools
This skill should be used when the user asks to "perform vulnerability scanning", "scan networks for open ports", "assess web application security", "scan wireless networks", "detec...
rust-async-patterns
Master Rust async programming with Tokio, async traits, error handling, and concurrent patterns. Use when building async Rust applications, implementing concurrent systems, or debugging async code.
red-team-tools
This skill should be used when the user asks to "follow red team methodology", "perform bug bounty hunting", "automate reconnaissance", "hunt for XSS vulnerabilities", "enumerate su...
red-team-tools-and-methodology
This skill should be used when the user asks to "follow red team methodology", "perform bug bounty hunting", "automate reconnaissance", "hunt for XSS vulnerabilities", "enumerate subdomains", or needs security researcher techniques and tool configurations from top bug bounty hunters.
personal-tool-builder
Expert in building custom tools that solve your own problems first. The best products often start as personal tools - scratch your own itch, build for yourself, then discover others have the same itch. Covers rapid prototyping, local-first apps, CLI tools, scripts that grow into products, and the art of dogfooding. Use when: build a tool, personal tool, scratch my itch, solve my problem, CLI tool.
n8n-mcp-tools-expert
Expert guide for using n8n-mcp MCP tools effectively. Use when searching for nodes, validating configurations, accessing templates, managing workflows, or using any n8n-mcp tool. Provides tool selection guidance, parameter formats, and common patterns.
debugging-toolkit-smart-debug
Use when working with debugging toolkit smart debug
agent-tool-builder
Tools are how AI agents interact with the world. A well-designed tool is the difference between an agent that works and one that hallucinates, fails silently, or costs 10x more tokens than necessary. This skill covers tool design from schema to error handling. JSON Schema best practices, description writing that actually helps the LLM, validation, and the emerging MCP standard that's becoming the lingua franca for AI tools. Key insight: Tool descriptions are more important than tool implementa
doc-sync
Keeps IdeaVim documentation in sync with code changes. Use this skill when you need to verify documentation accuracy after code changes, or when checking if documentation (in doc/, README.md, CONTRIBUTING.md) matches the current codebase. The skill can work bidirectionally - from docs to code verification, or from code changes to documentation updates.
tools-ui
Tool lifecycle UI components for React/Next.js from ui.inference.sh. Display tool calls: pending, progress, approval required, results. Capabilities: tool status, progress indicators, approval flows, results display. Use for: showing agent tool calls, human-in-the-loop approvals, tool output. Triggers: tool ui, tool calls, tool status, tool approval, tool results, agent tools, mcp tools ui, function calling ui, tool lifecycle, tool pending
test-echo-tool
A tool that echoes its input for testing