Promptr

Promptr 是一个命令行工具，让你能够使用简单的英语指令来指导 OpenAI 的 LLM 模型对你的代码库进行修改。这些修改会直接应用到你在提示中引用的文件中。

使用方法

promptr [选项] -p "你的指令" <文件1> <文件2> <文件3> ...

我发现以下工作流程效果不错：

• 提交所有更改，保持工作区干净。
• 在一个文件中编写你的提示。提示应该是具体明确的指令。
• 确保你的提示包含与你的指令相关的任何文件的相对路径。
• 使用 Promptr 执行你的提示。使用 -p 选项提供你的提示文件路径： promptr -p my_prompt.txt

Promptr 会将模型生成的代码直接应用到你的文件中。使用你喜欢的 git 界面来检查结果。

示例

以下 PR 是使用 Promptr 能够完成的很好的例子。你可以在 PR 描述中找到各个提交的链接以及创建它们的提示。

• https://github.com/ferrislucas/promptr/pull/38
• https://github.com/ferrislucas/promptr/pull/41

模板使用

Promptr 支持使用 liquidjs 进行模板化，这允许用户在他们的提示文件中包含模板命令。这个功能增强了提示的灵活性和可重用性，特别是在处理具有重复模式或标准的大型项目时。

使用包含文件

项目可以有一个或多个"包含文件"——可重用的代码片段或指令——可以从提示文件中引用。这些包含文件可能包含项目特定的标准、指令或代码模式，使用户能够在整个代码库中保持一致性。

例如，你可能有一个名为 _project.liquid 的包含文件，内容如下：

本项目使用 Node 18 版本。
使用 yarn 进行依赖管理。
在 Javascript 中使用 import 而不是 require。
不要在 Javascript 类的底部包含 `module.exports`。
按字母顺序排列方法名和变量声明。

在你的提示文件中，你可以使用 liquidjs 的 render 函数来包含这个包含文件：

{% render '_project.liquid' %}
// 你的提示在这里

这种方法允许开发可重用的包含文件，可以在多个项目间共享或在同一项目的不同部分使用。

示例用例

• 项目范围的编码标准：创建一个包含文件，概述编码标准，并将其包含在项目的每个新代码文件中。

• 样板代码：为应用程序的不同部分（如模型定义、API 端点）开发一组样板代码片段，并根据需要包含它们。

• 共享指令：维护一组特定任务的指令或指南（如如何记录函数），并将它们包含在相关的提示文件中。

通过利用模板功能，提示工程师可以显著减少冗余并确保提示创建的一致性，从而导致对代码库进行更高效和标准化的修改。

选项

选项	描述
-p, --prompt <prompt>	指定在非交互模式下使用的提示。也可以指定路径或 URL - 在这种情况下，指定路径或 URL 的内容将被用作提示。提示可以利用 liquidjs 模板系统。
-m, --model <model>	可选标志，用于设置模型，默认为 gpt-4o。使用值 "gpt3" 将使用 gpt-3.5-turbo 模型。
-d, --dry-run	可选的布尔标志，可用于在干运行模式下运行工具，仅显示将发送给模型的提示。使用此选项时不会对文件系统进行任何更改。
-i, --interactive	可选的布尔标志，启用交互模式，用户可以交互式地提供输入。如果未设置此标志，工具将在非交互模式下运行。
`-t, --template <templateName	templatePath
-x	可选的布尔标志。使用默认模板时，Promptr 解析模型的响应并将结果操作应用到你的文件系统。只有在你创建了自己的模板，并且希望 Promptr 以与内置 "refactor" 模板输出相同的方式解析和应用输出到文件系统时，才需要传递 -x 标志。
-o, --output-path <outputPath>	可选的字符串标志，指定输出文件的路径。如果未设置此标志，输出将打印到标准输出。
-v, --verbose	可选的布尔标志，启用详细输出，在执行过程中提供更详细的信息。
-dac, --disable-auto-context	防止在提示中引用的文件自动包含在发送给模型的上下文中。
--version	显示版本并退出

可以指定额外的参数来指定将作为上下文包含在提示中的文件路径。参数应该用空格分隔。

要求

• Node 18
• OpenAI 的 API 密钥
• 在 OpenAI 中设置账单

安装

使用 yarn

yarn global add @ifnotnowwhen/promptr

使用 npm

npm install -g @ifnotnowwhen/promptr

使用发布的二进制文件

你可以通过将当前版本的二进制文件复制到你的路径来安装 Promptr。目前只支持 MacOS。

设置 OpenAI API 密钥

需要一个名为 OPENAI_API_KEY 的环境变量来存储你的 OpenAI API 密钥。

使用 PKG 构建二进制文件

npm run bundle

npm run build:<platform win|macos|linux>

npm run test-binary

许可证

Promptr 根据 MIT 许可证 发布。