Skip to content
A general command-line wrapper for puppeteer. Currently only supports one command—`print`—to render a local/or remote HTML file to PDF. Aims to be a easy replacement for the deprecated wkhtmltopdf.
JavaScript
Branch: develop
Clone or download
Pull request Compare This branch is even with JarvusInnovations:develop.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.vscode
.gitignore
.npmignore
LICENSE
README.md
index.js
package-lock.json
package.json

README.md

puppeteer-cli

A general command-line wrapper for puppeteer. Currently only supports one command—print—to render a local/or remote HTML file to PDF. Aims to be a easy replacement for the deprecated wkhtmltopdf.

Usage

puppeteer print <input> <output>

Print an HTML file or URL to PDF

Options:
  --version        Show version number                                 [boolean]
  --help           Show help                                           [boolean]
  --background                                         [boolean] [default: true]
  --margin-top                                               [default: "6.25mm"]
  --margin-right                                             [default: "6.25mm"]
  --margin-bottom                                           [default: "14.11mm"]
  --margin-left                                              [default: "6.25mm"]
  --format                                                   [default: "Letter"]
  --timeout                                            [number] [default: 30000]
  --landscape                                         [boolean] [default: false]
puppeteer screenshot <input> <output>

Take screenshot of an HTML file or URL to PNG

Options:
  --version          Show version number                               [boolean]
  --help             Show help                                         [boolean]
  --full-page                                          [boolean] [default: true]
  --omit-background                                   [boolean] [default: false]
  --viewport         Set viewport to a given size, e.g. 800x600         [string]

Example

npm install -g puppeteer-cli
echo "<h1>Hello world!</h1>" > mypage.html
puppeteer print mypage.html myprint.pdf # local file
puppeteer print https://github.com/JarvusInnovations/puppeteer-cli puppeteer-cli.pdf # url
puppeteer screenshot mypage.html myscreenshot.png # local file
puppeteer screenshot https://jarv.us myscreenshot.png # url
puppeteer screenshot https://jarv.us myscreenshot.png --viewport 300x200

Roadmap

  • Add print command
  • Add support for http:// inputs in addition to local file paths
  • Add screenshot command
  • Add compatibility with wkhtmltopdf parameters to provide a drop-in replacement?
  • Detect .json or .js files as input to screenshot command instead of a single HTML file or URL, specifying a set of screenshots to capture in series
You can’t perform that action at this time.