GitIngest：快速将Github代码仓库转为适合LLM理解的文本

General Introduction

GitIngest 是一个开源工具，旨在将 GitHub 代码库转化为适合大语言模型（LLM）提示的文本。通过简单的操作，用户可以将任何 GitHub 仓库的内容提取并格式化为适合 LLM 使用的文本。该工具提供了一键分析、智能格式化和统计信息等功能，帮助用户快速获取代码库的结构和内容摘要。GitIngest 采用 FastAPI 作为后端框架，并使用 Tailwind CSS 构建了一个简洁响应的用户界面。

体验地址：https://gitingest.com/

Function List

• 一键分析：只需粘贴 GitHub 仓库 URL，即可获得即时结果
• 智能格式化：优化输出格式，适合 LLM 提示
• 统计信息：提供文件和目录结构、令牌计数和统计数据
• Web 界面：简洁响应的用户界面，易于使用
• 安装和运行：支持通过 pip 和 Docker 安装和运行

Using Help

简易使用指南

示例项目地址：https://github.com/pptt121212/freefluxapi/

github修改为gitingest

https://gitingest.com/pptt121212/freefluxapi/

安装部署流程

Installation with pip

1. Cloning Warehouse:

   git clone https://github.com/cyclotruc/gitingest.git
cd gitingest

2. Install the dependencies:

   pip install -r requirements.txt

3. Run the application:

   cd src
uvicorn main:app --reload

The application will run on the http://localhost:8000The

Installing with Docker

1. Build the mirror image:

   docker build -t gitingest .

2. 运行容器：

   docker run -d --name gitingest -p 8000:8000 gitingest

The application will run on the http://localhost:8000The

Guidelines for use

1. 一键分析：打开 GitIngest 网站，粘贴 GitHub 仓库的 URL，点击分析按钮，即可获得仓库的结构和内容摘要。
2. 智能格式化：分析结果将以优化的格式显示，适合直接用于 LLM 提示。
3. 查看统计信息：在结果页面，可以查看文件和目录结构、令牌计数和其他统计数据。
4. Web 界面：通过简洁响应的用户界面，用户可以轻松浏览和操作分析结果。

Detailed function operation flow

• 粘贴 URL：在输入框中粘贴 GitHub 仓库的 URL。
• 点击分析：点击分析按钮，等待几秒钟，系统将自动提取和分析仓库内容。
• View Results：分析结果将显示在页面上，包括文件和目录结构、文本内容和统计信息。
• 下载摘要：用户可以选择下载分析结果的摘要文件，方便离线查看和使用。

GitIngest 提供了强大的功能和简洁的操作流程，使用户能够快速将 GitHub 代码库转化为适合 LLM 提示的文本，极大地提高了工作效率和准确性。

The layman's guide to getting started with AI

Help you learn how to utilize AI tools at a low cost and from a zero base.AI, like office software, is an essential skill for everyone. Mastering AI will give you an edge in your job search and half the effort in your future work and studies.

View Details>