https://github.com/naturalcycles/puppeteer-lib

CLI to quickly produce PDFs from HTML files using Puppeteer
https://github.com/naturalcycles/puppeteer-lib

cli html pdf puppeteer

Last synced: about 1 month ago
JSON representation

CLI to quickly produce PDFs from HTML files using Puppeteer

• Host: GitHub
• URL: https://github.com/naturalcycles/puppeteer-lib
• Owner: NaturalCycles
• Created: 2019-04-23T16:51:57.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2022-12-03T06:54:13.000Z (about 2 years ago)
• Last Synced: 2024-11-15T22:09:51.422Z (about 2 months ago)
• Topics: cli, html, pdf, puppeteer
• Language: HTML
• Size: 1.06 MB
• Stars: 1
• Watchers: 13
• Forks: 0
• Open Issues: 12
• Metadata Files:
  • Readme: readme.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

        
## @naturalcycles/puppeteer-lib

> CLI to quickly produce PDFs or screenshots from HTML files or urls using Puppeteer

[![npm](https://img.shields.io/npm/v/@naturalcycles/puppeteer-lib/latest.svg)](https://www.npmjs.com/package/@naturalcycles/puppeteer-lib)

[![](https://circleci.com/gh/NaturalCycles/puppeteer-lib.svg?style=shield&circle-token=123)](https://circleci.com/gh/NaturalCycles/puppeteer-lib)

[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)

# Install

    yarn add @naturalcycles/puppeteer-lib

OR

    npm i @naturalcycles/puppeteer-lib

# Features

- `yarn html2pdf`

- `yarn html2png`

- `yarn url2pdf`

- `yarn url2png`

# html2pdf

    yarn html2pdf index.html

Will produce `index.html.pdf` file next to the original file.

Positional arguments:

- List of paths to process. Multiple files are supported. Globs are supported (see examples below).

Options:

Run `yarn html2pdf help` to see all available options.

- `--scale` Print scale, e.g `0.5`. Default: `1`.

- `--format`. Default: `A4`. Google which PDF formats Puppeteer supports.

- `--landscape`. Default: `false`.

- `--margins`, e.g `20mm 20mm 20mm 20mm` (css-like syntax).

- `--headerTemplate`, `--footerTemplate`

- `--headerTemplateFile`, `--footerTemplateFile`

- `--headerText`, `--footerText`

- `--headerTextFile`, `--footerTextFile`

- `--concurrency` Concurrency for opened Puppeteer pages. Default to 8. Tune if something is not

  working.

- `--verbose` Print more logs.

- `--debug`

Example, convert many matching files:

    yarn html2pdf index1.html index2.html

Example, convert all matching files:

    yarn html2pdf './someFolder/**/*.html'

# html2png

    yarn html2pdf index.html

Will produce `index.html.png` file next to the original file.

Positional arguments:

- List of paths to process. Multiple files are supported. Globs are supported (see examples below).

Options:

Run `yarn html2png help` to see all available options.

- `--verbose` Print more logs.

- `--concurrency` Concurrency for opened Puppeteer pages. Default to 8. Tune if something is not

  working.

- `--format`. Default: `png`. `jpeg` is also supported.

  - `--quality` `0-100`, only for `jpeg`

- `--wh` (Width/Height). Default: `800x600`. String, width/height separated by `x` character.

- `--fullpage`

Example, convert many matching files:

    yarn html2pdf index1.html index2.html

Example, convert all matching files:

    yarn html2pdf './someFolder/**/*.html'

# url2pdf

    yarn url2pdf https://google.com --outDir someDir

Will produce `someDir/1.pdf` file. Files are numbered incrementally starting with 1 based on order

of inputs.

Options: same as html2pdf, plus:

- `--outDir` - output directory (defaults to `cwd`)

# url2png

    yarn url2png https://google.com --outDir someDir

Will produce `someDir/1.png` file. Files are numbered incrementally starting with 1 based on order

of inputs.

Options: same as html2png, plus:

- `--outDir` - output directory (defaults to `cwd`)