Introduction

Reshot keeps docs visuals current by turning them into a repeatable workflow: author locally or by config, re-run in CI, review the diff, and keep one permanent image URL current after approval.

Setup sequence

  1. Install the CLI
  2. Run reshot setup
  3. Add or record one scenario
  4. Run reshot run against a production-like local server
  5. Publish only after the output looks right
  6. Add CI after the local flow is stable

Minimal config

JSON
{
  "baseUrl": "http://localhost:3000",
  "scenarios": [
    {
      "name": "billing-overview",
      "steps": [
        { "action": "goto", "url": "/app/billing" },
        { "action": "capture", "key": "billing-overview" }
      ]
    }
  ]
}

That one scenario is enough to prove the contract locally, then hand it to CI without changing the authoring model.

What Reshot includes

LayerWhat it does
Config / RecorderDefine the capture contract manually or record it once
ExecutionRe-run the same contract locally and in CI
ReviewShow before/after changes before the live docs image updates
DeliveryKeep one stable image URL current after approval

Continue to Installation, then follow the Quick Start to get one real capture green.

Introduction | Reshot Docs