CodePress Review

A turnkey GitHub Action for automatic, inline code review on every Pull Request using LLMs (OpenAI, Anthropic, Google Gemini, Cohere, Mistral, Groq, DeepSeek, and more).

Features

🤖 AI-Powered Reviews: Use GPT-4, Claude, Gemini, Groq, DeepSeek, and more to power your PRs
🔑 BYOK + OS: 100% open source. Install as a github action, and use your own key
💬 Inline Comments: Posts line-level feedback directly on PRs
📄 Smart PR Descriptions: Automatically generates structured PR descriptions for blank PRs
🔄 Provider Agnostic: Easily switch between 11+ LLM providers including self-hosted models
📝 Smart Chunking: Handles large diffs efficiently
🛡️ Robust: Built-in retries, rate limiting, and error handling
⚡ Zero Setup: Just add to your github action workflows
🎯 Customizable: Use custom review guidelines via configuration file
🚨 Blocking-Only Mode: Focus only on critical issues that must be fixed before approval

Quick Start

Add this workflow to your repository at .github/workflows/codepress-review.yml:

name: CodePress Review

on:
  pull_request:
    types: [opened, reopened, review_requested] #synchronize
  issue_comment:
    types: [created]
  workflow_dispatch: # Allow manual triggering

permissions:
  pull-requests: write
  contents: read
  issues: read

jobs:
  ai-review:
    runs-on: ubuntu-latest
    steps:
      - name: CodePress Review
        uses: quantfive/codepress-review@v3
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          model_provider: "openai"
          model_name: "o4-mini"
          openai_api_key: ${{ secrets.OPENAI_API_KEY }}
          # All trigger configurations use sensible defaults
          # + synchronize event runs automatically when included in workflow

Configuration

Required Secrets

Add these to your repository's Settings → Secrets and variables → Actions (only add the ones for providers you plan to use):

Secret	Provider	Description
`OPENAI_API_KEY`	OpenAI	Your OpenAI API key
`ANTHROPIC_API_KEY`	Anthropic	Your Anthropic API key
`GEMINI_API_KEY`	Google/Gemini	Your Google AI API key
`COHERE_API_KEY`	Cohere	Your Cohere API key
`MISTRAL_API_KEY`	Mistral	Your Mistral API key
`PERPLEXITY_API_KEY`	Perplexity	Your Perplexity API key
`FIREWORKS_API_KEY`	Fireworks	Your Fireworks API key
`GROQ_API_KEY`	Groq	Your Groq API key
`XAI_API_KEY`	xAI	Your xAI API key
`DEEPSEEK_API_KEY`	DeepSeek	Your DeepSeek API key
`OPENAI_COMPATIBLE_API_KEY`	OpenAI-Compatible	API key for self-hosted OpenAI-compatible APIs
`OLLAMA_API_KEY`	Ollama	API key for Ollama (often not needed)

Input Parameters

Input	Required	Default	Description
`github_token`	✅	`${{ github.token }}`	GitHub token for API access
`model_provider`	✅	`openai`	AI provider (see Supported Providers)
`model_name`	✅	`gpt-4o`	Model name (see examples below)
`openai_api_key`	⚠️		Required if using OpenAI
`anthropic_api_key`	⚠️		Required if using Anthropic
`gemini_api_key`	⚠️		Required if using Google/Gemini
`cohere_api_key`	⚠️		Required if using Cohere
`mistral_api_key`	⚠️		Required if using Mistral
`perplexity_api_key`	⚠️		Required if using Perplexity
`fireworks_api_key`	⚠️		Required if using Fireworks
`groq_api_key`	⚠️		Required if using Groq
`xai_api_key`	⚠️		Required if using xAI
`deepseek_api_key`	⚠️		Required if using DeepSeek
`openai_compatible_api_key`	⚠️		Required if using OpenAI-compatible provider
`openai_compatible_base_url`	⚠️		Required if using OpenAI-compatible provider
`ollama_api_key`	❌		API key for Ollama (optional, often not needed)
`ollama_base_url`	❌	`localhost:11434/v1`	Base URL for Ollama instance
`max_turns`	❌	`12`	Maximum turns for interactive agent review
`update_pr_description`	❌	`true`	Auto-generate PR descriptions for blank PRs
`blocking_only`	❌	`false`	Only generate comments for critical/blocking issues
`debug`	❌	`false`	Enable debug mode for detailed console logs
`run_on_pr_opened`	❌	`true`	Run review when PR is opened
`run_on_pr_reopened`	❌	`true`	Run review when PR is reopened
`run_on_review_requested`	❌	`true`	Run review when re-review requested from github-actions[bot]
`run_on_comment_trigger`	❌	`true`	Run review when comments contain trigger phrase
`comment_trigger_phrase`	❌	`"@codepress/review"`	Phrase that triggers review in comments

Triggering Reviews

Beyond the default behavior of reviewing new PRs, you can configure CodePress to run on-demand or on every push.

Review on Every Push (Optional)

To trigger reviews whenever new commits are pushed to a PR, add synchronize to your trigger types:

on:
  pull_request:
    types: [opened, reopened, synchronize] # Added synchronize

Note: This will run a review on every push to the PR branch, which may increase costs and generate more review comments. Consider your team's workflow and budget when enabling this.

On-Demand via PR Comments

You can trigger a new review at any time by posting a comment containing @codepress/review on the pull request. This feature is enabled by default and works automatically when you include issue_comment triggers in your workflow.

Basic setup with comment triggers:

name: CodePress Review

on:
  pull_request:
    types: [opened, reopened]
  issue_comment:
    types: [created]
  workflow_dispatch: # Allows manual triggering from the Actions tab

permissions:
  pull-requests: write
  contents: read
  issues: read # Required to read PR comments

jobs:
  ai-review:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v4
        with:
          fetch-depth: 0
          ref: ${{ github.event.issue.pull_request && format('refs/pull/{0}/head', github.event.issue.number) || github.ref }}

      - name: CodePress Review
        uses: quantfive/codepress-review@v3
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          model_provider: "openai"
          model_name: "gpt-4o"
          openai_api_key: ${{ secrets.OPENAI_API_KEY }}
          # Comment triggers are enabled by default
          # run_on_comment_trigger: true  # Default
          # comment_trigger_phrase: "@codepress/review"  # Default

To disable comment triggers:

- name: CodePress Review
  uses: quantfive/codepress-review@v3
  with:
    github_token: ${{ secrets.GITHUB_TOKEN }}
    model_provider: "openai"
    model_name: "gpt-4o"
    openai_api_key: ${{ secrets.OPENAI_API_KEY }}
    run_on_comment_trigger: false # Disable comment triggers

To customize the trigger phrase:

- name: CodePress Review
  uses: quantfive/codepress-review@v3
  with:
    github_token: ${{ secrets.GITHUB_TOKEN }}
    model_provider: "openai"
    model_name: "gpt-4o"
    openai_api_key: ${{ secrets.OPENAI_API_KEY }}
    comment_trigger_phrase: "please review" # Custom trigger phrase

Manually from the Actions Tab

With workflow_dispatch enabled in your workflow file (as shown above), you can manually trigger a review for any branch:

Navigate to your repository's Actions tab.
Select the CodePress Review workflow from the list.
Click the Run workflow dropdown.
Choose the branch you want to review and click Run workflow.

The action will automatically find the open pull request associated with that branch and run the review.

Supported Providers

CodePress Review supports 11+ LLM providers through the Vercel AI SDK, including self-hosted options:

Cloud Providers

Provider	Models Available	Notes
OpenAI	`gpt-4o`, `gpt-4o-mini`, `o1-preview`, `o1-mini`	Most popular, reliable
Anthropic	`claude-3-5-sonnet-20241022`, `claude-3-haiku-20240307`	Excellent for code review
Google	`gemini-1.5-pro`, `gemini-1.5-flash`, `gemini-2.0-flash-exp`	Fast and cost-effective
Cohere	`command-r-plus`, `command-r`	Strong reasoning capabilities
Mistral	`mistral-large-latest`, `mistral-small-latest`	European AI alternative
Perplexity	`llama-3.1-sonar-large-128k-online`	Web-connected models
Fireworks	`llama-v3p1-70b-instruct`, `mixtral-8x7b-instruct`	Fast inference
Groq	`llama-3.1-70b-versatile`, `mixtral-8x7b-32768`	Ultra-fast inference
xAI	`grok-beta`	Elon Musk's AI company
DeepSeek	`deepseek-chat`, `deepseek-coder`	Specialized coding models

Self-Hosted Options

Option	Description	Configuration
OpenAI-Compatible	Any API that follows OpenAI's format	Requires `openai_compatible_base_url`
Ollama	Local LLM instances	Defaults to `localhost:11434/v1`

Examples

OpenAI GPT-4o

- name: CodePress Review
  uses: quantfive/codepress-review@v3
  with:
    github_token: ${{ secrets.GITHUB_TOKEN }}
    model_provider: "openai"
    model_name: "gpt-4o"
    openai_api_key: ${{ secrets.OPENAI_API_KEY }}

Anthropic Claude

- name: CodePress Review
  uses: quantfive/codepress-review@v3
  with:
    github_token: ${{ secrets.GITHUB_TOKEN }}
    model_provider: "anthropic"
    model_name: "claude-3-5-sonnet-20241022"
    anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}

Google Gemini

- name: CodePress Review
  uses: quantfive/codepress-review@v3
  with:
    github_token: ${{ secrets.GITHUB_TOKEN }}
    model_provider: "gemini"
    model_name: "gemini-1.5-pro"
    gemini_api_key: ${{ secrets.GEMINI_API_KEY }}

Groq (Ultra-Fast)

- name: CodePress Review
  uses: quantfive/codepress-review@v3
  with:
    github_token: ${{ secrets.GITHUB_TOKEN }}
    model_provider: "groq"
    model_name: "llama-3.1-70b-versatile"
    groq_api_key: ${{ secrets.GROQ_API_KEY }}

DeepSeek (Coding Specialist)

- name: CodePress Review
  uses: quantfive/codepress-review@v3
  with:
    github_token: ${{ secrets.GITHUB_TOKEN }}
    model_provider: "deepseek"
    model_name: "deepseek-coder"
    deepseek_api_key: ${{ secrets.DEEPSEEK_API_KEY }}

Cohere Command R+

- name: CodePress Review
  uses: quantfive/codepress-review@v3
  with:
    github_token: ${{ secrets.GITHUB_TOKEN }}
    model_provider: "cohere"
    model_name: "command-r-plus"
    cohere_api_key: ${{ secrets.COHERE_API_KEY }}

Self-Hosted OpenAI-Compatible API

- name: CodePress Review
  uses: quantfive/codepress-review@v3
  with:
    github_token: ${{ secrets.GITHUB_TOKEN }}
    model_provider: "openai-compatible"
    model_name: "llama-3.1-70b-instruct"
    openai_compatible_api_key: ${{ secrets.OPENAI_COMPATIBLE_API_KEY }}
    openai_compatible_base_url: "https://your-api-endpoint.com/v1"

Local Ollama Instance

- name: CodePress Review
  uses: quantfive/codepress-review@v3
  with:
    github_token: ${{ secrets.GITHUB_TOKEN }}
    model_provider: "ollama"
    model_name: "llama3.1:70b"
    # ollama_base_url: "http://localhost:11434/v1"  # Default
    # ollama_api_key: ""  # Often not needed for local instances

All Other Providers

Click to expand examples for Mistral, Perplexity, Fireworks, and xAI

Mistral

- name: CodePress Review
  uses: quantfive/codepress-review@v3
  with:
    github_token: ${{ secrets.GITHUB_TOKEN }}
    model_provider: "mistral"
    model_name: "mistral-large-latest"
    mistral_api_key: ${{ secrets.MISTRAL_API_KEY }}

Perplexity (Web-Connected)

- name: CodePress Review
  uses: quantfive/codepress-review@v3
  with:
    github_token: ${{ secrets.GITHUB_TOKEN }}
    model_provider: "perplexity"
    model_name: "llama-3.1-sonar-large-128k-online"
    perplexity_api_key: ${{ secrets.PERPLEXITY_API_KEY }}

Fireworks (Fast Inference)

- name: CodePress Review
  uses: quantfive/codepress-review@v3
  with:
    github_token: ${{ secrets.GITHUB_TOKEN }}
    model_provider: "fireworks"
    model_name: "accounts/fireworks/models/llama-v3p1-70b-instruct"
    fireworks_api_key: ${{ secrets.FIREWORKS_API_KEY }}

xAI Grok

- name: CodePress Review
  uses: quantfive/codepress-review@v3
  with:
    github_token: ${{ secrets.GITHUB_TOKEN }}
    model_provider: "xai"
    model_name: "grok-beta"
    xai_api_key: ${{ secrets.XAI_API_KEY }}

With Debug Mode Enabled

- name: CodePress Review (Debug)
  uses: quantfive/codepress-review@v3
  with:
    github_token: ${{ secrets.GITHUB_TOKEN }}
    model_provider: "openai"
    model_name: "gpt-4o"
    openai_api_key: ${{ secrets.OPENAI_API_KEY }}
    debug: true
    max_turns: 20
    update_pr_description: false

Blocking-Only Mode (Critical Issues Only)

For high-velocity teams or repositories that only want comments on truly blocking issues, you can enable blocking_only mode:

- name: CodePress Review (Blocking Only)
  uses: quantfive/codepress-review@v3
  with:
    github_token: ${{ secrets.GITHUB_TOKEN }}
    model_provider: "openai"
    model_name: "gpt-4o"
    openai_api_key: ${{ secrets.OPENAI_API_KEY }}
    blocking_only: true

What Blocking-Only Mode Does:

✅ Only generates "required" severity comments for critical issues that must be fixed before approval
❌ Skips all non-blocking feedback (praise, optional suggestions, nits, informational notes)
🎯 Focuses on: Security vulnerabilities, bugs, critical performance issues, breaking changes
📉 Reduces noise for teams that want minimal, high-signal feedback
⚡ Faster reviews with fewer API calls and lower costs

Perfect for:

High-velocity development teams
Code bases with established style and patterns
Repositories where you primarily want to catch critical issues
Cost-conscious environments wanting minimal token usage

File Filtering and Ignore Patterns

CodePress automatically ignores common files that don't need code review (like node_modules/, lock files, build artifacts, etc.) and also supports custom ignore patterns through a .codepressignore file.

Default Ignore Patterns

CodePress ships with comprehensive default ignore patterns for all major programming languages and frameworks:

Frontend/JavaScript:

node_modules/, *.lock, package-lock.json, yarn.lock, pnpm-lock.yaml
dist/, build/, .next/, .nuxt/, coverage/
*.min.js, *.min.css, *.bundle.js, *.chunk.js

Backend Languages:

Python: __pycache__/, *.pyc, venv/, .venv/, *.egg-info/, .pytest_cache/
Java: *.class, *.jar, .gradle/, .mvn/, target/
C#/.NET: *.dll, *.exe, packages/, bin/, obj/
Ruby: *.gem, .bundle/, vendor/bundle/
Go: vendor/, *.test, go.sum
Rust: target/, Cargo.lock

General:

IDE files: .vscode/, .idea/, *.swp
Logs: *.log, logs/
Environment files: .env, .env.*
Cache and temp: .cache/, .tmp/, .DS_Store

Custom Ignore Patterns

Create a .codepressignore file in your repository root to add your own ignore patterns:

# .codepressignore

# Don't review generated API documentation
docs/api/
*.generated.ts

# Skip test files if desired
*.test.ts
__tests__/

# Large data files
*.json
data/

# Specific files
README.md
CHANGELOG.md

Include Previously Ignored Files

Use the ! prefix to force review of files that would otherwise be ignored by defaults:

# Force review of package-lock.json even though lock files are ignored by default
!package-lock.json

# Review specific config files
!webpack.config.js

Example `.codepressignore`

We provide a .codepressignore.example file showing common patterns you might want to add.

Review Output Format

CodePress Review uses a structured XML format for consistent, rich code review comments. Each finding includes:

Severity: required, optional, nit, or fyi (in blocking-only mode, only required comments are generated)
Inline Comments: Posted directly on the relevant line
Suggestions: Optional code improvements with syntax highlighting
Examples: Optional code blocks demonstrating best practices

Example output format:

<comment>
  <severity>required</severity>
  <file>src/components/Button.tsx</file>
  <line>+  onClick?: () => void;</line>
  <message>Consider making onClick required for better UX - users expect buttons to be interactive.</message>
  <suggestion>+  onClick: () => void;</suggestion>
  <code>
    ```tsx
    interface ButtonProps {
      text: string;
      onClick: () => void; // required for user interaction
    }
    ```
  </code>
</comment>

Two-Pass Review System

CodePress Review uses a sophisticated two-pass review system for enhanced code analysis:

First Pass - Diff Summarization: Analyzes the entire diff to identify PR type, key themes, and risks
Second Pass - Chunk Review: Reviews each code chunk with context from the first pass

This provides global awareness while maintaining focused, line-level feedback.

Automatic PR Description Generation

CodePress Review can automatically generate well-structured PR descriptions for pull requests that don't already have one. This feature is enabled by default and helps maintain consistent documentation across your project.

How It Works

When analyzing a PR, CodePress will:

Check Current Description: Only updates PRs with blank or empty descriptions
Generate Content: Creates a structured description including:
- Brief summary of what the PR accomplishes
- Bulleted list of key changes
- Notable considerations for reviewers
- Proper markdown formatting
Smart Updates: Won't overwrite existing descriptions to preserve manual content

Example Generated Description

## Add User Authentication Service

This PR introduces a new authentication service to handle user login and session management.

**Key Changes:**

- Added AuthService class with JWT token handling
- Integrated authentication middleware for protected routes
- Added user session management and logout functionality
- Updated API endpoints to require authentication

**Review Notes:**

- Please verify the JWT token validation logic
- Ensure proper error handling for invalid credentials
- Check that session cleanup works correctly on logout

Configuration

The feature is controlled by the update_pr_description parameter:

- name: CodePress Review
  uses: quantfive/codepress-review@v3
  with:
    github_token: ${{ secrets.GITHUB_TOKEN }}
    model_provider: "openai"
    model_name: "gpt-4o"
    openai_api_key: ${{ secrets.OPENAI_API_KEY }}
    update_pr_description: "true" # Enable (default)
    # update_pr_description: "false"  # Disable

Large PR Processing

Very large PRs may hit token limits or timeout
Consider using .codepressignore to exclude generated files, .codepressignore follows .gitignore conventions

Custom Description Guidelines

You can customize PR description generation by modifying the summary guidelines in your custom-codepress-summary-prompt.md file. The AI will use your custom instructions when generating descriptions.

Custom Review Guidelines

You can customize the review behavior by creating a custom-codepress-review-prompt.md file in the root of your repository. If this file exists, CodePress will use your custom guidelines instead of the default ones.

Creating Custom Guidelines

Create a file named custom-codepress-review-prompt.md in your repository root:

# My Custom Review Guidelines

You are a code reviewer focusing on:

- Security vulnerabilities and best practices
- Performance optimization opportunities
- Code maintainability and readability
- Proper error handling

Use these severity levels:

- **required**: Critical issues that must be fixed
- **optional**: Suggestions for improvement
- **nit**: Minor style or polish issues
- **fyi**: Informational notes

Example Custom Guidelines

Security-Focused Review

# Security-Focused Code Review

You are a security expert reviewing code for vulnerabilities. Focus on:

## Security Priorities

- Authentication and authorization issues
- Input validation and sanitization
- SQL injection, XSS, and CSRF vulnerabilities
- Sensitive data exposure
- Cryptographic implementations
- Third-party dependency vulnerabilities

## Severity Guidelines

- **required**: Critical security vulnerabilities that expose the system to attack
- **optional**: Security improvements that enhance the overall security posture
- **nit**: Minor security polish (logging, error messages)
- **fyi**: Security-related information for future consideration

Always explain the potential impact of security issues and provide concrete remediation steps.

Performance-Focused Review

# Performance-Focused Code Review

You are a performance optimization expert. Review this code for:

## Performance Areas

- Inefficient algorithms and data structures
- Memory leaks and excessive allocations
- Database query optimization opportunities
- Caching and batching improvements
- Network request optimization
- Unnecessary computations or iterations

## Guidelines

- Provide concrete performance improvements with estimated impact
- Suggest specific optimizations with code examples
- Identify potential bottlenecks and scaling issues
- Focus on measurable improvements

Use **required** for critical performance issues, **optional** for optimizations.

Beginner-Friendly Review

# Beginner-Friendly Code Review

You are a patient mentor reviewing code from a junior developer. Your feedback should be:

## Mentoring Approach

- Educational and encouraging
- Explain the "why" behind suggestions
- Include code examples when helpful
- Focus on learning opportunities
- Provide resources for further learning

## Tone Guidelines

- Use positive, constructive language
- Acknowledge good practices when you see them
- Offer alternatives rather than just pointing out problems
- Encourage best practices without being overwhelming

Prefer **optional** for learning opportunities, **nit** for style, **fyi** for educational notes.

Custom Summarization Guidelines

You can also customize the initial diff summarization by creating a custom-codepress-summary-prompt.md file in your repository root. This allows you to tailor how CodePress analyzes and summarizes your pull requests.

Creating Custom Summary Guidelines

Create a file named custom-codepress-summary-prompt.md in your repository root:

# Custom PR Summary Guidelines

You are analyzing a complete pull request. Focus on:

## Analysis Priorities

- API design and breaking changes
- Cross-service dependencies
- Database migration impacts
- Performance implications at scale
- Security considerations in architectural changes

## Classification Guidelines

- Classify the PR type accurately: feature | bugfix | refactor | docs | test | chore | dependency-bump | mixed
- Identify key architectural concerns that reviewers should be aware of
- Highlight any risks that span multiple files or components

## Output Focus

- Provide concise, actionable insights for individual chunk reviewers
- Flag cross-cutting concerns that might not be obvious from individual file changes
- Emphasize testing strategies for complex changes

Debugging and Troubleshooting

Debug Mode

When troubleshooting issues or developing locally, you can enable detailed debug logging:

- name: CodePress Review
  uses: quantfive/codepress-review@v3
  with:
    github_token: ${{ secrets.GITHUB_TOKEN }}
    model_provider: "openai"
    model_name: "gpt-4o"
    openai_api_key: ${{ secrets.OPENAI_API_KEY }}
    debug: true # Enable detailed logging

Debug mode provides:

Detailed processing logs for each diff chunk
Raw AI model responses before parsing
Rate limiting and retry information
GitHub API call details
Agent interaction logs (v2 only)
Error stack traces and context

Note: Debug mode significantly increases log output. Only enable when troubleshooting specific issues. Always disable in production to keep action logs clean.

Common Issues

Reviews Not Appearing

Check that the action has pull-requests: write permission
Verify the correct API key is provided for your model provider
Enable debug mode to see detailed error logs

Rate Limiting

CodePress automatically handles GitHub API rate limits with exponential backoff
For high-volume repositories, consider using a dedicated PAT with higher rate limits
Debug mode shows rate limit details and retry attempts

Cost & Performance Caveats

LLM usage may incur costs depending on provider/model.
Review time and cost scale with diff size and model selection.

Fork Safety

If you want to run this bot on PRs from forks, use pull_request_target instead of pull_request in your workflow trigger. Warning: This exposes repository secrets to forked PRs. For maximum safety, use a low-privilege Personal Access Token (PAT) with only pull-requests: write and contents: read scopes, and store it as a secret (e.g., REVIEW_BOT_TOKEN).

Update the workflow:

on:
  pull_request_target:
    types: [opened, reopened, synchronize]

And set:

env:
  GITHUB_TOKEN: ${{ secrets.REVIEW_BOT_TOKEN }}

Version Comparison

v2 (Current) - Interactive Agent Architecture

CodePress Review v2 introduces a sophisticated interactive agent system powered by OpenAI's agents framework:

🤖 Interactive Tools: Agent can fetch additional file context, analyze dependencies, and explore code relationships
🔍 Smart Context Gathering: When reviewing diffs, the agent can request full file contents or specific code snippets for better understanding
📊 Dependency Analysis: Built-in tools to analyze import/export relationships and project structure
🎯 Context-Aware Reviews: No more false positives from missing context - the agent sees the full picture
⚡ Adaptive Processing: Agent determines when additional context is needed and fetches it automatically

Key Benefits of v2:

Eliminates incorrect comments about "missing" code that exists outside diff chunks
Provides more accurate reviews by understanding full file context
Reduces false positives for unused imports, missing migrations, etc.
Offers deeper architectural insights through dependency analysis

v1 (Legacy) - Static Diff Review

CodePress Review v1 uses a traditional static approach:

📝 Diff-Only Analysis: Reviews only the visible diff chunks without additional context
🚀 Faster Processing: Single-pass review with no additional API calls
💰 Lower Cost: Minimal token usage per review
⚠️ Limited Context: May miss relationships between files or make assumptions about missing code

When to Use v1:

Cost-sensitive environments where minimal token usage is priority
Simple codebases where diff context is usually sufficient
Legacy workflows that don't require advanced context analysis

Migration Guide

To use v1 instead of v2, simply change the version in your workflow:

# For v2 (recommended - interactive agent)
uses: quantfive/codepress-review@v3

# For v1 (legacy - static diff review)
uses: quantfive/codepress-review@v1

Note: v2 is the recommended version for most use cases due to its superior accuracy and context awareness.

Technical Architecture

This project uses the Vercel AI SDK (ai package) for universal LLM provider support. The system:

Universal Provider Support: 11+ LLM providers through unified AI SDK interface
Self-Hosted Compatibility: Support for OpenAI-compatible APIs and Ollama instances
Clean TypeScript Functions: System prompts managed in src/system-prompt.ts
Proper Message Structure: Uses system prompt for guidelines + user prompt for diff content
Preserved Response Format: Always includes XML <responseFormat> regardless of custom prompts
Structured XML Output: Parses XML responses for rich comment formatting
Severity System: required, optional, nit, fyi with emoji indicators
Hunk-Based Processing: Each diff hunk processed individually for focused reviews
Line Resolution: Handles line number mapping from diff context
File-Based Customization: Custom review guidelines from custom-codepress-review-prompt.md and summary guidelines from custom-codepress-summary-prompt.md
Interactive Agent Tools (v2): fetch_files (multi-file), fetch_snippet, and dep_graph for enhanced context gathering
Provider Configuration: Automatic API key detection and provider-specific configuration

Name		Name	Last commit message	Last commit date
Latest commit History 223 Commits
.cursor/rules		.cursor/rules
.github		.github
src		src
test		test
.codepressignore		.codepressignore
.codepressignore.example		.codepressignore.example
.eslintrc.json		.eslintrc.json
.gitignore		.gitignore
.prettierignore		.prettierignore
.prettierrc		.prettierrc
CLAUDE.md		CLAUDE.md
ENHANCED_COMMENT_RESOLUTION.md		ENHANCED_COMMENT_RESOLUTION.md
FILE_STRUCTURE.md		FILE_STRUCTURE.md
LICENSE		LICENSE
README.md		README.md
TRIGGER_CONFIGURATION.md		TRIGGER_CONFIGURATION.md
action.yml		action.yml
debug-pr-description.md		debug-pr-description.md
eslint.config.mjs		eslint.config.mjs
jest.config.js		jest.config.js
package.json		package.json
pnpm-lock.yaml		pnpm-lock.yaml
tsconfig.json		tsconfig.json
types.ts		types.ts

License

quantfive/codepress-review

Folders and files

Latest commit

History

Repository files navigation

CodePress Review

Features

Quick Start

Configuration

Required Secrets

Input Parameters

Triggering Reviews

Review on Every Push (Optional)

On-Demand via PR Comments

Manually from the Actions Tab

Supported Providers

Cloud Providers

Self-Hosted Options

Examples

OpenAI GPT-4o

Anthropic Claude

Google Gemini

Groq (Ultra-Fast)

DeepSeek (Coding Specialist)

Cohere Command R+

Self-Hosted OpenAI-Compatible API

Local Ollama Instance

All Other Providers

Mistral

Perplexity (Web-Connected)

Fireworks (Fast Inference)

xAI Grok

With Debug Mode Enabled

Blocking-Only Mode (Critical Issues Only)

File Filtering and Ignore Patterns

Default Ignore Patterns

Custom Ignore Patterns

Include Previously Ignored Files

Example .codepressignore

Review Output Format

Two-Pass Review System

Automatic PR Description Generation

How It Works

Example Generated Description

Configuration

Large PR Processing

Custom Description Guidelines

Custom Review Guidelines

Creating Custom Guidelines

Example Custom Guidelines

Security-Focused Review

Performance-Focused Review

Beginner-Friendly Review

Custom Summarization Guidelines

Creating Custom Summary Guidelines

Debugging and Troubleshooting

Debug Mode

Common Issues

Reviews Not Appearing

Rate Limiting

Cost & Performance Caveats

Fork Safety

Version Comparison

v2 (Current) - Interactive Agent Architecture

v1 (Legacy) - Static Diff Review

Migration Guide

Technical Architecture

About

Resources

License

Uh oh!

Stars

Watchers

Forks

Releases 17

Packages 0

Contributors 2

Uh oh!

Languages

Example `.codepressignore`

Packages