:memo: Available Translations: 🇨🇳 🇹🇼 🇧🇷 🇪🇸 🇰🇷 🇯🇵 🇷🇺 🇫🇷 🇹🇭 🇳🇱 🇹🇷 🇮🇩 🇺🇦 🇨🇿 🇮🇹 🇵🇱. View these docs in other languages at electron/i18n.
Follow @ElectronJS on Twitter for important announcements.
npm install electron --save-dev [--save-exact]
--save-exactflag is recommended for Electron prior to version 2, as it does not follow semantic versioning. As of version 2.0.0, Electron follows semver, so you don't need
--save-exactflag. For info on how to manage Electron versions in your apps, see Electron versioning.
For more installation options and troubleshooting tips, see installation.
Alternatively, clone and run the electron/electron-quick-start repository to see a minimal Electron app in action:
git clone https://github.com/electron/electron-quick-start cd electron-quick-start npm install npm start
Most people use Electron from the command line, but if you require
electroninside your Node app (not your Electron app) it will return the file path to the binary. Use this to spawn Electron from Node scripts:
const electron = require('electron') const proc = require('child_process')
// will print something similar to /Users/maf/.../Electron console.log(electron)
// spawn Electron const child = proc.spawn(electron)
Find documentation translations in electron/i18n.
If you are interested in reporting/fixing issues and contributing directly to the code base, please see CONTRIBUTING.md for more information on what we're looking for and how to get started.
Info on reporting bugs, getting help, finding third-party tools and sample apps, and more can be found in the support document.
When using the Electron or other GitHub logos, be sure to follow the GitHub logo guidelines.