Ruler - AI 代理指令管理 | Docs - NEXTDEVKIT - OpenNext & Next.js SaaS 启动模板

NEXTDEVKIT 使用 Ruler 集中管理 AI 代理指令，确保所有 AI 编程助手都能获得一致的指导和上下文信息。

什么是 Ruler？

Ruler 是一个集中指令管理系统，能将您的编程规范分发给多个 AI 代理，如 GitHub Copilot、Claude、Cursor、Aider 等。无需为每个代理单独维护配置文件，Ruler 提供统一的配置源。

安装

使用 npm 全局安装 Ruler：

npm install -g @intellectronica/ruler

或直接使用 npx：

npx @intellectronica/ruler apply

快速开始

NEXTDEVKIT 已预配置 Ruler。要将现有规则应用到您的 AI 代理：

# 导航到您的 NEXTDEVKIT 项目根目录
cd your-nextdevkit-project

# 将规则应用到所有配置的 AI 代理
ruler apply

这将自动使用 NEXTDEVKIT 的编程标准和项目上下文配置您的 AI 代理。

指定特定 AI 代理

如果您不想配置所有 AI 代理，可以指定特定的代理：

# 仅配置 Cursor
ruler apply --agents cursor

# 配置多个特定代理
ruler apply --agents cursor,claude,copilot

这样您可以选择性地为实际使用的 AI 工具生成配置文件。

更多 AI IDE 和选项，请访问 Ruler 官方文档。

预配置规则

NEXTDEVKIT 在 .ruler/ 目录中包含以下预配置指令文件：

🏗️ 项目架构 (`project-architecture.md`)

完整项目结构概览
技术栈详情
目录组织结构
配置系统说明

🛠️ 开发规范 (`development-guidelines.md`)

编程标准和最佳实践
开发工作流程
代码审查指南
测试策略

🔧 核心功能 (`core-files-and-functions.md`)

重要文件位置
关键函数参考
API 使用模式
常用工具

⚡ 常用命令 (`common-commands.md`)

常用开发命令
部署流程
数据库操作
故障排除步骤

配置示例

您的 Ruler 配置包含：

# .ruler/ruler.toml
[agents.copilot]
enabled = true
output_path = ".github/copilot-instructions.md"

[agents.claude]
enabled = true
output_path = "CLAUDE.md"

[agents.cursor]
enabled = true
output_path = ".cursor/rules/ruler_cursor_instructions.mdc"

支持的 AI 代理

Ruler 支持这些流行的 AI 编程助手：

GitHub Copilot → .github/copilot-instructions.md
Claude → CLAUDE.md
Cursor → .cursor/rules/ruler_cursor_instructions.mdc
Aider → ruler_aider_instructions.md
Windsurf → .windsurf/rules/ruler_windsurf_instructions.md
Cline → .clinerules

自定义

要添加自定义指令：

在 .ruler/ 目录中创建新的 .md 文件
运行 ruler apply 分发到所有代理
您的自定义规则将与现有的 NEXTDEVKIT 指南合并

更多高级配置选项，请访问 Ruler 官方文档。

优势

一致性：所有 AI 工具使用相同指令
效率：统一的指南配置源
上下文：AI 代理理解 NEXTDEVKIT 架构
自动化：无需手动配置个别代理

Ruler - AI 代理指令管理

On this page