Automation

Reshot's capture pipeline runs entirely on your local machine. Once you have a working local capture, you can script the workflow for repeatable use.

The capture → publish workflow

Terminal
# 1. Start your app
npm run build && npm run start &

# 2. Capture screenshots
npx reshot run --headless

# 3. Publish approved visuals
npx reshot publish

Headless mode

The --headless flag runs Playwright in headless mode, suitable for scripting:

Terminal
reshot run --headless

This executes every scenario in your reshot.config.json against your running localhost app, capturing screenshots without opening a visible browser.

Required environment

VariableDescription
RESHOT_API_KEYHosted API key from Project Settings
AWS_ACCESS_KEY_IDOnly if using BYOS/S3
AWS_SECRET_ACCESS_KEYOnly if using BYOS/S3

Where review sits relative to publish

reshot publish uploads the candidate visuals and creates review items for new or changed assets. If your workspace requires review, the permanent docs URL switches only after approval. Unchanged visuals remain approved automatically.

For the queue behavior itself, see Review Workflow.

Best practices

  1. Get a local capture green first — run reshot run interactively before using --headless
  2. Use a production-like local server (build + start, not dev mode)
  3. Review diffs before publishing

Reliability checks

If your team is using the certified target contract, add these after the core run and publish path is healthy:

Terminal
reshot doctor target
reshot verify publish
Automation | Reshot Docs