npmpackage.info

Gathering detailed insights and metrics for electron-updater

Other packages similar to electron-updater

electron_updater_node_cli

0.3.3

cli for electron updater

electron-updater-tools

0.3.2

Tools for building native addons compatible with electron-updater

@faltermj/electron-updater

4.3.9-debug1

Cross platform updater for electron applications

electron-asar-hot-updater

0.1.3

Handles Electron app.asar updates.

electron-updater

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

6.3.9

13,836

MIT

TypeScript

68.33 kB

123,553,249 6.1

Installations

npm install electron-updater

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Node Version

18.20.4

NPM Version

10.7.0 Score

96.2

Supply Chain

75.6

Quality

94.2

Maintenance

100

Vulnerability

98.6

License

Pull Requests

Open

10

Total

1,877

Closed

415

Merged

1,452

Issues

Open

356

Total

6,851

Closed

6,495

Releases

885

v26.0.6

Updated on Feb 06, 2025

v26.0.5

Updated on Feb 05, 2025

v26.0.4

Updated on Feb 04, 2025

v26.0.3

Updated on Feb 04, 2025

v26.0.2

Updated on Feb 03, 2025

electron-updater@6.5.0

Updated on Feb 03, 2025

View All 885 releases

Contributors

555

View All 555 Contributors

Languages

TypeScript

NSIS

JavaScript

Shell

Dockerfile

Smarty

CSS

TypeScript (91.19%)

NSIS (6.4%)

JavaScript (1.54%)

Shell (0.48%)

Dockerfile (0.34%)

Smarty (0.03%)

CSS (0.02%)

Love this project? Help keep it running — sponsor us today! 🚀

Developer

electron-userland

Download Statistics

Total Downloads

123,553,249

Last Day

65,476

Last Week

393,462

Last Month

1,394,264

Last Year

16,365,458

GitHub Statistics

MIT License

13,836 Stars

3,288 Commits

1,750 Forks

149 Watchers

48 Branches

555 Contributors

Updated on Feb 14, 2025

Bundle Size

217.17 kB

Minified

68.33 kB

Minified + Gzipped

Bundlephobia

Maintainers

Package Meta Information

Latest Version

6.3.9

Package Id

electron-updater@6.3.9

Unpacked Size

454.74 kB

Size

110.86 kB

File Count

NPM Version

10.7.0

Node Version

18.20.4

Published on

Oct 02, 2024

Total Downloads

Cumulative downloads

Total Downloads

123,553,249

Last Day

19.8%

65,476

Compared to previous day

Last Week

36.5%

393,462

Compared to previous week

Last Month

45.6%

1,394,264

Compared to previous month

Last Year

-75.5%

16,365,458

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

fs-extra js-yaml lazy-val lodash.escaperegexp lodash.isequal semver tiny-typed-emitter builder-util-runtime

Dev Dependencies

@types/fs-extra @types/js-yaml @types/lodash.escaperegexp @types/lodash.isequal @types/semver electron

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

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.

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.

Stable Version

6.3.9

High

7.5/10

Summary

electron-updater Code Signing Bypass on Windows

Affected Versions

<= 6.3.0-alpha.5

Patched Versions

6.3.0-alpha.6

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.

5

Code-Review

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

4

Pinned-Dependencies

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

1

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

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.

Score

6.1

/10

Last Scanned on 2025-02-10

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-updater

electron-updater

Installations

Developer Guide

No

CommonJS

18.20.4

10.7.0

Score

Pull Requests

10

1,877

415

1,452

Issues

356

6,851

6,495

Releases

Contributors

Languages

Developer

Download Statistics

GitHub Statistics

Bundle Size

217.17 kB

68.33 kB

Maintainers

Package Meta Information

Total Downloads

123,553,249

Daily Downloads

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

Stable Version

6.3.9

High

10

10

10

10

9

8

6

5

4

1

0

0

0

6.1

/10