doc-sync-tool
- Repo stars 0
- Author updated Live
- Author repo skills-registry
- Domain
- Documentation
- Compatible agents
-
- Claude Code
- Cursor
- Cline
- Codex
- Windsurf
- Gemini CLI
- +20
- Trust score
- 88 / 100 · community maintained
- Author / version / license
- @tomevault-io · no license declared
- Token usage
- Lean
- Setup complexity
- Plug-and-play
- External API key
- Not required
- Operating systems
- macOS · Linux · Windows
- Runtime requirements
- Node.js
- Permissions
-
- Read-only
- Write / modify
- Network behavior
- Local-only
- Install commands
- 26 variants
Profile is derived at build time from SKILL.md and install vectors. Subject to drift from author intent.
Heads up: 未限定 allowed-tools,默认拥有全部工具权限。
---
name: doc-sync-tool
description: 这个工具用于自动同步项目中的 AI Agent 配置文档,确保 Agents.md、claude.md 和 gemini.md 三个文件内容保持一致。 cd /Users/ben/Downlo…
category: documentation
runtime: Node.js
---
# doc-sync-tool output preview
## PART A: Task fit
- Use case: 这个工具用于自动同步项目中的 AI Agent 配置文档,确保 Agents.md、claude.md 和 gemini.md 三个文件内容保持一致。 cd /Users/ben/Downloads/go\ to\ wild/auto-website-system/_skills/doc-sync-tool node /Users/ben/Downloads/go\ to\ wild/auto-website-system/_skills/doc-sync-tool/sync.js runs entirely locally; runs on Node.js. Works with Claude Code, Cursor, Cline and 23 more..
- Inputs: target material, constraints, expected output, and acceptance criteria.
- Evidence boundary: follow “功能说明 / 核心功能 / 使用场景” and do not present inference as author intent.
## PART B: Execution result
- **01** The card summarizes the use case; runtime output centers on “这个工具用于自动同步项目中的 AI Agent 配置文档,确保 Agents.md、claude.md 和 gemini.md 三个文件内容保持一致。 cd /Users/ben/Downloads/go\ to\ wild/auto-website-system/_skills/doc-sync-tool node /Users/ben/Downloads/go\ to\ wild/auto-website-system/_skills/doc-sync-tool/sync.js runs entirely locally; runs on Node.js. Works with Claude Code, Cursor, Cline and 23 more.”.
- **02** When the source has headings, the agent prioritizes “功能说明 / 核心功能 / 使用场景” so the result follows the author’s structure.
- **03** Typical output includes task judgment, concrete steps, required commands or file edits, validation, and follow-up options.
- **04** Risk context follows the fingerprint: read files, write/modify files; mostly runs locally; usually needs no extra API key.
## Running Rules
- read files, write/modify files; mostly runs locally; usually needs no extra API key.
- Validate with a small sample before expanding scope.
- Return the result, validation criteria, and next iteration options. The source mentions slash commands such as `/users`; use them first when your agent supports command triggers.
Name target files or source material, expected output, forbidden changes, and whether network or shell access is allowed. Permission fingerprint: read files, write/modify files.
Start with a small task and check whether the result follows “功能说明 / 核心功能 / 使用场景”. Inspect diffs, logs, previews, or tests before expanding scope.
Confirm the final output includes a concrete result, evidence, and next action. If it stays generic, tighten inputs, boundaries, and acceptance criteria.
---
name: doc-sync-tool
description: 这个工具用于自动同步项目中的 AI Agent 配置文档,确保 Agents.md、claude.md 和 gemini.md 三个文件内容保持一致。 cd /Users/ben/Downlo…
category: documentation
source: tomevault-io/skills-registry
---
# doc-sync-tool
## When to use
- 这个工具用于自动同步项目中的 AI Agent 配置文档,确保 Agents.md、claude.md 和 gemini.md 三个文件内容保持一致。 cd /Users/ben/Downloads/go\ to\ wild/auto-…
- Use it when the task has clear inputs, repeatable steps, and validation criteria.
## What to provide
- Target material, scope, expected result, and forbidden changes.
- Whether network, commands, file writes, or external services are allowed.
## Execution rules
- Organize steps around “功能说明 / 核心功能 / 使用场景” and keep inference separate from source facts.
- read files, write/modify files; mostly runs locally; usually needs no extra API key.
- Validate with a small sample before expanding the task.
## Output requirements
- Return the deliverable, key evidence, validation method, and next action.
- Mark missing information as unknown; do not invent commands, platforms, or dependencies. The author source anchors workflow facts; repository files anchor sources and commands; Fluxly only adds fit, limitations, and quality judgment.
skill "doc-sync-tool" {
input -> user goal + target files + boundaries + acceptance criteria
context -> 功能说明 / 核心功能 / 使用场景
rules -> SKILL.md triggers / order / output contract
runtime -> Node.js | read files, write/modify files | mostly runs locally
guardrails -> usually needs no extra API key + small-sample validation + diff/log review
output -> copyable result + checklist + next iteration
} 文档同步工具 (Doc Sync Tool)
功能说明
这个工具用于自动同步项目中的 AI Agent 配置文档,确保 Agents.md、claude.md 和 gemini.md 三个文件内容保持一致。
核心功能
- 自动发现: 递归扫描当前目录下所有文件夹,查找这三个文档
- 智能同步: 发现任意一个文档时,自动创建/更新其余两个
- 文件监听: 实时监听文件变化,自动同步最新内容
- 手动触发: 支持命令行手动执行同步
使用场景
- 在多个 AI Agent 之间共享相同的项目配置
- 自动保持不同 AI 的工作指令一致
- 避免手动维护多个相同文档的麻烦
使用方法
安装依赖
cd /Users/ben/Downloads/go\ to\ wild/auto-website-system/_skills/doc-sync-tool
pnpm install
手动同步(单次执行)
# 在项目根目录执行
node /Users/ben/Downloads/go\ to\ wild/auto-website-system/_skills/doc-sync-tool/sync.js
# 或者使用 npm script
pnpm run sync
自动监听(持续运行)
# 启动文件监听服务
node /Users/ben/Downloads/go\ to\ wild/auto-website-system/_skills/doc-sync-tool/watch.js
# 或者使用 npm script
pnpm run watch
后台运行(推荐)
# 使用 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
工作原理
- 扫描阶段: 递归遍历指定目录,查找
Agents.md、claude.md、gemini.md文件 - 分组阶段: 将同一文件夹下的这三个文件归为一组
- 同步阶段:
- 如果某组只有一个文件,复制内容创建其余两个
- 如果某组有多个文件,选择最新修改的作为源,同步到其他文件
- 监听阶段 (watch 模式): 持续监听文件变化,触发同步
配置选项
可以在 sync.js 中修改以下配置:
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 管理进程
故障排除
权限问题
chmod +x sync.js watch.js
Node.js 版本要求
需要 Node.js 14+ 版本
依赖安装失败
rm -rf node_modules package-lock.json
pnpm install
Source: ComeOnOliver/skillshub — distributed by TomeVault.
Decide Fit First
Design Intent
How To Use It
Boundaries And Review