Skip to main content
No Result Found

Bring Your Own Screenshots

Feed your own screenshots to Percy for visual comparison

The Image Upload feature is currently in Alpha. Contact us if you face any issues.

Download this script that helps you upload images directly to App Percy.

Export your PERCY_TOKEN into your local or CI environment.

Organize your images as per the directory structure shown here:

Copy icon Copy
.resources/
    device1/
        image1.png
        image2.png
        device.json
    device2/
        image1.png
        image2.png
        device.json

You can have arbitrary device names.

Your device.json should look like this, for a sample device:

Copy icon Copy
{
  "deviceName": "OnePlus 8", # Arbitrary
  "os": "Android", # Can be any string
  "osVersion": "10", # can be any string
  "deviceScreenSize": "1080x2400", # Should match your screenshot resolution
  "statusBarHeight": 104, # Helps us automatically ignore any status bar, can be 0
  "navigationBarHeight": 229, # Helps us automatically ignore any navigation bar, can be 0
  "orientation": "portrait"
}

Run the upload script:

Copy icon Copy
npx percy app:exec -- node manual_upload.js

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