Agent skill

Agent Doc Sync Tool

by littleben in littleben/awesomeAgentskills

Keeps Agents.md, claude.md and gemini.md identical across a project by scanning folders and copying the newest version over the others, once or continuously.

MITAuto-check passedAgent Workflows

SKILL.md written in Chinese; this summary is our English description.

Install Agent Doc Sync Tool

skills CLI
$ npx skills add littleben/awesomeAgentskills --skill doc-sync-tool -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install littleben/awesomeAgentskills doc-sync-tool --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/littleben/awesomeAgentskills.git skills-src && mkdir -p .claude/skills && cp -r skills-src/doc-sync-tool .claude/skills/doc-sync-tool && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
doc-sync-tool
GitHub stars
188
Used in
2 other repos
Token cost
~470 tokens
SKILL.md length
82 words
Files
14
Skills in repo
3
Repo updated
First seen
Licence
MIT

At a glance

Keeps Agents.md, claude.md and gemini.md identical across a project by scanning folders and copying the newest version over the others, once or continuously.

  • Works in 4 steps: 自动发现: 递归扫描当前目录下所有文件夹,查找这三个文档 → 智能同步: 发现任意一个文档时,自动创建/更新其余两个 → 文件监听: 实时监听文件变化,自动同步最新内容 → …
  • Sharing one set of project instructions between several coding agents
  • SKILL.md covers 功能说明, 使用场景, 使用方法 and 工作原理, plus 3 more sections
  • Runs Shell and JavaScript scripts from its folder; calls pnpm and node

What it does

The skill ships Node.js scripts (sync.js and watch.js, with shell wrappers) that scan the current directory recursively for the three agent instruction files and group them by folder. If a folder holds only one of them, the other two are created from it. If several exist, the most recently modified file becomes the source for the rest.

A sync can run once from the command line or continuously in watch mode, and the docs suggest keeping the watcher alive under PM2. The folders node_modules, .git, .next and dist are skipped, and the target file names and scan path can be changed in a CONFIG object in sync.js. It needs Node.js 14 or newer, installs with pnpm, and works best in a Git repository so changes stay traceable. The commands in the skill use absolute paths from the author's machine, and the text is written in Chinese.

When your agent uses it

  • Sharing one set of project instructions between several coding agents
  • Stopping Agents.md, claude.md and gemini.md from drifting apart
  • Running a background watcher that mirrors edits to the other two files

Example prompts

  • “Sync Agents.md, claude.md and gemini.md across this repository.”
  • “Start the doc watcher in the background so my CLAUDE.md edits copy to the others.”
  • “Which of my three instruction files is newest, and what would a sync overwrite?”

Requirements

  • Node.js 14 or newer
  • pnpm to install the dependencies
  • PM2 for background watching (optional)

Workflow steps

4 steps, taken from the first numbered list in SKILL.md.

  1. 自动发现: 递归扫描当前目录下所有文件夹,查找这三个文档
  2. 智能同步: 发现任意一个文档时,自动创建/更新其余两个
  3. 文件监听: 实时监听文件变化,自动同步最新内容
  4. 手动触发: 支持命令行手动执行同步

What it can do on your machine

Read from SKILL.md and the folder at commit ece600f. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    Ships script files (Shell and JavaScript), which the agent can run.

    Shell commands in SKILL.md call:

    • pnpm
    • node

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    No URLs in SKILL.md. Its commands use pnpm, which can reach the network depending on how they are called.

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Agent Doc Sync Tool loads about 470 tokens when it runs. Until then it costs about 20 tokens; SKILL.md has 82 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~20
When it runs · the whole SKILL.md, loaded when a task matches
~470

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from littleben/awesomeAgentskills at commit ece600f, republished under its MIT licence (© littleben). 82 words, ~470 tokens.

Download SKILL.mdSave it as .claude/skills/doc-sync-tool/SKILL.md (or your agent's skills folder). This skill also uses 13 other files; get the full folder from GitHub.
name
doc-sync-tool
description
自动同步项目中的 Agents.md、claude.md 和 gemini.md 文件,保持内容一致性。支持自动监听和手动触发。

文档同步工具 (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

© littleben, MIT. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

SKILL.md and 13 other files in doc-sync-tool of littleben/awesomeAgentskills.

  • SKILL.md
  • .gitignore
  • EXAMPLES.md
  • INDEX.md
  • QUICKSTART.md
  • README.md
  • package.json
  • rename-quick.js
  • rename-to-uppercase.sh
  • run-sync.sh
  • run-watch.sh
  • sync.js
  • test.sh
  • watch.js

Open the folder on GitHubat commit ece600f

Used in 2 other repositories

We found 2 copies of this SKILL.md (exact, near-identical or edited) in other folders, from 2 other GitHub owners. This page covers the copy in littleben/awesomeAgentskills, which our catalogue first saw on October 7, 2026.

Compare with similar skills

Agent Doc Sync Tool next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Agent Doc Sync Tool compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Agent Doc Sync Tool this skilllittleben/awesomeAgentskills1882 repos~470Automated safety check: PassMIT
Promotealirezarezvani/claude-skills28k2 repos~1.1kAutomated safety check: PassMIT
Project Setupsd0xdev/sd0x-harness192—~7.1kAutomated safety check: NotesMIT
Project InitBlackBeltTechnology/pi-agent-dashboard315—~3.4kAutomated safety check: PassMIT
Tailordralgorhythm/claude-agentic-framework125—~1.6kAutomated safety check: PassNone
Add Plugin Ruleeslint-config/airbnb-extended129—~646Automated safety check: PassMIT

Similar skills

  • Promote

    alirezarezvani/claude-skills

    Graduate a proven pattern from auto-memory (MEMORY.md) to CLAUDE.md or .claude/rules/ for permanent enforcement.

    28k GitHub starsUsed in 2 repos~1.1k tokens
    Agent WorkflowsAuto-check passed
  • Project Setup

    sd0xdev/sd0x-harness

    Project configuration initialization. An agent skill from sd0xdev/sd0x-harness.

    192 GitHub stars~7.1k tokensUpdated yesterday
    Agent WorkflowsAuto-check: notes
  • Project Init

    BlackBeltTechnology/pi-agent-dashboard

    Scaffold an unconfigured directory into a configured pi project.

    315 GitHub stars~3.4k tokensUpdated yesterday
    Agent WorkflowsAuto-check passed
  • Tailor

    dralgorhythm/claude-agentic-framework

    Detects the project's stack from manifests and proposes tailored framework configuration — filled tech-strategy golden paths, REVIEW.md/CLAUDE.md review steering, and a prune list of unused…

    125 GitHub stars~1.6k tokensUpdated 2 mo ago
    Agent WorkflowsAuto-check passed
  • Add Plugin Rule

    eslint-config/airbnb-extended

    Fix the "<Plugin Updated with <rule" build error from script/checkUpdates.ts by adding a new or deprecated plugin rule to the right rules/ file.

    129 GitHub stars~646 tokensUpdated 2 days ago
    DevelopmentAuto-check passed
  • Optimize

    openplayerjs/openplayerjs

    Find and safely apply ONE worthwhile code optimization (reuse, simplification, efficiency, or a dead-weight cleanup) somewhere in packages//src, with new regression tests proving behavior is…

    649 GitHub stars~1.9k tokensUpdated 3 days ago
    DevelopmentAuto-check passed

More from littleben/awesomeAgentskills

  • Google Search SEO Guide

    littleben/awesomeAgentskills

    Answers Google Search optimization questions from reference files covering crawling, indexing, structured data, Search Console and site visibility, drawn from Google's documentation.

    188 GitHub starsUsed in 2 repos~4.2k tokens
    Auto-check passed
  • Shipany SaaS Boilerplate Reference

    littleben/awesomeAgentskills

    Shipany AI-powered SaaS boilerplate documentation. Use when working with Shipany framework, Next.js 15, TypeScript, Drizzle ORM, NextAuth, payment…

    188 GitHub stars~645 tokensUpdated 8 mo ago
    Auto-check passed

Works with

Categories

Questions about Agent Doc Sync Tool

What does Agent Doc Sync Tool do?

Keeps Agents.md, claude.md and gemini.md identical across a project by scanning folders and copying the newest version over the others, once or continuously. js, with shell wrappers) that scan the current directory recursively for the three agent instruction files and group them by folder. If a folder holds only one of them, the other two are created from it.

When should I use Agent Doc Sync Tool?

Agent Doc Sync Tool fits situations like: sharing one set of project instructions between several coding agents; stopping Agents.md, claude.md and gemini.md from drifting apart; running a background watcher that mirrors edits to the other two files.

How do I install Agent Doc Sync Tool in Claude Code?

Run `npx skills add littleben/awesomeAgentskills --skill doc-sync-tool -a claude-code`. Or copy the skill folder (doc-sync-tool in littleben/awesomeAgentskills) into .claude/skills/doc-sync-tool in your project. Claude Code loads it when a task matches its description.

How do I install Agent Doc Sync Tool in Codex?

Run `npx skills add littleben/awesomeAgentskills --skill doc-sync-tool -a codex`. Or copy the skill folder (doc-sync-tool in littleben/awesomeAgentskills) into .agents/skills/doc-sync-tool in your project. Codex loads it when a task matches its description.

Can I use Agent Doc Sync Tool in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add littleben/awesomeAgentskills --skill doc-sync-tool -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/doc-sync-tool, .gemini/skills/doc-sync-tool, .github/skills/doc-sync-tool and .opencode/skills/doc-sync-tool in your project.

What does Agent Doc Sync Tool need to run?

Going by SKILL.md and its folder, Agent Doc Sync Tool needs a shell and JavaScript for the scripts in its folder and the command-line tools its instructions call (pnpm and node). Our summary lists: Node.js 14 or newer; pnpm to install the dependencies; PM2 for background watching (optional).

Does Agent Doc Sync Tool access the network?

SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.

Is Agent Doc Sync Tool safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does Agent Doc Sync Tool use?

Agent Doc Sync Tool is published under the MIT licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Agent Doc Sync Tool use?

About 470 tokens (SKILL.md is roughly 1.9k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.

What are the alternatives to Agent Doc Sync Tool?

Skills that share tags, products or a category with Agent Doc Sync Tool: Promote (alirezarezvani/claude-skills, 28k stars), Project Setup (sd0xdev/sd0x-harness, 192 stars), Project Init (BlackBeltTechnology/pi-agent-dashboard, 315 stars) and Tailor (dralgorhythm/claude-agentic-framework, 125 stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Agent Doc Sync Tool?

littleben (a GitHub user) maintains it in littleben/awesomeAgentskills, which has 188 GitHub stars. The repository holds 3 skills in this directory. The repository was last updated on January 17, 2026.

Source: littleben/awesomeAgentskills on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.