# GPTAnalyzeHelper

**Repository Path**: pth2000/GPTAnalyzeHelper

## Basic Information

- **Project Name**: GPTAnalyzeHelper
- **Description**: GPTAnalyzeHelper 旨在为 GPT 提供开源项目的全面信息以进行分析，通过生成一个包含文件树和所有项目代码内容的 .txt 文件，以供 GPT 进一步处理和分析。
- **Primary Language**: Python
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-06-24
- **Last Updated**: 2024-06-24

## Categories & Tags

**Categories**: Uncategorized

**Tags**: Python, Code, gpt

## README

# GPTAnalyzeHelper

GPTAnalyzeHelper 旨在为 GPT 提供开源项目的全面信息以进行分析，通过生成一个包含文件树和所有项目代码内容的 `.txt` 文件，以供 GPT 进一步处理和分析。

该项目借鉴了[code-gpt](https://github.com/zyglovepp/code-gpt)的实现思路，并对代码和使用体验进行了改善。

## 特点

- 检测和处理不同的文件编码。
- 生成结构化的文件树。
- 将代码文件的内容聚合到一个输出文件中。
- 通过配置文件支持可配置的文件格式。
- 能够排除指定的目录。

## 直接使用

[发行版页面](https://gitee.com/pth2000/GPTAnalyzeHelper/releases)

GPTAnalyzeHelper 提供了Windows平台的编译版本以供快速使用。如果需要自行修改，请参照以下方法进行环境配置。

## 安装

1. 克隆代码库：

   ```bash
   git clone https://gitee.com/pth2000/GPTAnalyzeHelper.git
   cd GPTAnalyzeHelper
   ```

2. 安装所需的依赖项：

   ```bash
   pip install -r requirements.txt
   ```

## 配置

GPTAnalyzeHelper 使用一个 TOML 配置文件 (`config.toml`) 来指定要处理的文件格式和要排除的目录。以下是一个示例配置：

```toml
[Settings]
format_limit = [".py", ".cpp", ".c", ".java", ".json"]
exclude_dirs = ["venv", ".venv", ".git", ".idea"]
```

## 使用方法

1. 确保在工具同目录中存在 `config.toml` 文件。

2. 运行脚本（编译版本只需直接运行`.exe`）：

   ```bash
   python gpt_analyze_helper.py
   ```

3. 按提示选择要处理的目录。

4. 输出将写入工具同目录中的 `output.txt`。