Doc Sync Tool logo

Doc Sync Tool

Community
littleben
doc-sync-tool

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

Overview

Publisherlittleben
RepositoryawesomeAgentskills
Skill namedoc-sync-tool
Stars
187
Forks
31
Bundled files
11
LicenseMIT
Links
  • Markdown instructions

    A SKILL.md file the model loads on demand, so it only costs tokens when a request actually matches.

  • Works with any LLM

    AI skills are plain Markdown, not provider-specific code, so this works with GPT, Claude, Gemini, Grok, or a local model.

  • 11 bundled files

    Scripts, templates, and references the model can read while it works. Files are read-only and never executed.

  • Open source

    Published by littleben on GitHub. Read the source before you install it.

Installation

Install the Doc Sync Tool AI skill in TypingMind to use it with any LLM, or drop it into another agent that reads SKILL.md.

1

Install in TypingMind

TypingMind installs a skill straight from its GitHub folder — it reads SKILL.md, bundles the resource files, and stores the result locally.

  1. Open the app and go to Plugins → Skills.
  2. Choose "Install from GitHub".
  3. Paste the skill folder URL below and confirm.
  4. Enable the skill in any chat where you want it available.
Plugins → Skills → Add skill → From GitHub URL, then paste the folder URL and press Continue.
2

Install in another agent

Any agent that reads the Agent Skills format can use this skill — copy the folder into that agent's skills directory.

Claude Code — .claude/skills
git clone --depth 1 https://github.com/littleben/awesomeAgentskills.git /tmp/awesomeAgentskills
mkdir -p .claude/skills
cp -r /tmp/awesomeAgentskills/doc-sync-tool .claude/skills/doc-sync-tool
Restart Claude Code after copying so it picks up the new skill.

Use it in TypingMind

Enable Doc Sync Tool in any TypingMind chat and the model takes it from there. Its name and description sit in the system prompt, and the moment a request matches, the model loads the full instructions itself — you never invoke it by hand, and it costs no tokens until it is actually used.

The model loads Doc Sync Tool on its own as soon as a request matches it.

Works with any AI model

AI skills are plain Markdown instructions rather than provider-specific code, so Doc Sync Tool is not tied to the model it was written for. Install it once in TypingMind and use it with GPT-5, Claude, Gemini, Grok, DeepSeek, Mistral, Llama, or a local model you run yourself — all on your own API keys.

  • Loaded only when it is needed

    The system prompt carries just the name and description. The instructions are fetched on the first matching request, so an idle skill costs nothing.

  • Switch models mid-chat

    Because the skill is instructions rather than code, changing model does not break it — the next model reads the same SKILL.md.

Skill instructions

This is the SKILL.md content the model loads. Read it before installing — a skill is instructions your model will follow.

文档同步工具 (Doc Sync Tool)

功能说明

这个工具用于自动同步项目中的 AI Agent 配置文档,确保 Agents.mdclaude.mdgemini.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.mdclaude.mdgemini.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.nextdist 等目录
  • 同步时会保留文件的原始格式和内容
  • 建议在 Git 仓库中使用,方便追踪文件变化
  • 监听模式会持续运行,建议使用 PM2 管理进程

故障排除

权限问题

bash
chmod +x sync.js watch.js

Node.js 版本要求

需要 Node.js 14+ 版本

依赖安装失败

bash
rm -rf node_modules package-lock.json
pnpm install

Bundled files

The model reads these on demand while the skill is loaded. They are exposed as readable files and are never executed.

Frequently asked questions

What does the Doc Sync Tool AI skill do?

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

Why use Doc Sync Tool on TypingMind?

Because you install it once and use it with any model. Doc Sync Tool is plain Markdown rather than provider-specific code, so the same skill runs on GPT-5, Claude, Gemini, Grok, or a local model — and you can switch model mid-chat without it breaking. TypingMind runs on your own API keys, so you pay providers directly instead of a per-seat subscription, and your skills and chats stay in your own storage.

How do I install Doc Sync Tool in TypingMind?

Open Plugins → Skills → Install from GitHub in TypingMind and paste https://github.com/littleben/awesomeAgentskills/tree/main/doc-sync-tool. TypingMind reads its SKILL.md and bundles its files and installs it as a skill you can enable per chat.

Which AI models can use Doc Sync Tool?

Any model you connect in TypingMind. AI skills are plain Markdown instructions rather than provider-specific code, so GPT, Claude, Gemini, Grok, and local models can all load this skill when a request matches it.

How many AI models can I use with Doc Sync Tool?

As many as you like. As long as a model supports skills, you can use Doc Sync Tool with it — GPT, Claude, Gemini, Grok, DeepSeek, Mistral, Llama and more — all on TypingMind with your own API keys.

Is the Doc Sync Tool AI skill free?

Yes. It is published on GitHub by littleben under the MIT license. You only pay your own AI provider for the tokens you use.

What are AI skills?

An AI skill is a reusable instruction bundle that teaches an AI model how to do one specific task. It follows the open Agent Skills format: a SKILL.md file with a name and description, plus any scripts, templates or reference files the model may need. The model reads the instructions only when your request matches the skill, so an installed skill costs nothing until it is used.

How are AI skills different from plugins or MCP servers?

A plugin or MCP server gives a model new tools to call — code that runs somewhere and returns a result. An AI skill gives the model knowledge and process instead: how to approach a task, which steps to follow, what good output looks like. Skills are plain Markdown, so they need no server, no API key and no runtime, and they work with any model.

View all

Set up your own AI workspace now

Get notified about new features and future giveaways by subscribing to our newsletter 👇