Install Electron prebuilt binaries for
command-line use using npm. This module helps you easily install the
command for use on the command line without having to compile anything.
and Chromium. You use it similar to the
node command on the command line for
or dive into the Electron documentation.
Note As of version 1.3.1, this package is published to npm under two names:
electron-prebuilt. You can currently use either name, but
electron is recommended, as the
electron-prebuilt name is deprecated, and
will only be published until the end of 2016.
Download and install the latest build of Electron for your OS and add it to your
package.json as a
npm install electron --save-dev
This is the preferred way to use Electron, as it doesn't require users to install Electron globally.
You can also use the
-g flag (global) to symlink it into your PATH:
npm install -g electron
If that command fails with an
EACCESS error you may have to run it again with
sudo npm install -g electron
Now you can just run
electron to run electron:
If you need to use an HTTP proxy you can set these environment variables.
If you want to change the architecture that is downloaded (e.g.,
ia32 on an
x64 machine), you can use the
--arch flag with npm install or set the
npm_config_arch environment variable:
npm install --arch=ia32 electron
Works on Mac, Windows and Linux OSes that Electron supports (e.g. Electron does not support Windows XP).
First, you have to write an Electron application.
Then, you can run your app using:
- electron-packager - Package and distribute your Electron app with OS-specific bundles (.app, .exe etc)
- electron-builder - create installers
- menubar - high level way to create menubar desktop applications with electron
Find more at the awesome-electron list.
Most people use this from the command line, but if you require
your Node app (not your Electron app) it will return the file path to the
binary. Use this to spawn Electron from Node scripts:
var electron =var proc =// will print something similar to /Users/maf/.../Electronconsole// spawn Electronvar child = proc