https://github.com/juliangruber/download-chromium

Download Chromium!
https://github.com/juliangruber/download-chromium

Last synced: 12 days ago
JSON representation

Download Chromium!

• Host: GitHub
• URL: https://github.com/juliangruber/download-chromium
• Owner: juliangruber
• Created: 2017-09-16T11:58:11.000Z (about 7 years ago)
• Default Branch: main
• Last Pushed: 2024-02-20T19:25:28.000Z (9 months ago)
• Last Synced: 2024-10-17T19:52:46.429Z (26 days ago)
• Language: JavaScript
• Size: 764 KB
• Stars: 26
• Watchers: 4
• Forks: 8
• Open Issues: 4
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# download-chromium

[![CI](https://github.com/juliangruber/download-chromium/actions/workflows/ci.yml/badge.svg)](https://github.com/juliangruber/download-chromium/actions/workflows/ci.yml)

Download [Chromium](https://www.chromium.org/)!

Caches executables locally so you never download them twice.

Comes with a convenient CLI, so you can do things like this:

```bash

$ $(download-chromium) --headless --screenshot --disable-gpu https://twitter.com/

```

## Usage

Use the CLI:

```bash

$ download-chromium

Downloading Chromium r499413...Done!

/Users/julian/.chromium-cache/chromium-mac-499413/chrome-mac/Chromium.app/Contents/MacOS/Chromium

```

Or use the JavaScript API:

```js

const download = require('download-chromium')

const exec = await download()

console.log(`Downloaded Chromium to ${exec}`)

```

```bash

$ node example.js

Downloaded Chromium to /Users/julian/.chromium-cache/chromium-mac-499413/chrome-mac/Chromium.app/Contents/MacOS/Chromium

```

## Installation

```bash

# for the CLI

$ npm install -g download-chromium

# for the API

$ npm install download-chromium

```

## API

### download

```

download({ 

	platform = currentPlatform, 

	revision = '499413', 

	log = false, 

	onProgress = undefined, 

	installPath = '{__dirname}/.local-chromium' })

```

Returns a Promise resolving with the Chromium executable path.

* `installPath`: set the install path if you can't write to your `node_modules`, eg from within an `electron` packaged app (`installPath: require('electron').app.getPath('userData')`)

* `onProgress`: track download progress. `onProgress` receives one argument `{ percent, transferred, total }` 

## Kudos

This script was based on https://github.com/puppeteer/puppeteer/blob/11d94525c821ab1bb6e059f3b998a8660f597348/utils/ChromiumDownloader.js.

## License

MIT