site-shutter
TypeScript icon, indicating that this package has built-in type declarations

1.1.5 • Public • Published

Shutter

Shutter captures screenshots of internal website pages and compares them for differences.

Travis branch npm npm npm

Installation

$ npm install -g site-shutter

Quick Start

Quickest way to compare two environments is to use the compare command, navigate to a folder you want the comparisons to appear and run the command.

Compare two sites:

$ shutter compare http://example.com http://staging.com

shutter compare accepts two urls or two folder paths containing screenshots. The screenshots must be named the same in each folder and must be (png)'s

$ shutter compare path/to/original/screenshots path/to/comparison/screenshots

Screenshots

With shutter screenshots it is possible to capture any number of environments then compare them.

Screenshot any number of environments:

$ shutter screenshots master=example.com develop=staging.example.com

Screenshots must follow the convention [ENVIRONMENT]=[DOMAIN] the [ENVIRONMENT] is used for the output folder. Do not use symbols in the environment.

Compare the output with:

$ shutter compare master develop

Command Line Options

This tool can also be further configured with the following command line flags.

-h, --help          output usage information
    --version       output the version number

Notes

  • Be patient the crawling and screenshot process are very cpu intensive
  • The first site passed to the command defines the internal page paths for all of the other sites
  • Any sites larger than (600 pages +) will fail (Don't try and crawl google :$)

Coming soon!

  • Usage with docker
  • Assign your own config values
    • Concurrency
    • Chunk size
    • Crawler depth
    • And many more
  • Module support
  • Better windows support
  • Spinners / loading bars to indicate time taken
  • Performance optimization

Licence

MIT

Package Sidebar

Install

npm i site-shutter

Weekly Downloads

3

Version

1.1.5

License

MIT

Last publish

Collaborators

  • moshie