Use the Snapshot Site CLI when you want reproducible screenshot, analyze, and compare jobs from the shell without wiring a full SDK first.
pnpm add -g @snapshot-site/cliSNAPSHOT_SITE_API_KEY=ss_live_xxxThe CLI gives teams a direct operational interface to Snapshot Site. It is useful when the workflow starts in the shell, in CI, or in a small automation script.
You can run screenshot, analyze, and compare directly from the terminal.
The CLI is a good fit for scripted checks before deployment or for recurring operational reviews.
You can log in once locally instead of exporting an API key in every shell session.
Returned screenshots and JSON payloads can be written straight to disk for review.
Install `@snapshot-site/cli` globally
Export `SNAPSHOT_SITE_API_KEY` or run `snapshot-site login`
Call `snapshot-site screenshot`, `analyze`, or `compare`
Save JSON or image outputs locally for review
Capture a page and save both JSON output and an image locally.
snapshot-site screenshot \ --url https://snapshot-site.com/pricing \ --width 1440 \ --full-size \ --hide-cookie \ --output ./pricing.json \ --save-image ./pricing.png
Run page analysis and persist both the JSON payload and image.
snapshot-site analyze \ --url https://snapshot-site.com \ --width 1440 \ --full-size \ --enable-summary \ --enable-quality \ --output ./analysis.json \ --save-image ./analysis.png
Compare two URLs and save the result set locally.
snapshot-site compare \ --before-url https://snapshot-site.com/pricing \ --after-url https://staging.snapshot-site.com/pricing \ --width 1440 \ --full-size \ --hide-cookie \ --threshold 0.1 \ --output ./compare.json \ --save-image ./compare-assets
Store credentials locally when you do not want to export the API key every time.
snapshot-site login --api-key ss_live_xxx snapshot-site whoami-config snapshot-site logout # saved config path ~/.config/snapshot-site/config.json