使用文档

• 桌面端（Electron）：IDE 编辑工作区，或进入审查流水线看板完成本机审查
• 拉码主路径：经「设置 → 代码仓库」鉴权后 Git 克隆；MCP 用于工具扩展，不是拉码主路径
• 大模型记忆：跨会话偏好 / 约定，对话与审查可注入（默认仅存本机）
• Web 控制台：登录、订阅、MCP、审查规则、审查记录；企业另有组织协作
• 平台维护：配置中心、用户 / 组织 / 套餐、审计日志、客户端版本控制
• 审查默认本机执行，不做云端代跑代码

1. 01
   下载安装桌面端

   在下载中心获取 macOS / Windows / Linux 安装包，或先用浏览器打开 Web 控制台。

2. 02
   登录账号

   手机号 + 短信验证码登录；首次自动注册。桌面端可通过浏览器授权回流登录。

3. 03
   配置审查能力

   桌面端连接「代码仓库」Token、选择模型与规则；控制台可管理审查规则与 MCP 工具目录。

4. 04
   创建并运行流水线

   新建流水线：源 → 审查方式 → 模型 → 报告格式；经 Git 克隆拉码后运行，查看 Diff 与报告。

5. 05
   配置大模型记忆（推荐）

   设置 → 记忆写入偏好，或对话 /remember；之后对话与审查会按作用域自动注入。

6. 06
   企业协作（可选）

   开通企业席位并邀请成员后，组织范围内共享审查记录与协作配置。

• 支持平台：macOS 12+、Windows 10+、Linux（AppImage）
• 下载中心提供桌面端安装包与 Web 控制台入口（浏览器无需安装）
• 安装包地址由平台维护在「配置中心 → 工具配置 / 版本控制」维护
• 桌面端可检查更新；平台维护可在版本控制上传各平台包并标记当前版本

• 控制台：手机号验证码登录；开发环境可开启短信调试便于联调
• 桌面端：浏览器授权登录后回流到客户端
• 账号设置：头像、昵称、换绑手机号 / 邮箱、退出登录
• 邀请链接 /invite/[token]：未登录会先跳转登录，再接受加入组织

• 免费：完整个人菜单，基础审查额度，审查记录仅自己可见
• 个人付费（月 / 季 / 年）：同菜单，更高额度；可同时加入企业组织
• 企业（按席位 / 年）：组织与成员、组织范围审查记录、规则 / MCP 协作
• 组织角色：成员、组织管理员、创建者；另有计费只读、审计等细分角色
• 平台维护：用户、全站组织、套餐、配置中心、审计、版本控制（与是否付费无关）

• 工作台：问候、当前套餐与本月用量、最近审查；平台维护另有平台概览
• 订阅管理：权益、用量、升级下单与订阅记录（计费 / 用量已并入本页）
• MCP：从平台市场添加或手动配置，管理启用状态
• 审查规则：从平台选用或自建自然语言规则
• 审查记录：检索云端同步的报告；可见范围按个人 / 组织角色区分
• 企业用户额外可见「组织」：成员、邀请与组织信息

1. 在「订阅管理」查看当前方案与本月已用审查次数
2. 通过升级入口选择免费升级个人档或企业席位方案并提交订单
3. 企业管理员可为组织下单席位；成员可查看组织企业版信息（只读）
4. 平台维护在后台确认付款并开通后，权益与额度生效

• 主导航：代码审查（流水线）、审查记录、对话助手
• 账号菜单：设置、检查更新、云端相关操作
• 本地 SQLite 保存运行历史；密钥加密落盘
• 时间展示统一为 YYYY-MM-DD HH:mm:ss

• 打开本地文件夹或流水线项目工作区，多标签编辑
• Markdown / HTML 支持预览与编辑切换；其余文件使用代码编辑器
• 常用快捷键：保存、快速打开；资源管理器支持右键操作
• 可从流水线看板「查看项目」进入 IDE，报告页与编辑器共用工作区

• 「我的流水线」：搜索、新建、复制、删除、批量删除、批量运行（可配并发）
• 看板 Tab：流程配置、最近运行、运行历史
• 代码源：手动 Git 地址 + 分支，或已在「设置 → 代码仓库」连接的平台仓库；可指定本地工作目录
• 审查方式：从平台 / 本地目录勾选（安全、规范等分组）
• 运行前确认：代码源、运行备注、可选强制刷新缓存
• 未配齐源 / 方式 / 模型 / 报告格式时不可运行

1. 01
   初始化

   创建本次运行任务与上下文。

2. 02
   拉取代码

   按流水线配置的代码源，使用「设置 → 代码仓库」中已连接平台的鉴权，Git 克隆到本地工作目录（可在设置中开关）。

3. 03
   缓存检查

   相同提交 / 指纹可复用历史结果；需要时强制刷新。

4. 04
   静态规则扫描

   内置与自定义规则扫描；中间态聚焦 error。

5. 05
   LLM 重点审查

   可按勾选的审查方式分步语义审查；失败时仍可继续出报告。

6. 06
   合并与报告

   去重合并后最终报告仅保留 error，再按选定格式生成并落盘。

• 报告页三栏：文件树（含 error 计数）/ Diff 或编辑器 / 流程时间线
• 含 error 的源码文件可 Diff 高亮；富文档走编辑器预览
• 导出格式按流水线配置：Markdown / HTML，可选 JSON
• 落盘优先写入项目「分析报告」目录，否则使用全局报告目录
• 本地历史可上传 / 同步到控制台「审查记录」

• 账号：刷新资料与组织、拉取云端配置、上传最近报告、打开控制台账号页
• 通用：主题、语言、Git 克隆开关、批量并发、启用 LLM、完成通知等
• 代码仓库：从云端目录加载平台（失败时本地兜底），填写 Token 并校验连接
• MCP：stdio / SSE 管理；从市场添加或粘贴 JSON；自动发现 Tools
• 模型：多 Provider（含本地 Ollama 等），启用并选用当前模型
• 记忆：总开关、自动沉淀、容量、增强检索、列表管理、JSON 导入导出、可选 MCP 导入
• 规则：内置静态规则开关与自定义规则

• 侧栏「对话」可关联「审查过的代码仓库」（按仓库去重，取最近一次审查上下文）
• 输入 / 唤起命令（如 /help、切换模型、/remember 写入记忆）
• 工具栏：附件、本轮排除记忆、沉淀本轮；悬停可查看说明
• 发送后可展开「本轮用到的记忆」；底部可切换已配置模型
• 命令目录可由平台维护在配置中心「对话命令」维护

产品级 Memory 让模型在多轮对话与多次审查之间，稳定遵守你确认过的偏好、命名约定与修复经验，而不是每次从零开始。

1. 01
   写入记忆

   设置 → 记忆手动添加；对话输入 /remember …；或开启自动沉淀后由系统启发式提取。

2. 02
   作用域与检索

   全局 / 仓库级作用域；默认增强检索（关键词 + 文本相似度），亦可改为仅关键词；注入有条数与字符预算。

3. 03
   对话与审查注入

   发消息或跑 LLM 审查时自动拼入相关记忆；可临时排除本轮；发送后可查看本轮用到的条目。

4. 04
   备份与可选导入

   导出 / 导入 JSON 做跨机迁移；若已连接 Memory MCP，可一次性导入实体（非主路径）。

• 类型：用户偏好、项目约定、审查结论、修复经验、笔记
• 容量上限可配置，超出自动清理最旧；相似内容写入时去重合并
• 自动沉淀默认关闭，避免噪声；可随时手动「沉淀本轮」
• 账号级云端双向同步尚未开放；跨设备请先用 JSON 备份

1. 01
   开通席位

   管理员按席位下单企业版，平台维护确认开通后生效。

2. 02
   邀请成员

   组织页可定向手机邀请或生成通用链接，成员经邀请页加入。

3. 03
   本机审查 + 云端共享

   成员仍在本机跑审查；记录按组织角色可见范围共享。

4. 04
   统一标准

   从平台目录选用 MCP / 规则，减少个人配置漂移；治理目录由平台维护更新。

平台维护账号（isPlatformAdmin）与个人/企业套餐无关，登录控制台后侧栏为运营菜单集：工作台平台概览、用户、组织、套餐、配置中心、审计日志、版本控制等。

1. 01
   用户治理

   全站账号列表与检索；查看套餐 / 组织归属；异常或封禁须填写原因，保障可追溯。

2. 02
   组织治理

   查看全部企业组织；可禁用组织；不在此直接移除成员（成员管理在组织语境下进行）。

3. 03
   套餐与订单元数据

   维护免费 / 个人（月·季·年）/ 企业席位等方案的价格、额度与展示信息，供订阅下单引用。

4. 04
   确认开通

   用户或企业在订阅管理提交订单后，由平台维护在后台确认付款并开通，权益与额度才会生效。

5. 05
   配置中心

   维护桌面端与控制台共用的平台目录与运行参数（见下表），发布后客户端 / 控制台可拉取。

6. 06
   版本与下载

   上传或填写 macOS / Windows / Linux 安装包地址、版本号与说明；同步到下载中心与客户端检查更新。

7. 07
   审计日志

   全站关键操作留痕，便于排查开通、封禁、配置变更等问题。

• 配置中心 · 工具配置：API / 鉴权站点、CORS、各平台安装包 URL、下载页说明、更新源
• 配置中心 · MCP 目录：市场条目 CRUD、启用发布、排序，供用户「从市场添加」
• 配置中心 · 内置模型：平台推荐模型目录，桌面端可同步选用
• 配置中心 · 代码仓库：GitHub / GitLab / Gitee 等平台目录与 logo，供桌面端连接鉴权
• 配置中心 · 对话命令：/help、/remember 等命令目录维护
• 配置中心 · 审查规则（审查方式）：安全 / 规范等分组目录，流水线勾选来源
• 配置中心 · 服务条款：用户协议 / 隐私协议正文，官网页脚弹窗读取
• 配置中心 · 文件存储：对象存储（如七牛）等上传相关参数
• 配置中心 · 组织配置：可代为查看 / 编辑指定组织的云端配置 JSON
• 工作台：平台概览指标（用户量、组织、用量等，视当前实现）