RepoAgent

环境要求

• Python 环境（项目基于 Python，README 未指定具体版本）
• PDM 包管理器（README 提供官方安装链接）
• 可调用的大模型 API（默认模型 gpt-3.5-turbo，默认 base-url 为 https://api.openai.com/v1）
• 一个需要生成文档的目标代码仓库路径

安装与启动步骤

1. 1克隆项目仓库

   把 RepoAgent 源码下载到本地并进入项目根目录，后续命令都要在该目录内执行。

   git clone https://github.com/LOGIC-10/RepoAgent.git
   cd RepoAgent

   复制

2. 2安装 PDM

   README 仅给出 PDM 官方安装文档链接，未提供具体安装命令，请按官方文档完成安装后再继续。

3. 3创建虚拟环境

   确保当前位于 RepoAgent 目录内，用 PDM 创建名为 repoagent 的 Python 虚拟环境。

   pdm venv create --name repoagent

   复制

4. 4激活虚拟环境

   README 只给出 PDM 官方虚拟环境激活文档链接，未列出具体激活命令，请按文档激活刚创建的 repoagent 环境。

5. 5安装依赖

   在已激活的虚拟环境中用 PDM 安装项目全部依赖，耗时取决于网络情况。

   pdm install

   复制

6. 6生成或更新文档

   在 RepoAgent 根目录运行，会自动生成文档；若目标仓库已有文档则执行更新。

   repoagent run

   复制

7. 7查看解析结构

   可选操作，打印 repo-agent 如何解析目标仓库的结构，便于确认解析范围是否符合预期。

   repoagent run --print-hierarchy

   复制

关键配置

如何确认成功

运行 repoagent run 后，目标仓库根目录会生成记录全局结构的 JSON 文件（默认 .project_doc_record）和 markdown_docs 文档文件夹。

常见问题

注意事项

• README 只提供 PDM 开发环境安装方式，未给出 pip install repoagent 等命令，请勿自行替换安装方式。
• 模型、温度、超时、base-url 等参数都有默认值，命令行传入的 flag 会覆盖配置默认值。
• 生成文档需要调用大模型 API，README 未说明密钥的具体配置方式，使用前请确认接口凭据已就绪。
• 若目标仓库已有全局文档信息，可直接配置 pre-commit hook 实现文档自动维护。