Skip to content

README_ZH.md

Latest commit

 

History

History
145 lines (110 loc) · 7.29 KB

README_ZH.md

File metadata and controls

145 lines (110 loc) · 7.29 KB

AI Rules Sync

Npm License Npm download

English | 中文 | 📖 文档

AI Rules Sync (AIS) — 跨项目和团队同步、管理和共享你的 AI 代理规则。

不再复制粘贴 .mdc 文件。在 Git 仓库中管理规则，通过软链接同步。

为什么选择 AIS？

  • 🔄 一次同步，处处更新 — 单一数据源，编辑一次，所有项目自动更新
  • 🧩 多仓库支持 — 混合使用公司标准、社区集合和个人偏好的规则
  • 🤝 团队共享 — 通过 Git 共享编码标准，ais install 一键完成新成员入职
  • 🔒 隐私优先 — 使用 ai-rules-sync.local.json 保持敏感规则本地化
  • 🛠️ 多工具支持 — 一套工作流支持 Cursor、Copilot、Claude Code 及 8+ 更多工具

支持的工具

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

工具 类型 模式 默认源目录 文件后缀 文档
Cursor Rules hybrid .cursor/rules/ .mdc, .md 文档
Cursor Commands file .cursor/commands/ .md 文档
Cursor Skills directory .cursor/skills/ - 文档
Cursor Subagents directory .cursor/agents/ - 文档
GitHub Copilot Instructions file .github/instructions/ .instructions.md, .md 文档
GitHub Copilot Prompts file .github/prompts/ .prompt.md, .md 文档
GitHub Copilot Skills directory .github/skills/ - 文档
GitHub Copilot Agents file .github/agents/ .agent.md, .md 文档
Claude Code Rules file .claude/rules/ .md 文档
Claude Code Skills directory .claude/skills/ - 文档
Claude Code Subagents directory .claude/agents/ - 文档
Claude Code CLAUDE.md file .claude/ .md 文档
Trae Rules file .trae/rules/ .md 文档
Trae Skills directory .trae/skills/ - 文档
OpenCode Commands file .opencode/commands/ .md 文档
OpenCode Skills directory .opencode/skills/ - 文档
OpenCode Agents file .opencode/agents/ .md 文档
OpenCode Tools file .opencode/tools/ .ts, .js 文档
Codex Rules file .codex/rules/ .rules 文档
Codex Skills directory .agents/skills/ - 文档
Codex AGENTS.md file .codex/ .md 文档
Gemini CLI Commands file .gemini/commands/ .toml 文档
Gemini CLI Skills directory .gemini/skills/ - 文档
Gemini CLI Agents file .gemini/agents/ .md 文档
Gemini CLI GEMINI.md file .gemini/ .md 网站
Warp Rules file .（根目录） .md 文档 — 与 AGENTS.md 相同，使用 ais agents-md
Warp Skills directory .agents/skills/ - 文档
Windsurf Rules file .windsurf/rules/ .md 文档
Windsurf Skills directory .windsurf/skills/ - 文档
Cline Rules file .clinerules/ .md, .txt 文档
Cline Skills directory .cline/skills/ - 文档
通用 AGENTS.md file .（根目录） .md 标准

安装

通过 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

快速开始

使用仓库中的规则

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

了解更多

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

链接

许可证

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