README.md



prebuild-install


A command line tool to easily install prebuilt binaries for multiple versions of Node.js & Electron on a specific platform.
By default it downloads prebuilt binaries from a GitHub release.


Note

Instead of prebuild paired with prebuild-install, we recommend prebuildify paired with node-gyp-build.

With prebuildify, all prebuilt binaries are shipped inside the package that is published to npm, which means there's no need for a separate download step like you find in prebuild. The irony of this approach is that it is faster to download all prebuilt binaries for every platform when they are bundled than it is to download a single prebuilt binary as an install script.

Upsides:


No extra download step, making it more reliable and faster to install.
Supports changing runtime versions locally and using the same install between Node.js and Electron. Reinstalling or rebuilding is not necessary, as all prebuilt binaries are in the npm tarball and the correct one is simply picked on runtime.
The node-gyp-build runtime dependency is dependency-free and will remain so out of principle, because introducing dependencies would negate the shorter install time.
Prebuilt binaries work even if npm install scripts are disabled.
The npm package checksum covers prebuilt binaries too.


Downsides:


The installed npm package is larger on disk. Using Node-API alleviates this because Node-API binaries are runtime-agnostic and forward-compatible.
Publishing is mildly more complicated, because npm publish must be done after compiling and fetching prebuilt binaries (typically in CI).


Usage

Use prebuild to create and upload prebuilt binaries. Then change your package.json install script to:

{
  "scripts": {
    "install": "prebuild-install || node-gyp rebuild"
  }
}


Help

prebuild-install [options]

  --download    -d  [url]       (download prebuilds, no url means github)
  --target      -t  version     (version to install for)
  --runtime     -r  runtime     (Node runtime [node, napi or electron] to build or install for, default is node)
  --path        -p  path        (make a prebuild-install here)
  --token       -T  gh-token    (github token for private repos)
  --arch            arch        (target CPU architecture, see Node OS module docs, default is current arch)
  --platform        platform    (target platform, see Node OS module docs, default is current platform)
  --tag-prefix <prefix>         (github tag prefix, default is "v")
  --build-from-source           (skip prebuild download)
  --verbose                     (log verbosely)
  --libc                        (use provided libc rather than system default)
  --debug                       (set Debug or Release configuration)
  --version                     (print prebuild-install version and exit)


When prebuild-install is run via an npm script, options --build-from-source, --debug, --download, --target, --runtime, --arch and --platform may be passed through via arguments given to the npm command.

Alternatively you can set environment variables npm_config_build_from_source=true, npm_config_platform, npm_config_arch, npm_config_target and npm_config_runtime.


Private Repositories

prebuild-install supports downloading prebuilds from private GitHub repositories using the -T <github-token>:

$ prebuild-install -T <github-token>


If you don't want to use the token on cli you can put it in ~/.prebuild-installrc:

token=<github-token>


Alternatively you can specify it in the prebuild-install_token environment variable.

Note that using a GitHub token uses the API to resolve the correct release meaning that you are subject to the (GitHub Rate Limit).


Create GitHub Token

To create a token:


Go to this page

Click the Generate new token button
Give the token a name and click the Generate token button, see below


The default scopes should be fine.


Custom binaries

The end user can override binary download location through environment variables in their .npmrc file.
The variable needs to meet the mask % your package name %_binary_host or % your package name %_binary_host_mirror. For example:

leveldown_binary_host=http://overriden-host.com/overriden-path


Note that the package version subpath and file name will still be appended.
So if you are installing leveldown@1.2.3 the resulting url will be:

http://overriden-host.com/overriden-path/v1.2.3/leveldown-v1.2.3-node-v57-win32-x64.tar.gz


Local prebuilds

If you want to use prebuilds from your local filesystem, you can use the % your package name %_local_prebuilds .npmrc variable to set a path to the folder containing prebuilds. For example:

leveldown_local_prebuilds=/path/to/prebuilds


This option will look directly in that folder for bundles created with prebuild, for example:

/path/to/prebuilds/leveldown-v1.2.3-node-v57-win32-x64.tar.gz


Non-absolute paths resolve relative to the directory of the package invoking prebuild-install, e.g. for nested dependencies.


Cache

All prebuilt binaries are cached to minimize traffic. So first prebuild-install picks binaries from the cache and if no binary could be found, it will be downloaded. Depending on the environment, the cache folder is determined in the following order:


${npm_config_cache}/_prebuilds
${APP_DATA}/npm-cache/_prebuilds
${HOME}/.npm/_prebuilds


License

MIT