Skip to content

Commit 6a71238

Browse files
authored
Updated readme to mention installing chrome / providing CHROME_PATH (#269)
1 parent e7ad17e commit 6a71238

File tree

1 file changed

+21
-1
lines changed

1 file changed

+21
-1
lines changed

README.md

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,27 @@ uv run python examples/full_example.py
3434

3535
## Local mode example
3636

37-
If you want to run Stagehand locally, use the local example (`examples/local_example.py`). It shows how to configure the client for `server="local"`:
37+
If you want to run Stagehand locally, use the local example (`examples/local_example.py`). It shows how to configure the client for `server="local"`.
38+
39+
Local mode runs Stagehand’s embedded server and launches a **local Chrome/Chromium** browser (it is **not bundled** with the Python wheel), so you must have Chrome installed on the machine running the example.
40+
41+
If Chrome is installed but Stagehand can’t find it, set `CHROME_PATH` to your browser executable (or pass `browser.launchOptions.executablePath` when starting the session).
42+
43+
Common Windows paths:
44+
- `C:\Program Files\Google\Chrome\Application\chrome.exe`
45+
- `C:\Program Files (x86)\Google\Chrome\Application\chrome.exe`
46+
47+
PowerShell:
48+
49+
```powershell
50+
# optional if you don't already have Chrome installed
51+
winget install -e --id Google.Chrome
52+
53+
# optional if Stagehand can't auto-detect Chrome
54+
$env:CHROME_PATH="C:\Program Files\Google\Chrome\Application\chrome.exe"
55+
56+
uv run python examples/local_example.py
57+
```
3858

3959
```bash
4060
pip install stagehand-alpha

0 commit comments

Comments
 (0)