git2txt

轻松将 GitHub 仓库转换为文本文件。这款命令行工具会下载一个仓库，并将其内容拼接成一个单独的文本文件，非常适合用于分析、文档编写或 AI 训练。

功能特性

• 📥 下载任何公开的 GitHub 仓库
• 📝 将仓库内容转换为单个文本文件
• ⚡ 自动排除二进制文件
• 🔧 可配置的文件大小阈值
• 💻 跨平台支持（Windows、macOS、Linux）

安装

npm install -g git2txt

使用方法

您可以通过多种格式指定仓库：

# 完整的 HTTPS URL
git2txt https://github.com/username/repository

# 简短格式（用户名/仓库名）
git2txt username/repository

# SSH 格式
git2txt git@github.com:username/repository

URL 格式支持

该工具支持以下 GitHub 仓库 URL 格式：

• HTTPS URL：https://github.com/username/repository
• 简短格式：username/repository
• SSH URL：git@github.com:username/repository
• 带或不带 .git 后缀的 URL
• 带或不带尾部斜杠的 URL

选项

--output, -o     指定输出文件路径（默认：repo-name.txt）
--threshold, -t  设置文件大小阈值，单位为 MB（默认：0.1）
--include-all    包含所有文件，无论大小或类型
--debug         启用调试模式，显示详细日志
--help          显示帮助信息
--version       显示版本号

示例

使用不同格式下载并转换仓库：

# 使用 HTTPS URL
git2txt https://github.com/username/repository

# 使用简短格式
git2txt username/repository

# 使用 SSH URL
git2txt git@github.com:username/repository

# 指定自定义输出文件
git2txt username/repository --output=output.txt

# 设置自定义文件大小阈值（2MB）
git2txt username/repository --threshold=2

# 包含所有文件（不按大小或类型过滤）
git2txt username/repository --include-all

# 启用调试输出
git2txt username/repository --debug

默认行为

• 默认排除大于 100KB 的文件
• 自动排除二进制文件
• 输出文件将在当前目录下以仓库名称命名创建
• 文件会递归处理所有子目录（排除 node_modules 和 .git 目录）
• 文件路径和内容之间用清晰的标记分隔
• 输出中保留相对路径

输出格式

该工具生成的文本文件格式如下：

================================================================================
文件：path/to/file.txt
大小：1.2 KB
================================================================================

[此处为文件内容]

================================================================================
文件：another/file.js
大小：4.5 KB
================================================================================

[此处为文件内容]

贡献

欢迎贡献！详情请参阅我们的 贡献指南。

许可证

MIT

git2txt 快速上手指南

git2txt 是一款命令行工具，可将 GitHub 仓库的代码内容合并为单个文本文件，非常适合用于代码分析、文档生成或 AI 模型训练。

环境准备

• 系统要求：支持 Windows、macOS 和 Linux。
• 前置依赖：需预先安装 Node.js (建议版本 16+)，以确保 npm 命令可用。

安装步骤

使用 npm 全局安装该工具：

npm install -g git2txt

国内加速提示：若下载速度较慢，可配置淘宝镜像源后安装：

npm config set registry https://registry.npmmirror.com
npm install -g git2txt

基本使用

安装完成后，直接在终端运行以下命令即可将任意公开 GitHub 仓库转换为文本文件：

git2txt username/repository

示例：将 vuejs/core 仓库转换为文本文件（默认输出为 core.txt）：

git2txt vuejs/core

工具会自动排除二进制文件和大于 100KB 的文件，并在当前目录生成包含所有代码内容及文件路径标记的文本文件。