prxref
Fast automated AI code review for Bitbucket, GitLab, and GitHub — Cloud and self-hosted.
prxref inspects pull and merge requests across the three major code hosting forges in sub-minute review cycles. It parses unified diffs, partitions changes into risk-ranked chunks, fans out parallel single-shot LLM reviews across a cheap-first model fallback chain, filters findings through deterministic quality gates, and publishes inline comments alongside an executive summary.
┌──────────────────────┐
│ Pull / MR URL │
└──────────┬───────────┘
│
▼
┌──────────────────────┐
│ detect_forge │
└──────────┬───────────┘
│
▼
┌──────────────────────┐
│ Forge Adapter │
│ (BB / GitHub / GL) │
└──────────┬───────────┘
│
▼
┌──────────────────────┐
│ Unified Diff │
└──────────┬───────────┘
│
▼
┌──────────────────────┐
│ Risk-Ranked Chunking │
└──────────┬───────────┘
│
▼
┌──────────────────────┐
│ Parallel LLM Workers │
│ (Fallback Chain) │
└──────────┬───────────┘
│
▼
┌──────────────────────┐
│ Quality Gate │
│ Line Align / Dedup │
└──────────┬───────────┘
│
▼
┌──────────────────────┐
│ Post Inline Comments │
│ + Summary │
└──────────────────────┘
Quickstart
Run reviews instantly without local installation using uvx, or install the CLI globally:
# Run one-shot review via uvx
uvx prxref review --pr-url https://github.com/org/repo/pull/123
# Or install tool globally
uv tool install prxref
prxref review --pr-url https://github.com/org/repo/pull/123
# Or install straight from source (works before the first PyPI release)
uv tool install git+https://github.com/sblattj/prxref
Review Any Forge
Pass any PR or MR URL directly. Forge type, repository namespace, and pull request ID are detected automatically:
# Bitbucket Cloud
prxref review --pr-url https://bitbucket.org/workspace/repo/pull-requests/42
# Bitbucket Server / Data Center (self-hosted, any host, with or without a deployment context path)
prxref review --pr-url https://bitbucket.corp.example/projects/PLAT/repos/api/pull-requests/42
# ...including a plain-HTTP deployment, e.g. the standalone install's default port
prxref review --pr-url http://bitbucket.internal:7990/projects/PLAT/repos/api/pull-requests/42
# GitHub & GitHub Enterprise
prxref review --pr-url https://github.com/owner/repository/pull/108
# GitLab & Self-Hosted GitLab (including nested subgroups)
prxref review --pr-url https://gitlab.com/group/subgroup/project/-/merge_requests/15
Supported hosts. Every forge is supported on any host. GitHub Enterprise Server and self-hosted GitLab share one adapter each with their SaaS products, which speak the same REST API at a different base URL. Bitbucket does not: Server / Data Center speaks /rest/api/1.0 against different resource shapes, so it is a separate adapter selected automatically from the URL — PRXREF_BITBUCKET_SERVER_TOKEN for Data Center, PRXREF_BITBUCKET_TOKEN for Cloud. See docs/forges.md.
LLM Configuration
prxref operates without direct cloud provider SDK keys (no Anthropic API keys). It ships with no default endpoint and no default model chain: point it at any OpenAI-compatible /chat/completions server (OpenRouter, Together, Groq, vLLM, Ollama, a self-hosted gateway), or install the optional litellm extra. PRXREF_LLM_BASE_URL and PRXREF_LLM_MODELS are required — leaving either unset exits 2 with an error naming the variable.
# Default backend: plain HTTP to any OpenAI-compatible endpoint
export PRXREF_LLM_BACKEND=openai-compat # aliases: ferry, http
export PRXREF_LLM_BASE_URL="https://openrouter.ai/api/v1"
export PRXREF_LLM_API_KEY="$OPENROUTER_API_KEY"
export PRXREF_LLM_MODELS="z-ai/glm-5.3-flash"
export PRXREF_LLM_REASONING_EFFORT=low
export PRXREF_LLM_MAX_TOKENS=4096 # raise this if you raise the effort
# Optional: in-process litellm extra
# pip install 'prxref[litellm]'
export PRXREF_LLM_BACKEND=litellm
export PRXREF_LLM_MODELS="openrouter/meta-llama/llama-3.3-70b-instruct,bedrock/anthropic.claude-3-7-sonnet-20250219-v1:0"
On a reasoning model the hidden reasoning trace draws from the same completion budget as the answer, so turning PRXREF_LLM_REASONING_EFFORT up makes truncation more likely. A truncated chunk is counted as failed and the posted summary names the reason and the variable to raise; see Reasoning models and the token budget.
See docs/llm.md for architecture, failover behavior, and backend setup, and docs/env-vars.md for tuning the confidence floor and finding caps to your team.
Forge Authentication
Configure the authentication token matching your forge:
| Forge | Environment Variable | Notes |
|---|---|---|
| Bitbucket Cloud | PRXREF_BITBUCKET_TOKEN |
Bearer token (workspace or repo access token) |
| Bitbucket Cloud (Basic) | PRXREF_BITBUCKET_USER + PRXREF_BITBUCKET_APP_PASSWORD |
App password fallback |
| Bitbucket Server / DC | PRXREF_BITBUCKET_SERVER_TOKEN |
HTTP access token (falls back to PRXREF_BITBUCKET_TOKEN) |
| Bitbucket Server (Basic) | PRXREF_BITBUCKET_SERVER_USER + PRXREF_BITBUCKET_SERVER_PASSWORD |
Basic-auth fallback |
| GitHub | PRXREF_GITHUB_TOKEN |
Personal Access Token (PAT) or GitHub App token |
| GitHub Enterprise | PRXREF_GITHUB_ENTERPRISE_TOKEN |
Used when host is not github.com (falls back to PRXREF_GITHUB_TOKEN) |
| GitLab | PRXREF_GITLAB_TOKEN |
Personal, project, or group access token (PRIVATE-TOKEN) |
See docs/env-vars.md for the full configuration reference and docs/forges.md for forge specifics.
Webhook Server
Run prxref as a persistent daemon to handle webhook events from GitHub, Bitbucket, and GitLab:
prxref serve --port 8080 --host 0.0.0.0
The service exposes:
POST /webhook— verifies HMAC or token signatures per forge, enqueues incoming PR events, and responds immediately with202 Accepted. A background worker processes reviews serially.GET /health— liveness probe returning{"ok": true}.
CLI Flags
--pr-url URL— full web URL of the PR or MR (required forreview).--no-post— dry run; run review analysis and quality passes without writing comments to the forge.--max-chunks N— override maximum diff chunks evaluated (default8).-v, --verbose— output run timing, token counts, and finding breakdowns to stdout.
Exit Codes
prxref is an advisor, never a gate. Its exit code says whether prxref was configured correctly, not whether your code is good.
| Code | Meaning |
|---|---|
0 |
The run finished — including every review error: an empty diff, a network failure, an LLM timeout, bad forge credentials, an unrecognized URL, or a review in which every chunk failed. Diagnostics go to stderr; the pipeline step stays green. With PRXREF_FAIL_ON set (see below) a finding or a failed review can turn this into 1. |
1 |
Gated review outcome — only when PRXREF_FAIL_ON is set: error exits 1 when the completed review carries an active error-severity finding, any exits 1 on any active finding, and under either value a review that fails to complete also exits 1. The reason is printed to stderr. |
2 |
Usage or configuration error — no subcommand, invalid command-line arguments, or a required value missing, malformed, outside its valid range, or outside its key's allowed vocabulary (PRXREF_FAIL_ON accepts only never, error, any). The message names the source that supplied it: the environment variable, or the CLI flag when a flag is what you typed. |
$ prxref review --pr-url https://github.com/org/repo/pull/1 --max-chunks 0
configuration error: --max-chunks: must be a finite number greater than 0, got 0
PRXREF_FAIL_ON is the one opt-out of the advisory contract, and its default never is the doctrine above, unchanged. Setting it to error or any turns the reviewer into a merge gate — failing a build on a finding turns a probabilistic reviewer into a gate, and the first false positive teaches a team to bypass the gate, so think hard before you set it. Read the verdict from the posted summary, which also carries a partial-review banner when some chunks did not make it. Do not build a security control on the exit code. The webhook daemon has no exit code and is unaffected.
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file prxref-0.7.0.tar.gz.
File metadata
- Download URL: prxref-0.7.0.tar.gz
- Upload date:
- Size: 187.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
3fc55aca8409cbfa00020aa381037004cb5e7db454fd9e492b2b0f509d9db3f2
|
|
| MD5 |
080b48c1d21176bf410c5ce4e927f52b
|
|
| BLAKE2b-256 |
fa51cdb5ae4de83d6eb3c2021a4b78e23afa8d49d840e6a8ac01e8ef5b296d91
|
Provenance
The following attestation bundles were made for prxref-0.7.0.tar.gz:
Publisher:
release.yml on sblattj/prxref
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
prxref-0.7.0.tar.gz -
Subject digest:
3fc55aca8409cbfa00020aa381037004cb5e7db454fd9e492b2b0f509d9db3f2 - Sigstore transparency entry: 2665274742
- Sigstore integration time:
-
Permalink:
sblattj/prxref@ae47cb5ac982d3142275816a1e1da56fa2c8801b -
Branch / Tag:
refs/tags/v0.7.0 - Owner: https://github.com/sblattj
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@ae47cb5ac982d3142275816a1e1da56fa2c8801b -
Trigger Event:
push
-
Statement type:
File details
Details for the file prxref-0.7.0-py3-none-any.whl.
File metadata
- Download URL: prxref-0.7.0-py3-none-any.whl
- Upload date:
- Size: 93.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f37a3c4a244108171a8f42ac26384b17615e4a25501e8ca36739263b2a1ed4f0
|
|
| MD5 |
fd10668d676010c1a469c89084c9bc52
|
|
| BLAKE2b-256 |
d4fff3f55ae9213e459c824d9532de37f6da3e04d05e6b522ae13ba67bef3e1d
|
Provenance
The following attestation bundles were made for prxref-0.7.0-py3-none-any.whl:
Publisher:
release.yml on sblattj/prxref
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
prxref-0.7.0-py3-none-any.whl -
Subject digest:
f37a3c4a244108171a8f42ac26384b17615e4a25501e8ca36739263b2a1ed4f0 - Sigstore transparency entry: 2665274905
- Sigstore integration time:
-
Permalink:
sblattj/prxref@ae47cb5ac982d3142275816a1e1da56fa2c8801b -
Branch / Tag:
refs/tags/v0.7.0 - Owner: https://github.com/sblattj
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@ae47cb5ac982d3142275816a1e1da56fa2c8801b -
Trigger Event:
push
-
Statement type: