puppeteer/packages/browsers
release-please[bot] 3a6569e8ef
chore: release main (#10137)
Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com>
2023-05-05 13:25:47 +02:00
..
src fix: rename PUPPETEER_DOWNLOAD_HOST to PUPPETEER_DOWNLOAD_BASE_URL (#10130) 2023-05-05 10:32:58 +02:00
test/src feat!: switch to Chrome for Testing instead of Chromium (#10054) 2023-05-02 08:53:40 +02:00
tools refactor: rename fetch->install, launcher->launch (#9985) 2023-04-06 13:23:28 +02:00
.gitignore chore: test server for browsers (#9974) 2023-04-05 16:18:25 +02:00
.mocharc.cjs chore: test server for browsers (#9974) 2023-04-05 16:18:25 +02:00
api-extractor.docs.json docs: website docs for browsers (#9986) 2023-04-06 14:23:10 +02:00
api-extractor.json docs: website docs for browsers (#9986) 2023-04-06 14:23:10 +02:00
CHANGELOG.md chore: release main (#10137) 2023-05-05 13:25:47 +02:00
package.json chore: release main (#10137) 2023-05-05 13:25:47 +02:00
README.md docs: use bash tag to get better formatting (#10086) 2023-04-26 11:32:33 +02:00
tsconfig.json chore: introduce @puppeteer/browsers with a fetch method implementation (#9647) 2023-02-13 11:49:50 +01:00

@puppeteer/browsers

Manage and launch browsers/drivers from a CLI or programmatically.

CLI

Use npx to run the CLI:

npx @puppeteer/browsers --help

CLI help will provide all documentation you need to use the CLI.

npx @puppeteer/browsers --help # help for all commands
npx @puppeteer/browsers install --help # help for the install command
npx @puppeteer/browsers launch --help # help for the launch command

Known limitations

  1. We support installing and running Firefox and Chrome/Chromium. The latest keyword only works during the installation. For the launch command you need to specify an exact build ID. The build ID is provided by the install command (see npx @puppeteer/browsers install --help for the format).
  2. Launching the system browsers is only possible for Chrome/Chromium.

API

The programmatic API allows installing and launching browsers from your code. See the test folder for examples on how to use the install, canInstall, launch, computeExecutablePath, computeSystemExecutablePath and other methods.