安装

要安装预编译好的的二进制文件, 请使用 npm。 首选的方法是在项目中作为development dependency安装。

  1. npm install electron --save-dev

查看versioning doc获取如何在你的应用中管理Electron的相关信息。

全局安装

您还可以在 $PATH 中全局安装 electron 命令:

  1. npm install electron -g

自定义

如果想修改下载安装的位版本(例如, 在x64机器上安装ia32位版本), 你可以使用npm install中的--arch标记，或者设置npm_config_arch 环境变量:

  1. npm install --arch=ia32 electron

此外, 您还可以使用 --platform 来指定开发平台 (例如, win32、linux 等):

  1. npm install --platform=win32 electron

代理

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:

自定义镜像和缓存

During installation, the electron module will call out to @electron/get to download prebuilt binaries of Electron for your platform. 这将通过访问 GitHub 的发布下载页面来完成 (https://github.com/electron/electron/releases/tag/v$VERSION, 这里的 $VERSION 是 Electron 的确切版本).

如果您无法访问GitHub，或者您需要提供自定义构建，则可以通过提供镜像或现有的缓存目录来实现。

镜像

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:

  1. url = ELECTRON_MIRROR + ELECTRON_CUSTOM_DIR + '/' + ELECTRON_CUSTOM_FILENAME

例如，使用中国镜像：

  1. ELECTRON_MIRROR="https://cdn.npm.taobao.org/dist/electron/"

缓存

或者，您可以覆盖本地缓存。 @electron/get will cache downloaded binaries in a local directory to not stress your network. 您可以使用该缓存文件夹来提供 Electron 的定制版本，或者避免进行网络连接。

  • Linux: $XDG_CACHE_HOME or ~/.cache/electron/
  • MacOS: ~/Library/Caches/electron/
  • Windows: $LOCALAPPDATA/electron/Cache or ~/AppData/Local/electron/Cache/

在使用旧版本 Electron 的环境中，您也可以在~/.electron中找到缓存。

You can also override the local cache location by providing a electron_config_cache environment variable.

缓存包含版本的官方zip文件以及校验和，存储为文本文件。 典型的缓存可能如下所示：

  1. ├── httpsgithub.comelectronelectronreleasesdownloadv1.7.9electron-v1.7.9-darwin-x64.zip
  2. │   └── electron-v1.7.9-darwin-x64.zip
  3. ├── httpsgithub.comelectronelectronreleasesdownloadv1.7.9SHASUMS256.txt
  4. │   └── SHASUMS256.txt
  5. ├── httpsgithub.comelectronelectronreleasesdownloadv1.8.1electron-v1.8.1-darwin-x64.zip
  6. │   └── electron-v1.8.1-darwin-x64.zip
  7. ├── httpsgithub.comelectronelectronreleasesdownloadv1.8.1SHASUMS256.txt
  8. │   └── SHASUMS256.txt
  9. ├── httpsgithub.comelectronelectronreleasesdownloadv1.8.2-beta.1electron-v1.8.2-beta.1-darwin-x64.zip
  10. │   └── electron-v1.8.2-beta.1-darwin-x64.zip
  11. ├── httpsgithub.comelectronelectronreleasesdownloadv1.8.2-beta.1SHASUMS256.txt
  12. │   └── SHASUMS256.txt
  13. ├── httpsgithub.comelectronelectronreleasesdownloadv1.8.2-beta.2electron-v1.8.2-beta.2-darwin-x64.zip
  14. │   └── electron-v1.8.2-beta.2-darwin-x64.zip
  15. ├── httpsgithub.comelectronelectronreleasesdownloadv1.8.2-beta.2SHASUMS256.txt
  16. │   └── SHASUMS256.txt
  17. ├── httpsgithub.comelectronelectronreleasesdownloadv1.8.2-beta.3electron-v1.8.2-beta.3-darwin-x64.zip
  18. │   └── electron-v1.8.2-beta.3-darwin-x64.zip
  19. └── httpsgithub.comelectronelectronreleasesdownloadv1.8.2-beta.3SHASUMS256.txt
  20.     └── SHASUMS256.txt

跳过二进制包下载

当您在安装 electron NPM 包时, 它会自动下载 electron 的二进制包。

当在CI环境中 测试另一个组件的时候，这可能是不必要的。

为了防止当您安装所有 npm 依赖关系时下载二进制文件，您可以设置环境变量 ELECTRON_SKIP_BINARY_DOWNODD。 例如:

  1. ELECRON_SKIP_BINARY_DOWNOAD=1 npm install

故障排查

在运行 npm install electron 时，有些用户会偶尔遇到安装问题。

在大多数情况下，这些错误都是由网络问题导致，而不是因为 electron npm 包的问题。 如 ELIFECYCLE、EAI_AGAIN、ECONNRESET 和 ETIMEDOUT 等错误都是此类网络问题的标志。 最佳的解决方法是尝试切换网络，或是稍后再尝试安装。

如果通过 npm 安装失败，您可以尝试直接从 electron/electron/releases 直接下载 Electron。

如果安装失败并出现 EACCESS 错误, 则可能需要 修复您的 npm 权限 。（例如使用 sudo ）

如果上述错误仍然存在, 则可能需要将参数 unsafe-perm 设置为 true

  1. sudo npm install electron --unsafe-perm=true

在较慢的网络上, 最好使用 --verbose 标志来显示下载进度:

  1. npm install --verbose electron

如果需要强制重新下载文件, 并且 SHASUM 文件将 force_no_cache 环境变量设置为 true。