pr-buddy
is a command-line tool designed to help automate the creation of Pull Request (PR) documentation. It reads your latest Git commit and generates a PR description in markdown format based on a customizable template.
- Generate a PR description based on your latest Git commit.
- Use a markdown template to customize your PR documentation.
- Easily install and set up AI assistance if needed.
You can install pr-buddy
globally using either Bun or npm.
You need to have bun installed since core modules depend on bun
To install bun via npm
npm install -g bun
bun add -g pr-buddy-bun
npm i -g pr-buddy-bun
Once installed, you can initialize the tool using the following command:
pr-buddy init
This will start the interactive CLI.
To create a PR document based on your latest Git commit, run:
pr-buddy init
Then choose the Create PR
option. pr-buddy
will read the latest commit and generate a Pull Request description in markdown format, which you can use as your PR documentation.
pr-buddy
allows you to customize the generated PR document using a markdown template. Simply provide a template.md
file that follows the structure you need for your PRs. An example of the template format can be found in the GitHub repository.
pr-buddy init
# Choose 'Create PR'
# A PR markdown file will be generated based on the latest Git commit.
This project is licensed under the MIT License. See the LICENSE file for details.