Skip to content

dhruv-anand-aintech/agent-rules-sync

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

48 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

agent-sync

Synchronize rules, skills, and settings across Claude Code, Cursor, Gemini, OpenCode, and Codex — in real-time.

Edit rules or skills in any AI agent → they automatically sync to all others. Global Claude settings propagate to configured repos for Claude Code web access.

Installation

Works on macOS, Linux, and Windows (native + WSL).

pip install agent-rules-sync
uv pip install agent-rules-sync   # faster

The daemon installs and starts automatically as a system service.

CLI

agent-sync                         # start/ensure daemon is running
agent-sync sync                    # one-shot sync: rules + skills + settings
agent-sync sync rules              # sync only CLAUDE.md / rules files
agent-sync sync skills             # sync only skills directories
agent-sync sync settings           # sync only .claude/settings.json + hooks
agent-sync sync rules skills       # multiple scopes
agent-sync setup                   # TUI wizard to configure sync directions
agent-sync status                  # daemon and sync status
agent-sync stop                    # stop daemon
agent-sync watch                   # watch in foreground (debugging)

agent-rules-sync also works as an alias for backwards compatibility.

What Gets Synced

1. Rules (CLAUDE.md, GEMINI.md, etc.)

Rules sync bidirectionally across all agent config files. Changes from any agent propagate to all others within 3 seconds.

# Shared Rules
- use pydantic for validation      ← syncs to all agents

## Claude Code Specific
- claude-specific rule             ← stays in Claude only

Monitored locations:

Agent Path
Claude Code ~/.claude/CLAUDE.md
Cursor ~/.cursor/rules/global.mdc
Gemini Antigravity ~/.gemini/GEMINI.md
OpenCode ~/.config/opencode/AGENTS.md
Codex ~/.codex/AGENTS.md
+ 4 more ~/.config/agents/AGENTS.md, ~/.config/AGENTS.md, ~/.agent/AGENTS.md, ~/.agent/AGENT.md

Repo-specific CLAUDE.md files can be added via repo_paths.json (see Configuration).

2. Skills

Skills are directories containing a SKILL.md file. Synced across all frameworks:

Framework Path
Claude Code ~/.claude/skills/
Cursor ~/.cursor/skills/, ~/.cursor/skills-cursor/
Codex ~/.codex/skills/
Gemini Antigravity ~/.gemini/antigravity/skills/
OpenCode ~/.config/opencode/skills/
Shared ~/.agents/skills/

Newest version wins. Add a skill anywhere and it appears everywhere within 3 seconds.

3. Settings & Hooks (Claude Code)

Syncs a portable version of ~/.claude/settings.json to configured repos' .claude/settings.json:

  • Strips machine-specific keys (statusLine, spinnerVerbs, remote, etc.)
  • Strips permission rules with absolute paths
  • Rewrites hook commands from ~/.claude/hooks/foo.sh.claude/hooks/foo.sh
  • Copies hook scripts into the repo's .claude/hooks/

This enables full tool permissions and hooks when using Claude Code web on those repos.

Configuration

Repo Paths

Add repos to sync rules, skills, and settings into:

~/.config/agent-rules-sync/repo_paths.json
["~/Code/my-project", "~/Code/another-repo"]

Each repo gets:

  • <repo>/CLAUDE.md — synced from global rules
  • <repo>/.claude/skills/ — synced from master skills
  • <repo>/.claude/settings.json — portable settings (auto-generated)
  • <repo>/.claude/hooks/ — hook scripts (copied from ~/.claude/hooks/)

Sync Directions

Configure per-component direction via agent-sync setup (TUI wizard) or edit directly:

~/.config/agent-rules-sync/sync_config.json
{
  "mode": "default",
  "components": {
    "rules":    { "direction": "bidirectional", "enabled": true },
    "skills":   { "direction": "bidirectional", "enabled": true },
    "settings": { "direction": "push",          "enabled": true },
    "hooks":    { "direction": "push",           "enabled": true }
  }
}

Directions:

Direction Behavior
bidirectional Newest version wins, syncs everywhere (default for rules/skills)
push Master → agents only (master is source of truth)
pull Agents → master only (aggregate, don't push back)

Settings and hooks only support push (they are generated from global config).

Settings Strip Rules

Customize which keys/paths are stripped when generating portable settings:

~/.config/agent-rules-sync/settings_sync.json
{
  "strip_keys": ["statusLine", "spinnerVerbs", "remote"],
  "strip_path_prefixes": ["/Users/", "/home/", "/opt/homebrew/"],
  "sync_hooks": true,
  "hook_script_dir": ".claude/hooks"
}

Setup Wizard

Run agent-sync setup for a guided TUI to configure sync directions:

┌──────────────────────────────────────────────────────────┐
│ agent-sync  ·  Setup Wizard                              │
└──────────────────────────────────────────────────────────┘

  ── Sync Mode ───────────────────────────────────────────

  default       Rules/skills are bidirectional (newest wins).
                Settings/hooks push from global → repos.

  per_component Configure each component independently.

  Choice [1-2] (Enter = default):

Commands Reference

agent-sync sync [rules] [skills] [settings] [all]
Scope What it syncs
rules Rules files (CLAUDE.md, GEMINI.md, etc.) across all agents
skills Skill directories across all frameworks + configured repos
settings ~/.claude/settings.json → repo .claude/settings.json + hooks
all All of the above (default when no scope given)

How It Works

~/.claude/settings.json         ~/.claude/CLAUDE.md        ~/.claude/skills/
        │                               │                         │
        │  strip machine-specific       │  merge shared +         │  newest
        │  rewrite hook paths           │  agent-specific         │  version
        ▼                               ▼                         ▼
  repo/.claude/             all agent CLAUDE.md          all framework
  settings.json             GEMINI.md AGENTS.md          skills/ dirs
  hooks/                    (9+ locations)               (6+ locations)

Daemon watches all locations every 3 seconds. Changes trigger immediate sync.

Backups

Every file change is backed up with a timestamp:

~/.config/agent-rules-sync/backups/     ← rules backups
~/.config/agent-rules-sync/skill_backups/  ← skills backups

Restore any version:

cp ~/.config/agent-rules-sync/backups/claude_20260125_014532.md ~/.claude/CLAUDE.md

Troubleshooting

agent-sync status              # check daemon + sync status
tail -f ~/.config/agent-rules-sync/daemon.log   # live logs
agent-sync stop && agent-sync  # restart daemon
agent-sync watch               # run in foreground for debugging

Uninstall

curl -fsSL https://raw.githubusercontent.com/dhruv-anand-aintech/agent-rules-sync/main/uninstall.sh | bash

Or manually:

agent-sync stop
pip uninstall -y agent-rules-sync
rm -rf ~/.config/agent-rules-sync

Agent rule files and repos are not touched.

Requirements

  • Python 3.8+
  • macOS, Linux, or Windows

License

MIT — see LICENSE


Edit anywhere. Sync everywhere.

About

Synchronize rules across Claude Code, Cursor, Gemini, and OpenCode. Edit anywhere, sync everywhere.

Topics

Resources

License

Contributing

Stars

Watchers

Forks

Packages

 
 
 

Contributors