Customize and package your Electron app with OS-specific bundles (.app, .exe, etc.) via JS or CLI
The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:
Package your Electron app into OS-specific bundles (
Electron Packager is a command line tool and Node.js library that bundles Electron-based application source code with a renamed Electron executable and supporting files into folders ready for distribution.
For creating distributables like installers and Linux packages, consider using either Electron Forge (which uses Electron Packager internally), or one of the related Electron tools, which utilizes Electron Packager-created folders as a basis.
Note that packaged Electron applications can be relatively large. A zipped, minimal Electron application is approximately the same size as the zipped prebuilt binary for a given target platform, target arch, and Electron version_(files named
Electron Packager is known to run on the following host platforms:
It generates executables/bundles for the following target platforms:
, for x86, x86_64, and arm64 architectures)
) / Mac App Store (also known as
*Note for macOS / Mac App Store target bundles: the
bundle can only be signed when building on a host macOS platform.
This module requires Node.js 10.0 or higher to run.
# For use in npm scripts (recommended) npm install electron-packager --save-dev # For use from the CLI npm install electron-packager -g
Building an Electron app for the Windows target platform requires editing the
file. Currently, Electron Packager uses node-rcedit to accomplish this. A Windows executable is bundled in that Node package and needs to be run in order for this functionality to work, so on non-Windows host platforms, Wine 1.6 or later needs to be installed. On macOS, it is installable via Homebrew.
Running electron-packager from the command line has this basic form:
electron-packager <sourcedir> <appname> --platform=<platform> --arch=<arch> [optional flags...] </arch></platform></appname></sourcedir>
(this can be customized via an optional flag)
can be omitted, in two cases:
For an overview of the other optional flags, run
is omitted, this will use the name specified by "productName" or "name" in the nearest package.json.
**Characters in the Electron app name which are not allowed in all target platforms' filenames (e.g.,
), will be replaced by hyphens (
You should be able to launch the app on the platform you built for. If not, check your settings and try again.
Be careful not to include
you don't want into your final app. If you put them in the
, by default none of the modules related to those dependencies will be copied in the app bundles. (This behavior can be turned off with the
API option or
CLI flag.) In addition, folders like
will be ignored by default. You can use
to ignore files and folders via a regular expression (not a glob pattern). Examples include
Let's assume that you have made an app based on the electron-quick-start repository on a macOS host platform with the following file structure:
foobar ├── package.json ├── index.html ├── […other files, like the app's LICENSE…] └── script.js
…and that the following is true:
is installed globally
has been set to
module is in the
, and set to the exact version of ```
app has been run at least once When one runs the following command for the first time in the
will do the following: - Use the current directory for the
- Infer the
- Infer the
- Infer the
from the host, in this example,
arch. - Download the darwin x64 build of Electron 1.4.15 (and cache the downloads in
) - Build the macOS
directory was not specified, it used the current working directory) The file structure now looks like:
foobar ├── Foo Bar-darwin-x64 │ ├── Foo Bar.app │ │ └── […Mac app contents…] │ ├── LICENSE [the Electron license] │ └── version ├── […other application bundles, like "Foo Bar-win32-x64" (sans quotes)…] ├── package.json ├── index.html ├── […other files, like the app's LICENSE…] └── script.js
folder generated can be executed by a system running macOS, which will start the packaged Electron app. This is also true of the Windows x64 build on a system running a new enough version of Windows for a 64-bit system (via
Foo Bar-win32-x64/Foo Bar.exe
``` ), and so on.
These Node modules utilize Electron Packager API hooks: