Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/andreyvit/create-dmg

A shell script to build fancy DMGs
https://github.com/andreyvit/create-dmg

bash dmg macos

Last synced: 3 months ago
JSON representation

A shell script to build fancy DMGs

Awesome Lists containing this project

README 

        
create-dmg

==========



A shell script to build fancy DMGs.



Status and contribution policy

------------------------------



Create-dmg is mostly maintained by [@aonez](https://github.com/aonez) and the contributors who send pull requests.

The project home page is .



We will merge any pull request that adds something useful and does not break existing things.



If you're an active user and want to be a maintainer, or just want to chat, please ping us on Gitter at [gitter.im/create-dmg/Lobby](https://gitter.im/create-dmg/Lobby), or [email Andrew directly]([email protected]).



Create-dmg was originally created by [Andrey Tarantsov](https://github.com/andreyvit).

In May 2020 [Andrew Janke](https://github.com/apjanke) helped vastly with the project.



Installation

------------



- You can install this script using [Homebrew](https://brew.sh):



  ```sh

  brew install create-dmg

  ```



- You can download the [latest release](https://github.com/create-dmg/create-dmg/releases/latest) and install it from there:



  ```sh

  make install

  ```



- You can also clone the entire repository and run it locally from there:



  ```sh

  git clone https://github.com/create-dmg/create-dmg.git

  ```



Usage

-----



```sh

create-dmg [options ...]  

```



All contents of source\_folder will be copied into the disk image.



**Options:**



- **--volname \:** set volume name (displayed in the Finder sidebar and window title)

- **--volicon \:** set volume icon

- **--background \:** set folder background image (provide png, gif, jpg)

- **--window-pos \ \:** set position the folder window

- **--window-size \ \:** set size of the folder window

- **--text-size \:** set window text size (10-16)

- **--icon-size \:** set window icons size (up to 128)

- **--icon \ \ \:** set position of the file's icon

- **--hide-extension \:** hide the extension of file

- **--app-drop-link \ \:** make a drop link to Applications, at location x, y

- **--ql-drop-link \ \:** make a drop link to /Library/QuickLook, at location x, y

- **--eula \:** attach a license file to the dmg

- **--rez \:** specify custom path to Rez tool used to include license file

- **--no-internet-enable:** disable automatic mount&copy

- **--format:** specify the final image format (UDZO|UDBZ|ULFO|ULMO) (default is UDZO)

- **--filesystem:** specify the image filesystem (HFS+|APFS) (default is HFS+, APFS supports macOS 10.13 or newer)

- **--encrypt:** enable encryption for the resulting disk image (AES-256 - you will be prompted for password)

- **--encrypt-aes128:** enable encryption for the resulting disk image (AES-128 - you will be prompted for password)

- **--add-file \ \ \ \:** add additional file or folder (can be used multiple times)

- **--disk-image-size \:** set the disk image size manually to x MB

- **--hdiutil-verbose:** execute hdiutil in verbose mode

- **--hdiutil-quiet:** execute hdiutil in quiet mode

- **--bless:** bless the mount folder (deprecated, needs macOS 12.2.1 or older, [#127](https://github.com/create-dmg/create-dmg/pull/127))

- **--codesign \:** codesign the disk image with the specified signature

- **--notarize \:** notarize the disk image (waits and staples) with the keychain stored credentials

    For more information check [Apple's documentation](https://developer.apple.com/documentation/security/notarizing_macos_software_before_distribution/customizing_the_notarization_workflow)

- **--skip-jenkins:** skip Finder-prettifying AppleScript, useful in Sandbox and non-GUI environments, [#72](https://github.com/create-dmg/create-dmg/pull/72)

- **--sandbox-safe:** hdiutil with sandbox compatibility, do not bless and do not execute the cosmetic AppleScript (not supported for APFS disk images)

- **--version:** show tool version number

- **-h, --help:** display the help



Encryption

-------

hdiutil supports native disk image encryption using AES-256 (slower but stronger) or AES-128 (faster but weaker).  Enabling disk image encryption via create-dmg will require the entry of the password during the middle (compression phase) of the process.  Take care to enter the password correctly, because hdiutil will not prompt a second time to confirm the password.



Example

-------



```sh

#!/bin/sh

test -f Application-Installer.dmg && rm Application-Installer.dmg

create-dmg \

  --volname "Application Installer" \

  --volicon "application_icon.icns" \

  --background "installer_background.png" \

  --window-pos 200 120 \

  --window-size 800 400 \

  --icon-size 100 \

  --icon "Application.app" 200 190 \

  --hide-extension "Application.app" \

  --app-drop-link 600 185 \

  "Application-Installer.dmg" \

  "source_folder/"

```



See the `examples` folder in the source tree for more examples.



Requirements

------------



Nothing except a standard installation of macOS/OS X is required.



We think this works in OS X 10.6 Snow Leopard and later.



We'd like to keep it working in as many versions as possible, but unfortunately, we just don't have test boxes running old versions of OS X adequate to make this happen. Development and testing mostly happens in the last 3-5 years' worth of macOS releases; as of 2020, this means macOS 10.12 and later.



But if you find a bug in an older version, go ahead and report it! We'll try to work with you to get it fixed.



If you're running OS X 10.5 or earlier, you're SOL. That's just too hard to deal with in 2023. ;)



Alternatives

------------



- [node-appdmg](https://github.com/LinusU/node-appdmg)

- [dmgbuild](https://pypi.python.org/pypi/dmgbuild)

- see the [StackOverflow question](http://stackoverflow.com/questions/96882/how-do-i-create-a-nice-looking-dmg-for-mac-os-x-using-command-line-tools)