Skip to content

使用说明

Code Meeseeks 是本地运行的 PR 评审客户端:连上你的代码平台 → 拉取待评审的 PR → 用 LLM(pr-agent)做 /describe /review,评论 / 审批 / 合并都在本地客户端完成。

本目录是面向用户的安装与配置说明(开发/架构文档见 ../arch/)。各项配置都在应用内 设置 页可视化编辑,首次启动也有配置向导引导最快进入可用状态。

篇目

文档内容
00 · 安装与首次使用系统要求、下载安装、首次启动配置向导
01 · 代码平台配置接入 GitHub / Bitbucket Server / GitLab:Base URL、访问令牌(PAT)权限、Clone 协议
02 · LLM 配置选 LLM 服务商与模型;含进阶的本地 CLI 模式(经授权调用本机 agentic CLI,以本机登录态执行评审)
03 · 网络代理配置内网 / 受限网络下统一走 HTTP 代理出网
04 · 配置文件参考config.yaml 完整结构与各配置项功能说明(含高级参数)
05 · 自定义评审规则编写规则 .md 文件:frontmatter 命中条件 + 正文注入 AI 的评审指令
06 · CLI 命令行工具开启本地 API 服务 + 用 meebox 命令行浏览 PR / 操作评审 Agent(供脚本 / 外部 agent 集成)

通用须知

  • 数据目录固定 ~/.code-meeseeks/:配置、状态、日志都在这里;config.yaml 是唯一配置文件,含连接 / LLM / 代理等全部设置。
  • 凭据安全:访问令牌、API Key、代理密码等请按最小授权配置,及时吊销泄露的令牌。
  • 保存即生效:设置页每项保存后写盘并热更新,无需重启;连接 / 代理变更会即时重建生效。
  • 高级编辑:设置页提供「用系统关联程序打开 config.yaml」,可直接改文件(适合批量 / 高级配置)。

采用 Apache License 2.0 发布。