sync-readme — claude-code sync-readme, ai-rules-sync, community, claude-code, ide skills, claude-skills, copilot, copilot-prompts, gemini, opencode, Claude Code

v1.0.0
GitHub

About this Skill

Ideal for Multilingual AI Agents needing synchronized documentation management across English and Chinese README files Synchronize, manage, and share your ai rules, skills, commands, subagents (Cursor, Claude Code, Copilot, OpenCode, Trae AI, Codex, Gemini CLI, Warp) with ease.

# Core Topics

claude-code claude-skills copilot copilot-prompts gemini opencode
lbb00 lbb00
[14]
[1]
Updated: 2/27/2026

Agent Capability Analysis

The sync-readme skill by lbb00 is an open-source community AI agent skill for Claude Code and other IDE workflows, helping agents execute tasks with better context, repeatability, and domain-specific guidance. Optimized for claude-code, claude-skills, copilot.

Ideal Agent Persona

Ideal for Multilingual AI Agents needing synchronized documentation management across English and Chinese README files

Core Value

Empowers agents to maintain consistency between README.md and README_ZH.md files by automatically translating and synchronizing changes, leveraging file comparison and direction-based translation protocols

↓ Capabilities Granted for sync-readme

Synchronizing English and Chinese documentation
Automating translation updates for README files
Comparing and identifying differences between multilingual documentation

! Prerequisites & Limits

  • Requires access to both README.md and README_ZH.md files
  • Limited to English and Chinese languages
Labs Demo

Browser Sandbox Environment

⚡️ Ready to unleash?

Experience this Agent in a zero-setup browser environment powered by WebContainers. No installation required.

Boot Container Sandbox

sync-readme

Install sync-readme, an AI agent skill for AI agent workflows and automation. Works with Claude Code, Cursor, and Windsurf with one-command setup.

SKILL.md
Readonly

Sync README

Purpose

Keep the English (README.md) and Chinese (README_ZH.md) documentation in sync. When one is updated, this skill helps translate and synchronize changes to the other.

Instructions

  1. Compare Both Files

    • Read README.md and README_ZH.md
    • Identify sections that differ
    • Note new sections in either file

  2. Determine Sync Direction

    • If English was updated more recently: translate EN → ZH
    • If Chinese was updated more recently: translate ZH → EN
    • If unclear, ask user which is the source of truth

  3. Translate Content

    • Preserve all code blocks unchanged
    • Translate prose sections accurately
    • Keep technical terms consistent:
      • "rules" → "规则"
      • "commands" → "命令"
      • "skills" → "技能"
      • "agents" → "代理"
      • "instructions" → "指令"
      • "adapter" → "适配器"
      • "symbolic link" → "软链接"

  4. Preserve Structure

    • Keep same heading hierarchy
    • Maintain table formats
    • Preserve all links and badges
    • Keep code examples identical

  5. Update Language Links

    • Ensure language toggle links are present
    • English: [English](./README.md) | [中文](./README_ZH.md)
    • Chinese: [English](./README.md) | [中文](./README_ZH.md)

  6. Verify Completeness

    • All sections present in both files
    • All features documented in both
    • Examples work in both versions

Translation Guidelines

Section Headers

EnglishChinese
Install安装
Commands命令
Architecture架构
Tab CompletionTab 补全
Legacy compatibilityLegacy 兼容说明
Supported Sync Types支持的同步类型

Common Phrases

EnglishChinese
Default mapping默认映射
Source directory源目录
Target directory目标目录
Run this command运行此命令
This command will该命令会

Output

After running this skill:

  • Both README files contain identical information
  • All features documented in both languages
  • Formatting consistent across both files

FAQ & Installation Steps

These questions and steps mirror the structured data on this page for better search understanding.

? Frequently Asked Questions

What is sync-readme?

Ideal for Multilingual AI Agents needing synchronized documentation management across English and Chinese README files Synchronize, manage, and share your ai rules, skills, commands, subagents (Cursor, Claude Code, Copilot, OpenCode, Trae AI, Codex, Gemini CLI, Warp) with ease.

How do I install sync-readme?

Run the command: npx killer-skills add lbb00/ai-rules-sync/sync-readme. It works with Cursor, Windsurf, VS Code, Claude Code, and 19+ other IDEs.

What are the use cases for sync-readme?

Key use cases include: Synchronizing English and Chinese documentation, Automating translation updates for README files, Comparing and identifying differences between multilingual documentation.

Which IDEs are compatible with sync-readme?

This skill is compatible with Cursor, Windsurf, VS Code, Trae, Claude Code, OpenClaw, Aider, Codex, OpenCode, Goose, Cline, Roo Code, Kiro, Augment Code, Continue, GitHub Copilot, Sourcegraph Cody, and Amazon Q Developer. Use the Killer-Skills CLI for universal one-command installation.

Are there any limitations for sync-readme?

Requires access to both README.md and README_ZH.md files. Limited to English and Chinese languages.

↓ How To Install

  1. 1. Open your terminal

    Open the terminal or command line in your project directory.

  2. 2. Run the install command

    Run: npx killer-skills add lbb00/ai-rules-sync/sync-readme. The CLI will automatically detect your IDE or AI agent and configure the skill.

  3. 3. Start using the skill

    The skill is now active. Your AI agent can use sync-readme immediately in the current project.

Related Skills

Looking for an alternative to sync-readme or another community skill for your workflow? Explore these related open-source skills.

View All

widget-generator

Logo of f
f

f.k.a. Awesome ChatGPT Prompts. Share, discover, and collect prompts from the community. Free and open source — self-host for your organization with complete privacy.

★ 149.6k
⑂ 0
AI

flags

Logo of vercel
vercel

flags is a Next.js feature management skill that enables developers to efficiently add or modify framework feature flags, streamlining React application development.

★ 138.4k
⑂ 0
Browser

zustand

Logo of lobehub
lobehub

The ultimate space for work and life — to find, build, and collaborate with agent teammates that grow with you. We are taking agent harness to the next level — enabling multi-agent collaboration, effortless agent team design, and introducing agents as the unit of work interaction.

★ 72.8k
⑂ 0
AI

data-fetching

Logo of lobehub
lobehub

The ultimate space for work and life — to find, build, and collaborate with agent teammates that grow with you. We are taking agent harness to the next level — enabling multi-agent collaboration, effortless agent team design, and introducing agents as the unit of work interaction.

★ 72.8k
⑂ 0
AI

Related Collections

View All Collections →
■Agent Workflow Skills & Companion Tools | AI Agent Skills[12]■Codex Workflow Skills & Developer Integrations | AI Agent Skills[10]■GitHub Copilot Companion Skills & Dev Tools | AI Agent Skills[5]■Cursor-Compatible Skills & Workflow Integrations | AI Agent Skills[9]■Gemini-Compatible Dev Tools & Agent Workflow Skills | AI Agent Skills[6]■OpenCode Workflow Tools & Companion Integrations | AI Agent Skills[5]