shot-scraper 命令

常用示例

说明

shot-scraper is a command-line utility for taking automated screenshots of websites, built on Playwright. It can capture full pages, specific elements, or execute JavaScript before capturing. The tool is designed for documentation, automated testing, and web scraping workflows. Beyond screenshots, shot-scraper can execute JavaScript on pages and return results, generate PDFs, export accessibility trees, and capture HAR (HTTP Archive) files. It integrates well with CI/CD pipelines, particularly GitHub Actions, for generating regularly updated screenshots. Before first use, run shot-scraper install to download the required browser binaries.

参数

-o, --output _FILE_

Output filename. Use - for stdout.

-w, --width _PIXELS_

Browser viewport width. Default: 1280.

-h, --height _PIXELS_

Browser viewport height. Default: full page.

-s, --selector _SELECTOR_

CSS selector to capture instead of full page.

--selector-all _SELECTOR_

Capture all elements matching the selector.

--padding _PIXELS_

Add padding around selected elements.

--js-selector _EXPRESSION_

JavaScript expression to filter elements.

--wait _MS_

Milliseconds to wait after page load.

--wait-for _EXPRESSION_

Wait until JavaScript expression is truthy.

-j, --javascript _CODE_

Execute JavaScript before taking screenshot.

--quality _PERCENT_

Save as JPEG with specified quality (1-100).

--retina

Use device scale factor of 2.

--scale-factor _N_

Custom device pixel ratio.

--omit-background

Transparent background (PNG only).

-b, --browser _NAME_

Browser to use: chromium, firefox, webkit, chrome.

--browser-arg _ARG_

Pass command-line argument to browser.

--user-agent _STRING_

Custom User-Agent header.

-i, --interactive

Pause for manual interaction before capture.

--bypass-csp

Bypass Content-Security-Policy restrictions.

--log-requests _FILE_

Log HTTP requests as newline-delimited JSON.

--timeout _MS_

Timeout in milliseconds before failing.