CLI Reference
report
Post build results as a GitHub PR comment with visual diff summaries.
The report command posts or updates a comment on a GitHub pull request with visual regression test results.
Usage
npx ui-inspect report [options]Options
| Flag | Type | Default | Description |
|---|---|---|---|
--project <id> | string | config file | Project ID |
--build-id <id> | string | latest build | Build ID to report |
--pr <number> | number | auto-detect | Pull request number |
--json | boolean | false | Output as JSON |
--status-check | boolean | false | Also post a GitHub status check |
PR comment format
The report creates a structured comment with:
- Build summary (pass/fail, total comparisons)
- Table of all comparisons with diff percentages
- Links to the dashboard for detailed diff views
- Stability indicators for flaky detections
Comments use a hidden HTML marker (<!-- ui-inspect-report -->) to update existing comments instead of creating new ones on subsequent runs.
Example
# Post results for the latest build
npx ui-inspect report \
--project proj_abc123 \
--pr 42
# Include a status check
npx ui-inspect report \
--project proj_abc123 \
--pr 42 \
--status-checkRequirements
A GitHub integration must be configured for your project in Settings → Integrations → GitHub. The integration needs:
- Repository owner and name
- A GitHub personal access token with
reposcope