Skip to content

Commit 9a54b9c

Browse files
docs: Update CLI installation instructions and browser handling
1 parent e90a184 commit 9a54b9c

1 file changed

Lines changed: 3 additions & 7 deletions

File tree

docs/pages/reference/cli.md

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -29,13 +29,9 @@ curl -fsSL https://cdn.edgepython.com/cli/install.sh | sh
2929
cargo install --path cli
3030
```
3131

32-
`install.sh` drops the binary at `~/.local/bin/edge` and appends that directory to your `~/.bashrc` or `~/.zshrc` if it isn't already on `PATH`. Open a new shell (or `source` the file it printed) and `edge --version` should work. Re-run the same `curl … | sh` line any time to upgrade. To remove everything: `curl -fsSL https://cdn.edgepython.com/cli/uninstall.sh | sh` (asks before touching Chromium).
32+
`install.sh` drops the binary at `~/.local/bin/edge` and appends that directory to your `~/.bashrc` or `~/.zshrc` if it isn't already on `PATH`. Open a new shell (or `source` the file it printed) and `edge --version` should work. Re-run the same `curl … | sh` line any time to upgrade. To remove everything: `curl -fsSL https://cdn.edgepython.com/cli/uninstall.sh | sh` (asks before removing the bundled browser cache).
3333

34-
`install.sh` also provisions Chromium if it isn't already on `PATH`. It reads `/etc/os-release` and uses the host's package manager (`apt`, `dnf`, `pacman`, `zypper`, `apk`, or `brew --cask` on macOS); `sudo` is invoked only when not running as root. On an unsupported distro, install Chrome/Chromium manually or set `EDGE_CHROME_PATH=/path/to/chrome`. See [Bring your own browser](#bring-your-own-browser).
35-
36-
## `edge run` — run a Python file
37-
38-
Runs a script and streams its output to the terminal. Imports resolve through [`packages.json`](/reference/imports#packagesjson); uncaught errors print a traceback to stderr and exit with code 1.
34+
`install.sh` also downloads a pinned `chrome-headless-shell` into `~/.cache/edge` when no browser is already reachable; this needs `unzip`, with no package manager and no `sudo`. An existing browser on `PATH`, or an `EDGE_CHROME_PATH` you set, is used as-is. Linux arm64 has no such build — install Chrome/Chromium manually and set `EDGE_CHROME_PATH`. See [Bring your own browser](#bring-your-own-browser).
3935

4036
```text
4137
$ edge run hello.py
@@ -169,4 +165,4 @@ Removes the binary and its `PATH` entry, and asks before removing Chromium. Equi
169165

170166
## Bring your own browser
171167

172-
`edge` drives whatever system Chrome/Chromium is on `PATH` (`chromium`, `chromium-browser`, `google-chrome`, or `microsoft-edge`). `install.sh` provisions it on supported distros and macOS; on anything else, install it manually or point `EDGE_CHROME_PATH=/path/to/chrome` at the binary.
168+
`edge` uses, in order: `EDGE_CHROME_PATH` if set, the bundled `chrome-headless-shell` in `~/.cache/edge`, or a system `chromium` / `chromium-browser` / `google-chrome` / `microsoft-edge` on `PATH`. `install.sh` downloads `chrome-headless-shell` when none is present; Linux arm64 has no build, so install Chrome/Chromium manually and point `EDGE_CHROME_PATH=/path/to/chrome` at it.

0 commit comments

Comments
 (0)