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
: 估算输出文件的 tokens 数量。如果未指定,则不进行估算。-j
,--json
: 以 JSON 格式输出,而不是纯文本。使用-o
指定输出文件。-i
,--ignore
:.gptignore
文件的路径。如果未指定,将在与.gitignore
文件相同的目录中查找.gptignore
文件。-g
,--ignore-gitignore
: 忽略.gitignore
文件。-s
,--scrub-comments
: 从输出文件中删除注释以节省 tokens。
贡献
欢迎贡献!要贡献,请提交拉取请求或在 GitHub 仓库中打开一个 issue。
许可证
git2gpt 根据 MIT 许可证授权。更多信息请查看 LICENSE 文件。