指令是临时的:仅对该次评审运行生效。它不会保存到你的设置中,也不会影响后续评审。若要永久改变 Kody 的行为,请改用 Custom Prompts 或 Kody Rules。
何时使用
- 一个 PR 改动了很多文件,但你最关心其中某个高风险区域(认证、支付、数据库迁移)。
- 你希望 Kody 追踪某处改动的调用方与被调用方,并更严格地审视它。
- 你在重新运行评审,想在不编辑任何配置的情况下引导注意力。
是优先级,而非过滤器
这是最需要理解的一点: 用指令来表达 “这里要最重点地看” ——而不是 “只看这里”。如何触发
- PR / MR 评论
- CLI
在拉取请求评论中,紧接评审命令之后写上你的聚焦文本:你也可以使用 支持 GitHub、GitLab、Azure DevOps、Bitbucket 和 Forgejo。
start-review,并与 --force 组合:只有命令之后的第一行会被用作指令。后续各行都会被忽略,因此请把聚焦内容写在一行内。
如何写好一条指令
- 明确区域,而非结论。“聚焦于队列消费者的并发”比”找出缺陷”更有效。
- 指名代码,而非结果。 指向某个模块、流程或关注点(“重试逻辑”、“报表服务中的 SQL”)。
- 保持简短。 指令上限为 500 个字符;只会读取评论的第一行。
好的示例
好的示例
@kody review 聚焦于认证与令牌刷新流程@kody review 聚焦于新的 Stripe webhook 处理kodus review --focus "后台 worker 中的竞态条件"
较弱的示例
较弱的示例
@kody review 请仔细一点—— 没有可优先的区域。@kody review 只评论文件 X—— 指令不是过滤器;请用忽略路径来限定文件。
说明与限制
- 长度: 指令会在 500 个字符处截断。
- 仅第一行: 在 PR 评论中,只有命令之后的第一行会成为指令。
- 设计上不信任: 由于任何能评论 PR 的人都可以提供指令,文本在使用前会被清洗(去除控制字符和尖括号)。这不会改变你的聚焦——只是防止文本篡改 Kody 的内部提示词。
- 不持久化: 不会向你的仓库或组织设置写入任何内容。