Skip to content
A complete solution to package and build a ready for distribution Electron app with “auto update” support out of the box
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci feat(linux): add fileAssociation support for fpm target Jul 18, 2019
.github chore: use fs-extra directly Jul 9, 2019
.idea fix(dmg): cannot build DMG on macOS 10.15 Jul 20, 2019
docker fix: disable AppImage target by default if build on Windows Jun 21, 2019
packages fix: include SnapStoreOptions into schema Jul 23, 2019
scripts fix: include SnapStoreOptions into schema Jul 23, 2019
test fix: include SnapStoreOptions into schema Jul 23, 2019
typings chore: get rid of plist to reduce node module dependencies Jun 29, 2019
.editorconfig feat: support finding electron version in build.electronVersion or el… May 26, 2016
.gitignore chore: disable schema generation for now Feb 26, 2019
.mention-bot chore: rc-producer.yml for IDEA, mention bot config, update deps Dec 5, 2016
.travis.yml fix: ensure that setgid and setuid flags are cleared Jun 20, 2019
.yarnclean feat(deployment): DigitalOcean Spaces support (publish & auto update) Sep 23, 2017
CHANGELOG.md feat(nsis): app requestedExecutionLevel Aug 11, 2017
CONTRIBUTING.md fix(nsis): nsis-web: Windows 7 and above is required when installing … Jul 8, 2019
LICENSE Initial commit May 21, 2015
README.md chore: add Zulip badge Jun 26, 2019
appveyor.yml feat: update rcedit, use rcedit x64 on Windows x64 Jul 7, 2019
babel.config.js fix(electron-updater): reduce electron-updater size Jun 29, 2019
mkdocs.yml feat(snap): publishing to Snapcraft Jul 10, 2019
netlify.toml fix(linux): Include main category for inferred DEB desktop entries Jul 22, 2018
package.json fix: include SnapStoreOptions into schema Jul 23, 2019
yarn.lock fix: include SnapStoreOptions into schema Jul 23, 2019

README.md

electron-builder npm version downloads per month donate project chat

A complete solution to package and build a ready for distribution Electron, Proton Native app for macOS, Windows and Linux with “auto update” support out of the box.

See documentation on electron.build.

  • NPM packages management:
  • Code Signing on a CI server or development machine.
  • Auto Update ready application packaging.
  • Numerous target formats:
    • All platforms: 7z, zip, tar.xz, tar.7z, tar.lz, tar.gz, tar.bz2, dir (unpacked directory).
    • macOS: dmg, pkg, mas.
    • Linux: AppImage, snap, debian package (deb), rpm, freebsd, pacman, p5p, apk.
    • Windows: nsis (Installer), nsis-web (Web installer), portable (portable app without installation), AppX (Windows Store), MSI, Squirrel.Windows.
  • Publishing artifacts to GitHub Releases, Amazon S3, DigitalOcean Spaces and Bintray.
  • Advanced building:
    • Pack in a distributable format already packaged app.
    • Separate build steps.
    • Build and publish in parallel, using hard links on CI server to reduce IO and disk space usage.
    • electron-compile support (compile for release-time on the fly on build).
  • Docker images to build Electron app for Linux or Windows on any platform.
  • Proton Native support.
  • Downloads all required tools files on demand automatically (e.g. to code sign windows application, to make AppX), no need to setup.
Question Answer
“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 support development” Donate

Installation

Yarn is strongly recommended instead of npm.

yarn add electron-builder --dev

Quick Setup Guide

electron-webpack-quick-start is a recommended way to create a new Electron application. See Boilerplates.

  1. Specify the standard fields in the application package.jsonname, description, version and author.

  2. Specify the build configuration in the package.json as follows:

    "build": {
      "appId": "your.id",
      "mac": {
        "category": "your.app.category.type"
      }
    }

    See all options. Option files to indicate which files should be packed in the final application, including the entry file, maybe required.

  3. Add icons.

  4. Add the scripts key to the development package.json:

    "scripts": {
      "pack": "electron-builder --dir",
      "dist": "electron-builder"
    }

    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 package.json.

  5. If you have native addons of your own that are part of the application (not as a dependency), set nodeGypRebuild to true.

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.

Donate

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.

Sponsors

WorkFlowy Tidepool

You can’t perform that action at this time.