跳转到主要内容
CLAUDE.md、AGENTS.md、.cursor/rules 和 .github/copilot-instructions.md 这类文件告诉编码代理您的团队如何工作。它们不是审查策略,因此 Kodus 从不把它们变成 Kody Rules。开启此设置后,Kody 会读取覆盖拉取请求所更改文件的那些指令文件,并指出违反其内容的更改。 要把某个约定变成强制执行的审查规则,请在 .kody/rules 中把它写成代码库规则。

​
开启方式

  • 在入门引导中,Teach Kody how your team builds software 步骤会列出在每个所选代码库中找到的编码代理文件,并询问 Kody 是否应使用它们。除非您开启,否则它保持关闭。
  • 之后,在侧边栏 Code review 分组顶部的范围选择器中选择 Global 或某个代码库,打开 What to review,并开启 Coding-agent instructions。全局值是所有未设置自身值的代码库的默认值。
该设置以 repoInstructionsEnabled 的形式存储在代码审查配置中(以及 kodus-config.yml 中)。旧的 ideRulesSyncEnabled 不再被读取,在其中设置的值不会开启此功能。

​
Kody 读取的文件

​
Cursor

  • .cursorrules
  • .cursor/rules/**/*.mdc

​
GitHub Copilot

  • .github/copilot-instructions.md
  • .github/instructions/**/*.instructions.md

​
代理(agents.md 约定)

  • AGENTS.md、.agents.md、.agent.md
  • .agents/rules/**

​
Claude

  • CLAUDE.md

​
Windsurf

  • .windsurfrules

​
Sourcegraph Cody

  • .sourcegraph/**/*.rule.md
工具配置文件(.claude/settings.json、.opencode.json、.aider.conf.yml、.aiderignore)会被识别但从不读取,因为它们不包含可用来检查代码的指令。 Claude 技能(.claude/skills/**)也不会被读取:Claude 只在任务需要时才加载技能。

​
审查如何使用它们

  • 只读取覆盖本次更改的文件。 代码库根目录下的文件覆盖所有文件。嵌套文件(例如 services/billing/CLAUDE.md)覆盖 services/billing/**。带有 globs:(且没有 alwaysApply: true)的 Cursor 规则,或带有 applyTo: 的 Copilot 文件,只覆盖其声明的文件。两者都没有的 Cursor 规则只在 Cursor 的代理请求时才加载,因此不会被读取。
  • 从拉取请求的目标分支读取。 拉取请求会按照目标分支上已合并的指令进行检查;拉取请求对指令所做的更改在合并后才会生效。
  • 会跟随引用。 指向代码库中另一个文件的文件(只包含路径的一行,如 AI-AGENTS.md,或 Claude Code 的导入 @docs/guide.md)会在目标分支上被跟随:改为读取它所指向的文件,并受相同的上限约束。代码库之外的路径会被忽略。
  • 有上限。 每次审查最多 8 个文件、64 KB,离修改的代码最近的文件优先;更长的文件会被截断。审查会记录被省略的内容。
  • 发现的问题标记为 Repo Instruction。 只有当指令适用于被更改的文件,且违反它的那一行是由该拉取请求新增或修改的,Kody 才会报告。评论会引用该指令并注明所在文件。
  • 审查的过滤器同样适用。 Repo Instruction 发现与其他发现一样,要经过团队的严重性过滤器和建议数量上限;低于阈值的发现不会发布。该设置让 Kody 读取这些文件,而不是绕过这些上限发布评论。
  • 从不作为给 Kody 的指令。 这些文件被视为用来检查 diff 的代码库文本。其中要求审查者做的任何事情都会被忽略,也从不改变对 bug、安全或性能问题的判断方式。

​
此变更之前导入的规则

早期版本的 Kodus 会把这些文件转换为 Kody Rules。这些规则会被保留但冻结:文件更改时它们不再更新,并在 Kody Rules 页面上带有 Agent file 来源。rules from coding-agent files 筛选标签会把列表筛选到这些规则,方便您暂停或删除它们,或把想要强制执行的约定移到 .kody/rules 中。 入门引导在无人选择的情况下从编码代理文件导入的规则已被删除:每个仓库中同一文件的副本都各自变成了一条适用于所有仓库的规则。Kody Rules 页面会显示删除的数量,并指向 What to review 中的 Coding-agent instructions,开启后会在每个仓库的审查中读取这些文件。如需恢复已删除的规则,请联系支持团队。 @kody-sync 不再有任何作用:Kody Rule 文件始终同步,而编码代理文件从不会变成规则。@kody-ignore 仍然可以将某个 Kody Rule 文件排除在同步之外。

​
在自托管环境中验证

对于每一次读取编码代理指令的审查,worker 日志都会输出一个便于 grep 的标记:
每一行会显示找到了多少个指令文件、读取了哪些、多少字节,以及是否有内容被省略。