Package Exports

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (snaprocket) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

🚀 Snaprocket

Snaprocket is a fast CLI tool for capturing screenshots of web pages using Puppeteer with multiple viewports and custom configurations. It is designed to be simple, flexible, and highly configurable, making it perfect for developers and testers who need quick visual feedback of websites.

✨ Features

Fast Screenshot Capture: Leverages Puppeteer to quickly capture screenshots of web pages.
Multiple Viewports: Supports default viewports ("s", "m", "l", "xl") and user-defined custom resolutions.
Custom Configurations: Easily configure timeouts, height limits, and output directories.
Flexible Usage: Capture full-page or constrained screenshots based on your needs.

📥 Installation

You can install Snaprocket using your favorite package manager: npm, Yarn, or pnpm.

Global Installation

Using npm:
```
npm install -g snaprocket
```
Using Yarn:
```
yarn global add snaprocket
```
Using pnpm:
```
pnpm install -g snaprocket
```

Local Installation (Development Dependency)

Using npm:
```
npm install --save-dev snaprocket
```
Using Yarn:
```
yarn add --dev snaprocket
```
Using pnpm:
```
pnpm add -D snaprocket
```

💻 Usage

Run snaprocket from the command line with the following syntax:

snaprocket -h <baseURL> -p <paths> [-t <timeout>] [-o <output_directory>] [-H <height>] [-c <width>x<height>]... [-v <viewports>...]

Command-line Arguments

-h: Base URL (required) – The starting URL for capturing screenshots.
-p: Paths (required) – One or more URL paths to capture. Provide each path as a space-separated list.
-t: Timeout – Delay (in milliseconds) after the page loads before capturing a screenshot (default: 1000).
-o: Output Directory – Directory where screenshots will be saved. Defaults to the current working directory. Screenshots are organized into sub-folders by domain and viewport.
-H: Height Limit – If provided, only captures up to the specified height (in pixels). If omitted, the entire page is captured.
-c or --custom: Custom Resolution(s) – Specify custom resolution(s) in the format WIDTHxHEIGHT. This flag can be repeated to add multiple resolutions.
-v: Viewports – Define which viewports to generate. Acceptable values are s, m, l, xl, and custom (to include all custom resolutions defined with -c). If omitted, screenshots are generated for all default viewports and any custom resolutions.

Examples

1. Full-page screenshots for default viewports

Capture screenshots for the homepage, blog, bio, and contact pages:

snaprocket -h https://dawidrylko.com -p / /blog /bio /contact

2. Screenshots with a height limit for selected viewports

Capture screenshots with a height limit of 800 pixels for the "s" (small) and "xl" (extra-large) viewports:

snaprocket -h https://dawidrylko.com -p / /blog -H 800 -v s xl

3. Screenshots with custom resolutions

Generate screenshots using two custom resolutions (800x600 and 1200x800). The -v custom flag ensures that only the specified custom viewports are processed:

snaprocket -h https://dawidrylko.com -p / -v custom -c 800x600 -c 1200x800

📂 Directory Structure

After execution, screenshots will be organized in the output directory as shown below:

📁 output_directory/
  └── dawidrylko.com/
      ├── s/
      ├── m/
      ├── l/
      └── xl/

Note: If custom viewports are used, an additional folder (e.g. custom/) will be created containing screenshots for each custom resolution.

📜 License

This project is licensed under the MIT License – see the LICENSE file for details.

👨‍💻 Author

Developed and maintained by Dawid Ryłko.