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.

# CodeShip Basic setup

CodeShip provides an easy way to set environment variables in settings for a repository:


In your CodeShip project go to Settings > Environment Variables.

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


# CodeShip Pro setup

CodeShip Pro is based on Docker and uses an encrypted files to load your environment variables into Docker containers.

You can learn more about encrypting your environment variables for CodeShip Pro builds here: <https://documentation.codeship.com/pro/builds-and-configuration/environment-variables/>

# More information

CodeShip has more documentation for integrating Percy with your CI/CD builds.

  • CodeShip Pro: <https://documentation.codeship.com/pro/continuous-integration/percy-docker/>

  • CodeShip Basic: <https://documentation.codeship.com/basic/continuous-integration/percy-basic/>

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

# 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:


  • [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>


  • [Rails](🔗)

  • [Other](🔗)

  • [Capybara, no tests](🔗)

  • [Best practices](🔗)


  • [Selenium](🔗)

Static sites

  • [Command-line client](🔗)

Everything else

  • [Percy Anywhere](🔗)