@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,stablekeywords are only supported for the install command. For thelaunchcommand you need to specify an exact build ID. The build ID is provided by theinstallcommand (seenpx @puppeteer/browsers install --helpfor 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.
Classes
| Class | Description |
|---|---|
| CLI | |
| InstalledBrowser | |
| Process | |
| TimeoutError |
Enumerations
| Enumeration | Description |
|---|---|
| Browser | Supported browsers. |
| BrowserPlatform | Platform names used to identify a OS platform x architecture combination in the way that is relevant for the browser download. |
| ChromeReleaseChannel |
Functions
| Function | Description |
|---|---|
| canDownload(options) | |
| computeExecutablePath(options) | |
| computeSystemExecutablePath(options) | |
| createProfile(browser, opts) | |
| detectBrowserPlatform() | |
| getInstalledBrowsers(options) | Returns metadata about browsers installed in the cache directory. |
| getVersionComparator(browser) | Returns a version comparator for the given browser that can be used to sort browser versions. |
| install(options) | |
| install(options) | |
| launch(opts) | |
| makeProgressCallback(browser, buildId) | |
| resolveBuildId(browser, platform, tag) | |
| uninstall(options) |
Interfaces
| Interface | Description |
|---|---|
| GetInstalledBrowsersOptions | |
| InstallOptions | |
| LaunchOptions | |
| Options | |
| ProfileOptions | |
| SystemOptions | |
| UninstallOptions |
Variables
| Variable | Description |
|---|---|
| CDP_WEBSOCKET_ENDPOINT_REGEX | |
| WEBDRIVER_BIDI_WEBSOCKET_ENDPOINT_REGEX |