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
- Install the CLI
- Run
reshot setup - Add or record one scenario
- Run
reshot runagainst a production-like local server - Publish only after the output looks right
- 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
| Layer | What it does |
|---|---|
| Config / Recorder | Define the capture contract manually or record it once |
| Execution | Re-run the same contract locally and in CI |
| Review | Show before/after changes before the live docs image updates |
| Delivery | Keep one stable image URL current after approval |
Recommended next step
Continue to Installation, then follow the Quick Start to get one real capture green.

