Gathering detailed insights and metrics for electron-installer-dmg
Gathering detailed insights and metrics for electron-installer-dmg
Gathering detailed insights and metrics for electron-installer-dmg
Gathering detailed insights and metrics for electron-installer-dmg
electron-builder
A complete solution to package and build a ready for distribution Electron app for MacOS, Windows and Linux with “auto update” support out of the box
app-builder-lib
electron-builder lib
@electron-forge/installer-dmg
DMG file installer for Electron Forge
@types/electron-installer-dmg
TypeScript definitions for electron-installer-dmg
Create DMG installers for your electron apps using appdmg.
npm install electron-installer-dmg
Typescript
Module System
Min. Node Version
Node Version
NPM Version
TypeScript (84.53%)
JavaScript (15.47%)
Total Downloads
0
Last Day
0
Last Week
0
Last Month
0
Last Year
0
Apache-2.0 License
326 Stars
129 Commits
40 Forks
10 Watchers
16 Branches
22 Contributors
Updated on Jun 03, 2025
Latest Version
5.0.1
Package Id
electron-installer-dmg@5.0.1
Unpacked Size
303.93 kB
Size
271.58 kB
File Count
12
NPM Version
10.2.4
Node Version
20.11.0
Published on
Jul 02, 2024
Cumulative downloads
Total Downloads
Last Day
0%
NaN
Compared to previous day
Last Week
0%
NaN
Compared to previous week
Last Month
0%
NaN
Compared to previous month
Last Year
0%
NaN
Compared to previous year
Create DMG installers for your electron apps using appdmg.
This module requires using macOS and Node 16 or above.
For use in npm scripts:
1npm i electron-installer-dmg --save-dev
For use from cli:
1npm i electron-installer-dmg -g
Usage: electron-installer-dmg <path/to/.app> <appname>
Create DMG installers for your electron apps.
Usage:
electron-installer-dmg ./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. [Size: 658 x 498]
--title=<string> The title of the produced DMG, which will be shown when mounted.
--overwrite Overwrite any existing DMG.
-h --help Show this screen.
--version Show version.
1const { createDMG } = require('electron-installer-dmg'); 2 3async function buildDMG() { 4 await createDMG({ 5 appPath: '/path/to/app.app', 6 name: 'MyApp' 7 }); 8}
opts
appPath
- String - Required
The .app
directory generated by electron-packager.
name
- String - Required
The application name.
title
- String
The title of the produced DMG, which will be shown when mounted.
background
- String
Path to the background for the DMG window. Background image should be of size 658 × 498.
icon
- String
Path to the icon to use for the app in the DMG window.
iconSize
- Number
How big to make the icon for the app in the DMG. [Default: 80
].
overwrite
- Boolean
Overwrite an existing DMG file if if already exists.
out
- String
The directory to put the DMG into. [Default: process.cwd()
].
contents
- Array or Function that returns an Array of objects.
The content that will appear in the window when user opens the .dmg
file.
[Default: Array of two icons, application and application destination folder].
Array example:
1[ { x: 448, y: 344, type: 'link', path: '/Applications'}, 2 { x: 192, y: 344, type: 'file', path: '/path/to/application.app'} ]
Function example (more flexible for getting useful options used in creating a DMG):
1function (opts) { 2 return [ { x: 448, y: 344, type: 'link', path: '/Applications'}, 3 { x: 192, y: 344, type: 'file', path: opts.appPath} ]; 4}
format
- String
Disk image format. [Default: UDZO
].
UDRW
:arrow_right: read/write imageUDRO
:arrow_right: read-only imageUDCO
:arrow_right: ADC-compressed imageUDZO
:arrow_right: zlib-compressed imageUDBZ
:arrow_right: bzip2-compressed imageULFO
:arrow_right: lzfse-compressed image (macOS 10.11+ only)additionalDMGOptions
- Object
Additional options to pass through to appdmg
You can use this to set additional features like background-color
and
code-sign
. See the docs of the appdmg
module for all possible options.
Apache 2.0
No vulnerabilities found.
Reason
no dangerous workflow patterns detected
Reason
no binaries found in the repo
Reason
license file detected
Details
Reason
dependency not pinned by hash detected -- score normalized to 6
Details
Reason
Found 5/11 approved changesets -- score normalized to 4
Reason
0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0
Reason
detected GitHub workflow tokens with excessive permissions
Details
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
security policy file not detected
Details
Reason
project is not fuzzed
Details
Reason
branch protection not enabled on development/release branches
Details
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
Reason
13 existing vulnerabilities detected
Details
Score
Last Scanned on 2025-07-07
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More