Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/electron-userland/electron-builder/llms.txt

Use this file to discover all available pages before exploring further.

Package and Distribute Electron Apps

A complete solution to build ready-for-distribution Electron apps for macOS, Windows, and Linux with auto-update support out of the box.

Get StartedAPI Reference

Quick Start

Get your Electron app packaged and distributed in minutes

1

Install electron-builder

Add electron-builder to your project as a dev dependency:
npm install electron-builder --save-dev
2

Configure your package.json

Add build configuration to your package.json:
package.json
{
  "name": "your-app",
  "version": "1.0.0",
  "description": "Your Electron app",
  "author": "Your Name",
  "build": {
    "appId": "com.yourcompany.yourapp",
    "mac": {
      "category": "your.app.category.type"
    }
  },
  "scripts": {
    "build": "electron-builder"
  }
}
The appId should be unique to your application and follow reverse-DNS notation.
3

Build your application

Run the build command to package your app:
npm run build
electron-builder will automatically detect your platform and build the appropriate installer. Find your packaged app in the dist directory.
• electron-builder  version=24.13.3 os=macOS
• loaded configuration  file=package.json ("build" field)
• building        target=macOS zip arch=arm64 file=dist/YourApp-1.0.0-arm64-mac.zip
• building        target=DMG arch=arm64 file=dist/YourApp-1.0.0-arm64.dmg
4

Customize your build

Explore configuration options to customize installers, add code signing, configure auto-updates, and more.

Platform Support

Build native installers for all major platforms

macOS

DMG, PKG, and Mac App Store builds with code signing and notarization support.

Windows

NSIS, MSI, AppX, and portable installers with code signing and Squirrel.Windows support.

Linux

AppImage, Snap, Flatpak, deb, rpm, and more distribution formats.

Key Features

Everything you need to ship production-ready Electron apps

Auto Update

Built-in auto-update support with electron-updater for seamless app updates.

Code Signing

Sign your apps for macOS and Windows to avoid security warnings.

Multi-Platform Builds

Build for all platforms from any platform using Docker.

Publishing

Publish to GitHub Releases, S3, DigitalOcean Spaces, and more.

Native Dependencies

Automatic compilation of native Node.js modules for the target platform.

CLI & Programmatic API

Use from command line or integrate into your build pipeline with the programmatic API.

Explore the Documentation

Dive deeper into electron-builder capabilities

Build Configuration

Learn how to configure electron-builder for your project needs

Read more

Code Signing Guide

Sign your applications to ensure users trust your software

Read more

Configuration Reference

Complete reference for all configuration options

Read more

Programmatic API

Integrate electron-builder into your build scripts

Read more

Ready to build your Electron app?

Install electron-builder and start packaging your application for distribution in minutes.

Get Started Now