puppeteer/packages/browsers
release-please[bot] a63b8305ac
chore: release main (#12190)
Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com>
2024-04-05 13:11:52 +00:00
..
src fix: do not use fallback download URLs if custom baseUrl is provided (#12206) 2024-04-04 14:21:55 +00:00
test/src fix: do not use fallback download URLs if custom baseUrl is provided (#12206) 2024-04-04 14:21:55 +00:00
tools ci: fix firefox test pin (#12036) 2024-03-04 10:41:44 +01:00
.mocharc.cjs chore: remove unused code and dep (#11705) 2024-01-19 14:03:29 +01: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 (#12190) 2024-04-05 13:11:52 +00:00
package.json chore: release main (#12190) 2024-04-05 13:11:52 +00:00
README.md docs: update @puppeteer/browsers readme (#12220) 2024-04-05 12:03:40 +00:00
tsconfig.json chore(deps-dev): Bump the dev-dependencies group with 13 updates (#11908) 2024-02-14 18:20:12 +00:00
tsdoc.json chore: update license headers (#11563) 2024-01-03 10:11:33 +00:00

@puppeteer/browsers

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

CLI

Use npx to run the CLI:

npx @puppeteer/browsers --help

Built-in per-command 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

Some example to give an idea of what the CLI looks like (use the --help command for more examples):

# Download the latest available Chrome for Testing binary corresponding to the Stable channel.
npx @puppeteer/browsers install chrome@stable

# Download a specific Chrome for Testing version.
npx @puppeteer/browsers install chrome@116.0.5793.0

# Download the latest Chrome for Testing version for the given milestone.
npx @puppeteer/browsers install chrome@117

# Download the latest available ChromeDriver version corresponding to the Canary channel.
npx @puppeteer/browsers install chromedriver@canary

# Download a specific ChromeDriver version.
npx @puppeteer/browsers install chromedriver@116.0.5793.0

Known limitations

  1. 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.