repogather 使用教程-优快云博客

repogather 使用教程

repogather Easily copy all relevant source files in a repository to clipboard. For use in LLM code understanding and generation workflows 项目地址: https://gitcode.com/gh_mirrors/re/repogather

1. 项目介绍

repogather 是一个命令行工具，用于将代码库中的所有相关文件（保留其相对路径）复制到剪贴板。它旨在用于大型语言模型（LLM）的代码理解或代码生成工作流中。该工具可以使用 gpt-4o-mini（可配置）来判断文件的相关性，也可以不使用 LLM 来返回所有文件，并带有非 AI 过滤器（例如排除测试或配置文件）。

2. 项目快速启动

首先，您需要安装 repogather。可以通过 pip 命令进行安装：

pip install repogather

安装完成后，您需要设置 OpenAI API 密钥。有几种方法可以设置 API 密钥：

作为环境变量：

export OPENAI_API_KEY=您的_api_key_这里

在当前工作目录的 .env 文件中：
```
OPENAI_API_KEY=您的_api_key_这里
```
在运行工具时作为命令行参数提供。

接下来，您可以从命令行运行 repogather：

repogather [QUERY] [OPTIONS]

例如，如果您想分析所有与用户认证相关的文件，可以使用以下命令：

repogather "查找与用户认证相关的文件" --include-config --relevance-threshold 70 --model gpt-4o-2024-08-06

这个命令将会：

搜索与用户认证相关的文件。
包含配置文件在搜索结果中。
只返回相关性评分为 70 或更高的文件。
使用 2024 年 8 月的 GPT-4o 模型进行分析。

如果您想获取代码库中的所有文件，不使用 LLM 分析，可以使用以下命令：

repogather --all --include-test --include-config --include-ecosystem --include-gitignored --exclude "legacy_code"

这个命令将会：

获取代码库中的所有代码文件。
包含测试、配置和特定生态系统的文件在输出结果中。
包含通常被 .gitignore 忽略的文件。
排除路径中包含 "legacy_code" 的任何文件或目录。
不使用 LLM 分析将所有收集的文件复制到剪贴板。

3. 应用案例和最佳实践

案例 1：使用 repogather 生成项目的代码文档。

在项目的文档编写阶段，可以使用 repogather 来收集所有的代码文件，然后使用文档生成工具生成项目的 API 文档。
案例 2：在代码审查过程中使用 repogather。

审查代码时，可以使用 repogather 来快速获取和审查相关的代码文件，提高审查效率。