explaingit

panishandsome/ai-rules-sync

Analysis updated 2026-05-18

112JavaScriptAudience · developerComplexity · 2/5Setup · easy

TLDR

Agentsync keeps one source of truth file for AI coding tool instructions and automatically generates all the other tool specific rule files from it.

Mindmap

mindmap
  root((Agentsync))
    What it does
      Single source rules file
      Auto generation
    Tech stack
      JavaScript
      Node.js
    Use cases
      Multi tool sync
      Rule file linting
    Audience
      Developers

Code map

Detail Auto

An interactive map of this repo's files and how they connect — its source is parsed live in your browser. Click Visualize to build it.

filefunction / class

What do people build with it?

USE CASE 1

Keep AGENTS.md as the single source of truth and auto generate CLAUDE.md.cursorrules, and others

USE CASE 2

Merge several existing rule files from different tools into one consolidated file

USE CASE 3

Generate a fresh AGENTS.md from a short description of your project

USE CASE 4

Lint an existing rules file for stale commands or paths that no longer exist

What is it built with?

JavaScriptNode.js

How does it compare?

panishandsome/ai-rules-synccupidbity/cupid-music-playertj/co-parallel
Stars112112109
LanguageJavaScriptJavaScriptJavaScript
Last pushed2016-12-27
MaintenanceDormant
Setup difficultyeasyeasyeasy
Complexity2/52/52/5
Audiencedevelopergeneraldeveloper

Figures from each repo's GitHub metadata at analysis time.

How do you get it running?

Difficulty · easy Time to first run · 5min

No external dependencies, installable globally via npm or run directly with npx.

License terms are not described in the explanation.

In plain English

Different AI coding tools each read their instructions from a different file. Codex reads a file called AGENTS.md. Claude Code reads CLAUDE.md. Cursor reads .cursorrules. GitHub Copilot reads a file inside a .github folder. If you use more than one of these tools in the same project, you end up maintaining the same instructions in multiple files, and they tend to drift apart over time. Agentsync solves this by letting you keep one file as the single source of truth and generating the others from it automatically. You run a setup command once, point it at your repo, and it creates an AGENTS.md, writes a configuration file listing which other files to generate, and installs a pre-commit hook so the generated files stay in sync every time you commit. After that you only edit AGENTS.md, the tool handles the rest. The tool also handles the reverse: if you already have several rule files and want to consolidate them, a merge command combines them into one. A convert command translates any supported format into any other. A generate command creates a fresh AGENTS.md from a short description of your project, including the language, framework, and test commands. A lint command checks an existing file for stale commands or paths that no longer exist in the repository. For situations where you want to keep using whichever file your current tool prefers rather than standardizing on AGENTS.md, an auto mode tracks which file changed since the last sync and regenerates the others from it. The supported tools include Codex, Claude Code, Cursor, GitHub Copilot, Windsurf, Cline, Aider, Gemini CLI, and Qwen Code. The conversion works by parsing each format into a shared internal structure and then rendering that structure into the target format. Constructs that have no equivalent in the target format produce warnings rather than being silently dropped. The package has no external dependencies and can be installed globally via npm or run directly with npx. A browser playground is available for trying conversions without installing anything.

Copy-paste prompts

Prompt 1
Help me run the setup command to generate AGENTS.md and a pre-commit sync hook
Prompt 2
Explain how the merge command combines several existing rule files into one
Prompt 3
Walk me through using auto mode so I can keep editing my current tool's file
Prompt 4
Which AI coding tools does this support and how does conversion between them work?

Frequently asked questions

What is ai-rules-sync?

Agentsync keeps one source of truth file for AI coding tool instructions and automatically generates all the other tool specific rule files from it.

What language is ai-rules-sync written in?

Mainly JavaScript. The stack also includes JavaScript, Node.js.

What license does ai-rules-sync use?

License terms are not described in the explanation.

How hard is ai-rules-sync to set up?

Setup difficulty is rated easy, with roughly 5min to a first successful run.

Who is ai-rules-sync for?

Mainly developer.

Open on GitHub → Explain another repo

This repo across BitVibe Labs

Verify against the repo before relying on details.