Commands Overview

Percy CLI commands for creating, validating, and updating Percy configuration files:

• percy config:create
• percy config:validate
• percy config:migrate

percy config:create

Create a Percy config file

percy config:validate

Validate a Percy config file

percy config:migrate

Migrate a Percy config file to the latest version Validate a Percy config file

Commands for interacting with Percy builds:

• percy build:finalize
• percy build:wait

percy build:finalize

Finalize parallel Percy builds

percy build:wait

Wait for a build to be finished

The Percy CLI is used to capture and upload snapshots to percy.io from the command line.

Installation

Command

• percy app:exec - Start and stop Percy around a supplied command
• percy app:exec:start - Starts a local Percy snapshot server
• percy app:exec:stop - Stops a local running Percy snapshot server
• percy app:exec:ping - Pings a local running Percy snapshot server

percy exec

percy app:exec:start

percy app:exec:stop

percy app:exec:ping

Percy Options is part of the device capability configured for App Automate or any similar service.

Available Percy options

'appium:percyOptions': {
  enabled: true, // true by default, decides if percy is enabled for particular session or device
  ignoreErrors: true // true by default, decides whether to ignore errors occurred during test
}

var capabilties = {
   ...,
   "deviceName": "iPhone 14",
   "percy.enabled": true/false,
   "percy.ignoreErrors": true/false,
   ...
}

You can run your tests on Percy using either your make file or by utilizing the Percy start and stop commands.

Run test using exec command

Add the percy app exec command in your make file for executing tests on Percy, as shown below:

Percy CLI command to upload a directory of static images to Percy for diffing.

Run test using Percy start stop commands

If you cannot use the percy app:exec command in your configuration file or you want to run your test via IDE, use the percy app:exec:start and percy app:exec:stop commands.

(1) Execute the below command to start Percy.

Percy CLI command to upload a directory of static images to Percy for diffing.

(2) Run your tests using the IDE’s run option.
(3) On test completion, you can stop Percy.

Percy CLI command to upload a directory of static images to Percy for diffing.