Skip to main content

Deterministic pull request review for public GitHub pull requests

Project description

Reviewer CLI

Reviewer CLI exposes the shared pull request analysis engine as a guided terminal experience.

Install

After the package is published, install it with pip:

pip install reviewer-cli

For local development in this repository:

pip install -e backend

Configure

Reviewer CLI ships with the default GitHub device login client id, so most users can run reviewer login immediately after install. GITHUB_CLIENT_ID remains available only as an override for local or self-hosted setups.

Advanced users can still provide a token directly:

# Windows PowerShell
$env:GITHUB_TOKEN="your_token_here"
# macOS / Linux
export GITHUB_TOKEN="your_token_here"

Optional: override where Reviewer stores the local login session.

# Windows PowerShell
$env:REVIEWER_CONFIG_DIR="C:\Users\you\AppData\Roaming\reviewer-cli"

Usage

Quick start flow:

  1. Open the CLI to see the available commands
reviewer
  1. Connect GitHub
reviewer login
  1. Analyze a pull request
reviewer analyze https://github.com/owner/repo/pull/123
  1. Publish or update the GitHub summary comment
reviewer publish-summary https://github.com/owner/repo/pull/123
  1. Check session or logout
reviewer whoami
reviewer logout

All commands:

reviewer login
reviewer whoami
reviewer analyze https://github.com/owner/repo/pull/123
reviewer publish-summary https://github.com/owner/repo/pull/123
reviewer logout

What The CLI Does For Users

  • Guides GitHub login step by step with the device link and one-time code.
  • Reuses the saved GitHub session automatically so people do not have to log in again on every command.
  • Renders reports in readable sections so the next action is obvious.
  • Suggests what to do after login, publish, and logout.

Protected commands automatically start the login flow when no valid session is available.

If REVIEWER_BACKEND_API_BASE is set, reviewer publish-summary uses the hosted Reviewer backend instead of the local GitHub session. Configure GITHUB_APP_ID, GITHUB_APP_PRIVATE_KEY, and GITHUB_WEBHOOK_SECRET on that backend to publish PR comments from a GitHub App bot identity and handle automatic webhook reviews. REVIEWER_PUBLISH_GITHUB_TOKEN remains available as a fallback.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

reviewer_cli-0.1.9.tar.gz (52.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

reviewer_cli-0.1.9-py3-none-any.whl (65.8 kB view details)

Uploaded Python 3

File details

Details for the file reviewer_cli-0.1.9.tar.gz.

File metadata

  • Download URL: reviewer_cli-0.1.9.tar.gz
  • Upload date:
  • Size: 52.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.0

File hashes

Hashes for reviewer_cli-0.1.9.tar.gz
Algorithm Hash digest
SHA256 e3f24107a417df45069c59e47adea89081fade8fe92b5f0d1c3be8773d528f9e
MD5 83e8f10eb4f9f0e455dbb1ac3ee6db98
BLAKE2b-256 7957b49a9ae67e8fb8bd37f9148c4db23209dcf7f2c43b104bc12e2715469c41

See more details on using hashes here.

File details

Details for the file reviewer_cli-0.1.9-py3-none-any.whl.

File metadata

  • Download URL: reviewer_cli-0.1.9-py3-none-any.whl
  • Upload date:
  • Size: 65.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.0

File hashes

Hashes for reviewer_cli-0.1.9-py3-none-any.whl
Algorithm Hash digest
SHA256 00f1fafff253c3fb061710572f1a2c5facf1d5684a3b2275c43e51b1d66b15d5
MD5 ab3763cc24f9af29313017b72d2abde4
BLAKE2b-256 0bdb057c411d769e77ee033b144003bb3e67655d8de9fb1efab585b28ff1fd6d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page