electron-packager
github.com
What it is
electron-packager bundles Electron app source code with a renamed Electron executable and supporting files into folders ready for distribution. It works as a command-line tool or a Node.js library called through JavaScript. Packager can find or download a matching Electron release and build for a selected platform and architecture, all valid combinations, or the host combination. Output targets include Windows, macOS—including Mac App Store targets—and Linux; these are also the listed host platforms. Documented target architectures include x86, x86_64, arm64, universal macOS, Linux armv7l, and Linux mips64el, though some depend on Electron versions. CLI options include a regular-expression ignore filter for files and folders. Electron Forge uses Packager internally, and installer tools can use its output folders to create distributables. The free, open-source Node.js tool requires Node.js 22.12.0 or higher, and local installation is recommended. Signing a macOS or Mac App Store bundle requires building on a macOS host. The project also notes that even a minimal zipped app is approximately the size of the matching zipped Electron binary.
Spec sheet
- Purpose
- Electron Packager bundles Electron app source code with a renamed Electron executable and supporting files into folders ready for distribution.Read 7 Oct 2026 · github.com
- Integrations
- Electron Forge uses Electron Packager internally, while related installer tools use Packager-created folders to create distributables.Read 7 Oct 2026 · github.com
- Security
- GitHub reports that the project has not set up a SECURITY.md security policy.Read 7 Oct 2026 · github.com
- Support
- The project directs usage questions to its FAQ and troubleshooting questions to its contributing documentation.Read 7 Oct 2026 · github.com
- API plugins
- The project lists API-hook plugins for locale selection, non-proprietary FFmpeg codecs, and rebuilding native Node.js modules.Read 7 Oct 2026 · github.com
- Architecture support
- Documented target architectures include x86, x86_64, arm64, universal macOS, Linux armv7l, and Linux mips64el, with some architecture availability limited by Electron versions.Read 7 Oct 2026 · github.com
- Build behavior
- Packager can find or download the matching Electron release and create an app bundle for a chosen platform and architecture, all valid combinations, or the host combination.Read 7 Oct 2026 · github.com
- Configuration
- The CLI supports optional flags, and its ignore option filters files and folders with a regular expression.Read 7 Oct 2026 · github.com
- Host platforms
- The project lists Windows, macOS, and Linux as supported host platforms for running Packager.Read 7 Oct 2026 · github.com
- Interfaces
- It can be used as a command-line tool or as a Node.js library through JavaScript.Read 7 Oct 2026 · github.com
- Prerequisite
- The module requires Node.js 22.12.0 or higher and the project recommends installing it locally rather than globally.Read 7 Oct 2026 · github.com
- Signing limit
- A macOS or Mac App Store app bundle can only be signed when the build runs on a macOS host.Read 7 Oct 2026 · github.com
- Size limit
- The project notes that packaged Electron apps can be relatively large, with a minimal zipped app approximately the size of the matching zipped Electron binary.Read 7 Oct 2026 · github.com
- Target platforms
- It generates application bundles for Windows, macOS including Mac App Store targets, and Linux.Read 7 Oct 2026 · github.com
Plans and prices
Strong points and limits
Strong points
- Offers CLI and JavaScript library interfaces
- Targets Windows, macOS, and Linux
- Can select target architectures
- Supports regular-expression file filtering
Limits
- Requires Node.js 22.12.0 or higher
- Mac bundle signing requires a macOS build host
- Packaged apps can be relatively large
- No auto-update support
Who it suits
electron-packager suits developers who need to bundle Electron applications for Windows, macOS, or Linux from the command line or JavaScript. Builds require Node.js 22.12.0 or higher.
Verdict
electron-packager focuses on creating distribution-ready application folders, with multiple target platforms and architectures. Its Node.js requirement and macOS-host requirement for signing are relevant constraints.
Where Specifiction places it
- Software Packaging Tools#8 of 297.9