CLI

The PullApprove CLI provides tools for configuring, validating, and testing your code review setup. It's installed as pullapprove (or pa for short).

Installation

Install the CLI globally using uv:

uv tool install pullapprove

If you don't have uv installed:

curl -LsSf https://astral.sh/uv/install.sh | sh

Commands

Configuration Management

  • pullapprove init - create a starter CODEREVIEW.toml
  • pullapprove check - validate configuration files

File Matching and Testing

  • pullapprove match - show files and their matching scopes
  • pullapprove match --changed - show only changed files
  • pullapprove match --diff - show diff content with matches
  • pullapprove match --by-scope - organize output by scope instead of by path
  • pullapprove match --scope <name> - filter to show only files matching specific scopes

Coverage Analysis

  • pullapprove coverage - calculate file coverage for review scopes

Examples

Validate your configuration

pullapprove check

Returns validation errors if your CODEREVIEW.toml has syntax issues or invalid settings.

Test file matching for changed files

pullapprove match --changed

Shows which review scopes would be triggered by files you've modified locally.

Check review coverage

pullapprove coverage

Displays what percentage of files in your repository are covered by review scopes.

View specific scope matches

pullapprove match --scope backend

Shows only files that match the "backend" scope, useful for testing scope patterns.

Automated Setup

For automated configuration help, see the Agents documentation which provides AI-powered assistance for setting up and migrating PullApprove configurations.