electron-builder

A complete solution to package and build a ready for distribution Electron ...

Desktop app
electron-userland/electron-builderwww.electron.buildelectron-builder

README

electron-builder npm version downloads per month donate project discussions

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. :shipit:

:large_orange_diamond: - Looking for additional maintainers!

We condemn Russia’s military aggression against Ukraine. We stand with the people of Ukraine.

Sponsors


WorkFlowy
Notes, Tasks, Projects. All in a Single Place.

Tidepool
Your gateway to understanding your diabetes data

Keygen
A dead-simple software licensing and distribution API built for developers

ToDesktop
ToDesktop: An all-in-one platform for building and releasing Electron apps


Documentation


See the full documentation on electron.build.

NPM packages management:
    Native application dependencies compilation (including Yarn support).
    Development dependencies are never included. You don't need to ignore them explicitly.
    Two package.json structure is supported, but you are not forced to use it even if you have native production dependencies.
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.

QuestionAnswer
|----------|-------|
“I[See
“I[Join
“I[Open
“I[Donate](https://www.electron.build/donate)

Installation

Yarn is strongly recommended instead of npm.

yarn add electron-builder --dev

Note for PNPM


In order to use with pnpm, you'll need to adjust your .npmrc to use any one the following approaches in order for your dependencies to be bundled correctly (ref: #6389):
  1. ```
  2. node-linker=hoisted
  3. ```
  1. ```
  2. public-hoist-pattern=*
  3. ```
  1. ```
  2. shamefully-hoist=true
  3. ```

Note: Setting shamefully-hoist to true is the same as setting public-hoist-pattern to *.

Note for Yarn 3


Yarn 3 use PnP by default, but electron-builder still need node-modules(ref: yarnpkg/berry#4804). Add configuration in the.yarnrc.yaml as follows:
  1. ```
  2. nodeLinker: "node-modules"
  3. ```
will declare to use node-modules instead of PnP.

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.json — name,description, version and author.

2. Specify the build configuration in thepackage.json as follows:
  1. ``` json
  2.     "build": {
  3.       "appId": "your.id",
  4.       "mac": {
  5.         "category": "your.app.category.type"
  6.       }
  7.     }
  8. ```
   See all options. Option files to indicate which files should be packed in the final application, including the entry file, maybe required.
   You can also use separate configuration files, such as js, ts, yml, and json/json5. See read-config-file for supported extensions. JS Example for programmatic API

3. Add icons.

4. Add the scripts key to the developmentpackage.json:
  1. ``` json
  2.     "scripts": {
  3.       "app:dir": "electron-builder --dir",
  4.       "app:dist": "electron-builder"
  5.     }
  6. ```
    Then you can run yarn app:dist (to package in a distributable format (e.g. dmg, windows installer, deb package)) or yarn app:dir (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 totrue.

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.