Quick Start

Run your first PR review in under 2 minutes.

Your First Review

After installation, simply run:

Terminal
wtp --review https://github.com/owner/repo/pull/123

The review will be saved to ~/pr-reviews/ and automatically opened in your browser (if HTML format).

Common Commands

Preview Without API Call

Use --dry-run to see what will be sent to the AI without actually calling the API:

Terminal
wtp --review <PR_URL> --dry-run

Verbose Output

See detailed progress information:

Terminal
wtp --review <PR_URL> --verbose

Change Output Format

Choose between HTML, Markdown, or plain text:

Terminal
# One-time format change wtp --review <PR_URL> --format md # Or change default format wtp --switch-output

Add External Context

Include additional files or documentation as context:

Terminal
# Local files wtp --review <PR_URL> --context ./src/types.ts # URLs (including private GitHub files) wtp --review <PR_URL> --context https://github.com/org/repo/blob/main/docs/api.md # Multiple contexts wtp --review <PR_URL> -c ./local/file.py -c https://docs.example.com/api

Switching Engines

Change the AI engine used for reviews:

Terminal
# Interactive engine selection wtp --switch-engine # Switch model for current engine wtp --switch-model

Useful Commands

Command Description
wtp --status Show current configuration
wtp --test-config Test AI engine connection
wtp --switch-engine Change AI engine
wtp --switch-model Change model
wtp --switch-output Change output format
wtp --edit-config Open config in editor
wtp --edit-prompt Customize review prompt
wtp --update Update to latest version

Next Steps