Skip to main content

Interface: PkgOptions

macOS product archive options.

Extends​

Properties​

allowAnywhere?​

readonly optional allowAnywhere?: boolean | null

Whether can be installed at the root of any volume, including non-system volumes. Otherwise, it cannot be installed at the root of a volume.

Corresponds to enable_anywhere.

Default​

true

allowCurrentUserHome?​

readonly optional allowCurrentUserHome?: boolean | null

Whether can be installed into the current user’s home directory. A home directory installation is done as the current user (not as root), and it cannot write outside of the home directory. If the product cannot be installed in the user’s home directory and be not completely functional from user’s home directory.

Corresponds to enable_currentUserHome.

Default​

true

allowRootDirectory?​

readonly optional allowRootDirectory?: boolean | null

Whether can be installed into the root directory. Should usually be true unless the product can be installed only to the user’s home directory.

Corresponds to enable_localSystem.

Default​

true

artifactName?​

readonly optional artifactName?: string | null

The artifact file name template.

Inherited from​

TargetSpecificOptions.artifactName

background?​

readonly optional background?: PkgBackgroundOptions | null

Options for the background image for the installer.

conclusion?​

readonly optional conclusion?: string | null

The path to the conclusion file. This may be used to customize the text on the final "Summary" page of the installer.

extraPkgsDir?​

readonly optional extraPkgsDir?: string | null

The extra component packages directory (relative to build resources directory) for MacOS product archive Autoscans directory for any .pkg files and adds to productbuild command as --package-path and --package accordingly

hasStrictIdentifier?​

readonly optional hasStrictIdentifier?: boolean | null

Require identical bundle identifiers at install path?

Default​

true

identity?​

readonly optional identity?: string | null

The name of certificate to use when signing. Consider using environment variables CSC_LINK or CSC_NAME instead of specifying this option.

installLocation?​

readonly optional installLocation?: string | null

The install location. Do not use it to create per-user package. Mostly never you will need to change this option. /Applications would install it as expected into /Applications if the local system domain is chosen, or into $HOME/Applications if the home installation is chosen.

Default​

/Applications

isRelocatable?​

readonly optional isRelocatable?: boolean | null

Install bundle over previous version if moved by user?

Default​

true

isVersionChecked?​

readonly optional isVersionChecked?: boolean | null

Don't install bundle if newer version on disk?

Default​

true

license?​

readonly optional license?: string | null

The path to EULA license file. Defaults to license.txt or eula.txt (or uppercase variants). In addition to txt, rtf and html supported (don't forget to use target="_blank" for links).

mustClose?​

readonly optional mustClose?: string[] | null

Identifies applications that must be closed before the package is installed.

Corresponds to must-close.

overwriteAction?​

readonly optional overwriteAction?: "update" | "upgrade" | null

Specifies how an existing version of the bundle on disk should be handled when the version in the package is installed.

If you specify upgrade, the bundle in the package atomi-cally replaces any version on disk; this has the effect of deleting old paths that no longer exist in the new version of the bundle.

If you specify update, the bundle in the package overwrites the version on disk, and any files not contained in the package will be left intact; this is appropriate when you are delivering an update-only package.

Another effect of update is that the package bundle will not be installed at all if there is not already a version on disk; this allows a package to deliver an update for an app that the user might have deleted.

Default​

upgrade

publish?​

optional publish?: Publish

Inherited from​

TargetSpecificOptions.publish

scripts?​

readonly optional scripts?: string | null

The scripts directory, relative to build (build resources directory). The scripts can be in any language so long as the files are marked executable and have the appropriate shebang indicating the path to the interpreter. Scripts are required to be executable (chmod +x file).

Default​

build/pkg-scripts

See​

Scripting in installer packages.

welcome?​

readonly optional welcome?: string | null

The path to the welcome file. This may be used to customize the text on the Introduction page of the installer.