跳转到主要内容

Documentation Index

Fetch the complete documentation index at: https://docs.kodus.io/llms.txt

Use this file to discover all available pages before exploring further.

在 Kody Rules 的界面里,你实际上是在配置两种不同的东西。理解它们各自的用途,会让代码审查更有效。 一个实用的判断方式是:
  • 记忆 用来教会 Kody 你的代码库是如何工作的,这样后续的审查和建议会更贴合上下文。
  • 审查规则 用来告诉 Kody,当 PR 不符合你的标准时应该明确指出什么问题。

审查规则

审查规则是在专门的代码审查阶段运行的传统代码审查检查。它们根据您定义的标准分析文件差异或整个 PR。 最适用于:
  • 架构边界(“领域层不得导入基础设施”)
  • 代码模式(“避免在循环条件中使用 ==”)
  • PR 要求(“每个服务文件必须有测试”)
  • 使用 fileDiffpr_files_diff 等变量进行结构验证
工作原理:
  • 应用于文件级或 PR 级范围
  • 仅在代码审查期间运行
  • 支持文件引用(@file@repo)和 MCP 函数
  • 产生带有严重性级别的建议

记忆

记忆是注入到所有交互中的持久上下文指令 — 代码审查、对话和 AI 建议。它们代表 Kody 应该持续携带的背景知识,包括代码库上下文、团队约定和偏好。 最适用于:
  • 代码库上下文(“这个仓库会镜像第三方 API,因此某些外部字段会刻意保持 snake_case”)
  • 建议偏好(“在这个仓库里给 JS 工具建议时,优先原生方法而不是 Lodash”)
  • 迁移上下文(“billing 模块正处于迁移中,所以更适合渐进式修改,而不是大范围重构”)
  • 架构上下文(“这个服务采用六边形架构,并把 adapter 放在边界层”)
工作原理:
  • 作为高优先级上下文注入到所有提示中
  • 通过提供仓库特定的上下文来改善未来的建议
  • 通过对话(@kody remember: ...)或在 UI 中手动创建
  • 范围限定为目录、代码库或组织级别
  • Kody 自动去重和解决记忆之间的冲突

何时使用哪个

场景使用
检查每个服务是否有测试文件审查规则
”这个仓库会镜像外部 API,因此某些响应字段会刻意保持 snake_case”记忆
PR 描述必须遵循模板审查规则
”在这个服务里,测试通常放在实现文件旁边,而不是统一的测试目录”记忆
标记违反架构层的导入审查规则
”认证模块正处于迁移中,因此更适合渐进式修改,而不是大范围重构”记忆

可以相互转换吗?

可以。在待审记忆模态窗口中,您可以将记忆转换为审查规则,如果您认为它需要更结构化的执行(带有文件路径和严重性级别)。 更多详情,请参阅 Kody 规则