RepoAgent: 一个基于 LLM 的代码库级文档生成框架

English readme • 简体中文 readme

:tv: 演示

👾 背景

在计算机编程领域，完善的项目文档（包括对每个 Python 文件的详细解释）的重要性不言而喻。这些文档是理解、维护和增强代码库的基石。它们为代码提供了必要的上下文和逻辑解释，使当前和未来的开发者能够更容易地理解软件的目的、功能和结构。这不仅有助于开发者掌握项目的意图和架构，还能确保项目在长期的迭代中保持可访问性和可修改性，从而显著降低新成员的学习曲线。

传统上，创建和维护软件文档需要大量的人力投入和专业知识，这对没有专职文档人员的小型团队来说是一个巨大的挑战。像 GPT 这样的大语言模型（LLM）的出现改变了这一现状，使 AI 能够处理大部分文档编写工作。这种转变让开发人员能够专注于审核和微调，极大地减轻了人工编写文档的负担。

🏆 我们的目标是打造一个智能文档助手，帮助用户阅读和理解代码库并自动生成文档，最终帮助用户提高效率并节省时间。

✨ 功能特性

• 🤖 自动检测 Git 仓库中的变更：跟踪文件的添加、删除和修改。
• 📝 通过 AST 独立分析代码结构：为单个对象生成对应的文档。
• 🔍 精准识别对象间的双向调用关系：丰富了文档内容的全局视角。
• 📚 基于变更无缝替换 Markdown 内容：保持文档与代码的一致性。
• 🕙 执行多线程并发操作：提高文档生成的效率。
• 👭 提供可持续的自动化文档更新方案：助力团队协作。
• 😍 以极佳的方式展示代码文档：通过 Gitbook 为每个项目提供专门的文档页。

🚀 快速开始

安装方法

使用 GitHub Actions

本仓库支持通过 GitHub Actions 实现构建、测试和部署等工作流的自动化。关于如何配置和使用 GitHub Actions 的详细说明，请参考 actions/run-repoagent。

使用 pip 安装（推荐用户使用）

直接使用 pip 安装 repoagent 包：

pip install repoagent

使用 PDM 进行开发配置

如果您希望为本项目做出贡献或配置开发环境：

• 安装 PDM：如果您尚未安装，请参考 安装 PDM。

• 使用 CodeSpace 或克隆仓库：

  • 使用 CodeSpace 这是获取 RepoAgent 环境最简单的方法。点击下方按钮使用 GitHub Codespaces，然后进入下一步。

  

  • 克隆仓库

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

• 使用 PDM 配置

  • 初始化 Python 虚拟环境。请确保在 /RepoAgent 目录下运行以下命令：

    pdm venv create --name repoagent
    

  • 激活虚拟环境

  • 使用 PDM 安装依赖

     pdm install
    

配置 RepoAgent

在配置 RepoAgent 的具体参数之前，请确保已在命令行中将 OpenAI API Key 设置为环境变量：

export OPENAI_API_KEY=YOUR_API_KEY # Linux/Mac 系统
set OPENAI_API_KEY=YOUR_API_KEY # Windows 系统
$Env:OPENAI_API_KEY = "YOUR_API_KEY" # Windows (PowerShell)

运行 RepoAgent

进入 RepoAgent 的根目录，并在终端尝试运行以下命令：

repoagent run # 该命令将生成文档或更新文档（pre-commit-hook 会自动调用此命令）
repoagent run --print-hierarchy # 打印 repo-agent 如何解析目标代码库

run 命令支持以下可选参数（若设置，将覆盖配置文件中的默认值）：

• -m, --model TEXT: 指定用于补全的 LLM 模型。默认：gpt-3.5-turbo
• -t, --temperature FLOAT: 设置模型的生成温度参数。较低的值会使模型生成的结果更具确定性。默认：0.2
• -r, ...