ReviewScope Docs
Master the art of automated code reviews. Configure your engine, understand the architecture, and contribute to the core.
On this page
Contents
Getting Started
Install the GitHub App
Install the ReviewScope GitHub App on your account or organization. You can grant access to all repositories or select specific ones.
Install AppConfiguration (BYOK)
ReviewScope uses a Bring Your Own Key (BYOK) model. We do not resell AI credits. You must configure a valid API key for each installation in the Settings tab.
Supported Providers
- BESTGoogle GeminiRecommended for speed/cost
- OpenAIGPT-4o, GPT-3.5 Turbo
Security & Privacy
- Keys are encrypted at rest using AES-256.
- Code snippets are sent to LLMs ephemerally for analysis only.
- We do not use your code to train models.
Smart Routing
ReviewScope automatically analyzes the complexity of a PR (lines of code, file types) to choose the most cost-effective model if multiple keys are provided, or uses the configured default.
Supported Languages
Default Rules
Missing Error Handling
Flags empty catch blocks and unhandled promises.
Console Log Detection
Identifies console.log statements in production code.
Unsafe Patterns
Detects eval(), innerHTML, and other security risks.
TODO/FIXME Tracker
Highlights technical debt markers.
Commands & Workflow
1. Automatic Review
Simply open a Pull Request. ReviewScope will post a review within seconds.
2. Manual Trigger
Use this to force a re-scan after pushing commits.
3. Interactive Chat
ReviewScope replies with context-aware answers.