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