LLM PR Helper is an automated tool designed to simplify the process of creating pull requests for developers. It uses language models via the llm command-line tool to analyze the changes introduced in a Git branch and generates a concise and informative title and body for the pull request.

1. Prerequisites
   • GitHub CLI (gh)
   • llm
2. Functionality
3. Usage
4. Customization
5. Issues and Feedback
6. License

Install by running one of the commands below:

pip install llm
brew install llm
pipx install llm

After installing:

llm keys set openai
# Follow the prompts to input your OpenAI API key

If not installed, the script won't actually create a Pull Request, but will generate and output a title and body.

Installed using preferred method as per the official guide.

brew install gh

sudo mkdir -p -m 755 /etc/apt/keyrings && wget -qO- https://cli.github.com/packages/githubcli-archive-keyring.gpg | sudo tee /etc/apt/keyrings/githubcli-archive-keyring.gpg > /dev/null \
&& sudo chmod go+r /etc/apt/keyrings/githubcli-archive-keyring.gpg \
&& echo "deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/githubcli-archive-keyring.gpg] https://cli.github.com/packages stable main" | sudo tee /etc/apt/sources.list.d/github-cli.list > /dev/null \
&& sudo apt update \
&& sudo apt install gh -y

Authenticate using gh auth login. The GITHUB_TOKEN environment variable is also supported.

Set up ~/.config/prompts/ with pr-title-prompt.txt and pr-body-prompt.txt.

To use the script, you may need to make it executable with chmod +x and then you can run it directly from your terminal:

./pr.sh

To ensure the tool is easily accessible from any location on your system, you may create a symbolic link (symlink) to the pr.sh script in a directory that's included in your PATH. Alternatively, add the directory with the script to your PATH.

For an extra cool trick, add a git alias:

git config --global alias.pr '!pr.sh'

then your flow can be like so:

git commit -a
git push
git pr

The llm tool uses separate .txt files for PR titles and bodies, so they can be adapted to your needs.

Write a concise, informative pull request title:

* It should be a very short summary in imperative mood
* Explain the 'why' behind changes more so than the changes
* Keep the title under 50 characters
* If there are no changes, or the input is blank - then return a blank string

Think carefully before you write your title.

What you write will be passed to create the title of a github pull request

Write a clear, informative pull request message in markdown:

* Remember to mention the files that were changed, and what was changed
* Start with a summary
* Explain the 'why' behind changes
* Include a bulleted list to outline all of the changes
* If there are changes that resolve specified issues add the issues to a list of closed issues
* If there are no changes, or the input is blank - then return a blank string

Think carefully before you write your pull request body.

What you write will be passed to create a github pull request

Report issues or provide feedback at [email protected] or via the issue tracker.

Released under the MIT License, see LICENSE.