CLI

如何使用 Electron Forge 的命令行界面 (CLI) 命令

概述

Forge 的 CLI 是运行 Electron Forge 命令的主要方式。它包含其核心 API 的一个薄包装器。这些命令的配置是通过您的 Forge 配置 对象完成的。

如果您想以编程方式使用核心 API，请参阅下面的 编程使用 部分。

Forge 的 CLI 使用逗号分隔的值字符串将多个参数传递到单个标志中。根据您的终端，这些逗号分隔的值可能需要用引号括起来。

安装

要使用 Forge CLI，请将 @electron-forge/cli 模块作为开发依赖项安装到您的项目中。如果您使用的是 create-electron-app 脚本，则此模块将已为您安装。

npm install --save-dev @electron-forge/cli

引导命令

这些命令可帮助您开始使用 Forge。如果您刚开始使用 Electron Forge，我们建议您按照 入门指南 或 导入现有项目 指南操作。

初始化

我们建议使用 create-electron-app 脚本（它使用此命令）开始，而不是直接运行 Init。

此命令将在给定目录（默认为 .，当前目录）中初始化一个新的 Forge 驱动的应用程序。

请注意，如果您想使用非内置模板，则必须在运行 init 命令之前全局安装它。

选项

所有标志都是可选的。

标志	值	描述
--template	模板名称	用于创建此新应用的模板名称
--copy-ci-files	N/A	如果您想复制模板化的 CI 文件，请设置 (即将推出)

用法

npx electron-forge init --template=webpack

导入

此命令将尝试获取现有的 Electron 应用并使其与 Forge 兼容。通常，这只是创建一个基本的 Electron Forge 配置并添加所需的依赖项。

选项

导入命令没有选项。

用法

npx electron-forge import

构建命令

打包、构建和发布命令是 Electron Forge 构建管道的三个主要步骤。每个步骤都依赖于上一个步骤的输出，因此它们默认情况下是级联的（例如，运行 publish 将首先运行 package，然后运行 make）。

有关更多概念细节，请参阅 构建生命周期 指南。

打包

此命令会将您的应用程序打包到特定于平台的可执行文件包中，并将结果放在一个文件夹中。请注意，这不会生成可分发的格式。要生成正确的可分发文件，请使用构建命令。

选项

所有标志都是可选的。

标志	值	描述
--arch	体系结构，例如 x64	要打包的目标体系结构。默认为主机体系结构。
--platform	平台，例如 mas	要打包的目标平台。默认为主机平台。

用法

# By default, the package command corresponds to a package npm script:
npm run package -- --arch="ia32"
# If there is no package script:
npx electron-forge package --arch="ia32"

构建

此命令将根据您的 Forge 配置和您传递的参数为您的应用程序构建可分发文件。

如果您不需要在构建运行之间重新打包应用程序，请使用 --skip-package 标志。

选项

所有标志都是可选的。

标志	值	描述
--arch	体系结构，例如 x64	要构建的目标体系结构。默认为您正在运行的体系结构（“主机”体系结构）。允许的值为：“ia32”、“x64”、“armv7l”、“arm64”、“universal”或“mips64el”。多个值应以逗号分隔。
--platform	平台，例如 mas	要构建的目标平台，请注意，您通常只能从平台 X 构建平台 X。默认为您正在运行的平台（“主机”平台）。
--targets	构建器名称的逗号分隔列表	覆盖此运行的构建目标。构建器名称是完整的节点模块名称，例如 @electron-forge/maker-deb。默认情况下，使用的构建目标是为给定平台提供的和配置的目标。
--skip-package	N/A	如果您想跳过打包步骤，请设置此选项，这在您运行连续构建并希望节省时间时很有用。默认情况下，打包 不会跳过。

用法

基本用法

# By default, the make command corresponds to a make npm script:
npm run make -- --arch="ia32"
# If there is no make script:
npx electron-forge make --arch="ia32"

为 ia32 和 x64 体系结构构建

npm run make -- --arch="ia32,x64"

发布

此命令将尝试打包、构建和将 Forge 应用程序发布到 Forge 配置中定义的发布目标。

如果您想在发布之前验证构建步骤中的工件，可以使用下面解释的“干运行”选项。

选项

所有标志都是可选的。

标志	值	描述
--target	发布者名称的逗号分隔列表	覆盖此运行的发布目标
--dry-run	N/A	触发发布干运行，该运行保存状态并且不上传任何内容
--from-dry-run	N/A	尝试发布磁盘上保存的任何干运行的工件

用法

# By default, the publish command corresponds to a publish npm script:
npm run publish -- --from-dry-run
# If there is no publish script:
npx electron-forge publish -- --from-dry-run

开发命令

启动

此命令将在开发模式下使用给定目录（默认为 .）中的 electron 二进制文件启动您的应用。

如果您在运行启动命令的同一终端中键入 rs（然后按 Enter），则正在运行的应用程序将被终止并重新启动。

Forge 插件可以覆盖此命令以运行自定义开发逻辑。例如，Webpack 插件 运行 webpack-dev-server 实例以提供实时重新加载和 HMR。

选项

所有标志都是可选的。

标志	值	描述
--app-path	从工作目录到您的应用程序的路径	覆盖要启动的 Electron 应用的路径（默认为 .）。
--enable-logging	N/A	启用高级日志记录。这将记录 Electron 内部信息。
--run-as-node	N/A	以 Node.JS 脚本的方式运行 Electron 应用。
--inspect-electron	N/A	触发 Electron 的检查模式，以允许调试主进程。
--	额外参数	传递给 Electron 或应用本身的任何额外参数。例如： -- --my-app-argument

用法

# By default, the start command corresponds to a start npm script:
npm start --enable-logging
# if there is no start script
npx electron-forge start --enable-logging

编程使用

Forge CLI 应该适用于大多数用例，但我们确实公开了 @electron-forge/core 包用于编程命令使用。

const { api } = require('@electron-forge/core');

const main = async () => {
  await api.package({
    // add package command options here
  });
};

main();

有关更多信息，请参阅 API 文档。