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), MSI, 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|
Real project example — onshape-desktop-shell.
yarn add electron-builder --dev
7zip-bin-* packages are
optionalDependencies, which may require manual install if you have npm configured to not install optional deps by default.
electron-webpack-quick-start is a recommended way to create a new Electron application.
Specify the build configuration in the
package.json as follows:
See all options.
Add the scripts key to the development
Then you can run
yarn dist (to package in a distributable format (e.g. dmg, windows installer, deb package)) or
yarn 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 script
"postinstall": "electron-builder install-app-deps" to your
If you have native addons of your own that are part of the application (not as a dependency), set nodeGypRebuild to
Install the required system packages if you are not on macOS 10.12+.
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.
node_modules/electron-builder/out/index.d.ts. Typings for TypeScript are provided.
To build for current platform and current arch:
"use strict"const builder =// Promise is returnedbuilder
win:  to build for Windows default target. Add
win: ["nsis-web"] to build specified target (web installer) for Windows. The same for
mac:  and
ia32: true to build
x64: true, or
armv7l: true). Several can be specified and built at once.
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/electron-builder --prepackaged <packed dir>
--projectDir (the path to project directory) option also can be useful.
Brief guide in Chinese (maybe outdated and not accurate).
Set the DEBUG environment variable to debug what electron-builder is doing:
We do this open source work in our free time. If you'd like us to invest more time on it, please donate. Donation can be used to increase some issue priority.