- By default checks only `stable`.
- Supports macOS / Windows / Linux
- Works both as an ES module or CommonJS
## Installation
```bash
npm i chromium-location
```
## Support table
This table lists the default locations where Chromium is typically installed for each supported platform and channel. By default, only the Stable channel is checked.
| Platform | Channel | Paths checked |
|---|---|---|
 macOS |
Chromium (Stable) |
|
 Windows |
Chromium (Stable) |
|
 Linux/other |
Chromium (Stable) |
|
null if none are found.
## Usage
**Via Node.js (strict by default):**
```js
// Returns the path to Chromium as a string.
import chromiumLocation, {
locateChromiumOrExplain,
getInstallGuidance,
getChromiumVersion
} from 'chromium-location'
// Strict (Stable only)
console.log(chromiumLocation())
// => "/Applications/Chromium.app/Contents/MacOS/Chromium" or null
// Enable fallback (Stable / alternative binaries on Linux)
console.log(chromiumLocation(true))
// Throw with an install guide when not found
try {
const path = locateChromiumOrExplain({allowFallback: true})
console.log(path)
// Cross-platform version (no exec by default)
const v = getChromiumVersion(path)
console.log(v) // e.g. "120.0.6099.109" or null
// Opt-in: allow executing the binary to fetch version on platforms without metadata (e.g. Linux)
const v2 = getChromiumVersion(path, {allowExec: true})
console.log(v2)
} catch (e) {
console.error(String(e))
// Or print getInstallGuidance() explicitly
}
```
**Via CLI:**
```bash
npx chromium-location
# Respect Puppeteer cache (after you install once):
npx @puppeteer/browsers install chromium
npx chromium-location
# Respect environment overrides
CHROMIUM_BINARY=/custom/path/to/chromium npx chromium-location
```
### Environment overrides
If any of these environment variables are set and point to an existing binary, they take precedence:
- `CHROMIUM_BINARY`
- `CHROME_BINARY`
### When nothing is found
When nothing is found, the helper throws with this message:
```
We couldn't find a Chromium browser on this machine.
To install one:
1) Install Chromium via Puppeteer Browsers (recommended)
npx @puppeteer/browsers install chromium
Re-run your command afterward and it will be detected automatically.
Alternatively, install Chromium using your OS package manager and re-run.
```
## API
- `default export locateChromium(allowFallback?: boolean): string | null`
- Returns the first existing path among the selected channels or `null`.
- When `allowFallback` is `true`, checks the stable locations and common alternatives per-platform.
- `locateChromiumOrExplain(options?: boolean | { allowFallback?: boolean }): string`
- Returns a path if found, otherwise throws an `Error` with a friendly installation guide.
- `getChromiumVersion(bin: string, opts?: { allowExec?: boolean }): string | null`
- Cross-platform version resolver that does not execute the browser by default.
- Windows: reads PE file metadata via PowerShell (no GUI spawn).
- macOS: reads `Info.plist` (no GUI spawn).
- Linux/other: attempts to infer from Puppeteer cache path; otherwise returns `null` unless `allowExec` is `true`.
- `getInstallGuidance(): string`
- Returns the same guidance text used by `locateChromiumOrExplain()`.
## Related projects
- [brave-location](https://github.com/cezaraugusto/brave-location)
- [chrome-location2](https://github.com/cezaraugusto/chrome-location2)
- [edge-location](https://github.com/cezaraugusto/edge-location)
- [firefox-location2](https://github.com/cezaraugusto/firefox-location2)
- [safari-location2](https://github.com/cezaraugusto/safari-location2)
- [opera-location2](https://github.com/cezaraugusto/opera-location2)
- [vivaldi-location2](https://github.com/cezaraugusto/vivaldi-location2)
- [waterfox-location](https://github.com/cezaraugusto/waterfox-location)
- [librewolf-location](https://github.com/cezaraugusto/librewolf-location)
- [yandex-location](https://github.com/cezaraugusto/yandex-location)
## Acknowledgements
This project is adapted from [chrome-location](http://github.com/hughsk/chrome-location).
## License
MIT (c) Cezar Augusto.