Gitingest 代码库智能提取工具

项目简介

Gitingest 是一款强大的开源工具，能够将任意 GitHub 仓库或本地代码目录转换为适合大语言模型（LLM）阅读的文本摘要。只需将 GitHub URL 中的 'hub' 替换为 'ingest'，即可快速获取代码库的结构、统计信息和核心内容。

该项目由 coderamp-labs 开发，目前已在 GitHub 上获得超过 15,000 颗星，采用 MIT 许可证，基于 Python 构建。

核心功能

1. 多方式代码提取

• 支持从 GitHub URL、本地目录或特定子目录提取代码摘要
• 通过 Web 服务（gitingest.com）或浏览器扩展快速访问
• 提供完整的命令行工具和 Python API

2. 智能格式化输出

• 生成针对 LLM 优化的文本格式
• 包含文件树结构和目录统计信息
• 提供 token 数量估算，帮助控制输入成本

3. 灵活的使用方式

命令行工具：

bash
# 基本用法
pip install gitingest
gitingest /path/to/directory

# 从 URL 提取
gitingest https://github.com/coderamp-labs/gitingest

# 输出到标准输出
gitingest /path/to/directory --output -

Python API：

python
from gitingest import ingest

summary, tree, content = ingest("path/to/directory")
# 或从 URL 提取
summary, tree, content = ingest("https://github.com/coderamp-labs/gitingest")

4. 私有仓库支持

• 通过 GitHub Personal Access Token 访问私有仓库
• 支持环境变量配置

5. 浏览器扩展

• 支持 Chrome、Firefox 和 Edge
• 一键提取当前浏览的 GitHub 仓库

技术栈

• 后端框架：FastAPI
• 前端：Tailwind CSS
• 模板引擎：Jinja2
• Token 估算：tiktoken
• 监控分析：Sentry、PostHog

使用场景

1. AI 编程辅助：为 AI 编程助手提供完整的代码库上下文
2. 代码学习：快速了解陌生项目的结构和核心实现
3. 技术文档：自动生成项目概览和代码摘要
4. 团队协作：帮助新成员快速上手项目
5. 自动化集成：集成到 CI/CD 或数据处理管道

推荐人群

• 使用 AI 编程工具的开发者
• 需要快速理解代码库的技术人员
• 技术文档编写者
• AI 应用开发者
• 开源项目维护者

快速开始

bash
# 安装
pip install gitingest

# 使用命令行
gitingest https://github.com/coderamp-labs/gitingest

# 或访问 Web 服务
gitingest.com

项目特点

• 开源免费：MIT 许可证，完全免费使用
• 易于集成：提供多种使用方式
• 智能优化：针对 LLM 输入优化格式
• 社区活跃：超过 15,000 颗星，持续更新

声明：本文内容基于公开的 GitHub 仓库信息整理，仅供参考。项目功能和使用方式可能随时间更新，请以官方文档为准。

来源信息

• 原始仓库: coderamp-labs/gitingest
• 作者: coderamp-labs
• 开源协议: MIT License
• Stars: ⭐ 15300
• Forks: 🍴 1140
• 编程语言: Python

---

⚠️ 内容由 AI 整理，信息以原项目为准。请前往 原项目 查看最新信息。