# puppeteer-pdf-cli

> A command-line wrapper for generating PDF prints and PNG screenshots with Puppeteer.

Latest version **1.0.1** (published 2023-08-25) · MIT license · 0 weekly downloads

## Install

```sh
npm install puppeteer-pdf-cli
pnpm add puppeteer-pdf-cli
yarn add puppeteer-pdf-cli
bun add puppeteer-pdf-cli
```

Provides the command `puppeteer`.

## Health

**Score 35/100 (D)** — status: abandoned.

Positive: esm support; no vulnerabilities; has provenance.

Warnings: low downloads; no types.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2023-08-25 |
| First published | 2023-08-24 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM |
| Dependencies | 5 |
| Unpacked size | 10 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 0 |
| Author | GroupeLM - Lionel Bataille |
| Maintainers | grouplm |

## Links

- npm: https://www.npmjs.com/package/puppeteer-pdf-cli
- Repository: https://github.com/GroupeLM/puppeteer-pdf-cli
- Homepage: https://github.com/GroupeLM/puppeteer-pdf-cli#readme
- Issues: https://github.com/GroupeLM/puppeteer-pdf-cli/issues
- npm.io page: https://npm.io/package/puppeteer-pdf-cli

## Dependencies (5)

- [yargs](https://npm.io/package/yargs.md) ^17.7.2
- [is-url](https://npm.io/package/is-url.md) ^1.2.4
- [file-url](https://npm.io/package/file-url.md) ^4.0.0
- [puppeteer](https://npm.io/package/puppeteer.md) ^21.1.0
- [url-parse](https://npm.io/package/url-parse.md) ^1.4.7

## Recent versions

- 1.0.1 (latest) — 2023-08-25
- 1.0.0 — 2023-08-24

## README

# puppeteer-pdf-cli

A command-line wrapper for generating PDF prints and PNG screenshots with [Puppeteer](https://developers.google.com/web/tools/puppeteer). Aims to be a easy replacement for the deprecated wkhtmltopdf.

## Install

```bash
npm install -g puppeteer-pdf-cli
```

## Usage

```bash
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: ""]
```

```bash
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

``` shell
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
```

---
_Source: https://npm.io/package/puppeteer-pdf-cli · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._