Qcode code-review

Qoder CLI 一键 Code Review 完整使用与自定义规则文档

一、工具基础说明

Qoder CLI 是轻量AI命令行工具,支持终端本地一键代码评审,配套 qoder-action 可接入GitHub CI流水线实现PR自动审查,核心评审指令为 /review,实现代码质量左移。

二、本地一键Code Review /review 各类用法

进入 qodercli 交互式终端后执行以下指令:

  1. 基础增量评审(默认对比主分支,扫描已提交+未提交全部变更)

    /review

  2. 仅检查未提交的本地修改

    /review 只检查未提交的本地修改

  3. 仅评审指定单个文件

    /review 检查 src/service/user.ts

  4. 指定对比分支(非默认main/master)

    /review --target_branch=develop

  5. 过滤目录,跳过测试、文档文件扫描

    /review --exclude="tests/,docs/"

  6. 仅聚焦安全、逻辑缺陷,忽略代码格式规范

    /review --focus_areas=security,logic

  7. 全仓库存量代码完整审计(不限Git Diff,扫描全部历史代码)

    /review 全量扫描整个仓库所有代码

三、自定义检查规则体系说明

核心特性

Qoder 所有代码审查规则依托 LLM提示词约束 实现,不具备底层静态AST解析引擎,规则分为四层,优先级从高到低

  1. 子目录 AGENTS.md:模块专属规则,优先级最高
  2. 项目根目录 AGENTS.md:项目全局统一规范
  3. .qoder/rules/*.md:大型项目模块化拆分规则文件
  4. 用户全局 ~/.qoder/AGENTS.md:本机所有项目通用兜底规则,优先级最低

四、补充配套能力(来自官方文档)

  1. 本地CLI与GitHub Action共用同一套AGENTS.md规则,本地自测、流水线评审标准统一;
  2. 流水线可在prompt中追加临时约束、指定输出语言(OUTPUT_LANGUAGE: Chinese);
  3. PR评论区支持 @qoder 交互式修复、代码解释,可自动提交修复补丁至当前分支;
  4. 可配置流水线阻断阈值,高危漏洞直接终止PR合并流程。