Home

Awesome

electron-installer-zip

CI status npm Code coverage

Create a zip file with support for symlinks required by Electron on macOS.

Installation

# For use in npm scripts
npm i electron-installer-zip --save-dev

# For use from cli
npm i electron-installer-zip -g

Usage

electron-installer-zip <dir> <out>

Options:
  --verbose  Confused or trying to track down a bug and want lots of debug
             output?                                  [boolean] [default: false]
  --help     Show help                                                 [boolean]

var zip = require('electron-installer-zip');

var opts = {
  dir: 'dist/MongoDB Compass-darwin-x64/MongoDB Compass.app',
  // out can either be a directory or a path for a ZIP file
  out: 'dist/',
  // out: 'dist/App.zip',
};

zip(opts, function(err, res) {
  if (err) {
    console.error(err);
    process.exit(1);
  }
  console.log('Zip file written to: ', res);
});

License

Apache 2.0