create-dmg

Create a good-looking DMG for your macOS app in seconds

Github stars Tracking Chart

create-dmg Build Status

Create a good-looking DMG for your macOS app in seconds

Imagine you have finished a macOS app, exported it from Xcode, and now want to distribute it to users. The most common way of distributing an app outside the Mac App Store is by putting it in a .dmg file. These are hard to create, especially good-looking ones. You can either pay for a GUI app where you have to customize an existing design or you can run some homebrewed Bash script and you still have to design it. This tool does everything for you, so you can play with your ? instead.

Discuss it on Product Hunt and Twitter.

This tool is intentionally opinionated and simple. I'm not interested in adding lots of options.

You might also find my LaunchAtLogin project useful.

Install

Ensure you have Node.js 8 or later installed. Then run the following:

$ npm install --global create-dmg

Usage

$ create-dmg --help

  Usage
    $ create-dmg <app> [destination]

  Options
    --overwrite         Overwrite existing DMG with the same name
    --identity=<value>  Manually set code signing identity (automatic by default)
    --dmg-title=<value>  Manually set title of DMG volume (only used if app name is >27 character limit)

  Examples
    $ create-dmg 'Lungo.app'
    $ create-dmg 'Lungo.app' Build/Releases

DMG

The DMG requires macOS 10.11 or later and has the filename App Name 0.0.0.dmg, for example Lungo 1.0.0.dmg.

It will try to code sign the DMG, but the DMG is still created and fine even if the code signing fails, for example if you don't have a developer certificate.

DMG Icon

GraphicsMagick is required to create the custom DMG icon that's based on the app icon and the macOS mounted device icon.

Steps using Homebrew

$ brew install graphicsmagick imagemagick

Icon Example

Original icon → DMG icon

Main metrics

Overview
Name With Ownersindresorhus/create-dmg
Primary LanguageJavaScript
Program languageJavaScript (Language Count: 2)
Platform
License:MIT License
所有者活动
Created At2017-03-27 17:24:44
Pushed At2024-01-30 10:16:23
Last Commit At
Release Count25
Last Release Namev7.0.0 (Posted on 2024-01-30 17:15:34)
First Release Namev1.0.0 (Posted on 2017-03-28 00:36:33)
用户参与
Stargazers Count4.9k
Watchers Count36
Fork Count207
Commits Count83
Has Issues Enabled
Issues Count61
Issue Open Count7
Pull Requests Count19
Pull Requests Open Count0
Pull Requests Close Count13
项目设置
Has Wiki Enabled
Is Archived
Is Fork
Is Locked
Is Mirror
Is Private