webcapt - CLI for web capture

• Motivation
• Prerequisites
• Quick start
  • Install
• Usage
  • Examples
• Contribute
  • Clone the repo
  • Install dependencies
  • Develop
  • Build the project and link locally for development
  • Run tests
  • Submit a pull request
• License

Motivation

A simple cli to screen capture web pages and save them to disk as images or pdfs.

Prerequisites

• Node.js
• puppeteer

[!IMPORTANT] You need to install puppeteer globally to use webcapt.

npm install -g puppeteer

Quick start

Install

npm install -g webcapt

pnpm install -g webcapt

Usage

webcapt -h

Usage: webcapt [options] [command]

A simple cli to screen capture web pages and save them to disk as images or pdfs.

Options:
  -V, --version   output the version number
  -h, --help      display help for command

Commands:
  pdf [options]   Screenshot the provided url and download as a pdf
  img [options]   Screenshot the provided url and download as an image
  help [command]  display help for command

wbecapt pdf -h

Usage: webcapt pdf [options]

Screenshot the provided url and download as a pdf

Options:
  -u, --url <url>        URL to download
  -o, --output <output>  Output file name
  -f, --format <format>  Format of the file to download, options: A4 or letter (default: "A4")
  -h, --help             display help for command

webcapt img -h

Usage: webcapt img [options]

Screenshot the provided url and download as an image

Options:
  -u, --url <url>        URL to download
  -o, --output <output>  Output file name
  -f, --format <format>  Format of the file to download, options: png or jpeg (default: "png")
  -h, --help             display help for command

Examples

Note: For pdfs and images, you don't need to specify the file's extension if you want to download to a format other than the default, you can use the -f flag and specify the file's format.

webcapt pdf -u https://google.com -o example

If you want to download an image in jpeg format:

webcapt img -u https://google.com -o example -f jpeg

If you want to download a pdf in letter format:

webcapt pdf -u https://google.com -o example -f letter

Contribute

Clone the repo

git clone https://github.com/theodrosyimer/webcapt@latest
cd webcapt

Install dependencies

pnpm install

Develop

pnpm dev

reset the local link

pnpm dev:reset

Build the project and link locally for development

pnpm build-link

Run tests

Unit tests

pnpm test

Integration tests

pnpm run test:int

End to end tests

pnpm run test:e2e

Full test suite

pnpm run test:all

Submit a pull request

If you'd like to contribute code, documentation, or any other improvements, please fork the project, make your changes, and submit a pull request.

If you're unsure about adding a feature or fixing a bug, create an issue to discuss it first.

License

MIT © Theodros Yimer