使用场景

开发者使用GitIngest从GitHub仓库中提取代码，以便在本地进行分析。

数据科学家利用GitIngest将代码库转换为文本摘要，用于训练机器学习模型。

研究人员使用GitIngest来理解开源项目的代码结构和历史。

产品特色

- 从Git仓库URL或目录获取文本摘要。

- 优化的输出格式，适合LLM提示。

- 提供文件和目录结构、提取大小和令牌计数的统计信息。

- 命令行工具，支持Linux系统。

- 可以作为Python包导入代码中使用。

- 支持从URL或本地路径分析代码库。

- 默认情况下，摘要会写入当前工作目录的文本文件中。

使用教程

1. 安装GitIngest：在命令行中运行`pip install gitingest`。

2. 使用命令行工具：在终端中输入`gitingest /path/to/directory`或`gitingest https://github.com/cyclotruc/gitingest`来分析代码库。

3. 查看结果：分析完成后，摘要会默认写入当前工作目录的`digest.txt`文件中。

4. 作为Python包使用：在Python代码中导入`gitingest`模块，并调用`ingest`函数，传入路径或URL。

5. 自行部署：通过Docker构建和运行GitIngest的镜像，访问`http://localhost:8000`来使用。

6. 贡献代码：在GitHub上Fork仓库，进行修改后提交Pull Request。