Percy Report Generator

Installation

npm install @percy/report

export PERCY_TOKEN=<read-only | full-access>

Usage

npx percy-report generate <buildId> [options]

Note: Build ID can be found in the URL of the Percy Dashboard as well as the REST API data. Example Build URL: https://percy.io/<projectId>/PercyReporting/builds/<buildId>

  --percy-token <percyToken>      Percy ReadOnly or FullAccess Token (default: PERCY_TOKEN Environment Variable)
  --download-path <downloadPath>  Directory path where to generate the report (default: "./Reports")
  --download-images               If True Images will be downloaded (default: false)
  --diff-threshold                Threshold for percentage change in snapshots (default : 1)
  -h, --help                      display help for command

Step 1 : Run the Percy Build Step 2 : Extract the Percy Build ID from the Percy run Step 3 : Execute the Percy Report Generation Step

Example:

export PERCY_TOKEN=<your-percy-token>
BUILD_ID=$(npx percy exec -- {Test Command} | grep https:\/\/percy.io\/.*\/builds | awk -F "/" '{print $NF}')
npx percy-report generate $BUILD_ID

npx percy-report summary <project-slug> [options]

Note: Project Slug is equal to Project Name on your percy dashboard

  --percy-token <percyToken>  Percy ReadOnly or FullAccess Token
  --start-date <start-date>   Consider builds created on greater than equal to start date(mm/dd/yyyy) (Default: Today)
  --end-date <end-date>       Consider builds created on less than equal to end date(mm/dd/yyyy) (Default: Today)
  -h, --help                  display help for command

Note: Interval between start date and end date should not exceed 30 days.

Examples

Web Percy

Build Report

Summary Report

App Percy

Build Report

Summary Report