首页/Grok Build 功能/项目规则

AGENTS.md 项目规则

项目规则是 Markdown 文件,Grok 会为目录树中的每个会话加载到上下文中。将编码约定、构建和测试命令以及架构说明放在仓库根目录的 AGENTS.md 中,Grok 就会在每次会话中遵循它们而无需重复告知。

发现规则

Grok 按以下顺序加载规则,较深的文件在冲突时优先:

  1. ~/.grok/ 中的全局规则
  2. 从仓库根目录到工作目录的每个目录(或 git 仓库外仅工作目录)

在每个目录中,Grok 读取 AGENTS.mdAgents.mdAGENT.mdCLAUDE.mdClaude.mdCLAUDE.local.md 中的任意一个,以及 .grok/rules/ 目录中的每个 *.md 文件(.claude/rules/.cursor/rules/ 也会读取以兼容)。被 .gitignore 忽略的文件会被跳过,这使 CLAUDE.local.md 等个人覆盖不会进入共享上下文。

Monorepo 支持

嵌套的 AGENTS.md 限定在其子树范围内,因此 monorepo 可以为每个包携带不同的约定:

my-monorepo/
  AGENTS.md                # 仓库级规则
  packages/
    frontend/AGENTS.md     # "使用 React。优先使用 CSS modules。"
    backend/AGENTS.md      # "使用 Express。遵循 REST 约定。"

文件全文加载,无大小上限;简短、具体的指令比冗长的指令更可靠地被遵循。

会话规则

要为单次运行添加规则而不编辑文件,传入 --rules(Grok 将文本追加到系统提示),或 --system-prompt-override 完全替换系统提示:

grok --rules "Always use TypeScript. Prefer functional components."

验证

grok inspect

这会列出 Grok 发现的每个规则文件,及其路径和大致 token 数。