node package manager
Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

electron-installer-dmg

electron-installer-dmg travis npm

Create DMG installers for your electron apps using appdmg.

Installation

# For use in npm scripts
npm i electron-installer-dmg --save-dev
 
# For use from cli
npm i electron-installer-dmg -g

Usage

Usage: electron-installer-dmg <path/to/.app> <appname>
 
Create DMG installers for your electron apps.
 
Usage:
  electron-packager ./FooBar-darwin-x64/FooBar.app FooBar
 
Options:
  --out=<path>         The directory to put the DMG into. [Default: `process.cwd()`].
  --icon=<path>        Path to the icon file that will be the app icon in the DMG window.
  --icon-size=<px>     How big to make the icon for the app in the DMG. [Default: `80`].
  --background=<path>  Path to a PNG image to use as the background of the DMG.
  --debug              Enable debug messages.
  --overwrite          Overwrite any existing DMG.
  -h --help            Show this screen.
  --version            Show version.
 

API

var createDMG = require('electron-installer-dmg')
createDMG(opts, function done (err) { })

createDMG(opts, callback)

opts

Required appPath - String The .app directory generated by electron-packager.

name - String The application name.

Optional

background - String Path to the background for the DMG window.

icon - String Path to the icon to use for the app in the DMG window.

overwrite - Boolean Overwrite an existing DMG file if if already exists.

debug - Boolean Enable debug message output.

out - String The directory to put the DMG into. [Default: process.cwd()].

icon-size - Number How big to make the icon for the app in the DMG. [Default: 80].

format - String Disk image format. [Default: UDZO].

Must be one of the following:

  • UDRW ➡️ read/write image
  • UDRO ➡️ read-only image
  • UDCO ➡️ ADC-compressed image
  • UDZO ➡️ zlib-compressed image
  • UDBZ ➡️ bzip2-compressed image
  • ULFO ➡️ lzfse-compressed image (macOS 10.11+ only)
callback

err - Error Contains errors if any.

License

Apache 2.0