Skip to Content
πŸŽ‰ ShotSweep is live! Launched on NFSFU234 Open Source Day.
DocsQuick Start

Quick Start

Capture a single page

terminal
shotsweep capture --url https://tour-guide.nforshifu234dev.com --mode full
βœ” Resolved 1 URL βœ” Captured 1 screenshot β†’ ./screenshots Done in 2.4s Manifest: screenshots/manifest.json

This writes screenshots into ./screenshots, organized by hostname and page, plus a manifest.json describing every shot:

screenshots/ β”œβ”€β”€ tour-guide.nforshifu234dev.com/ β”‚ └── home/ β”‚ └── full-1440x900.png └── manifest.json
The screenshot produced by the capture command above.

Capture every page in a sitemap

terminal
shotsweep capture --sitemap https://tour-guide.nforshifu234dev.com/sitemap.xml --out ./screenshots

Capture a local dev build, two viewports, zipped

terminal
shotsweep capture \ --base http://localhost:3000 \ --paths paths.json \ --viewport 1440x900 \ --viewport 390x844 \ --zip

Preview before capturing

--dry-run resolves your targets and prints them, without opening a browser:

terminal
shotsweep capture --sitemap https://tour-guide.nforshifu234dev.com/sitemap.xml --dry-run

Next steps

Last updated on