Quick Start
1. Create an Account
- Go to PeerReview and create a free account
- Once registered, you'll receive your API key in your dashboard
2. Install the GitHub App
- Go to PeerReview GitHub App
- Click "Configure" to install the app
- Select the repositories where you want to enable AI code reviews
- Click "Install"
3. Add Required Secret
- Go to your repository's Settings → Secrets and variables → Actions
- Add the following secret:
PEERREVIEW_API_KEY: Your PeerReview API key
Configuration
Add this to your repository's .github/workflows/peerreview.yml:
name: PeerReview
on:
pull_request:
types: [opened, synchronize, reopened]
jobs:
peer-review:
runs-on: ubuntu-latest
permissions:
contents: read
pull-requests: write
steps:
- uses: actions/checkout@v4
- name: Run PeerReview
uses: PeerReview-ai/[email protected]
with:
api-key: ${{ secrets.PEERREVIEW_API_KEY }}
api-endpoint: https://api.getpeerreview.com
review-type: full # optional: full, focused, or securityConfiguration Options
| Input | Description | Required | Default |
|---|---|---|---|
| api-key | API key for the PeerReview service | Yes | - |
| api-endpoint | The endpoint URL of the PeerReview service | Yes | - |
| review-type | Type of review to perform (full, focused, security) | No | full |
| installation-id | GitHub App installation ID (if known) | No | - |
Outputs
| Output | Description |
|---|---|
| review-completed | Whether the review was completed successfully |
| error | Error message if the review failed |
Frequently Asked Questions
How does the AI review process work?
Our AI analyzes your pull requests by examining code changes, commit history, and related files. It provides instant feedback on code quality, potential issues, and best practices, helping you maintain high standards while saving time on manual reviews.
Is my code data secure?
Absolutely. We never store your code. Our AI analyzes your pull requests in real-time and provides feedback without retaining any of your code. All communication is encrypted, and we follow industry best practices for security.
What happens if I exceed my monthly PR limit?
You'll receive notifications when you're approaching your limit. Once reached, you can either upgrade your plan for more reviews or wait until your next billing cycle. We never charge overage fees - you simply need to upgrade to continue using the service.