usepr 0.1.6

AI-powered PR summary generator for Git repositories

AI-powered PR summary generator for Git repositories

Explore the Documentation »
Report Bug · Request Feature

Table of Contents

1. About
2. Quick Start
3. Usage
4. Development
5. Contributing
6. License

About

usepr (usepr) is a Python CLI that generates pull request summaries from your git commits using AI (DSPy). It analyzes your commit history and produces well-structured, meaningful PR descriptions.

• AI-powered summaries - Uses DSPy ChainOfThought to understand and summarize your changes
• Template support - Automatically detects and uses PR templates from your repository
• Flexible diffing - Generate summaries between any branches, tags, or commits
• Interactive prompts - Guided workflow with base branch and issue selection
• Clipboard integration - Copy generated summaries directly to clipboard
• Model override - Use different LLM models via the -m flag

(back to top)

Quick Start

Install usepr with uv (recommended)

uv tool install usepr

Install with pipx (alternative)

pipx install usepr

Generate a PR summary

usepr generate

This will prompt you to select a base branch, optionally link related issues, and generate a summary from your commits.

(back to top)

Usage

Generate a PR Summary

usepr generate

The interactive workflow will:

1. Detect your repository's default branch
2. Prompt for a base branch to diff against
3. Gather commits between base and HEAD
4. Ask for related issues (optional)
5. Detect and offer PR templates (if any)
6. Generate and display the summary
7. Offer to copy to clipboard

Use a Custom Model

Set your API key as an environment variable for the provider you're using:

export OPENAI_API_KEY="sk-..."
export ANTHROPIC_API_KEY="sk-ant-..."

Then run with the provider/model format:

usepr generate -m openai/gpt-4o
usepr generate -m anthropic/claude-sonnet-4-20250514
usepr generate -m openrouter/google/gemini-2.5-flash

Use the Short Alias

usepr gen

Available Commands

generate (gen)  Generate a PR summary from commits
help            Show help

(back to top)

Development

Common tasks:

uv run poe clean-full
uv run poe test
uv run poe lint
uv run poe format

(back to top)

Contributing

Quick workflow:

1. Fork and branch: git checkout -b feature/name
2. Make changes
3. Run checks: uv run poe clean-full
4. Commit and push
5. Open a Pull Request

(back to top)

License

License information has not been added yet.

(back to top)

---

_{Built by thememium}