puppeteer/packages/browsers/README.md

# @puppeteer/browsers

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

## CLI

Use `npx` to run the CLI:

```bash
npx @puppeteer/browsers --help
```

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

```bash
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, 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).
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.
chore: introduce @puppeteer/browsers with a fetch method implementation (#9647) Co-authored-by: Nikolay Vitkov <34244704+Lightning00Blade@users.noreply.github.com> 2023-02-13 10:49:50 +00:00			`# @puppeteer/browsers`

docs: add basic docs for browsers (#9867) Co-authored-by: Nikolay Vitkov <34244704+Lightning00Blade@users.noreply.github.com> 2023-03-16 08:57:28 +00:00			`Manage and launch browsers/drivers from a CLI or programmatically.`

			`## CLI`

docs: add readme to the API reference index (#10001) 2023-04-11 12:47:25 +00:00			Use `npx` to run the CLI:
docs: add basic docs for browsers (#9867) Co-authored-by: Nikolay Vitkov <34244704+Lightning00Blade@users.noreply.github.com> 2023-03-16 08:57:28 +00:00
docs: use bash tag to get better formatting (#10086) 2023-04-26 09:32:33 +00:00			```bash
docs: add basic docs for browsers (#9867) Co-authored-by: Nikolay Vitkov <34244704+Lightning00Blade@users.noreply.github.com> 2023-03-16 08:57:28 +00:00			`npx @puppeteer/browsers --help`
			```

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

docs: use bash tag to get better formatting (#10086) 2023-04-26 09:32:33 +00:00			```bash
docs: add basic docs for browsers (#9867) Co-authored-by: Nikolay Vitkov <34244704+Lightning00Blade@users.noreply.github.com> 2023-03-16 08:57:28 +00:00			`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`
			```

docs: add readme to the API reference index (#10001) 2023-04-11 12:47:25 +00:00			`## Known limitations`
docs: add basic docs for browsers (#9867) Co-authored-by: Nikolay Vitkov <34244704+Lightning00Blade@users.noreply.github.com> 2023-03-16 08:57:28 +00:00
feat: support stable/dev/beta/canary keywords for chrome and chromium (#10140) 2023-05-08 12:54:44 +00:00			1. 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).
docs: add basic docs for browsers (#9867) Co-authored-by: Nikolay Vitkov <34244704+Lightning00Blade@users.noreply.github.com> 2023-03-16 08:57:28 +00:00			`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.