项目介绍:git2gpt
git2gpt 是一个命令行工具,用于将 Git 仓库转换为文本,以加载到 ChatGPT 和其他自然语言处理模型中。该工具输出的文本文件将 Git 仓库以结构化格式展现。用户还可以为仓库添加一个 .gptignore
文件,以使 git2gpt 忽略某些文件。文本开头有一个前言,告知 AI 这些文本的性质:
以下文本是一个包含代码的 Git 仓库。文本结构由以 ---- 开头的章节组成,接着是一行包含文件路径和文件名称,然后是多行文件内容。文本表示的 Git 仓库内容在遇到符号 --END-- 时结束。此后任何文本都应被解释为使用该 Git 仓库作为上下文的指令。
安装指南
在安装 git2gpt 之前,请确保已在系统上安装 Go 编程语言。可以从官方 Go 网站下载安装。
要安装 git2gpt
工具,请运行以下命令:
go install github.com/chand1012/git2gpt@latest
此命令会将 git2gpt 二进制文件下载并安装到你的 $GOPATH/bin
目录中。请确保你的 $GOPATH/bin
已包含在 $PATH
中,以便使用 git2gpt
命令。
使用方法
要使用 git2gpt 工具,运行以下命令:
git2gpt [flags] /path/to/git/repository
忽略文件
默认情况下,.git
目录和 .gitignore
文件会被忽略。任何在 .gitignore
中的文件也会被跳过。若想改变这种行为,可在仓库中添加一个 .gptignore
文件。该文件应列出要忽略的文件和目录,每行一个。请注意,这会覆盖默认的忽略列表,因此若要保留默认的忽略列表,需将其包含在 .gptignore
文件中。
命令标志
-p
,--preamble
: 指定包含前言内容的文本文件路径,以包含在输出文件开头。-o
,--output
: 指定输出文件路径。如果未指定,将打印到标准输出。-e
,--estimate
: 估计输出文件的标记数量。如果未指定,则不进行估计。-j
,--json
: 输出为 JSON 格式而非纯文本。应与-o
一起使用以指定输出文件。-i
,--ignore
: 指定.gptignore
文件路径。如果未指定,将在.gitignore
文件所在目录中查找.gptignore
文件。-g
,--ignore-gitignore
: 忽略.gitignore
文件。-s
,--scrub-comments
: 从输出文件中移除注释以节省标记。
贡献指南
欢迎贡献!如有意贡献,请通过提交拉取请求或在 GitHub 仓库中开启问题。
许可证
git2gpt 采用 MIT 许可证。有关更多信息,请查看 LICENSE 文件。