Ruler：多 AI 编程助手统一配置管理方案

.ruler/                    # 单一数据源
├── AGENTS.md             # 主指令文件
├── coding_style.md       # 代码风格指南
├── api_guidelines.md     # API 设计规范
├── ruler.toml            # Ruler 配置
└── skills/               # 集中管理的 Skills
    ├── my-skill/
    │   └── SKILL.md
    └── another-skill/
        └── SKILL.md

AGENTS.md                 # 分发给所有支持的工具
.cursor/mcp.json          # Cursor 的 MCP 配置
.mcp.json                 # Claude 的 MCP 配置
.codex/config.toml        # Codex 的 MCP 配置
.claude/skills/           # Claude/Copilot/Kilocode 的 Skills
.codex/skills/            # Codex 的 Skills
.opencode/skill/          # OpenCode 的 Skills
.gitignore               # 自动更新，忽略生成的文件

.ruler/
├── AGENTS.md              # 主指令文件（新标准）
├── instructions.md        # 旧版支持（向后兼容）
├── ruler.toml             # Ruler 配置文件
├── coding_style.md        # 额外的规则文件
├── api_conventions.md     # API 设计规范
└── skills/                # Skills 目录
    ├── skill-1/
    │   └── SKILL.md      # 必需
    └── skill-2/
        └── SKILL.md

my-monorepo/
├── .ruler/                    # 全局规则
│   ├── AGENTS.md
│   └── global_standards.md
├── frontend/
│   └── .ruler/                # 前端特定规则
│       └── react_guidelines.md
├── backend/
│   └── .ruler/                # 后端特定规则
│       └── api_standards.md
└── docs/
    └── .ruler/                # 文档写作规则
        └── writing_style.md

# .ruler/ruler.toml
nested = true

ruler apply --nested

# .ruler/ruler.toml

[mcp]
enabled = true
merge_strategy = "merge"  # 或 "overwrite"

# 本地 stdio 服务器
[mcp_servers.filesystem]
command = "npx"
args = ["-y", "@modelcontextprotocol/server-filesystem", "/path/to/project"]

# Git 服务器
[mcp_servers.git]
command = "npx"
args = ["-y", "@modelcontextprotocol/server-git", "--repository", "."]

# 远程服务器
[mcp_servers.api]
url = "https://mcp.example.com"

[mcp_servers.api.headers]
Authorization = "Bearer your-token"

.ruler/skills/
├── obsidian-workflow/
│   ├── SKILL.md          # 必需：技能说明
│   ├── templates/        # 可选：模板文件
│   └── scripts/          # 可选：辅助脚本
└── api-design/
    ├── SKILL.md
    └── examples/

# 全局安装（推荐）
npm install -g @intellectronica/ruler

# 或使用 npx（一次性）
npx @intellectronica/ruler apply

# 进入项目目录
cd your-project

# 初始化 Ruler
ruler init

ruler init

# .ruler/AGENTS.md

## 项目概述
这是一个 TypeScript + React 项目，使用 Vite 构建。

## 代码规范
- 使用 TypeScript strict 模式
- 组件使用函数式写法，优先使用 hooks
- 使用 ESLint 和 Prettier
- 所有导出函数必须有 JSDoc 注释

## 测试要求
- 每个功能必须有单元测试
- 使用 Vitest 作为测试框架
- 测试覆盖率不低于 80%

ruler apply

# 只配置 Cursor 和 Claude
ruler apply --agents cursor,claude

# 查看详细输出
ruler apply --agents cursor,claude --verbose

[mcp]
enabled = true

[mcp_servers.filesystem]
command = "npx"
args = ["-y", "@modelcontextprotocol/server-filesystem", "${PROJECT_ROOT}"]

[mcp_servers.git]
command = "npx"
args = ["-y", "@modelcontextprotocol/server-git", "--repository", "."]

ruler apply --mcp

mkdir -p .ruler/skills/api-design
cat > .ruler/skills/api-design/SKILL.md << 'EOF'
# API Design Guidelines

## REST API 设计原则

1. **资源命名**
   - 使用名词复数形式：`/users`, `/products`
   - 避免动词

2. **HTTP 方法**
   - GET：获取资源
   - POST：创建资源
   - PUT：完整更新资源
   - PATCH：部分更新资源
   - DELETE：删除资源
EOF

ruler apply --skills

nested = true

ruler apply --nested

# .gitignore
# 生成的文件由 Ruler 自动管理，不提交
AGENTS.md
.cursor/mcp.json
.mcp.json
.claude/skills/

# .ruler/ 目录提交到版本控制
!.ruler/

{
  "scripts": {
    "ruler:apply": "ruler apply",
    "ruler:check": "ruler apply --dry-run",
    "postinstall": "npm run ruler:apply"
  }
}

team-configs/
├── ruler-templates/
│   ├── frontend.toml
│   ├── backend.toml
│   └── fullstack.toml
└── skills/
    ├── company-api-design/
    └── security-guidelines/

cp team-configs/ruler-templates/frontend.toml .ruler/ruler.toml
cp -r team-configs/skills/* .ruler/skills/
ruler apply