doc-sync-tool

自动同步项目中的 Agents.md、claude.md 和 gemini.md 文件,保持内容一致性。支持自动监听和手动触发。

25 stars

Best use case

doc-sync-tool is best used when you need a repeatable AI agent workflow instead of a one-off prompt.

自动同步项目中的 Agents.md、claude.md 和 gemini.md 文件,保持内容一致性。支持自动监听和手动触发。

Teams using doc-sync-tool should expect a more consistent output, faster repeated execution, less prompt rewriting.

When to use this skill

  • You want a reusable workflow that can be run more than once with consistent structure.

When not to use this skill

  • You only need a quick one-off answer and do not need a reusable workflow.
  • You cannot install or maintain the underlying files, dependencies, or repository context.

Installation

Claude Code / Cursor / Codex

$curl -o ~/.claude/skills/doc-sync-tool/SKILL.md --create-dirs "https://raw.githubusercontent.com/ComeOnOliver/skillshub/main/skills/aiskillstore/marketplace/zhanlincui/doc-sync-tool/SKILL.md"

Manual Installation

  1. Download SKILL.md from GitHub
  2. Place it in .claude/skills/doc-sync-tool/SKILL.md inside your project
  3. Restart your AI agent — it will auto-discover the skill

How doc-sync-tool Compares

Feature / Agentdoc-sync-toolStandard Approach
Platform SupportNot specifiedLimited / Varies
Context Awareness High Baseline
Installation ComplexityUnknownN/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

model-quantization-tool

25
from ComeOnOliver/skillshub

Model Quantization Tool - Auto-activating skill for ML Deployment. Triggers on: model quantization tool, model quantization tool Part of the ML Deployment skill category.

model-explainability-tool

25
from ComeOnOliver/skillshub

Model Explainability Tool - Auto-activating skill for ML Training. Triggers on: model explainability tool, model explainability tool Part of the ML Training skill category.

data-normalization-tool

25
from ComeOnOliver/skillshub

Data Normalization Tool - Auto-activating skill for ML Training. Triggers on: data normalization tool, data normalization tool Part of the ML Training skill category.

async-api-caller

25
from ComeOnOliver/skillshub

Async Api Caller - Auto-activating skill for API Integration. Triggers on: async api caller, async api caller Part of the API Integration skill category.

learning-a-tool

25
from ComeOnOliver/skillshub

Create learning paths for programming tools, and define what information should be researched to create learning guides. Use when user asks to learn, understand, or get started with any programming tool, library, or framework.

recipe-sync-contacts-to-sheet

25
from ComeOnOliver/skillshub

Export Google Contacts directory to a Google Sheets spreadsheet.

csharp-async

25
from ComeOnOliver/skillshub

Get best practices for C# async programming

mermaid-tools

25
from ComeOnOliver/skillshub

Extracts Mermaid diagrams from markdown files and generates high-quality PNG images using bundled scripts. Activates when working with Mermaid diagrams, converting diagrams to PNG, extracting diagrams from markdown, or processing markdown files with embedded Mermaid code.

markdown-tools

25
from ComeOnOliver/skillshub

Converts documents to markdown with multi-tool orchestration for best quality. Supports Quick Mode (fast, single tool) and Heavy Mode (best quality, multi-tool merge). Use when converting PDF/DOCX/PPTX files to markdown, extracting images from documents, validating conversion quality, or needing LLM-optimized document output.

no-tools

25
from ComeOnOliver/skillshub

Instructions only skill

../../../marketing-skill/prompt-engineer-toolkit/SKILL.md

25
from ComeOnOliver/skillshub

No description provided.

security-scanning-tools

25
from ComeOnOliver/skillshub

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.