Puppeteer SOP

Appearance

Install ​

Full Package (with bundled Chromium) ​

bash
npm i puppeteer

Installing puppeteer downloads a pinned version of Chromium during the postinstall step. This is the recommended starting point.

Core Package (no browser download) ​

bash
npm i puppeteer-core

puppeteer-core is a library-only build. You must supply the path to an existing Chrome or Chromium binary (or connect to a remote browser endpoint). Use this when:

  • Integrating with a cloud browser service (Steel, Browserbase, Hyperbrowser) via a CDP WebSocket URL
  • You have Chrome already installed and want to connect to it
  • Docker images where you install Chrome separately

Alternative Package Managers ​

bash
yarn add puppeteer
pnpm add puppeteer
bun add puppeteer

Manual Browser Installation ​

Some environments block install scripts. If Chromium was not downloaded automatically, install it manually:

bash
npx puppeteer browsers install chrome

To list available browser targets:

bash
npx puppeteer browsers list

TypeScript Support ​

Puppeteer ships its own TypeScript types -- no @types/ package needed.

Node Version ​

Requires Node.js 18 or later. Check with node -v.

No Starter Template ​

There is no official downloadable boilerplate. The official examples directory is: https://github.com/puppeteer/puppeteer/tree/main/examples