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

docs: add readme to the API reference index (#10001)

Browse Source
This commit is contained in:
Alex Rudenko
2023-04-11 14:47:25 +02:00
committed by GitHub
parent 1eca5663f1
commit dba1b2d9cc
3 changed files with 41 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
docs/browsers-api/index.md
View File

@@ -2,7 +2,34 @@
sidebar_label: API
---
# API Reference
# @puppeteer/browsers
Manage and launch browsers/drivers from a CLI or programmatically.
## CLI
Use `npx` to run the CLI:
```sh
npx @puppeteer/browsers --help
```
CLI help will provide all documentation you need to use the CLI.
```sh
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.
## Classes