mirror of https://github.com/puppeteer/puppeteer synced 2024-06-14 14:02:48 +00:00

History

release-please[bot] 9a814a3656 chore: release main (#10598 ) Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com>		2023-08-02 14:50:46 +02:00
..
src	fix: clear pending TLS socket handle (#10667 )	2023-08-01 18:33:35 +02:00
test/src	chore: removes dependency on Firefox Json endpoint (#10668 )	2023-08-01 11:55:16 +00:00
tools	chore: removes dependency on Firefox Json endpoint (#10668 )	2023-08-01 11:55:16 +00:00
.gitignore
.mocharc.cjs
api-extractor.docs.json
api-extractor.json
CHANGELOG.md	chore: release main (#10598 )	2023-08-02 14:50:46 +02:00
package.json	chore: release main (#10598 )	2023-08-02 14:50:46 +02:00
README.md	feat: support stable/dev/beta/canary keywords for chrome and chromium (#10140 )	2023-05-08 14:54:44 +02:00
tsconfig.json

README.md

@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

We support installing and running Firefox, Chrome and Chromium. The latest, beta, dev, canary, stable keywords are only supported for the install command. 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).
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.