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

JavaScript API client

Build StatusBuild Status Package StatusPackage Status

JavaScript API client library for Percy.


NOTE: This is a low-level API library, you probably want to use a higher-level framework plugin. Check out:


  1. Fork it (https://github.com/percy/percy-js/fork)
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request

Running Tests

  • npm run test
  • npm run tdd