Skip to content

Commit 7405655

Browse files
mxschmittmxschmitt
authored
docs(cli): add install-deps command and reference to it (#6374)
1 parent 934bc67 commit 7405655

File tree

6 files changed

+103
-30
lines changed

6 files changed

+103
-30
lines changed

‎docs/src/cli.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -369,5 +369,24 @@ $ mvn exec:java -e -Dexec.mainClass=com.microsoft.playwright.CLI -Dexec.args="pd
369369
$ playwright pdf https://en.wikipedia.org/wiki/PDF wiki.pdf
370370
```
371371

372+
## Install system dependencies
373+
374+
Ubuntu 18.04 and Ubuntu 20.04 system dependencies can get installed automatically. This is useful for CI environments.
375+
376+
```sh js
377+
# See command help
378+
$ npx playwright install-deps
379+
```
380+
381+
```sh java
382+
# See command help
383+
$ mvn exec:java -e -Dexec.mainClass=com.microsoft.playwright.CLI -Dexec.args="install-deps"
384+
```
385+
386+
```sh python
387+
# See command help
388+
$ playwright install-deps
389+
```
390+
372391
## Known limitations
373392
Opening WebKit Web Inspector will disconnect Playwright from the browser. In such cases, code generation will stop.

‎docs/src/intro-csharp.md

Lines changed: 20 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -50,10 +50,23 @@ Command Line Interface [CLI](./cli.md) can be used to record user interactions a
5050

5151
The browser binaries for Chromium, Firefox and WebKit work across the 3 platforms (Windows, macOS, Linux):
5252

53-
* **Windows**: Works with Windows and Windows Subsystem for Linux (WSL).
54-
* **macOS**: Requires 10.14 or above.
55-
* **Linux**: Depending on your Linux distribution, you might need to install additional
56-
dependencies to run the browsers.
57-
* Firefox requires Ubuntu 18.04+
58-
* For Ubuntu 20.04, the additional dependencies are defined in [our Docker image](https://github.com/microsoft/playwright/blob/master/utils/docker/Dockerfile.focal),
59-
which is based on Ubuntu.
53+
### Windows
54+
55+
Works with Windows and Windows Subsystem for Linux (WSL).
56+
57+
### macOS
58+
59+
Requires 10.14 (Mojave) or above.
60+
61+
### Linux
62+
63+
Depending on your Linux distribution, you might need to install additional
64+
dependencies to run the browsers.
65+
66+
:::note
67+
Only Ubuntu 18.04 and Ubuntu 20.04 are officially supported.
68+
:::
69+
70+
See also in the [Command Line Interface](./cli.md#install-system-dependencies)
71+
which has a command to install all necessary dependencies automatically for Ubuntu
72+
LTS releases.

‎docs/src/intro-java.md

Lines changed: 20 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -128,10 +128,23 @@ $ mvn exec:java -e -Dexec.mainClass=com.microsoft.playwright.CLI -Dexec.args="co
128128
Playwright requires **Java 8** or newer. The browser binaries for Chromium,
129129
Firefox and WebKit work across the 3 platforms (Windows, macOS, Linux):
130130

131-
* **Windows**: Works with Windows and Windows Subsystem for Linux (WSL).
132-
* **macOS**: Requires 10.14 or above.
133-
* **Linux**: Depending on your Linux distribution, you might need to install additional
134-
dependencies to run the browsers.
135-
* Firefox requires Ubuntu 18.04+
136-
* For Ubuntu 20.04, the additional dependencies are defined in [our Docker image](https://github.com/microsoft/playwright/blob/master/utils/docker/Dockerfile.focal),
137-
which is based on Ubuntu.
131+
### Windows
132+
133+
Works with Windows and Windows Subsystem for Linux (WSL).
134+
135+
### macOS
136+
137+
Requires 10.14 (Mojave) or above.
138+
139+
### Linux
140+
141+
Depending on your Linux distribution, you might need to install additional
142+
dependencies to run the browsers.
143+
144+
:::note
145+
Only Ubuntu 18.04 and Ubuntu 20.04 are officially supported.
146+
:::
147+
148+
See also in the [Command Line Interface](./cli.md#install-system-dependencies)
149+
which has a command to install all necessary dependencies automatically for Ubuntu
150+
LTS releases.

‎docs/src/intro-js.md

Lines changed: 20 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -100,10 +100,23 @@ let page: import('playwright').Page;
100100
Playwright requires Node.js version 10.17 or above. The browser binaries for Chromium,
101101
Firefox and WebKit work across the 3 platforms (Windows, macOS, Linux):
102102

103-
* **Windows**: Works with Windows and Windows Subsystem for Linux (WSL).
104-
* **macOS**: Requires 10.14 or above.
105-
* **Linux**: Depending on your Linux distribution, you might need to install additional
106-
dependencies to run the browsers.
107-
* Firefox requires Ubuntu 18.04+
108-
* For Ubuntu 20.04, the additional dependencies are defined in [our Docker image](https://github.com/microsoft/playwright/blob/master/utils/docker/Dockerfile.focal),
109-
which is based on Ubuntu.
103+
### Windows
104+
105+
Works with Windows and Windows Subsystem for Linux (WSL).
106+
107+
### macOS
108+
109+
Requires 10.14 (Mojave) or above.
110+
111+
### Linux
112+
113+
Depending on your Linux distribution, you might need to install additional
114+
dependencies to run the browsers.
115+
116+
:::note
117+
Only Ubuntu 18.04 and Ubuntu 20.04 are officially supported.
118+
:::
119+
120+
See also in the [Command Line Interface](./cli.md#install-system-dependencies)
121+
which has a command to install all necessary dependencies automatically for Ubuntu
122+
LTS releases.

‎docs/src/intro-python.md

Lines changed: 21 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -80,13 +80,26 @@ $ playwright codegen wikipedia.org
8080

8181
## System requirements
8282

83-
Playwright requires Python version 3.7 or above. The browser binaries for Chromium,
83+
Playwright requires Python 3.7 or above. The browser binaries for Chromium,
8484
Firefox and WebKit work across the 3 platforms (Windows, macOS, Linux):
8585

86-
* **Windows**: Works with Windows and Windows Subsystem for Linux (WSL).
87-
* **macOS**: Requires 10.14 or above.
88-
* **Linux**: Depending on your Linux distribution, you might need to install additional
89-
dependencies to run the browsers.
90-
* Firefox requires Ubuntu 18.04+
91-
* For Ubuntu 20.04, the additional dependencies are defined in [our Docker image](https://github.com/microsoft/playwright/blob/master/utils/docker/Dockerfile.focal),
92-
which is based on Ubuntu.
86+
### Windows
87+
88+
Works with Windows and Windows Subsystem for Linux (WSL).
89+
90+
### macOS
91+
92+
Requires 10.14 (Mojave) or above.
93+
94+
### Linux
95+
96+
Depending on your Linux distribution, you might need to install additional
97+
dependencies to run the browsers.
98+
99+
:::note
100+
Only Ubuntu 18.04 and Ubuntu 20.04 are officially supported.
101+
:::
102+
103+
See also in the [Command Line Interface](./cli.md#install-system-dependencies)
104+
which has a command to install all necessary dependencies automatically for Ubuntu
105+
LTS releases.

‎docs/src/troubleshooting.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,9 @@ title: "Troubleshooting"
1010
Playwright does self-inspection every time it runs to make sure the browsers can be launched successfully. If there are missing
1111
dependencies, playwright will print instructions to acquire them.
1212

13-
We also provide [Ubuntu 18.04 dockerfile](https://github.com/microsoft/playwright/blob/master/utils/docker/Dockerfile.bionic) and [Ubuntu 20.04 dockerfile](https://github.com/microsoft/playwright/blob/master/utils/docker/Dockerfile.focal) with the list of Debian dependencies.
13+
See also in the [Command Line Interface](./cli.md#install-system-dependencies)
14+
which has a command to install all necessary dependencies automatically for Ubuntu
15+
LTS releases.
1416

1517
## Code transpilation issues
1618

0 commit comments

Comments
 (0)