Commands overview

👍

Covered in this doc

• What Percy CLI is
• Percy CLI commands
• Percy CLI configuration

📘

You are viewing docs for the new @percy/cli. Most SDKs have been updated to utilize the new CLI, so check the appropriate SDK doc for instructions for your specific SDK!

The Percy CLI is used to capture and upload snapshots to percy.io from the
command line.

Installation

$ npm install @percy/cli --save-dev

Command Topics

• percy exec - capture and upload snapshots
• percy snapshot - snapshot a static directory or a list of pages
• percy upload - upload a static directory of images
• percy config - manage configuration files
• percy build - interact with Percy builds

Configuration

You can find Percy CLI's configuration docs here.

Advanced

• Skipping the asset discovery browser download
• Capturing multiple asset hosts
• Capturing assets protected with authentication