Skip to content

Promptr is a CLI tool that lets you use plain English to instruct GPT3 or GPT4 to make changes to your codebase.

License

Notifications You must be signed in to change notification settings

ferrislucas/promptr

Repository files navigation

Promptr

Promptr is a CLI tool that lets you use plain English to instruct OpenAI LLM models to make changes to your codebase. Changes are applied directly to the files that you reference from your prompt.

Usage

promptr [options] -p "your instructions" <file1> <file2> <file3> ...

I've found this to be a good workflow:

  • Commit any changes, so you have a clean working area.
  • Author your prompt in a file. The prompt should be specific clear instructions.
  • Make sure your prompt contains the relative paths of any files that are relevant to your instructions.
  • Use Promptr to execute your prompt. Provide the path to your prompt file using the -p option: promptr -p my_prompt.txt

Promptr will apply the model's code directly to your files. Use your favorite git UI to inspect the results.





Examples

The PR's below are good examples of what can be accomplished using Promptr. You can find links to the individual commits and the prompts that created them in the PR descriptions.

Templating

Promptr supports templating using liquidjs, which allows users to incorporate templating commands within their prompt files. This feature enhances the flexibility and reusability of prompts, especially when working on larger projects with repetitive patterns or standards.

Using Includes