Installation

Install the CLI, choose a local-first or hosted lane, and aim for one working capture before you wire anything into CI.

Prerequisites

• Node.js 18 or higher
• Chrome browser installed
• A terminal on macOS, Linux, or Windows with WSL

Install the CLI

The fastest way is to run it on demand with npx — no global install needed (this is what the in-app onboarding shows):

npx @reshotdev/screenshot@latest <command>

To install it globally instead so the reshot command is always on your PATH:

npm install -g @reshotdev/screenshot

Or with pnpm:

pnpm add -g @reshotdev/screenshot

Or with yarn:

yarn global add @reshotdev/screenshot

Verify installation

reshot --version

Recommended path

This is the default self-serve flow:

reshot setup
reshot run
reshot publish

• reshot setup creates reshot.config.json and picks the right lane
• reshot run proves the scenario locally
• reshot publish unlocks hosted review and permanent URLs

Setup

reshot setup

reshot setup:

1. Creates reshot.config.json if it does not exist yet
2. Lets you choose a local-first or cloud-connected lane
3. Prints the launch-supported local server command when the target needs one

Launch-supported runtime

For launch-grade captures, run your app with a production-like local server before reshot run. For most Next.js apps that means next build && next start, not next dev.

Read Supported Environments before you wire Reshot into CI or promise production reliability to your team.

Manual initialization

If you prefer to initialize the project manually:

reshot init

Authentication

Authentication is optional until you want hosted publish, permanent URLs, or review workflows.

reshot auth

Credentials are stored securely in .reshot/settings.json.

Next step

Continue to the Quick Start guide for the full first-value flow.