github/puppeteer
0
0
Fork 0
mirror of https://github.com/puppeteer/puppeteer synced 2024-06-14 14:02:48 +00:00
Code Issues Packages Projects Releases Wiki Activity
fe0c74bd52
puppeteer/packages/browsers
History
release-please[bot] fe0c74bd52
chore: release main (#10003) 
Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com>
2023-04-13 14:26:52 +02:00
..
src fix: report install errors properly (#10016) 2023-04-13 10:20:02 +02:00
test/src fix: report install errors properly (#10016) 2023-04-13 10:20:02 +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 (#10003) 2023-04-13 14:26:52 +02:00
package.json chore: release main (#10003) 2023-04-13 14:26:52 +02:00
README.md docs: add readme to the API reference index (#10001) 2023-04-11 14:47:25 +02:00
tsconfig.json chore: introduce @puppeteer/browsers with a fetch method implementation (#9647) 2023-02-13 11:49:50 +01:00

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

  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.