A complete solution to package and build a ready for distribution Electron app for macOS, Windows and Linux with “auto update” support out of the box.
portable(portable app without installation), AppX (Windows Store), Squirrel.Windows.
|“I want to configure electron-builder”||See options|
|“I have a question”||Open an issue or join the chat|
|“I found a bug”||Open an issue|
|“I want to donate”||Donate with PayPal or Bitcoin|
Real project example — onshape-desktop-shell.
Note: Platform specific
7zip-bin-* packages are
optionalDependencies, which may require manual install if you have npm configured to not install optional deps by default.
Specify the build configuration in the
package.json as follows:
See all options.
Create a directory build in the root of the project and save a
background.png (macOS DMG background),
icon.icns (macOS app icon) and
icon.ico (Windows app icon) into it.
The Linux icon set will be generated automatically based on the macOS
icns file (or you can put them into the
build/icons directory if you want to specify them yourself. The filename must contain the size (e.g.
32x32.png) of the icon).
Add the scripts key to the development
Then you can run
npm run dist (to package in a distributable format (e.g. dmg, windows installer, deb package)) or
npm run pack (only generates the package directory without really packaging it. This is useful for testing purposes).
To ensure your native dependencies are always matched electron version, simply add
"postinstall": "install-app-deps" to your
If you have native addons of your own that are part of the application (not as a dependency), add
"nodeGypRebuild": true to the
build section of your development
💡 Don't use npm (neither
.npmrc) for configuring electron headers. Use node-gyp-rebuild bin instead.
Installing the required system packages.
Please note that everything is packaged into an asar archive by default.
For an app that will be shipped to production, you should sign your application. See Where to buy code signing certificates.
electron-builder produces all required artifacts, for example, for macOS:
.dmg: macOS installer, required for the initial installation process on macOS.
-mac.zip: required for Squirrel.Mac.
node_modules/.bin/build --help to get the actual CLI usage guide.
Building:--mac, -m, -o, --macos Build for macOS, accepts target list (see). [array]--linux, -l Build for Linux, accepts target list (see) [array]--win, -w, --windows Build for Windows, accepts target list (see) [array]--x64 Build for x64 [boolean]--ia32 Build for ia32 [boolean]--armv7l Build for armv7l [boolean]--dir Build unpacked dir. Useful to test. [boolean]--extraMetadata, --em Inject properties to package.json (asar only)--prepackaged, --pd The path to prepackaged app (to pack in adistributable format)--projectDir, --project The path to project directory. Defaults to currentworking directory.--config, -c The path to an electron-builder config. Defaults to`electron-builder.yml` (or `json`, or `json5`), seePublishing:--publish, -p Publish artifacts (to GitHub Releases), see[choices: "onTag", "onTagOrDraft", "always", "never"]--draft Create a draft (unpublished) release [boolean]--prerelease Identify the release as a prerelease [boolean]Deprecated:--platform The target platform (preferred to use --mac, --win or --linux)[choices: "mac", "win", "linux", "darwin", "win32", "all"]--arch The target arch (preferred to use --x64 or --ia32)[choices: "ia32", "x64", "all"]Other:--help Show help [boolean]--version Show version number [boolean]Examples:build -mwl build for macOS, Windows and Linuxbuild --linux deb tar.xz build deb and tar.xz for Linuxbuild --win --ia32 build for Windows ia32build --em.foo=bar set package.json property `foo` to `bar`build --config.nsis.unicode=false configure unicode options for NSIS
node_modules/electron-builder/out/electron-builder.d.ts. Typings is supported.
"use strict"const builder =const Platform = builderPlatform// Promise is returnedbuilder
You can use electron-builder only to pack your electron app in a AppImage, Snaps, Debian package, NSIS, macOS installer component package (
and other distributable formats.
./node_modules/.bin/build --prepackaged <packed dir>
--projectDir (the path to project directory) option also can be useful.
See the Wiki for more documentation.