schema
stringclasses 471
values | key
stringlengths 0
203
| description
stringlengths 0
4.37k
| object
stringlengths 2
322k
|
|---|---|---|---|
electron-builder.json | synopsis | The [short description](https://www.debian.org/doc/debian-policy/ch-controlfields.html#s-f-Description). | {"type": ["null", "string"]} |
electron-builder.json | systemIntegration | The system integration installation. | {"default": "ask", "enum": ["ask", "doNotAsk"], "type": "string"} |
electron-builder.json | addAutoLaunchExtension | Whether to add auto launch extension. Defaults to `true` if [electron-winstore-auto-launch](https://github.com/felixrieseberg/electron-winstore-auto-launch) in the dependencies. | {"type": "boolean"} |
electron-builder.json | applicationId | The application id. Defaults to `identityName`. Can't start with numbers. | {"type": "string"} |
electron-builder.json | artifactName | The [artifact file name template](/configuration/configuration#artifact-file-name-template). | {"type": ["null", "string"]} |
electron-builder.json | backgroundColor | The background color of the app tile. See [Visual Elements](https://msdn.microsoft.com/en-us/library/windows/apps/br211471.aspx). | {"default": "#464646", "type": ["null", "string"]} |
electron-builder.json | displayName | A friendly name that can be displayed to users. Corresponds to [Properties.DisplayName](https://msdn.microsoft.com/en-us/library/windows/apps/br211432.aspx).
Defaults to the application product name. | {"type": ["null", "string"]} |
electron-builder.json | identityName | The name. Corresponds to [Identity.Name](https://msdn.microsoft.com/en-us/library/windows/apps/br211441.aspx). Defaults to the [application name](/configuration/configuration#Metadata-name). | {"type": ["null", "string"]} |
electron-builder.json | languages | The list of [supported languages](https://docs.microsoft.com/en-us/windows/uwp/globalizing/manage-language-and-region#specify-the-supported-languages-in-the-apps-manifest) that will be listed in the Windows Store.
The first entry (index 0) will be the default language.
Defaults to en-US if omitted. | {"anyOf": [{"items": {"type": "string"}, "type": "array"}, {"type": ["null", "string"]}]} |
electron-builder.json | publisher | The Windows Store publisher. Not used if AppX is build for testing. See [AppX Package Code Signing](#appx-package-code-signing) below. | {"type": ["null", "string"]} |
electron-builder.json | publisherDisplayName | A friendly name for the publisher that can be displayed to users. Corresponds to [Properties.PublisherDisplayName](https://msdn.microsoft.com/en-us/library/windows/apps/br211460.aspx).
Defaults to company name from the application metadata. | {"type": ["null", "string"]} |
electron-builder.json | showNameOnTiles | Whether to overlay the app's name on top of tile images on the Start screen. Defaults to `false`. (https://docs.microsoft.com/en-us/uwp/schemas/appxpackage/uapmanifestschema/element-uap-shownameontiles) in the dependencies. | {"type": "boolean"} |
electron-builder.json | setBuildNumber | Whether to set build number. See https://github.com/electron-userland/electron-builder/issues/3875 | {"type": "boolean"} |
electron-builder.json | externalAllowed | Allows external asar files. | {"default": false, "type": "boolean"} |
electron-builder.json | smartUnpack | Whether to automatically unpack executables files. | {"default": true, "type": "boolean"} |
electron-builder.json | BintrayOptions | [Bintray](https://bintray.com/) options. Requires an API key. An API key can be obtained from the user [profile](https://bintray.com/profile/edit) page ("Edit Your Profile" -> API Key).
Define `BT_TOKEN` environment variable. | {"additionalProperties": false, "properties": {"component": {"type": ["null", "string"]}, "distribution": {"default": "stable", "type": ["null", "string"]}, "owner": {"type": ["null", "string"]}, "package": {"type": ["null", "string"]}, "provider": {"enum": ["bintray"], "type": "string"}, "publishAutoUpdate": {"default": true, "type": "boolean"}, "publisherName": {"anyOf": [{"items": {"type": "string"}, "type": "array"}, {"type": "null"}]}, "repo": {"default": "generic", "type": ["null", "string"]}, "token": {"type": ["null", "string"]}, "updaterCacheDirName": {"type": ["null", "string"]}, "user": {"type": ["null", "string"]}}, "required": ["provider"], "type": "object"} |
electron-builder.json | component | The Bintray component (Debian only). | {"type": ["null", "string"]} |
electron-builder.json | distribution | The Bintray distribution (Debian only). | {"default": "stable", "type": ["null", "string"]} |
electron-builder.json | owner | The owner. | {"type": ["null", "string"]} |
electron-builder.json | package | The Bintray package name. | {"type": ["null", "string"]} |
electron-builder.json | provider | The provider. Must be `bintray`. | {"enum": ["bintray"], "type": "string"} |
electron-builder.json | publishAutoUpdate | Whether to publish auto update info files.
Auto update relies only on the first provider in the list (you can specify several publishers).
Thus, probably, there`s no need to upload the metadata files for the other configured providers. But by default will be uploaded. | {"default": true, "type": "boolean"} |
electron-builder.json | repo | The Bintray repository name. | {"default": "generic", "type": ["null", "string"]} |
electron-builder.json | user | The Bintray user account. Used in cases where the owner is an organization. | {"type": ["null", "string"]} |
electron-builder.json | provider | The provider. | {} |
electron-builder.json | publishAutoUpdate | Whether to publish auto update info files.
Auto update relies only on the first provider in the list (you can specify several publishers).
Thus, probably, there`s no need to upload the metadata files for the other configured providers. But by default will be uploaded. | {"default": true, "type": "boolean"} |
electron-builder.json | artifactName | The [artifact file name template](/configuration/configuration#artifact-file-name-template). | {"type": ["null", "string"]} |
electron-builder.json | category | The [application category](https://specifications.freedesktop.org/menu-spec/latest/apa.html#main-category-registry). | {"type": ["null", "string"]} |
electron-builder.json | compression | The compression type. | {"anyOf": [{"enum": ["bzip2", "gz", "xz"], "type": "string"}, {"type": "null"}], "default": "xz"} |
electron-builder.json | depends | Package dependencies. Defaults to `["gconf2", "gconf-service", "libnotify4", "libappindicator1", "libxtst6", "libnss3"]`. | {"anyOf": [{"items": {"type": "string"}, "type": "array"}, {"type": "null"}]} |
electron-builder.json | description | As [description](/configuration/configuration#Metadata-description) from application package.json, but allows you to specify different for Linux. | {"type": ["null", "string"]} |
electron-builder.json | desktop | The [Desktop file](https://developer.gnome.org/integration-guide/stable/desktop-files.html.en) entries (name to value). | {} |
electron-builder.json | fpm | *Advanced only* The [fpm](https://github.com/jordansissel/fpm/wiki#usage) options.
Example: `["--before-install=build/deb-preinstall.sh", "--after-upgrade=build/deb-postinstall.sh"]` | {"anyOf": [{"items": {"type": "string"}, "type": "array"}, {"type": "null"}]} |
electron-builder.json | mimeTypes | The mime types in addition to specified in the file associations. Use it if you don't want to register a new mime type, but reuse existing. | {"anyOf": [{"items": {"type": "string"}, "type": "array"}, {"type": "null"}]} |
electron-builder.json | packageCategory | The [package category](https://www.debian.org/doc/debian-policy/ch-controlfields.html#s-f-Section). | {"type": ["null", "string"]} |
electron-builder.json | priority | The [Priority](https://www.debian.org/doc/debian-policy/ch-controlfields.html#s-f-Priority) attribute. | {"type": ["null", "string"]} |
electron-builder.json | synopsis | The [short description](https://www.debian.org/doc/debian-policy/ch-controlfields.html#s-f-Description). | {"type": ["null", "string"]} |
electron-builder.json | name | The name of the file within the DMG. Defaults to basename of `path`. | {"type": "string"} |
electron-builder.json | path | The path of the file within the DMG. | {"type": "string"} |
electron-builder.json | artifactName | The [artifact file name template](/configuration/configuration#artifact-file-name-template). | {"type": ["null", "string"]} |
electron-builder.json | background | The path to background image (default: `build/background.tiff` or `build/background.png` if exists). The resolution of this file determines the resolution of the installer window.
If background is not specified, use `window.size`. Default locations expected background size to be 540x380. | {"type": ["null", "string"]} |
electron-builder.json | backgroundColor | The background color (accepts css colors). Defaults to `#ffffff` (white) if no background image. | {"type": ["null", "string"]} |
electron-builder.json | contents | The content — to customize icon locations. | {"items": {}, "type": "array"} |
electron-builder.json | format | The disk image format. `ULFO` (lzfse-compressed image (OS X 10.11+ only)). | {"default": "UDZO", "enum": ["UDBZ", "UDCO", "UDRO", "UDRW", "UDZO", "ULFO"], "type": "string"} |
electron-builder.json | icon | The path to DMG icon (volume icon), which will be shown when mounted, relative to the [build resources](/configuration/configuration#MetadataDirectories-buildResources) or to the project directory.
Defaults to the application icon (`build/icon.icns`). | {"type": ["null", "string"]} |
electron-builder.json | iconSize | The size of all the icons inside the DMG. | {"default": 80, "type": ["null", "number"]} |
electron-builder.json | iconTextSize | The size of all the icon texts inside the DMG. | {"default": 12, "type": ["null", "number"]} |
electron-builder.json | internetEnabled | Whether to create internet-enabled disk image (when it is downloaded using a browser it will automatically decompress the image, put the application on the desktop, unmount and remove the disk image file). | {"default": false, "type": "boolean"} |
electron-builder.json | title | The title of the produced DMG, which will be shown when mounted (volume name).
Macro `${productName}`, `${version}` and `${name}` are supported. | {"default": "${productName} ${version}", "type": ["null", "string"]} |
electron-builder.json | window | The DMG windows position and size. | {} |
electron-builder.json | height | The height. Defaults to background image height or 380. | {"type": "number"} |
electron-builder.json | width | The width. Defaults to background image width or 540. | {"type": "number"} |
electron-builder.json | x | The X position relative to left of the screen. | {"default": 400, "type": "number"} |
electron-builder.json | y | The Y position relative to top of the screen. | {"default": 100, "type": "number"} |
electron-builder.json | cache | The [cache location](https://github.com/electron-userland/electron-download#cache-location). | {"type": ["null", "string"]} |
electron-builder.json | mirror | The mirror. | {"type": ["null", "string"]} |
electron-builder.json | FileAssociation | File associations.
macOS (corresponds to [CFBundleDocumentTypes](https://developer.apple.com/library/content/documentation/General/Reference/InfoPlistKeyReference/Articles/CoreFoundationKeys.html#//apple_ref/doc/uid/20001431-101685)) and NSIS only.
On Windows works only if [nsis.perMachine](https://electron.build/configuration/configuration#NsisOptions-perMachine) is set to `true`. | {"additionalProperties": false, "properties": {"ext": {"anyOf": [{"items": {"type": "string"}, "type": "array"}, {"type": "string"}]}, "icon": {"type": ["null", "string"]}, "isPackage": {"type": "boolean"}, "mimeType": {"type": ["null", "string"]}, "name": {"type": ["null", "string"]}, "role": {"default": "Editor", "type": "string"}}, "required": ["ext"], "type": "object"} |
electron-builder.json | description | *windows-only.* The description. | {"type": ["null", "string"]} |
electron-builder.json | ext | The extension (minus the leading period). e.g. `png`. | {"anyOf": [{"items": {"type": "string"}, "type": "array"}, {"type": "string"}]} |
electron-builder.json | icon | The path to icon (`.icns` for MacOS and `.ico` for Windows), relative to `build` (build resources directory). Defaults to `${firstExt}.icns`/`${firstExt}.ico` (if several extensions specified, first is used) or to application icon.
Not supported on Linux, file issue if need (default icon will be `x-office-document`). | {"type": ["null", "string"]} |
electron-builder.json | isPackage | *macOS-only* Whether the document is distributed as a bundle. If set to true, the bundle directory is treated as a file. Corresponds to `LSTypeIsPackage`. | {"type": "boolean"} |
electron-builder.json | mimeType | *linux-only.* The mime-type. | {"type": ["null", "string"]} |
electron-builder.json | name | The name. e.g. `PNG`. Defaults to `ext`. | {"type": ["null", "string"]} |
electron-builder.json | role | *macOS-only* The app's role with respect to the type. The value can be `Editor`, `Viewer`, `Shell`, or `None`. Corresponds to `CFBundleTypeRole`. | {"default": "Editor", "type": "string"} |
electron-builder.json | filter | The [glob patterns](/file-patterns). | {"anyOf": [{"items": {"type": "string"}, "type": "array"}, {"type": "string"}]} |
electron-builder.json | from | The source path relative to the project directory. | {"type": "string"} |
electron-builder.json | to | The destination path relative to the app's content directory for `extraFiles` and the app's resource directory for `extraResources`. | {"type": "string"} |
electron-builder.json | GenericServerOptions | Generic (any HTTP(S) server) options.
In all publish options [File Macros](/file-patterns#file-macros) are supported. | {"additionalProperties": false, "properties": {"channel": {"default": "latest", "type": ["null", "string"]}, "provider": {"enum": ["generic"], "type": "string"}, "publishAutoUpdate": {"default": true, "type": "boolean"}, "publisherName": {"anyOf": [{"items": {"type": "string"}, "type": "array"}, {"type": "null"}]}, "updaterCacheDirName": {"type": ["null", "string"]}, "url": {"type": "string"}, "useMultipleRangeRequest": {"type": "boolean"}}, "required": ["provider", "url"], "type": "object"} |
electron-builder.json | channel | The channel. | {"default": "latest", "type": ["null", "string"]} |
electron-builder.json | provider | The provider. Must be `generic`. | {"enum": ["generic"], "type": "string"} |
electron-builder.json | publishAutoUpdate | Whether to publish auto update info files.
Auto update relies only on the first provider in the list (you can specify several publishers).
Thus, probably, there`s no need to upload the metadata files for the other configured providers. But by default will be uploaded. | {"default": true, "type": "boolean"} |
electron-builder.json | url | The base url. e.g. `https://bucket_name.s3.amazonaws.com`. | {"type": "string"} |
electron-builder.json | useMultipleRangeRequest | Whether to use multiple range requests for differential update. Defaults to `true` if `url` doesn't contain `s3.amazonaws.com`. | {"type": "boolean"} |
electron-builder.json | GithubOptions | [GitHub](https://help.github.com/articles/about-releases/) options.
GitHub [personal access token](https://help.github.com/articles/creating-an-access-token-for-command-line-use/) is required. You can generate by going to [https://github.com/settings/tokens/new](https://github.com/settings/tokens/new). The access token should have the repo scope/permission.
Define `GH_TOKEN` environment variable. | {"additionalProperties": false, "properties": {"host": {"default": "github.com", "type": ["null", "string"]}, "owner": {"type": ["null", "string"]}, "private": {"type": ["null", "boolean"]}, "protocol": {"anyOf": [{"enum": ["http", "https"], "type": "string"}, {"type": "null"}], "default": "https"}, "provider": {"enum": ["github"], "type": "string"}, "publishAutoUpdate": {"default": true, "type": "boolean"}, "publisherName": {"anyOf": [{"items": {"type": "string"}, "type": "array"}, {"type": "null"}]}, "releaseType": {"anyOf": [{"enum": ["draft", "prerelease", "release"], "type": "string"}, {"type": "null"}], "default": "draft"}, "repo": {"type": ["null", "string"]}, "token": {"type": ["null", "string"]}, "updaterCacheDirName": {"type": ["null", "string"]}, "vPrefixedTagName": {"default": true, "type": "boolean"}}, "required": ["provider"], "type": "object"} |
electron-builder.json | host | The host (including the port if need). | {"default": "github.com", "type": ["null", "string"]} |
electron-builder.json | owner | The owner. | {"type": ["null", "string"]} |
electron-builder.json | private | Whether to use private github auto-update provider if `GH_TOKEN` environment variable is defined. See [Private GitHub Update Repo](/auto-update#private-github-update-repo). | {"type": ["null", "boolean"]} |
electron-builder.json | protocol | The protocol. GitHub Publisher supports only `https`. | {"anyOf": [{"enum": ["http", "https"], "type": "string"}, {"type": "null"}], "default": "https"} |
electron-builder.json | provider | The provider. Must be `github`. | {"enum": ["github"], "type": "string"} |
electron-builder.json | publishAutoUpdate | Whether to publish auto update info files.
Auto update relies only on the first provider in the list (you can specify several publishers).
Thus, probably, there`s no need to upload the metadata files for the other configured providers. But by default will be uploaded. | {"default": true, "type": "boolean"} |
electron-builder.json | releaseType | The type of release. By default `draft` release will be created.
Also you can set release type using environment variable. If `EP_DRAFT`is set to `true` — `draft`, if `EP_PRE_RELEASE`is set to `true` — `prerelease`. | {"anyOf": [{"enum": ["draft", "prerelease", "release"], "type": "string"}, {"type": "null"}], "default": "draft"} |
electron-builder.json | repo | The repository name. [Detected automatically](#github-repository-and-bintray-package). | {"type": ["null", "string"]} |
electron-builder.json | token | The access token to support auto-update from private github repositories. Never specify it in the configuration files. Only for [setFeedURL](/auto-update#appupdatersetfeedurloptions). | {"type": ["null", "string"]} |
electron-builder.json | vPrefixedTagName | Whether to use `v`-prefixed tag name. | {"default": true, "type": "boolean"} |
electron-builder.json | 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. | {"default": "com.electron.${name}", "type": ["null", "string"]} |
electron-builder.json | 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). | {"type": ["null", "string"]} |
electron-builder.json | asar | Whether to package the application's source code into an archive, using [Electron's archive format](http://electron.atom.io/docs/tutorial/application-packaging/).
Node modules, that must be unpacked, will be detected automatically, you don't need to explicitly set [asarUnpack](#configuration-asarUnpack) - please file an issue if this doesn't work. | {"anyOf": [{}, {"type": ["null", "boolean"]}], "default": true} |
electron-builder.json | asarUnpack | A [glob patterns](/file-patterns) relative to the [app directory](#MetadataDirectories-app), which specifies which files to unpack when creating the [asar](http://electron.atom.io/docs/tutorial/application-packaging/) archive. | {"anyOf": [{"items": {"type": "string"}, "type": "array"}, {"type": ["null", "string"]}]} |
electron-builder.json | category | The [application category](https://specifications.freedesktop.org/menu-spec/latest/apa.html#main-category-registry). | {"type": ["null", "string"]} |
electron-builder.json | compression | The compression level. If you want to rapidly test build, `store` can reduce build time significantly. `maximum` doesn't lead to noticeable size difference, but increase build time. | {"anyOf": [{"enum": ["maximum", "normal", "store"], "type": "string"}, {"type": "null"}], "default": "normal"} |
electron-builder.json | description | As [description](/configuration/configuration#Metadata-description) from application package.json, but allows you to specify different for Linux. | {"type": ["null", "string"]} |
electron-builder.json | desktop | The [Desktop file](https://developer.gnome.org/integration-guide/stable/desktop-files.html.en) entries (name to value). | {} |
electron-builder.json | 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`. | {"default": true, "type": "boolean"} |
electron-builder.json | electronUpdaterCompatibility | The [electron-updater compatibility](/auto-update#compatibility) semver range. | {"type": ["null", "string"]} |
electron-builder.json | executableName | The executable name. Defaults to `productName`.
Cannot be specified per target, allowed only in the `linux`. | {"type": ["null", "string"]} |
electron-builder.json | fileAssociations | The file associations. | {"anyOf": [{}, {"items": {}, "type": "array"}]} |
electron-builder.json | forceCodeSigning | Whether to fail if app will be not code signed. | {"type": "boolean"} |
electron-builder.json | generateUpdatesFilesForAllChannels | Please see [Building and Releasing using Channels](https://github.com/electron-userland/electron-builder/issues/1182#issuecomment-324947139). | {"default": false, "type": "boolean"} |
electron-builder.json | icon | The path to icon set directory or one png file, relative to the [build resources](/configuration/configuration#MetadataDirectories-buildResources) or to the project directory. The icon filename must contain the size (e.g. 32x32.png) of the icon.
By default will be generated automatically based on the macOS icns file. | {"type": "string"} |
electron-builder.json | maintainer | The maintainer. Defaults to [author](/configuration/configuration#Metadata-author). | {"type": ["null", "string"]} |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.