Skip to main content

screenshot

screenshot [url]

Take a screenshot of a specified element from an <html> document.

arguments:​

url​

The url for the request. (type: string)

flags:​

--appendStage​

Used to append the results from a previous stage to the current stage. (provide a label, stage index, or boolean true to append the previous results)

--args​

array of JSON encoded values to pass to expression as input

--attributes​

A comma separated list of attributes to include in the command results. If not provided, all attributes will be included.

--background​

background color in either RGB or HEX format including transparent

--base64​

base64 encoded variant of image NOTE: large images (ie., body selector) can significantly increase JSON payload sizes

--cache​

A boolean value of true/false that determines whether or not to use the cache. Generally most commands will default to true.

--cookieStorage​

JSON serialized Cookie values to set pre-request

--device​

device to emulate, see devices command

--engine​

css selector engine; "dom" or "jquery"

--expression​

javascript expression to evaluate after completion ES6 fat-arrow format with an argument of data passed (example "(data)=>data.map(item=>item.innerText)")

--filter​

A filter to run on the command results before completing the command. If not provided, no filter is run on the results.

--fresh​

Starts the stage as if it was a fresh query, so will not use any previous result.

--headers​

JSON header values to set pre-request

--jquery​

inject jquery library in last object argument passed to expression (example "(data, { $ })=>$('a').html()

--labelStage​

Used to label a stage with a user provided label.

--localStorage​

JSON sessionStorage values to set pre-request

--lodash​

inject lodash library in last object argument passed to expression (example "(data, { })=>)

--mathjs​

inject mathjs library in last object argument passed to expression (example "(data, { mathjs })=>mathjs)

--quality​

quality of the image from 0-100 for jpg images only

--retry​

number attempts to sucessfully run the following task

--selector​

CSS selector expression

--session​

capture session information; cookieStorage, localStorage and sessionStorage

--sessionStorage​

JSON serialized sessionStorage values to set pre-request

--stats​

Controls if a stats calculation is run on a stage after it completes.

--type​

image format; "png" or "jpeg"

--viewportHeight​

device viewport height in pixels

--viewportWidth​

device viewport width in pixels