npmpackage.info

Gathering detailed insights and metrics for electron-builder

Other packages similar to electron-builder

electron-builder-squirrel-windows

26.0.12

Plugin for [electron-builder](https://github.com/electron-userland/electron-builder) to build Squirrel.Windows installer.

vue-cli-plugin-electron-builder

2.1.1

Easily Build Your Vue.js App For Desktop With Electron

app-builder-lib

26.0.12

electron-builder lib

electron-publish

26.0.11

Part of [electron-builder](https://github.com/electron-userland/electron-builder).

Gathering detailed insights and metrics for electron-builder

electron-builder - 26.0.12 | npmpackage.info

electron-builder

A complete solution to package and build a ready for distribution Electron app with “auto update” support out of the box

26.0.12

14,115

MIT

TypeScript

74.21 kB

81,288,189 5.7

Installations

npm install electron-builder

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Min. Node Version

>=14.0.0

Node Version

22.14.0

NPM Version

10.9.2 Score

Supply Chain

55.2

Quality

91.3

Maintenance

100

Vulnerability

95.1

License

Pull Requests

Open

24

Total

2,022

Closed

442

Merged

1,556

Issues

Open

286

Total

7,000

Closed

6,714

Releases

901

v26.0.16

Updated on Jun 02, 2025

electron-updater@6.6.5

Updated on Jun 02, 2025

v26.0.15

Updated on May 04, 2025

electron-updater@6.6.4

Updated on May 04, 2025

v26.0.14

Updated on Apr 27, 2025

v26.0.13

Updated on Apr 12, 2025

View All 901 releases

Languages

TypeScript

NSIS

JavaScript

Shell

Dockerfile

Smarty

CSS

TypeScript (91.4%)

NSIS (6.11%)

JavaScript (1.59%)

Shell (0.52%)

Dockerfile (0.34%)

Smarty (0.02%)

CSS (0.02%)

Developer

electron-userland

Download Statistics

Total Downloads

81,288,189

Last Day

27,436

Last Week

491,561

Last Month

2,163,251

Last Year

18,345,409

GitHub Statistics

MIT License

14,115 Stars

3,393 Commits

1,786 Forks

148 Watchers

82 Branches

569 Contributors

Updated on Jun 11, 2025

Maintainers

View All 569 Contributors

Package Meta Information

Latest Version

26.0.12

Package Id

electron-builder@26.0.12

Unpacked Size

74.21 kB

Size

19.47 kB

File Count

NPM Version

10.9.2

Node Version

22.14.0

Published on

Mar 22, 2025

Total Downloads

Cumulative downloads

Total Downloads

81,288,189

Last Day

10.5%

27,436

Compared to previous day

Last Week

-8.9%

491,561

Compared to previous week

Last Month

2,163,251

Compared to previous month

Last Year

29.7%

18,345,409

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

chalk fs-extra is-ci lazy-val simple-update-notifier yargs app-builder-lib builder-util-runtime dmg-builder builder-util

Dev Dependencies

@types/fs-extra @types/is-ci @types/yargs

electron-builder

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. 📦

Always looking for community contributions! 👀 Setting up a dev environment is easy to do 🪩

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.

Question	Answer
“I want to configure electron-builder”	See options
“I found a bug or I have a question”	Open an issue
“I want to support development”	Donate

Installation

Yarn is strongly recommended instead of npm.

yarn add electron-builder --dev

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:

nodeLinker: "node-modules"

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.

Specify the standard fields in the application package.json — name, description, version and author.
Specify the build configuration in the package.json as follows:
```
1"build": {
2  "appId": "your.id",
3  "mac": {
4    "category": "your.app.category.type"
5  }
6}
```
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
Add icons.
Add the scripts key to the development package.json:
```
1"scripts": {
2  "app:dir": "electron-builder --dir",
3  "app:dist": "electron-builder"
4}
```
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.
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.

Programmatic Usage

See node_modules/electron-builder/out/index.d.ts. Typings for TypeScript are provided and also can be found here.

Code snippet provided below is also shown "in action" here as well.

1"use strict"
2
3const builder = require("electron-builder")
4const Platform = builder.Platform
5
6// Promise is returned
7builder.build({
8  targets: Platform.MAC.createTarget(),
9  config: {
10   "//": "build options, see https://goo.gl/QQXmcV"
11  }
12})
13  .then(() => {
14    // handle result
15  })
16  .catch((error) => {
17    // handle error
18  })

Boilerplates

electron-webpack-quick-start — A bare minimum project structure to get started developing with electron-webpack. Recommended.
electron-react-boilerplate A boilerplate for scalable cross-platform desktop apps.
electron-react-redux-boilerplate A minimal boilerplate to get started with Electron, React and Redux.
electron-boilerplate A minimalistic yet comprehensive boilerplate application.
Vue CLI 3 plugin for Electron A Vue CLI 3 plugin for Electron with no required configuration.
electron-vue-vite A real simple Electron + Vue3 + Vite5 boilerplate.
vite-electron-builder Secure boilerplate for Electron app based on Vite. Supports multiple frameworks.
electronjs-with-nextjs ElectronJS application with NextJS and TypeScript.

Debug

Set the DEBUG environment variable to debug what electron-builder is doing:

1DEBUG=electron-builder

FPM_DEBUG env to add more details about building linux targets (except snap and appimage).

DEBUG_DMG=true env var to add more debugging/verbosity from hdiutil (macOS).

!!! tip "cmd" On Windows the environment variable is set using the set command. bash set DEBUG=electron-builder

!!! tip "PowerShell" PowerShell uses different syntax to set environment variables. bash $env:DEBUG=electron-builder

Donate

We do this open source work in our free time. If you'd like us to invest more time on it, please donate.

No vulnerabilities found.

10

Maintained

Determines if the project is "actively maintained".

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

License

Determines if the project has defined a license.

10

Packaging

Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.

9

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

8

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

6

SAST

Determines if the project uses static code analysis.

3

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

3

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

Reason

dependency not pinned by hash detected -- score normalized to 3

Details

Warn: containerImage not pinned by hash: docker/base/Dockerfile:3: pin your Docker image by updating buildpack-deps:22.04-curl to buildpack-deps:22.04-curl@sha256:860ebe9ff5b69329b30fc3be51060cc1a36148f68458726e884dc13d548b11f3
Warn: containerImage not pinned by hash: docker/node/Dockerfile:2
Warn: containerImage not pinned by hash: docker/wine-chrome/Dockerfile:2
Warn: containerImage not pinned by hash: docker/wine-mono/Dockerfile:2
Warn: containerImage not pinned by hash: docker/wine/Dockerfile:2
Warn: containerImage not pinned by hash: mkdocs-dockerfile:1: pin your Docker image by updating squidfunk/mkdocs-material:9.5 to squidfunk/mkdocs-material:9.5@sha256:41942f7a2f5163aacd0e866e076d95db4f26550b97d76c1594c04250cbb580e9
Warn: containerImage not pinned by hash: test/src/updater/Dockerfile-appimage:1: pin your Docker image by updating buildpack-deps:noble-curl to buildpack-deps:noble-curl@sha256:156bbc18c945cc15e57a53005229b6c26dd09f60d7247a2033a3e801e2f5cacc
Warn: containerImage not pinned by hash: test/src/updater/Dockerfile-archlinux:1: pin your Docker image by updating archlinux:latest to archlinux:latest@sha256:d2094076ea97044f0a0d7e8ea7ce025cc4fb9409b3bd5c4749c21728c204d490
Warn: containerImage not pinned by hash: test/src/updater/Dockerfile-debian:1: pin your Docker image by updating debian:bookworm-slim to debian:bookworm-slim@sha256:e5865e6858dacc255bead044a7f2d0ad8c362433cfaa5acefb670c1edf54dfef
Warn: containerImage not pinned by hash: test/src/updater/Dockerfile-rpm:1: pin your Docker image by updating fedora:latest to fedora:latest@sha256:16ca3e34a9545583551589e71882f1f27cbce3c2f1fc6210c932d22a6931b73b
Warn: downloadThenRun not pinned by hash: docker/base/Dockerfile:8-22
Warn: npmCommand not pinned by hash: docker/node/Dockerfile:11
Warn: pipCommand not pinned by hash: mkdocs-dockerfile:2
Warn: downloadThenRun not pinned by hash: test/src/updater/Dockerfile-appimage:46
Warn: npmCommand not pinned by hash: test/src/updater/Dockerfile-appimage:48
Warn: npmCommand not pinned by hash: test/src/updater/Dockerfile-archlinux:13
Warn: downloadThenRun not pinned by hash: test/src/updater/Dockerfile-debian:5
Warn: npmCommand not pinned by hash: test/src/updater/Dockerfile-debian:8
Warn: npmCommand not pinned by hash: test/src/updater/Dockerfile-rpm:23
Info: 15 out of 15 GitHub-owned GitHubAction dependencies pinned
Info: 9 out of 9 third-party GitHubAction dependencies pinned
Info: 0 out of 1 pipCommand dependencies pinned
Info: 0 out of 10 containerImage dependencies pinned
Info: 0 out of 3 downloadThenRun dependencies pinned
Info: 0 out of 5 npmCommand dependencies pinned

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

5.7

/10

Last Scanned on 2025-06-09

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

Notes, Tasks, Projects. All in a Single Place.
Your gateway to understanding your diabetes data	An open, source-available software licensing and distribution API
ToDesktop: An all-in-one platform for building and releasing Electron apps	Dashcam: Capture the steps to reproduce any bug with video crash reports for Electron.

Other packages similar to electron-builder

Other packages similar to electron-builder

electron-builder

Installations

Developer Guide

No

CommonJS

>=14.0.0

22.14.0

10.9.2

Score

Pull Requests

24

2,022

442

1,556

Issues

286

7,000

6,714

Releases

Languages

Developer

Download Statistics

GitHub Statistics

Maintainers

Package Meta Information

Total Downloads

81,288,189

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Dev Dependencies

electron-builder

Sponsors

Documentation

Installation

Note for Yarn 3

Quick Setup Guide

Programmatic Usage

Boilerplates

Debug

Donate

10

10

10

10

9

8

6

3

3

0

0

0

0

5.7

/10