Skip to main content
Experience faster, smarter testing with BrowserStack AI Agents. See what your workflow’s been missing. Explore now!
No Result Found

Percy commands

This page provides Percy commands overview.

Use this reference guide to understand and implement the essential Percy commands that enhance your visual testing workflow.

Commands

  • percy upload - upload a static directory of images.

  • percy config - manage configuration files.
  • percy build - interact with Percy builds.

This applies only when using the Percy SDK.


percy upload

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

Text
Copy icon Copy

percy config

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

Text
Copy icon Copy

percy config:validate

Validate a Percy config file

Text
Copy icon Copy

percy config:migrate

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

Text
Copy icon Copy

percy build

Commands for interacting with Percy builds:

  • percy build:finalize
  • percy build:wait

percy build:finalize

Finalize parallel Percy builds

Text
Copy icon Copy

percy build:wait

Wait for a build to be finished

Text
Copy icon Copy

build actions

Use the Percy CLI to approve, unapprove, reject, or delete builds on percy.io directly from the command line. You can find your user-name and access-key on the BrowserStack profile page.

Approve a build

Approve the build using the following command. You can configure auth options either through the CLI or by passing them in the options.

Pass credentials using options

Copy icon Copy

Set credentials using environment variables

Copy icon Copy

Unapprove a build

Unapprove the build using the following command. You can configure Auth options either through the CLI or by passing them in the options.

Pass credentials using options

Copy icon Copy

Set credentials using environment variables

Copy icon Copy

Reject a build

Reject the build using the following command. You can configure Auth options either through the CLI or by passing them in the options.

Pass credentials using options

Copy icon Copy

Set credentials using environment variables

Copy icon Copy

Delete a build

Delete the build using the following command. You can configure Auth options either through the CLI or by passing them in the options.

Pass credentials using options

Copy icon Copy

Set credentials using environment variables

Copy icon Copy

We're sorry to hear that. Please share your feedback so we can do better

Contact our Support team for immediate help while we work on improving our docs.

We're continuously improving our docs. We'd love to know what you liked





Thank you for your valuable feedback

Is this page helping you?

Yes
No

We're sorry to hear that. Please share your feedback so we can do better

Contact our Support team for immediate help while we work on improving our docs.

We're continuously improving our docs. We'd love to know what you liked





Thank you for your valuable feedback!

Talk to an Expert
Download Copy Check Circle