git2gpt

git2gpt

git2gpt 是一个命令行实用程序，可将 Git 存储库转换为文本以加载到 ChatGPT 和其他 NLP 模型中。输出文本文件以结构化格式表示 Git 存储库。您还可以将.gptignore文件添加到您的存储库中，以使 git2gpt 忽略某些文件。该文本以序言为前缀，向 AI 解释该文本是什么：

以下文本是包含代码的 Git 存储库。文本的结构是以 ---- 开头的部分，后跟包含文件路径和文件名的单行，最后是包含文件内容的可变数量的行。当遇到符号 --END-- 时，表示 Git 存储库的文本结束。 --END-- 之外的任何其他文本都将被解释为使用上述 Git 存储库作为上下文的指令。

安装

首先，确保您的系统上安装了 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文件应包含要忽略的文件和目录列表，每行一个。 .gptignore文件应与.gitignore文件位于同一目录中。请注意，这会覆盖默认的忽略列表，因此如果您想保留默认的忽略列表，则应将其包含在.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 许可证获得许可。有关详细信息，请参阅许可证文件。