ai-rule

把一份 AI 编程规则源文件编译成多种 AI 编程工具需要的配置文件。

ai-rule 让你把项目规则统一维护在 .ai-rules/ 目录中，然后生成 Codex、Claude、Cursor、GitHub Copilot、Trae、Windsurf、Kiro、Cline、Roo、Antigravity 等工具各自需要的配置文件。

English documentation: README.en.md

为什么需要它

不同 AI 编程工具读取项目规则的位置和格式并不一样：

• Codex CLI: AGENTS.md
• Claude: CLAUDE.md
• Cursor: .cursor/rules/*.mdc
• GitHub Copilot: .github/copilot-instructions.md
• Trae: .trae/rules/ 和 .trae/skills/
• Windsurf: .windsurf/rules/
• Kiro: .kiro/steering/
• Cline: .clinerules/
• Roo: .roo/rules/
• Antigravity: .agents/rules/

有了 ai-rule，你只需要写一份规则源文件，就可以编译到各个工具对应的位置，避免重复维护多套内容。

安装

npm install -D @lvxiaohui/ai-rule

也可以不安装，直接使用：

npx ai-rule

源目录结构

默认读取项目根目录下的 .ai-rules/：

.ai-rules/
+-- rules/
|   +-- behavior-rules.md
|   +-- project-rules.md
+-- skills/
|   +-- some-skill.md
+-- mcp/
    +-- config.json

• rules/: 通用项目规则，Markdown 格式
• skills/: 任务型技能说明，Markdown 或其他文本文件
• mcp/: MCP 配置文件，默认读取 config.json

使用

npx ai-rule
npx ai-rule --target=all
npx ai-rule --target=codex
npx ai-rule --target=cursor,claude

也保留了兼容命令：

npx rulesmith --target=codex
npx ai-rules --target=codex

配置

当默认配置不够用时，可以在项目根目录创建 .ai-rules.config.json：

{
  "sourceDir": ".ai-rules",
  "rulesDir": "rules",
  "skillsDir": "skills",
  "mcpDir": "mcp",
  "targets": ["codex", "cursor"]
}

也可以把同样的配置放到 package.json 的 aiRules 字段中。

当配置了 targets 时，ai-rule 会把它作为默认生成目标。命令行传入的 --target 会覆盖配置文件中的 targets。

清理旧配置

生成前可以使用 --clean 清理已知的 AI 工具配置输出：

npx ai-rule --target=cursor --clean

适合在切换编辑器配置、或者想让项目里的生成文件保持干净时使用。

注意：--clean 会删除已知的 AI 工具配置路径，例如 AGENTS.md、.cursor/、.trae/、CLAUDE.md 等。请确认这些文件确实是可重新生成的配置文件。

API

const { compileProject } = require('@lvxiaohui/ai-rule');

compileProject({
  cwd: process.cwd(),
  target: ['codex', 'cursor'],
  clean: false
});

维护者发布

发布流程见 docs/releasing.md。

License

MIT