Electron api documentation install#
Electron api documentation code#

Otherwise, a single bundle for the host platform/architecture will be created.įor an overview of the other optional flags, run electron-packager -help or seeĭetailed descriptions, see the API documentation.If you specify -all instead, bundles for all valid combinations of target.platform and -arch can be omitted, in two cases: Use that version of Electron to create an app in /- (this can be customized via an optional flag).Find or download the correct release of Electron.Note: npx can be substituted for yarn or npm exec depending on what package manager and Running Electron Packager from the command line has this basic form: npx electron-packager -platform= -arch= JavaScript API usage can be found in the API documentation. A Windows executable is bundled in that Node package and needs to be run in order for thisįunctionality to work, so on non-Windows host platforms (not including WSL), Building Windows apps from non-Windows platformsīuilding an Electron app for the Windows target platform requires editing the Electron.exe file.Ĭurrently, Electron Packager uses node-rcedit to accomplish

Electron api documentation install#

It is not recommended to install electron-packager globally. This module requires Node.js 10.0 or higher to run.

app bundle can only be signed when building on a host macOS platform.

* Note for macOS / Mac App Store target bundles: the.

Linux (for x86, x86_64, armv7l, arm64, and mips64el architectures).

macOS (also known as darwin) / Mac App Store (also known as mas) * (for x86_64, arm64, and universal architectures).

Windows (also known as win32, for x86, x86_64, and arm64 architectures).

It generates executables/bundles for the following target platforms: Supported PlatformsĮlectron Packager is known to run on the following host platforms: Platform, target arch, and Electron version (files named electron-v$.zip). A zipped, minimal ElectronĪpplication is approximately the same size as the zipped prebuilt binary for a given target Note that packaged Electron applications can be relatively large. Internally), or one of the related Electron tools, which utilizesĮlectron Packager-created folders as a basis.

Electron api documentation code#

Source code with a renamed Electron executable and supporting files into folders ready for distribution.įor creating distributables like installers and Linux packages, consider using either Electron exe, etc.) via JavaScript or the command line.Įlectron Packager is a command line tool and Node.js library that bundles Electron-based application Package your Electron app into OS-specific bundles (.