JSON schema for electron-build configuration file. Json Format

$schema - JSON Schema for this document.

appId - The application id. Used as [CFBundleIdentifier](https://developer.apple.com/library/ios/documentation/General/Reference/InfoPlistKeyReference/Articles/CoreFoundationKeys.html#//apple_ref/doc/uid/20001431-102070) for MacOS and as [Application User Model ID](https://msdn.microsoft.com/en-us/library/windows/desktop/dd378459(v=vs.85).aspx) for Windows (NSIS target only, Squirrel.Windows not supported). It is strongly recommended that an explicit ID is set.

artifactName - The [artifact file name template](/configuration/configuration#artifact-file-name-template). Defaults to `${productName}-${version}.${ext}` (some target can have other defaults, see corresponding options).

buildDependenciesFromSource - Whether to build the application native dependencies from source.

buildVersion - The build version. Maps to the `CFBundleVersion` on macOS, and `FileVersion` metadata property on Windows. Defaults to the `version`. If `TRAVIS_BUILD_NUMBER` or `APPVEYOR_BUILD_NUMBER` or `CIRCLE_BUILD_NUM` or `BUILD_NUMBER` or `bamboo.buildNumber` env defined, it will be used as a build version (`version.build_number`).

cscKeyPassword

cscLink

detectUpdateChannel - Whether to infer update channel from application version pre-release components. e.g. if version `0.12.1-alpha.1`, channel will be set to `alpha`. Otherwise to `latest`.

electronCompile - Whether to use [electron-compile](http://github.com/electron/electron-compile) to compile app. Defaults to `true` if `electron-compile` in the dependencies. And `false` if in the `devDependencies` or doesn't specified.

electronDist - The path to custom Electron build (e.g. `~/electron/out/R`).

.electronDownload - ElectronDownloadOptions

_

electronDownload.arch

electronDownload.cache - The [cache location](https://github.com/electron-userland/electron-download#cache-location).

electronDownload.customDir

electronDownload.customFilename

electronDownload.isVerifyChecksum

electronDownload.mirror - The mirror.

electronDownload.platform

electronDownload.strictSSL

electronDownload.version

electronUpdaterCompatibility - The [electron-updater compatibility](/auto-update#compatibility) semver range.

electronVersion - The version of electron you are packaging for. Defaults to version of `electron`, `electron-prebuilt` or `electron-prebuilt-compile` dependency.

extends - The name of a built-in configuration preset or path to config file (relative to project dir). Currently, only `react-cra` is supported. If `react-scripts` in the app dependencies, `react-cra` will be set automatically. Set to `null` to disable automatic detection.

forceCodeSigning - Whether to fail if app will be not code signed.

framework - The framework name. One of `electron`, `proton-native`, `libui`. Defaults to `electron`.

generateUpdatesFilesForAllChannels - Please see [Building and Releasing using Channels](https://github.com/electron-userland/electron-builder/issues/1182#issuecomment-324947139).

icon

includePdb - Whether to include PDB files.

launchUiVersion - *libui-based frameworks only* The version of LaunchUI you are packaging for. Applicable for Windows only. Defaults to version suitable for used framework version.

muonVersion - The version of muon you are packaging for.

nodeGypRebuild - Whether to execute `node-gyp rebuild` before starting to package the app. Don't [use](https://github.com/electron-userland/electron-builder/issues/683#issuecomment-241214075) [npm](http://electron.atom.io/docs/tutorial/using-native-node-modules/#using-npm) (neither `.npmrc`) for configuring electron headers. Use `electron-builder node-gyp-rebuild` instead.

nodeVersion - *libui-based frameworks only* The version of NodeJS you are packaging for. You can set it to `current` to set the Node.js version that you use to run.

npmRebuild - Whether to [rebuild](https://docs.npmjs.com/cli/rebuild) native dependencies before starting to package the app.

npmSkipBuildFromSource

productName - As [name](#Metadata-name), but allows you to specify a product name for your executable which contains spaces and other special characters not allowed in the [name property](https://docs.npmjs.com/files/package.json#name).

protonNodeVersion

readonly - Whether to fail if the application is not signed (to prevent unsigned app if code signing configuration is not correct).

.releaseInfo - ReleaseInfo

_

releaseInfo.releaseDate - The release date.

releaseInfo.releaseName - The release name.

releaseInfo.releaseNotes - The release notes.

releaseInfo.releaseNotesFile - The path to release notes file. Defaults to `release-notes-${platform}.md` (where `platform` it is current platform â€” `mac`, `linux` or `windows`) or `release-notes.md` in the [build resources](#MetadataDirectories-buildResources).

remoteBuild - Whether to build using Electron Build Service if target not supported on current OS.

removePackageScripts - Whether to remove `scripts` field from `package.json` files.

LivMatter

Your Apps in Action

Use this form to visualize JSON schema for electron-build configuration file..

{{repoTitle.MainEntity}}

_

_