Provider-agnostic PR reviewer — six hosted providers, ollama, and any OpenAI-compatible endpoint, one flag, no keys in secrets for cloud.
Project description
lgtmaybe
Provider-agnostic PR reviewer. Six hosted providers, local ollama, and any OpenAI-compatible endpoint — one flag, no static keys for cloud providers. Posts inline review comments and a summary.
📖 Full documentation: https://mattjcoles.github.io/lgtmaybe/
What it reviews
lgtmaybe fetches the PR diff from the GitHub API and reviews the lines a pull request changes. It never checks out or runs your code. To judge each change in context it also reads a few surrounding lines from the file, but it only ever comments on what the PR actually changed, not the whole repository.
Reviews surface the kind of thing a careful reviewer would flag, each graded from
info up to critical: logic and correctness bugs (edge cases, null
dereferences, off-by-one and boundary errors, mismatched ranges, unhandled error
paths, races and TOCTOU, missed awaits, numeric and timezone bugs), missing
or weak tests for changed code paths (with a suggested test to drop in), and
undocumented public APIs or stale docs the change just made wrong. The model
is prompted with an OWASP-aligned security checklist — injection, XSS, CSRF
and open redirects, hardcoded secrets, broken authn/authz (including JWT
pitfalls), path traversal, unrestricted uploads, SSRF, insecure deserialization
and XXE, mass assignment, weak crypto, resource/DoS safety (including ReDoS),
secrets or PII (passwords, tokens, SSNs, card data) leaking into logs, and CI/IaC
misconfiguration (workflow script injection, unpinned actions, broad IAM, public
buckets) — so security findings are first-class, not an afterthought. It also
flags factually outdated code — deprecated APIs, end-of-life or vulnerable
dependencies, typosquat-looking additions — when the diff shows them,
performance regressions (N+1 queries, accidentally quadratic work, redundant
computation, allocations or blocking I/O on hot paths, unbounded queries, caches
that never evict), and needless complexity (deep nesting / high cyclomatic
complexity, over-long functions, duplicated logic). An intent lens checks
that the PR does what it says: it reads the PR title, description, and commit
names (or your git log commit names on the CLI) and flags out-of-scope hunks,
code that contradicts the stated intent, and promised behaviour the diff never
implements. A ponytail lens — the "lazy senior dev" (the best code is the
code you never wrote) — flags code that needn't exist at all: YAGNI, reach for
the standard library, do it in fewer lines. Generated and non-reviewable files (lockfiles, minified bundles,
vendored directories, binaries) are skipped automatically, and secrets are
redacted from the diff before it is sent to the model.
Hardened against malicious PRs. lgtmaybe never checks out or runs PR code, treats the diff as untrusted input, defends against prompt injection (including forged delimiter break-out attempts), and redacts a broad set of secret formats (cloud keys, GitHub/Slack/Google/Stripe tokens, private keys, passwords, and credentials in connection strings) before anything leaves your environment. See Data and Privacy.
How the scope is bounded. Every run is capped so a large PR can't blow up latency:
max_files(default 50) — reviews the top-N changed files and notes how many were skipped.max_input_tokens(default 100k) — batches the diff to fit the model's budget.recursive(default on) — when a single file's diff exceeds that budget, walks it hunk-by-hunk instead of sending it whole;--no-recursivesends files whole.categories(default all nine) — which review lenses to run; each is a concurrent model call, so narrowing the list means fewer calls.min_severity(defaultinfo) plusinclude_paths/exclude_paths— focus the review on what you care about.
See Configure .lgtmaybe.yml for every knob.
Big files, small models. When one file's diff is too big for a single model
call, lgtmaybe reviews it hunk-by-hunk rather than whole, so the model never
loses the tail of a large file. On by default; --no-recursive turns it off.
Smaller local models gain the most — across 8 runs on two fixtures, a local
qwen3.5:4b averaged 88% recall reviewing hunk-by-hunk versus 61%
reviewing files whole, with its worst run matching the whole-file method's
best (a real effect, not noise), at ~2.4× the tokens. See
the benchmark.
What you get back. Each finding is structured data — file, line, severity, a title, an explanation, and an optional suggested fix — so it renders the same everywhere:
- On a GitHub PR — an inline comment on the exact changed line for each finding, plus one summary comment naming the model used. Re-running updates the same comments instead of duplicating them, auto-resolves a conversation once its finding is fixed, and a clean PR gets a 👍 LGTM!.
- On the CLI —
lgtmaybe reviewreads your localgitdiff and prints the findings (a readable listing, a JSON array with--json, or--format agentfor an AI coding agent to read and apply); nothing is posted to GitHub.
On a GitHub PR — an inline comment on the changed line. The same findings on the CLI:
A fuller walkthrough with example output is in What gets reviewed.
Quick start (60 seconds, local, zero cost)
From inside a git repo, on a branch with changes, review your diff against the remote primary branch and print the findings:
pip install lgtmaybe
lgtmaybe review \
--provider ollama \
--model qwen3.6:27b \
--api-base http://localhost:11434
No GitHub token and no pull request needed — lgtmaybe review reads your local
git diff and prints the findings. To post reviews on real pull requests, wire
up the GitHub Action. See
Getting Started for the full walkthrough.
Picking a model: use a coding model, and bigger/newer is more accurate. Our benchmark numbers are for a small
qwen3.5:4b; a larger, current coding model catches more. See Which model?.
Providers
| Provider | Auth |
|---|---|
openai |
OPENAI_API_KEY |
anthropic |
ANTHROPIC_API_KEY |
openrouter |
OPENROUTER_API_KEY |
bedrock |
Ambient AWS creds — GitHub OIDC, no static key |
vertex |
Ambient GCP creds — Workload Identity Federation, no key |
azure |
Ambient Azure AD creds — GitHub OIDC, no static key (or AZURE_API_KEY) + endpoint |
ollama |
None — local only, zero cost |
openai-compatible |
Any OpenAI /v1 endpoint via --api-base (DeepSeek, llama.cpp, LM Studio, vLLM). Key optional — --api-key / OPENAI_COMPATIBLE_API_KEY, or none for local servers |
Documentation
Browse the rendered docs at https://mattjcoles.github.io/lgtmaybe/, or read the Markdown sources below.
Tutorial — learn by doing
- Getting Started — your first review with ollama
How-to guides — task recipes
- Run locally with ollama
- Use a custom OpenAI-compatible endpoint
- Review with Bedrock OIDC
- Review with Vertex WIF
- Review with Azure OpenAI
- Use as a GitHub Action
- Configure .lgtmaybe.yml
- Releasing (maintainers)
Reference — look things up
- Configuration Reference — all config fields and schemas (generated)
Explanation — understand the design
- What gets reviewed — scope, caps, and what the output looks like
- Architecture — ports and adapters, the review pipeline
- Auth Model — why keyless cloud, how credential resolution works
- Data and Privacy — what is sent where, secret redaction, ollama local mode
- Trust and Cost — choosing who reviews run for (everyone, trusted contributors, or admins) and the small cost angle
Use as a GitHub Action
name: lgtmaybe
on:
pull_request_target:
issue_comment:
types: [created]
permissions:
contents: read
pull-requests: write
jobs:
review:
if: ${{ github.event_name == 'pull_request_target' || github.event.issue.pull_request }}
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v6
- uses: MattJColes/lgtmaybe@v0
with:
provider: openai
model: gpt-5.5
api_key: ${{ secrets.OPENAI_API_KEY }}
Copy-paste workflows for every cloud and API-key provider live in
examples/workflows/. Cloud providers (Bedrock, Vertex,
Azure) are keyless — pass aws_role_arn / gcp_wif_provider /
azure_client_id and the action does the OIDC/WIF exchange for you (needs
id-token: write). See
Use as a GitHub Action. ollama is local
only — run it through the CLI instead.
🔧 Choose who can trigger reviews. You decide who reviews run for — everyone, trusted contributors, or just admins. The example workflows default to trusted contributors (
OWNER,MEMBER,COLLABORATOR), and it's a one-line change to open it up or tighten it. With ollama this is free; on a hosted provider it also keeps token spend predictable. See Who can trigger a review and Trust and Cost.
Distribution
- CLI —
pip install lgtmaybe - GitHub Action —
uses: MattJColes/lgtmaybe@v0
Contributing
Test-first, green CI, scope is the gate. See CONTRIBUTING.md.
License
MIT — see LICENSE.
Project details
Release history Release notifications | RSS feed
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 lgtmaybe-0.3.0.tar.gz.
File metadata
- Download URL: lgtmaybe-0.3.0.tar.gz
- Upload date:
- Size: 2.2 MB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
feb50542d661f1af363183e41a79e7d6fd7479c9c2bb19728e8a1cedf16b99b0
|
|
| MD5 |
0b630517a4c3988e0e423afb048c8b57
|
|
| BLAKE2b-256 |
44a233a1d9d5285829d0295335a05103e929d5eb43c517e220f1aacbe21cc591
|
Provenance
The following attestation bundles were made for lgtmaybe-0.3.0.tar.gz:
Publisher:
release-please.yml on MattJColes/lgtmaybe
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
lgtmaybe-0.3.0.tar.gz -
Subject digest:
feb50542d661f1af363183e41a79e7d6fd7479c9c2bb19728e8a1cedf16b99b0 - Sigstore transparency entry: 1851612150
- Sigstore integration time:
-
Permalink:
MattJColes/lgtmaybe@a205accc31bfc0693ee78df8169adee05a5c6633 -
Branch / Tag:
refs/heads/main - Owner: https://github.com/MattJColes
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release-please.yml@a205accc31bfc0693ee78df8169adee05a5c6633 -
Trigger Event:
push
-
Statement type:
File details
Details for the file lgtmaybe-0.3.0-py3-none-any.whl.
File metadata
- Download URL: lgtmaybe-0.3.0-py3-none-any.whl
- Upload date:
- Size: 95.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
cac3e9e893770919c16225a68a26db34c67b7dcaae3e22f58725c9afaf5d2a7e
|
|
| MD5 |
ffcd250814fac9086b7741e2cf143644
|
|
| BLAKE2b-256 |
2b81234850d21ca43d3e09734f9444430fe2e53a805dfb37d347768350716dde
|
Provenance
The following attestation bundles were made for lgtmaybe-0.3.0-py3-none-any.whl:
Publisher:
release-please.yml on MattJColes/lgtmaybe
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
lgtmaybe-0.3.0-py3-none-any.whl -
Subject digest:
cac3e9e893770919c16225a68a26db34c67b7dcaae3e22f58725c9afaf5d2a7e - Sigstore transparency entry: 1851612437
- Sigstore integration time:
-
Permalink:
MattJColes/lgtmaybe@a205accc31bfc0693ee78df8169adee05a5c6633 -
Branch / Tag:
refs/heads/main - Owner: https://github.com/MattJColes
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release-please.yml@a205accc31bfc0693ee78df8169adee05a5c6633 -
Trigger Event:
push
-
Statement type: