@yourorg/ai-pr

AI-powered Pull Request automation tool using GitHub Copilot CLI for intelligent code review and auto-fixing.

Quick Start

npx @yourorg/ai-pr

What It Does

1. 🔍 Generates diff against main branch
2. 🤖 AI reviews and auto-fixes using GitHub Copilot CLI with full tool access
3. 🚀 Commits, pushes, and creates PR automatically if approved

All in a single automated workflow!

Features

• ✅ Automated code review and fixing using AI
• 🔧 Single-command workflow
• 📋 Customizable review rules
• 🎯 Cross-platform (Windows/Linux/macOS)
• 🚀 Zero configuration required

Prerequisites

Prerequisites

• Node.js v18+
• Git
• GitHub CLI (gh) - Install here
• GitHub Copilot CLI - gh extension install github/gh-copilot
• GitHub Copilot Pro/Enterprise license

Installation & Usage

# Simple one-command usage
npx @yourorg/ai-pr

That's it! The tool automatically:

• Creates .pr/ directory with necessary files
• Generates diff against main branch
• Reviews code using AI with full tool access
• Applies fixes if needed
• Commits, pushes, and creates PR if approved

Customization

Custom Review Rules

Create templates/review-rules.md in your repo to override default rules:

# My Custom Review Rules
- Check for TypeScript types
- Ensure all functions have JSDoc
- Validate React component props

Config File

Create .ai-pr.yml in your repo root:

rules: "./.ai-pr/review-rules.md"
titlePattern: "AI PR: {branch} {date}"

How It Works

1. Diff Generation: Compares your branch with main branch
2. AI Review & Fix: Uses GitHub Copilot CLI with full tool access to:
   • Analyze code against review rules
   • Apply fixes directly to source files if needed
   • Commit changes with "Auto-fix: Apply code review suggestions"
   • Push changes to current branch
   • Create pull request with review results
3. Single Workflow: Everything happens in one automated process

File Structure

When you run the tool, it creates:

your-repo/
├── .pr/
│   ├── diff.patch      # Generated diff
│   └── REVIEW.md       # AI review results
├── templates/          # (optional) Custom rules
│   └── review-rules.md
└── .ai-pr.yml         # (optional) Config file

Review Outcomes

• APPROVED: Code is ready, automated commit/push/PR creation
• REQUEST CHANGES: Issues found and automatically fixed, then approved

Security & Privacy

• No code is sent to external services (except GitHub's Copilot API)
• All processing happens locally
• Review artifacts stored in .pr/ (automatically added to .gitignore)

Troubleshooting

Common Issues

Command not found: Make sure GitHub CLI and Copilot CLI extension are installed

gh --version
gh extension install github/gh-copilot

Permission denied: Ensure Copilot has --allow-all-tools permission

Contributing

Issues and PRs welcome! See INSTRUCTIONS.md for detailed setup guide.

License

ISC