Hey! These docs are for version 1, which is no longer officially supported. Click here for the latest version, 2-web!


Percy is designed to integrate with your tests and CI environment. To enable Percy, the token environment variable must be configured in your CI service:

  • `PERCY_TOKEN`: The Percy repo write-only API token. This is unique for each Percy repository.

# Jenkins build setup




Depending on how you have Jenkins configured, there are a few options for configuring environment variables.

You can use the [EnvInject plugin](🔗) to set the token environment variable for a build.

Set `PERCY_TOKEN` to the write-only token from your Percy repo. This token can be found in each Percy repo's settings.

Alternatively, you could export the variables as part of the build script:





**IMPORTANT: Keep your Percy token secret.** Anyone with access to your token can consume your account quota, though they cannot read data.

If your code is public, do not commit the PERCY_TOKEN to your code.

# Next step: integrate with tests




You're done with setup---the last step is to integrate Percy into your tests and run them. Just choose your client library:

JavaScript

  • [Ember](🔗)

  • [React](🔗)

  • [Storybook for React](🔗)

  • [Storybook for Angular](🔗)

  • [Storybook for Vue.js](🔗)

  • [Storybook for Ember](🔗)

  • [Cypress](🔗)

  • [WebdriverIO](🔗)<sup>beta</sup>

  • [Puppeteer](🔗)<sup>beta</sup>

  • [Nightmare.js](🔗)<sup>beta</sup>

  • [Protractor](🔗)<sup>beta</sup>

Ruby

  • [Rails](🔗)

  • [Other](🔗)

  • [Capybara, no tests](🔗)

  • [Best practices](🔗)

Python

  • [Selenium](🔗)

Static sites

  • [Command-line client](🔗)

Everything else

  • [Percy Anywhere](🔗)