Codium-ai PR-Agent 本地部署与使用指南

最新推荐文章于 2025-06-05 09:09:07 发布

单迅秋

最新推荐文章于 2025-06-05 09:09:07 发布

阅读量231

点赞数 5

本文链接：https://blog.youkuaiyun.com/gitblog_00330/article/details/148441570

版权

Codium-ai PR-Agent 本地部署与使用指南

pr-agent 🚀CodiumAI PR-Agent: An AI-Powered 🤖 Tool for Automated Pull Request Analysis, Feedback, Suggestions and More! 💻🔍 项目地址: https://gitcode.com/gh_mirrors/pr/pr-agent

前言

Codium-ai PR-Agent 是一款基于人工智能的代码审查助手，能够帮助开发团队自动化处理 Pull Request 的审查工作。本文将详细介绍如何在本地环境中部署和使用 PR-Agent，包括 Docker 方式、pip 包安装以及源码运行三种方法。

准备工作

在开始部署前，您需要准备以下两个关键凭证：

OpenAI API 密钥：需要具备 GPT-4 或 gpt-3.5-turbo 模型的访问权限。如果您希望使用其他语言模型，也可以准备相应平台的 API 密钥。
Git 平台个人访问令牌：根据您使用的 Git 平台（GitHub、GitLab、BitBucket 或 Gitea），需要生成具有仓库访问权限的个人访问令牌。

使用 Docker 运行 PR-Agent

Docker 是最简单快捷的部署方式，适合大多数用户。以下是针对不同 Git 平台的运行命令示例：

GitHub 平台

docker run --rm -it \
  -e OPENAI.KEY=<您的OpenAI密钥> \
  -e GITHUB.USER_TOKEN=<您的GitHub令牌> \
  codiumai/pr-agent:latest \
  --pr_url <PR链接> review

如果是企业版 GitHub，需要额外指定 API 地址：

-e GITHUB.BASE_URL=https://github.mycompany.com/api/v3

GitLab 平台

docker run --rm -it \
  -e OPENAI.KEY=<您的OpenAI密钥> \
  -e CONFIG.GIT_PROVIDER=gitlab \
  -e GITLAB.PERSONAL_ACCESS_TOKEN=<您的GitLab令牌> \
  codiumai/pr-agent:latest \
  --pr_url <PR链接> review

自托管 GitLab 实例需要指定 URL：

-e GITLAB.URL=<您的GitLab实例地址>

环境变量配置文件

为了简化配置，您可以创建一个 .env 文件：

CONFIG__GIT_PROVIDER="gitlab"
GITLAB__URL="<您的URL>"
GITLAB__PERSONAL_ACCESS_TOKEN="<您的令牌>"
OPENAI__KEY="<您的密钥>"

然后通过以下命令运行：

docker run --rm -it --env-file .env codiumai/pr-agent:latest <工具> <工具参数>

使用 pip 包安装

对于 Python 开发者，可以通过 pip 直接安装 PR-Agent：

pip install pr-agent

安装后，可以通过以下 Python 脚本使用：

from pr_agent import cli
from pr_agent.config_loader import get_settings

def main():
    # 配置参数
    provider = "github"  # 可选: github/gitlab/bitbucket/azure_devops
    user_token = "您的Git令牌"
    openai_key = "您的OpenAI密钥"
    pr_url = "PR链接"
    command = "/review"  # 支持/review, /describe, /ask等命令

    # 设置配置
    get_settings().set("CONFIG.git_provider", provider)
    get_settings().set("openai.key", openai_key)
    get_settings().set("github.user_token", user_token)

    # 执行命令
    cli.run_command(pr_url, command)

if __name__ == '__main__':
    main()

从源码运行

对于需要自定义开发的用户，可以从源码运行：

克隆仓库并安装依赖：

git clone <仓库地址>
cd pr-agent
pip install -e .

配置密钥文件：

cp pr_agent/settings/.secrets_template.toml pr_agent/settings/.secrets.toml
chmod 600 pr_agent/settings/.secrets.toml
# 编辑.secrets.toml文件

运行各种命令：

python3 -m pr_agent.cli --pr_url <PR链接> review
python3 -m pr_agent.cli --pr_url <PR链接> ask "您的问题"
python3 -m pr_agent.cli --pr_url <PR链接> describe

常见问题解决

Docker 运行错误：大多数情况下是由于 API 密钥或令牌配置错误导致。请仔细检查：
- OpenAI API 密钥是否正确
- Git 平台令牌是否具有足够权限
- 如果是企业版，URL 配置是否正确
Rust 相关错误：在从源码安装时，如果遇到 Rust 相关错误，需要先安装 Rust 工具链。
模型切换问题：如果需要使用 Azure OpenAI 或其他语言模型，需要额外配置相关参数。