mkdmg

✨ Features

• 🚀 Simple: Create DMGs with a single command.
• ⚙️ Configurable: JSON configuration for reproducible builds.
• 📦 Formats: Supports multiple DMG formats (UDZO, UDBZ, ULFO, ULMO).
• 🔐 Security: Integrated codesigning and notarization workflow.
• 🖥️ Filesystems: Support for both HFS+ and APFS.
• 🛡️ Sandbox: Create sandbox-safe disk images.

📦 Installation

Pre-built Binaries

You can download the latest pre-built binaries for macOS (Darwin) from the GitHub Releases page.

1. Visit the releases page.
2. Download the archive matching your architecture (x86_64 or arm64).
3. Extract the archive and move the mkdmg binary to a directory in your PATH (e.g., /usr/local/bin).

From Source

Requires Go 1.26 or later.

go install al.essio.dev/cmd/mkdmg@latest

To build from a local checkout:

make build

Verification

To verify the integrity of the downloaded binary, you can use the checksums.txt file provided in the GitHub Releases.

1. Download the binary archive and the checksums.txt file.
2. Run the following command to verify the checksum:

sha256sum -c checksums.txt --ignore-missing

🚀 Usage

mkdmg [OPTION]... [OUTFILE.DMG [DIRECTORY]]

mkdmg reads its configuration from a JSON file (default: mkdmg.json in the current directory). You can optionally provide positional arguments to override the output path and source directory from the config.

# Use default config (mkdmg.json)
mkdmg

# Use a specific config file
mkdmg --config path/to/config.json

# Override output path and source directory
mkdmg MyApp.dmg ./build

# Override output path only (source_dir must be in config)
mkdmg MyApp.dmg

# Dry run to preview commands
mkdmg --dry-run --verbose

⚙️ Options

📄 JSON Configuration

All build settings are defined in the JSON configuration file.

Example mkdmg.json

{
  "volume_name": "MyApplication",
  "volume_size_mb": 0,
  "sandbox_safe": false,
  "bless": false,
  "filesystem": "HFS+",
  "signing_identity": "",
  "notarize_credentials": "",
  "image_format": "UDZO",
  "hdiutil_verbosity": 0,
  "output_path": "./dist/MyApplication.dmg",
  "source_dir": "./build/Release",
  "simulate": false
}

Configuration Reference