文档中心 / CodeBee
💻 CodeBee · 代码助手 v2.0.1
命令行里的 AI 结对工程师:代码审查、单测生成、重构建议、提交信息。
快速开始
# 安装后,在任意 git 仓库中:
cd your-project
codebee review # 审查当前未提交的改动
codebee test src/pay.py # 为文件生成单元测试
codebee commit # 根据暂存区自动撰写提交信息
安装(三平台)
macOS:
brew install mifengba/tap/codebee
Windows:
winget install Mifengba.CodeBee
# 或使用 Scoop
scoop bucket add mifengba https://github.com/lianjietech/scoop-bucket
scoop install codebee
Linux:
# 一键脚本(自动识别发行版)
curl -fsSL https://get.mifengba.example/codebee.sh | bash
# 或手动安装 .deb / .rpm
sudo dpkg -i codebee_2.0.1_amd64.deb
sudo rpm -i codebee-2.0.1.x86_64.rpm
安装完成后运行 codebee auth login 完成授权;企业版配置自建网关地址即可离线使用。
命令参考
| 命令 | 说明 |
|---|---|
codebee review [path] | 审查未提交改动或指定路径,输出分级问题清单 |
codebee review --pr 123 | 审查 GitHub / GitLab 的 PR / MR |
codebee test <file> | 生成单元测试(Python / Go / Java / TS) |
codebee refactor <file> | 输出重构建议与可应用补丁 |
codebee commit | 根据暂存区自动撰写 commit message |
codebee explain <file> | 解释一段陌生代码的逻辑与风险 |
codebee config | 查看与修改配置 |
IDE 插件
VS Code 插件市场搜索 CodeBee 安装,提供:
- 保存时行内审查提示
- 选中代码右键 → 生成测试 / 解释代码
- 与 CLI 共享登录态和配置
JetBrains 系列插件开发中,预计下季度发布。
配置文件
项目级配置 .codebee.yaml(放在仓库根目录,可提交共享):
review:
level: strict # strict / normal / relaxed
ignore:
- "vendor/**"
- "*.generated.go"
test:
framework: pytest # 指定测试框架
gateway: "" # 企业版自建模型网关地址
常见问题
Q:我的代码会被上传吗?
只发送与任务相关的代码片段;企业版接入自建网关后,任何内容都不出内网。
Q:支持哪些语言?
审查与解释支持所有主流语言;单测生成目前支持 Python / Go / Java / TypeScript。
Q:能接入 CI 吗?
可以,codebee review --ci 输出 JSON 结果并以退出码标识是否阻断,配 GitHub Actions 或 GitLab CI 均可。