jarvusinnovations/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.

puppeteer-cli

A command-line wrapper for generating PDF prints and PNG screenshots with Puppeteer. Aims to be a easy replacement for the deprecated wkhtmltopdf.

Install

npm install -g puppeteer-cli

Usage

puppeteer print <url> [output]

Print an HTML file or URL to PDF

Options:
  --version                Show version number                         [boolean]
  --help                   Show help                                   [boolean]
  --sandbox                                            [boolean] [default: true]
  --timeout                                            [number] [default: 30000]
  --wait-until                                        [string] [default: "load"]
  --cookie                 Set a cookie in the form "key:value". May be repeated
                           for multiple cookies.                        [string]
  --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"]
  --landscape                                         [boolean] [default: false]
  --display-header-footer                             [boolean] [default: false]
  --header-template                                       [string] [default: ""]
  --footer-template                                       [string] [default: ""]

puppeteer screenshot <url> [output]

Take screenshot of an HTML file or URL to PNG

Options:
  --version          Show version number                               [boolean]
  --help             Show help                                         [boolean]
  --sandbox                                            [boolean] [default: true]
  --timeout                                            [number] [default: 30000]
  --wait-until                                        [string] [default: "load"]
  --cookie           Set a cookie in the form "key:value". May be repeated for
                     multiple cookies.                                  [string]
  --full-page                                          [boolean] [default: true]
  --omit-background                                   [boolean] [default: false]
  --viewport         Set viewport to a given size, e.g. 800x600         [string]

Example

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

puppeteer-cli's Issues

Source fetching

What's your thought about having a command like:

puppeteer source https://github.com

Which will just return the HTML source as text for that page?
I'm happy to create a PR for this but first wanted to check what your idea was about this feature.

GitHub "about" text is out of date

Current text:

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.

This is no longer accurate - the screenshot command can output to PNG.

Cookie issue

When building the cookies the code incorrectly uses the spread operator which causes the passed cooke string to not be read correctly.

The line return [...cookie].map(cookieString => { forces the cookies to be read one character at a time which is incorrect.

Changing the line to return [cookie].map(cookieString => { fixes this problem.

I would do a PR but I don't know how!

Header and Footer doesn't Show

Hi!

I'm trying to use the headerTemplate and footerTemplate option, like in the puppeteer documentation, but nothing seems to appear in my print. Am I missing something?

const headerTemplate = Header 1; const footerTemplate = Footer;

const buffer = await page.pdf({ path: filePath || null, format: argv.format, landscape: argv.landscape, printBackground: argv.background, margin: { top: argv.marginTop, right: argv.marginRight, bottom: argv.marginBottom, left: argv.marginLeft }, displayHeaderFooter: true, headerTemplate: headerTemplate, footerTemplate: footerTemplate, pageRanges: pageRangeArray[index] });

Support for deviceScaleFactor

Can you add support for deviceScaleFactor? I’d like to capture screenshots in retina resolution but I can’t do that with viewport alone.

A detailed explanation of how this is done on puppeteer is mentioned here: puppeteer/puppeteer#1329 (comment)

getting a punch of garbage

sprunge.us/sMiEhK

$ npx puppeteer-cli print https://www.ft.com/content/2bbedfde-c9da-4bc6-b2e6-af0698240851

External imported fonts - randomly not rendered

My page import fonts from adobe cdn. And they are randomly not render correctly. Approx 1 of 10 rendered fonts are not render at all or are used default fallback fonts. I struggle with this and i found solution.

Before render pdf i wait for fonts ready.

  //....
  // Output options if in debug mode
  if (cli.debug) {
    console.log(options);
  }
  await page.evaluateHandle('document.fonts.ready'); // add this line
  await page.pdf(options);

Would be nice to allow deviceScaleFactor for higher dpi screenshots

puppeteer-cli/index.js

Line 162 in 89a2670

await page.setViewport({

See example:
puppeteer/puppeteer#571 (comment)

import { loadScript } from "@paypal/paypal-js";

import { loadScript } from "@paypal/paypal-js";
loadScript({ "client-id": shango420 ID })
.then((paypal) => {
// start to use the PayPal JS SDK script
})
.catch((err) => {
console.error("failed to load the PayPal JS SDK script", err);
});

Publicado originalmente por @shango420 en shango420/echo--script-src-https-www.paypal.com-sdk-js-client-id-SU_CLIENTE_ID-componentes-SU_COMPONENTES-s#10 (comment)

Nuev

team-review-requested:[TEAMNAME

I can't install it...Why???

sudo npm install -g puppeteer-cli

/usr/local/bin/puppeteer -> /usr/local/lib/node_modules/puppeteer-cli/index.js

[email protected] install /usr/local/lib/node_modules/puppeteer-cli/node_modules/puppeteer
node install.js

ERROR: Failed to download Chromium r686378! Set "PUPPETEER_SKIP_CHROMIUM_DOWNLOAD" env variable to skip download.
{ Error: EACCES: permission denied, mkdir '/usr/local/lib/node_modules/puppeteer-cli/node_modules/puppeteer/.local-chromium'
-- ASYNC --
at BrowserFetcher. (/usr/local/lib/node_modules/puppeteer-cli/node_modules/puppeteer/lib/helper.js:111:15)
at Object. (/usr/local/lib/node_modules/puppeteer-cli/node_modules/puppeteer/install.js:64:16)
at Module._compile (internal/modules/cjs/loader.js:778:30)
at Object.Module._extensions..js (internal/modules/cjs/loader.js:789:10)
at Module.load (internal/modules/cjs/loader.js:653:32)
at tryModuleLoad (internal/modules/cjs/loader.js:593:12)
at Function.Module._load (internal/modules/cjs/loader.js:585:3)
at Function.Module.runMain (internal/modules/cjs/loader.js:831:12)
at startup (internal/bootstrap/node.js:283:19)
at bootstrapNodeJSCore (internal/bootstrap/node.js:622:3)
errno: -13,
code: 'EACCES',
syscall: 'mkdir',
path:
'/usr/local/lib/node_modules/puppeteer-cli/node_modules/puppeteer/.local-chromium' }
npm ERR! code ELIFECYCLE
npm ERR! errno 1
npm ERR! [email protected] install: node install.js
npm ERR! Exit status 1
npm ERR!
npm ERR! Failed at the [email protected] install script.
npm ERR! This is probably not a problem with npm. There is likely additional logging output above.

npm ERR! A complete log of this run can be found in:
npm ERR! /home/martin/.npm/_logs/2020-01-11T22_27_48_870Z-debug.log

Invalid regular expression when using --viewport=1920x1080

I am receiving an invalid regular expression error when using the puppeteer-cli 1.5.1 on ubuntu 18.04 LTS.

The result is listed below, why would this error trigger?

Failed to take screenshot: SyntaxError: Invalid regular expression: /^(?<width>\d+)[xX](?<height>\d+)$/: Invalid group at screenshot (/usr/local/lib/node_modules/puppeteer-cli/index.js:153:43) at <anonymous> at process._tickCallback (internal/process/next_tick.js:188:7)

Feature Proposal: Execute a script, injecting the puppeteer module.

Like that:

$ puppeteer-cli script ./script.js

and allow the script require puppeteer module without installation need.

Update puppeteer ?

puppeteer is in version 19 now, is this repo still maintained ?

Doesn't run on Apple M1 (can't set executablePath to work around it, either).

Right now, buildLaunchOptions only sets args. If it could set the executablePath, it'd be possible to point Puppeteer to a local copy of Chromium (since there is no ARM Chromium build available yet).

If there is interest, I'd be happy to look into building this in, testing, and raising a pull request.