/sitemap-to-screenshot-cli

A little node-based CLI tool for generating screenshots, provided a valid sitemap.xml url.

Primary LanguageJavaScript

Sitemap to screenshot CLI

A little node-based CLI tool for generating screenshots, provided a valid sitemap.xml url

Installation

We recommend global installation, but you can use it however you'd like.

yarn global add sitemap-to-screenshot-cli
npm install -g sitemap-to-screenshot-cli

Usage

sm2ss --url=<URL_TO_SITEMAP>

The following options are supported:

Argument Default Value Required Type Notes
url yes string Url to a valid xml sitemap
vw 1366 int Viewport width
vh 768 int Viewport height
dir cwd string Output directory
timeout 60000 int Max time for screen capture in milleseconds
format pdf string Capture format. Supports pdf, png, jpeg
heightBuffer 0 int Add additional fixed height to the capture
limit 20 int Limit batch size - number of concurrent events
delay 0 int Delay between loading the page and capturing the screenshot
waitUntil networkidle2 string Wait until there is only X active network connections
preset null string Path to a valid json file with options. See example-preset.json

Development and testing

yarn test
yarn lint
yarn lint-fix