AI Rules Sync

August 14, 2026 · View on GitHub

AIS:通过软链接将 Git 仓库中的原生 Agent 资产同步到 Cursor、Claude、Copilot、Codex 及 20+ 工具

npm 版本 Unlicense npm 下载量

English · 中文 · 文档

AI Rules Sync (AIS) — 从多个 Git 仓库安装、组合、更新和发布原生 Agent 资产,同步到所有项目。

AIS 是一个资产联邦工具,不是格式转换器。 它保持你的文件原样不动 — skills、rules、commands、agents — 通过软链接同步到每个项目。一处编辑,处处更新。


AIS 的与众不同

AIS其他工具
软链接 — 上游改动即时生效复制文件 — 需要重新运行才能更新
一个来源 → 多个项目一次只能处理一个项目
原生资产 — 不做格式转换重写/重新生成你的文件
导入 → 发布 → 审核 协作流程只能单向消费
370 KB,5 个依赖通常 10+ MB 及深层依赖树
Git 原生 — 兼容任何 Git remote绑定特定 registry 或 API

AIS 与格式转换工具互补。 如果你还需要跨工具格式转换,可以用 AIS 管理资产,用其他工具做生成 — 它们解决不同的问题。


支持的工具

此表由 docs/supported-tools.json 通过 npm run docs:sync-tools 自动生成。

工具rulesskillscommandsagentsAGENTS.mdtoolspromptsinstructions
通用
Aider
Amp
Antigravity CLI
Augment Code
Claude Code
Cline
CodeBuddy
Codex
Continue
Cursor
DeepAgents
DeepSeek
Factory Droid
Gemini CLI
GitHub Copilot
Goose
Hermes Agent
Junie
Kilo Code
Kimi Code
Kiro
OpenCode
Pi
Qwen Code
Trae
Warp
Windsurf
WorkBuddy
Zed

📋 完整目录参考 — 源路径、模式、后缀和文档链接。

同时支持 User 模式 管理个人 AI 配置文件。


安装

通过 npm(推荐)

npm install -g ai-rules-sync

通过 Homebrew(macOS)

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

验证:

ais --version

可选:启用 Tab 补全

ais completion install

快速开始

使用仓库中的资产

cd your-project

# 添加规则(第一次需要指定仓库 URL)
ais cursor add react -t https://github.com/your-org/rules-repo.git

# 之后可以省略 -t
ais cursor add vue
ais copilot instructions add coding-standards
ais claude skills add code-review

分享你的现有资产

# 将项目中的规则导入到仓库
ais cursor rules import my-custom-rule

# 可选:推送到远程
ais cursor rules import my-rule --push

恢复资产(团队入职 / CI)

# 从 ai-rules-sync.json 恢复所有资产
ais install

User 模式(个人 AI 配置)

# 同步个人配置到 $HOME
ais claude md add CLAUDE --user
ais gemini md add GEMINI --user

# 在新机器上恢复
ais user install

核心概念

工作原理

Git 仓库                      全局缓存                      你的项目
┌─────────────────┐   clone   ┌──────────────────┐ symlink ┌──────────┐
│ .claude/skills/ │ ────────→ │ ~/.config/       │ ──────→ │ 项目 A   │
│ .cursor/rules/  │           │ ai-rules-sync/   │ ──────→ │ 项目 B   │
│ .github/inst... │           │ repos/           │ ──────→ │ 项目 C   │
└─────────────────┘           └──────────────────┘         └──────────┘
  1. 克隆 — AIS 将资产仓库克隆到全局缓存(~/.config/ai-rules-sync/repos/
  2. 软链接 — 每个项目创建指向缓存的符号链接
  3. 更新 — 拉取仓库更新后,所有项目立即生效

三层配置

文件作用域提交到 Git
ai-rules-sync.local.json私有,单项目
ai-rules-sync.json共享,单项目
user.json~/.config/ai-rules-sync/全局,用户级可选(dotfiles)

三种核心操作

命令作用
ais add从仓库链接资产到项目
ais import从项目复制资产到仓库,然后替换为软链接
ais installai-rules-sync.json 恢复所有软链接(团队入职、CI)

基本用法

设置仓库

# 使用远程仓库
ais use https://github.com/your-org/rules-repo.git

# 使用本地路径(开发/测试)
ais use ~/my-rules-repo

# 列出所有已配置的仓库
ais ls

# 切换仓库
ais use company-rules
ais use personal-rules

添加资产到项目

cd your-project

# 首次:指定仓库
ais cursor add react -t https://github.com/org/rules.git

# 后续(使用当前仓库)
ais cursor add vue
ais cursor add typescript

# 使用别名
ais cursor add react react-18

# 从其他仓库
ais cursor add coding-standards -t company-rules

# 私有(保存到 ai-rules-sync.local.json)
ais cursor add company-secrets --local

# 自定义目标目录(monorepo)
ais cursor add my-rule -d packages/frontend/.cursor/rules

导入现有资产

ais cursor rules import my-custom-rule
ais cursor rules import my-rule -m "添加自定义规则"
ais cursor rules import my-rule --push
ais cursor rules import my-rule --force

移除资产

ais cursor rm react
ais cursor commands rm deploy
ais cursor skills rm code-review

从配置安装

git clone https://github.com/team/project.git
cd project
ais install

发现并安装全部

ais add-all
ais cursor add-all
ais add-all --dry-run
ais add-all --tools cursor,copilot
ais cursor add-all --interactive

各工具命令

Cursor

ais cursor add react                 # 规则
ais cursor commands add deploy       # 命令
ais cursor skills add code-review    # 技能
ais cursor agents add code-analyzer  # 子代理

GitHub Copilot

ais copilot instructions add coding-style
ais copilot prompts add generate-tests
ais copilot skills add web-scraping
ais copilot agents add code-reviewer

Claude Code

ais claude rules add general
ais claude skills add code-review
ais claude agents add debugger
ais claude md add CLAUDE             # CLAUDE.md(项目级)
ais claude md add CLAUDE --user      # CLAUDE.md(个人级)

Codex

ais codex rules add default
ais codex skills add code-assistant
ais codex md add AGENTS --user       # ~/.codex/AGENTS.md

Gemini CLI

ais gemini commands add deploy-docs
ais gemini skills add code-review
ais gemini agents add code-analyzer
ais gemini md add GEMINI --user      # ~/.gemini/GEMINI.md

其他工具

ais trae rules add project-rules
ais opencode agents add code-reviewer
ais opencode tools add project-analyzer
ais windsurf add project-style
ais windsurf skills add deploy-staging
ais cline add coding
ais cline skills add release-checklist
ais warp skills add my-skill
ais agents-md add .                  # 通用 AGENTS.md

高级功能

多仓库

ais cursor add coding-standards -t company-rules
ais cursor add react-best-practices -t https://github.com/community/rules.git
ais cursor add my-utils -t personal-rules

User 模式(个人 AI 配置文件)

ais claude md add CLAUDE --user      # → ~/.claude/CLAUDE.md
ais gemini md add GEMINI --user      # → ~/.gemini/GEMINI.md
ais codex md add AGENTS --user       # → ~/.codex/AGENTS.md
ais cursor rules add my-style --user

# 在新机器上恢复
ais user install

Dotfiles 集成:

ais config user set ~/dotfiles/ai-rules-sync/user.json
ais user install

仓库生命周期

ais check                  # 检查上游更新
ais update --dry-run       # 预览更新
ais update                 # 拉取更新
ais init                   # 初始化规则仓库模板

Git 命令

ais git status
ais git pull
ais git push
ais git log --oneline
ais git status -t company-rules

自定义源目录

# CLI 参数(临时)
ais cursor rules add-all -s custom/rules

# 持久化配置
ais config repo set-source third-party cursor.rules custom/rules
ais config repo show third-party

Tab 补全

ais completion install
ais cursor add <Tab>              # 列出可用规则
ais cursor commands add <Tab>     # 列出可用命令

配置参考

ai-rules-sync.json

{
  "version": 1,
  "cursor": {
    "rules": {
      "react": "https://github.com/user/repo.git",
      "react-v2": {
        "url": "https://github.com/user/another-repo.git",
        "rule": "react"
      }
    },
    "commands": { "deploy-docs": "https://github.com/user/repo.git" },
    "skills":   { "code-review": "https://github.com/user/repo.git" },
    "agents":   { "code-analyzer": "https://github.com/user/repo.git" }
  },
  "claude": {
    "rules":  { "general": "https://github.com/user/repo.git" },
    "skills": { "code-review": "https://github.com/user/repo.git" },
    "agents": { "debugger": "https://github.com/user/repo.git" },
    "md":     { "CLAUDE": "https://github.com/user/repo.git" }
  }
}

仓库配置(规则仓库中的 ai-rules-sync.json)

{
  "version": 1,
  "rootPath": "src",
  "sourceDir": {
    "cursor": { "rules": ".cursor/rules", "commands": ".cursor/commands" },
    "claude": { "skills": ".claude/skills", "rules": ".claude/rules" },
    "*": { "skills": "common/skills" }
  }
}

条目格式

格式示例
简单字符串"react": "https://github.com/user/repo.git"
带别名的对象"react-v2": { "url": "...", "rule": "react" }
自定义目标目录"docs-rule": { "url": "...", "targetDir": "docs/ai/rules" }

了解更多

📖 完整文档: https://lbb00.github.io/ai-rules-sync/


链接


许可证

Unlicense - 自由使用、修改和分发。