How to download electron
How to download electron
Advanced Installation Instructions
See the Electron versioning doc for info on how to manage Electron versions in your apps.
Running Electron ad-hoc​
If you’re in a pinch and would prefer to not use npm install in your local project, you can also run Electron ad-hoc using the npx command runner bundled with npm :
The above command will run the current working directory with Electron. Note that any dependencies in your app will not be installed.
Customization​
Proxies​
If you need to use an HTTP proxy, you need to set the ELECTRON_GET_USE_PROXY variable to any value, plus additional environment variables depending on your host system’s Node version:
Custom Mirrors and Caches​
If you are unable to access GitHub or you need to provide a custom build, you can do so by either providing a mirror or an existing cache directory.
Mirror​
You can use environment variables to override the base URL, the path at which to look for Electron binaries, and the binary filename. The URL used by @electron/get is composed as follows:
For instance, to use the China CDN mirror:
If your mirror serves artifacts with different checksums to the official Electron release you may have to set electron_use_remote_checksums=1 to force Electron to use the remote SHASUMS256.txt file to verify the checksum instead of the embedded checksums.
Cache​
Alternatively, you can override the local cache. @electron/get will cache downloaded binaries in a local directory to not stress your network. You can use that cache folder to provide custom builds of Electron or to avoid making contact with the network at all.
On environments that have been using older versions of Electron, you might find the cache also in
You can also override the local cache location by providing a electron_config_cache environment variable.
Skip binary download​
Under the hood, Electron’s JavaScript API binds to a binary that contains its implementations. Because this binary is crucial to the function of any Electron app, it is downloaded by default in the postinstall step every time you install electron from the npm registry.
However, if you want to install your project’s dependencies but don’t need to use Electron functionality, you can set the ELECTRON_SKIP_BINARY_DOWNLOAD environment variable to prevent the binary from being downloaded. For instance, this feature can be useful in continuous integration environments when running unit tests that mock out the electron module.
Troubleshooting​
You can also attempt to download Electron directly from electron/electron/releases if installing via npm is failing.
If installation fails with an EACCESS error you may need to fix your npm permissions.
If the above error persists, the unsafe-perm flag may need to be set to true:
electron/get
Use Git or checkout with SVN using the web URL.
Work fast with our official CLI. Learn more.
Launching GitHub Desktop
If nothing happens, download GitHub Desktop and try again.
Launching GitHub Desktop
If nothing happens, download GitHub Desktop and try again.
Launching Xcode
If nothing happens, download Xcode and try again.
Launching Visual Studio Code
Your codespace will open once ready.
There was a problem preparing your codespace, please try again.
Latest commit
Git stats
Files
Failed to load latest commit information.
README.md
Download Electron release artifacts
Simple: Downloading an Electron Binary ZIP
Advanced: Downloading a macOS Electron Symbol File
Specifying a mirror
To specify another location to download Electron assets from, the following options are available:
Anatomy of a download URL, in terms of mirrorOptions :
Using environment variables for mirror options
Mirror options can also be specified via the following environment variables:
Overriding the version downloaded
This module downloads Electron to a known place on your system and caches it so that future requests for that asset can be returned instantly. The cache locations are:
Downstream packages should utilize the initializeProxy function to add HTTP(S) proxy support. If the environment variable ELECTRON_GET_USE_PROXY is set, it is called automatically. A different proxy module is used, depending on the version of Node in use, and as such, there are slightly different ways to set the proxy environment variables. For Node 10 and above, global-agent is used. Otherwise, global-tunnel-ng is used. Refer to the appropriate linked module to determine how to configure proxy support.
Advanced Installation Instructions
Смотри документацию к версиям Electron, чтобы узнать, как управлять версиями Electron в приложении.
Running Electron ad-hoc
If you’re in a pinch and would prefer to not use npm install in your local project, you can also run Electron ad-hoc using the npx command runner bundled with npm :
The above command will run the current working directory with Electron. Note that any dependencies in your app will not be installed.
Настройка
Прокси
If you need to use an HTTP proxy, you need to set the ELECTRON_GET_USE_PROXY variable to any value, plus additional environment variables depending on your host system’s Node version:
Пользовательские зеркала и кеши
Если доступа к GitHub нет или нужна другая сборка, можно задать зеркало или папку кеша.
Зеркало
Можно использовать переменную окружения, чтобы переопределить базовый URL, по которому ищутся бинарники или имена файлов. The URL used by @electron/get is composed as follows:
For instance, to use the China CDN mirror:
If your mirror serves artifacts with different checksums to the official Electron release you may have to set electron_use_remote_checksums=1 to force Electron to use the remote SHASUMS256.txt file to verify the checksum instead of the embedded checksums.
Кроме того, можно заменить локальный кеш. @electron/get скачивает файлы в кеш, чтобы снизить нагрузку на сеть. Папку с кешем можно использовать для кастомных сборок или, чтобы полностью избежать сетевого трафика.
В старом Electron возможно использование папки
Skip binary download
Under the hood, Electron’s JavaScript API binds to a binary that contains its implementations. Because this binary is crucial to the function of any Electron app, it is downloaded by default in the postinstall step every time you install electron from the npm registry.
However, if you want to install your project’s dependencies but don’t need to use Electron functionality, you can set the ELECTRON_SKIP_BINARY_DOWNLOAD environment variable to prevent the binary from being downloaded. For instance, this feature can be useful in continuous integration environments when running unit tests that mock out the electron module.
Устранение проблем
Также вы можете попытаться скачать Electron непосредственно из electron/electron/releases, если установка через npm терпит неудачу.
Если ошибки не пропадают, можно использовать аргумент unsafe-perm:
Build cross-platform desktop apps with JavaScript, HTML, and CSS
Web Technologies
Electron embeds Chromium and Node.js to enable web developers to create desktop applications.
Cross Platform
Compatible with macOS, Windows, and Linux, Electron apps run on three platforms across all supported architectures.
Open Source
Electron is an open source project maintained by the OpenJS Foundation and an active community of contributors.
Use the tools you love
With the power of modern Chromium, Electron gives you an unopinionated blank slate to build your app. Choose to integrate your favourite libraries and frameworks from the front-end ecosystem, or carve your own path with bespoke HTML code.
Desktop development made easy
Electron takes care of the hard parts so you can focus on the core of your application.
Native graphical user interfaces
Interact with your operating system’s interfaces with Electron’s main process APIs. Customize your application window appearance, control application menus, or alert users through dialogs or notifications.
Automatic software updates
Send out software updates to your macOS and Windows users whenever you release a new version with Electron’s autoUpdater module, powered by Squirrel.
Application installers
Use community-supported tooling to generate platform-specific tooling like Apple Disk Image (.dmg) on macOS, Windows Installer (.msi) on Windows, or RPM Package Manager (.rpm) on Linux.
App store distribution
Distribute your application to more users. Electron has first-class support for the Mac App Store (macOS), the Microsoft Store (Windows), or the Snap Store (Linux).
Crash reporting
Automatically collect JavaScript and native crash data from your users with the crashReporter module. Use a third-party service to collect this data or set up your own on-premise Crashpad server.
Try Electron out
Electron Fiddle
Electron Fiddle lets you create and play with small Electron experiments. It greets you with a quick-start template after opening — change a few things, choose the version of Electron you want to run it with, and play around.
Save your Fiddle either as a GitHub Gist or to a local folder. Once pushed to GitHub, anyone can quickly try your Fiddle out by just entering it in the address bar.
Tutorial
Electron’s quick start tutorial will expose you to a mix of theory and practical code that will get you developing desktop apps like a pro in no time.
Learn how to run a web app in Electron, package your application, and distribute it to end users.
Installation
We recommend you install Electron locally in your devDependencies. For a production-ready experience, install the latest stable version. If you want something a bit more experimental, try the prerelease (beta or alpha) or nightly channels.
electron/electron
Use Git or checkout with SVN using the web URL.
Work fast with our official CLI. Learn more.
Launching GitHub Desktop
If nothing happens, download GitHub Desktop and try again.
Launching GitHub Desktop
If nothing happens, download GitHub Desktop and try again.
Launching Xcode
If nothing happens, download Xcode and try again.
Launching Visual Studio Code
Your codespace will open once ready.
There was a problem preparing your codespace, please try again.
Latest commit
Git stats
Files
Failed to load latest commit information.
README.md
The Electron framework lets you write cross-platform desktop applications using JavaScript, HTML and CSS. It is based on Node.js and Chromium and is used by the Atom editor and many other apps.
Follow @ElectronJS on Twitter for important announcements.
This project adheres to the Contributor Covenant code of conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to coc@electronjs.org.
For more installation options and troubleshooting tips, see installation. For info on how to manage Electron versions in your apps, see Electron versioning.
Each Electron release provides binaries for macOS, Windows, and Linux.
Quick start & Electron Fiddle
Use Electron Fiddle to build, run, and package small Electron experiments, to see code examples for all of Electron’s APIs, and to try out different versions of Electron. It’s designed to make the start of your journey with Electron easier.
Alternatively, clone and run the electron/electron-quick-start repository to see a minimal Electron app in action:
Resources for learning Electron
Most people use Electron from the command line, but if you require electron inside your Node app (not your Electron app) it will return the file path to the binary. Use this to spawn Electron from Node scripts:
See the Advanced Installation Instructions to learn how to use a custom mirror.
We crowdsource translations for our documentation via Crowdin. We currently accept translations for Chinese (Simplified), French, German, Japanese, Portuguese, Russian, and Spanish.
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 on the Community page.
When using Electron logos, make sure to follow OpenJS Foundation Trademark Policy.