Skip to main content

​
Installation

Install electron-builder as a development dependency in your Electron project.

​
Package Manager Installation

Choose your preferred package manager to install electron-builder: 
npm install electron-builder --save-dev
electron-builder should always be installed as a development dependency (using --save-dev or --dev flag) since it’s only needed during the build process.

​
Yarn 3 Configuration

If you’re using Yarn 3 or later, you need to configure it to use node-modules instead of the default PnP (Plug’n’Play) mode.
Yarn 3 uses PnP by default, but electron-builder still requires node-modules. Add the following configuration to your .yarnrc.yaml file:
.yarnrc.yaml
nodeLinker: "node-modules"
This tells Yarn to use the traditional node_modules directory structure instead of PnP.
This is a known limitation tracked in yarnpkg/berry#4804.

​
System Requirements

​
Node.js Version

electron-builder requires Node.js 14.0.0 or higher. You can check your Node.js version by running: 
node --version

​
Platform-Specific Requirements

  • macOS 10.13 or later recommended for building macOS apps
  • Xcode Command Line Tools (for code signing): xcode-select --install
  • Windows 7 or later
  • No additional tools required (electron-builder downloads necessary tools automatically)
  • Most modern Linux distributions are supported
  • For building certain formats (rpm, deb, etc.), electron-builder will download required tools automatically
  • Docker images are available for CI/CD builds

​
Verification

After installation, verify that electron-builder is correctly installed: 
npx electron-builder --version
You should see the version number displayed.

​
Next Steps

Quick Start Guide

Now that electron-builder is installed, follow the quick start guide to configure your first build

Build docs developers (and LLMs) love

Get started for freeTalk to us