SDKs overview

👍

Covered in this doc

Overview of how Percy's SDKs work
How to pick the right SDK
Information about SDK usage and configuration

With Percy, you can add visual testing to virtually anything that runs in a browser.

We have first-class support for several web application frameworks, component libraries, end-to-end testing frameworks, and static sites. You can also build your own Percy integration.

Supported SDKs


Our SDKs generally involve three parts—installing Percy, adding snapshots, and configuring CI. Follow the documentation for your framework to get started.

Percy Snapshot

  • Percy snapshot - the easiest way to get started with visual testing and Percy

Web applications

Components and component libraries

End-to-end testing frameworks

Static sites

Build your own SDK


Integrating Percy visual testing into a new framework is simple using Percy CLI.

The @percy/cli npm package is our core SDK that provides the foundation for all other SDKs. It takes care of all the heavy lifting of common tasks such as authentication, environment detection, and uploading screenshots to your Percy project. Follow our documentation to build your own SDK .

If you're unsure about which SDK you should use or don't see your technology represented, feel free to create a discussion


What's next

Once you've installed and configured an SDK, the next step is to add Percy to your CI workflow and pull requests.