Package cross-platform binaries

Downloads in past


0.2.33 years ago7 years agoMinified + gzip package size for binwrap in KB


Build Status npm
This package helps with distributing binaries via npm.


First, create your compiled binaries and make them available via HTTPS.
Now create your npm installer: Make a package.json that looks like this:
  "name": "myApp",
  "version": "1.0.0",
  "description": "Install myApp",
  "preferGlobal": true,
  "main": "index.js",
  "scripts": {
    "install": "binwrap-install",
    "prepare": "binwrap-prepare",
    "test": "binwrap-test",
    "prepublish": "npm test"
  "license": "BSD-3-Clause",
  "files": [
  "bin": {
    "myapp-cli": "bin/myapp-cli"
  "dependencies": {
    "binwrap": "^0.2.3"

Then create your index.js file like this:
var binwrap = require("binwrap");
var path = require("path");

var packageInfo = require(path.join(__dirname, "package.json"));
var version = packageInfo.version;
var root = "" + version;

module.exports = binwrap({
  dirname: __dirname,
  binaries: [
  urls: {
    "darwin-x64": root + "/mac-x64.tgz",
    "linux-x64": root + "/linux-x64.tgz",
    "win32-x64": root + "/",
    "win32-ia32": root + "/"

Then run npm test to verify that your packages are published correctly.
Finally, run npm publish when you are ready to publish your installer.

Javascript API

Javascript code can get the absolute path to a binary from a package that uses binwrap as follows (in this example, "my-package" is a published npm package that uses binwrap, and has a my-package-cli binary):
const cliPath = require('my-package').paths['my-package-cli'];