Quick Start

Let's capture your first visual documentation in under 5 minutes.

Step 1: Launch Chrome in Debug Mode

Reshot needs to control Chrome to record interactions. Launch a pre-configured instance:

reshot chrome

Navigate this Chrome window to the URL you want to capture (e.g., http://localhost:3000).

Step 2: Start Recording

You can start recording from the Studio UI or via the terminal:

reshot record "My First Scenario"

The CLI connects to your active Chrome tab and begins logging your actions.

Step 3: Interact and Capture

As you interact with the page, Reshot logs actions using robust selectors (data-testid, role, aria-label).

Controls:

Capture Options

When you press C:

• Single-Step Screenshot: Takes a PNG of the current state (Full Page or Specific Element)
• Multi-Step Clip: Records a short video (MP4) of subsequent actions

Step 4: Run the Scenario

Once recorded, re-run the scenario headlessly to generate fresh assets:

reshot run --scenarios "my-first-scenario"

Step 5: View Your Assets

Open the Studio to see your captured assets:

reshot studio

Or use the shortcut:

reshot ui

Navigate to the Assets tab to see your generated screenshots and videos.

Dashboard Overview

After setup, your workspace dashboard shows:

• Project cards with review status indicators
• Quick stats showing total visuals and pending reviews
• Recent activity feed with latest commits

The dashboard now includes a new "All reviews complete" status badge when there are no pending items.

Run Capture Workflow

Here's how to run captures from the Studio UI:

1

Select Scenario

Choose scenarios to run from the list.

initial

2

Check Scenario

Select the scenario checkbox.

click

3

Run Capture

Click Run to start the capture job.

click

What's Next?

• Learn about Recording in depth
• Configure Variants for multi-context captures
• Set up CI/CD Integration for automation