跳转到内容

功能

AGENTS.md

项目规则是 Grok 在目录树中为每个会话加载到上下文的 Markdown 文件。在你的仓库根目录放置一个 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 这样的个人覆盖文件不会进入共享上下文。

嵌套的 AGENTS.md 仅作用于其子树,因此单体仓库可以为每个包采用不同的约定:

text
my-monorepo/
  AGENTS.md                # repo-wide rules
  packages/
    frontend/AGENTS.md     # "Use React. Prefer CSS modules."
    backend/AGENTS.md      # "Use Express. Follow REST conventions."

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

会话规则

要为单次运行添加规则而不编辑文件,可以使用 --rules(Grok 会将文本附加到系统提示中),或使用 --system-prompt-override 完全替换系统提示:

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

验证

bash
grok inspect

这列出了 Grok 找到的每个规则文件,包括其路径和大约的 token 数量。

本文档为 docs.x.ai 全站中文翻译,由 AI 自动翻译生成。代码示例请以原文为准。