Skip to content

README.md

Latest commit

 

History

History
145 lines (110 loc) · 7.33 KB

README.md

File metadata and controls

145 lines (110 loc) · 7.33 KB

AI Rules Sync

Npm License Npm download

English | 中文 | 📖 Documentation

AI Rules Sync (AIS) — Synchronize, manage, and share your AI agent rules across projects and teams.

Stop copying .mdc files around. Manage your rules in Git repositories and sync them via symbolic links.

Why AIS?

  • 🔄 Sync Once, Update Everywhere — Single source of truth, edit once, update all projects
  • 🧩 Multi-Repository — Mix rules from company standards, community collections, and personal preferences
  • 🤝 Team Sharing — Share coding standards via Git, onboard new members with ais install
  • 🔒 Privacy First — Keep sensitive rules local with ai-rules-sync.local.json
  • 🛠️ Multi-Tool Support — One workflow for Cursor, Copilot, Claude Code, and 8+ more tools

Supported Tools

This table is generated from docs/supported-tools.json via npm run docs:sync-tools.

Tool Type Mode Default Source Directory File Suffixes Documentation
Cursor Rules hybrid .cursor/rules/ .mdc, .md Docs
Cursor Commands file .cursor/commands/ .md Docs
Cursor Skills directory .cursor/skills/ - Docs
Cursor Subagents directory .cursor/agents/ - Docs
GitHub Copilot Instructions file .github/instructions/ .instructions.md, .md Docs
GitHub Copilot Prompts file .github/prompts/ .prompt.md, .md Docs
GitHub Copilot Skills directory .github/skills/ - Docs
GitHub Copilot Agents file .github/agents/ .agent.md, .md Docs
Claude Code Rules file .claude/rules/ .md Docs
Claude Code Skills directory .claude/skills/ - Docs
Claude Code Subagents directory .claude/agents/ - Docs
Claude Code CLAUDE.md file .claude/ .md Docs
Trae Rules file .trae/rules/ .md Docs
Trae Skills directory .trae/skills/ - Docs
OpenCode Commands file .opencode/commands/ .md Docs
OpenCode Skills directory .opencode/skills/ - Docs
OpenCode Agents file .opencode/agents/ .md Docs
OpenCode Tools file .opencode/tools/ .ts, .js Docs
Codex Rules file .codex/rules/ .rules Docs
Codex Skills directory .agents/skills/ - Docs
Codex AGENTS.md file .codex/ .md Docs
Gemini CLI Commands file .gemini/commands/ .toml Docs
Gemini CLI Skills directory .gemini/skills/ - Docs
Gemini CLI Agents file .gemini/agents/ .md Docs
Gemini CLI GEMINI.md file .gemini/ .md Website
Warp Rules file . (root) .md Docs — same as AGENTS.md, use ais agents-md
Warp Skills directory .agents/skills/ - Docs
Windsurf Rules file .windsurf/rules/ .md Docs
Windsurf Skills directory .windsurf/skills/ - Docs
Cline Rules file .clinerules/ .md, .txt Docs
Cline Skills directory .cline/skills/ - Docs
Universal AGENTS.md file . (root) .md Standard

Installation

Via npm (Recommended)

npm install -g ai-rules-sync

Via Homebrew (macOS)

brew tap lbb00/ai-rules-sync https://github.com/lbb00/ai-rules-sync
brew install ais

Verify:

ais --version

Quick Start

Use rules from a repository

cd your-project

# Add a rule (specify repository URL the first time)
ais cursor add react -t https://github.com/your-org/rules-repo.git

# After first use, omit -t
ais cursor add vue
ais copilot instructions add coding-standards
ais claude skills add code-review

Share your existing rules

# Import a rule from your project into the repository
ais cursor rules import my-custom-rule

# Optionally push to remote
ais cursor rules import my-rule --push

Restore rules (team onboarding / CI)

# Restore all rules from ai-rules-sync.json
ais install

User-level sync (personal AI configs)

# Sync personal configs to $HOME
ais claude md add CLAUDE --user
ais gemini md add GEMINI --user

# Restore on a new machine
ais user install

Learn More

📖 Full documentation: https://lbb00.github.io/ai-rules-sync/

Links

License

Unlicense - Free to use, modify, and distribute.