Appearance
命令行界面
如何使用 Electron Forge 的命令行界面 （CLI） 命令
概述
Forge 的 CLI 是运行 Electron Forge 命令的主要方式。它由一个用于其核心 API 的精简包装器组成。这些命令的配置是通过 Forge 配置对象完成的。
如果要以编程方式使用核心 API，请参阅下面的编程用法部分。
TIP
Forge 的 CLI 使用逗号分隔的值字符串将多个参数传递到单个标志中。根据您的终端，这些逗号分隔的值可能需要用引号引起来。
安装
要使用 Forge CLI，请将@electron-forge/cli模块作为 devDependency 安装到您的项目中。如果您使用的是create-electron-app脚本，则此模块已为您安装。
bash
npm install --save-dev @electron-forge/cliBootstrap 命令
这些命令可帮助您开始使用 Forge。如果您刚刚开始使用 Electron Forge，我们建议您遵循 入门 或 导入现有项目 指南。
初始化
TIP
我们建议使用create-electron-app脚本（使用此命令）开始，而不是直接运行 Init
此命令将在给定目录（默认为.， 当前目录）中初始化一个新的 Forge 驱动的应用程序
请注意，如果你想使用非内置模板，则必须在运行init命令之前全局安装它。
选项
所有标志都是可选的。
| 标记 | 值 | 描述 |
|---|---|---|
--template | 模板名称 | 用于创建此新应用的模板的名称 |
--copy-ci-files | 无 | 设置是否要复制模板化 CI 文件（即将推出） |
用法
bash
npx electron-forge init --template=webpack导入
此命令将尝试获取现有的 Electron 应用程序并使其与 Forge 兼容。通常，这只是创建一个基本的 Electron Forge 配置并添加所需的依赖项。
选项
Import （导入） 命令没有选项。
用法
bash
npx electron-forge import生成命令
Package、Make 和 Publish 命令是 Electron Forge 构建管道的三个主要步骤。每个步骤都依赖于前一个步骤的输出，因此默认情况下它们是级联的（例如，publish 将首先运行package ，然后运行make）
TIP
有关更多概念性详细信息，请参阅 Build Lifecycle 指南。
打包
此命令会将应用程序打包到特定于平台的可执行捆绑包中，并将结果放在文件夹中。请注意，这不会形成可分发的格式。要制作适当的可分发对象，请使用 Make 命令。
选项
所有标志都是可选的。
| 标记 | 值 | 描述 |
|---|---|---|
--arch | 指令集架构，如x64 | 要为其打包的目标体系结构。默认为 host arch。 |
--platform | 平台，如mas | 要为其打包的目标平台。默认为主机平台。 |
用法
bash
# 默认情况下，package命令对应于程序包npm脚本：
npm run package -- --arch="ia32"
# 如果没有程序打包脚本：
npx electron-forge package --arch="ia32"生成安装包
此命令将根据您的 Forge 配置和您传入的参数为您的应用程序提供可分发的内容。
如果您不需要在 Make 运行之间重新打包应用程序，请使用--skip-package标记
选项
所有标志都是可选的。
| 标记 | 值 | 描述 |
|---|---|---|
--arch | 指令集架构，如x64 | 目标架构。默认为你正在运行的 arch （“host” arch）。允许的值为：“ia32”、“x64”、“armv7l”、“arm64”、“universal”或“mips64el”。多个值应以逗号分隔。 |
--platform | 平台，如mas | 目标平台，请注意，您通常只能从平台 X 定位平台 X。这默认为您运行的平台 （“host” 平台） 。 |
--targets | 以逗号分隔的 Maker 名称列表 | 覆盖此运行的 make 目标。maker name 是完整的节点模块名称，例如@electron-forge/maker-deb。默认情况下，使用的 make 目标是为给定平台配置和配置的 make 目标。 |
skip-package | 无 | 如果要跳过打包步骤，请设置此项，如果您正在运行 sequential make 并希望节省时间，则此设置非常有用。默认情况下，不会跳过打包。 |
用法
基本用法：
bash
# 默认情况下，make命令对应于make npm脚本：
npm run make -- --arch="ia32"
# 如果没有生成脚本：
npx electron-forge make --arch="ia32"针对 ia32 和 x64 架构进行构建：
bash
npm run make -- --arch="ia32,x64"发布
此命令将尝试将 Forge 应用程序打包、制作并发布到 Forge 配置中定义的发布目标。
如果要在发布之前验证 Make 步骤中的构件，可以使用下面介绍的 Dry Run 选项。
选项
所有标志都是可选的。
| 标记 | 值 | 描述 |
|---|---|---|
--target | 以逗号分隔的发布者名称列表 | 覆盖此运行的发布目标 |
--dry-run | 无 | 触发发布试运行，该运行保存状态但不上传任何内容 |
--from-dry-run | 无 | 尝试从保存在磁盘上的任何试运行中发布对象 |
用法
bash
# 默认情况下，publish命令对应于发布npm脚本：
npm run publish -- --from-dry-run
# 如果没有发布脚本：
npx electron-forge publish -- --from-dry-run开发环境命令
start命令
此命令将在开发模式下使用给定目录（默认为.）中的electron 二进制文件启动您的应用程序。
如果您在运行 start 命令的同一终端中键入 rs（并按 Enter），则正在运行的应用程序将终止并重新启动。
Forge 插件可以覆盖此命令以运行自定义开发逻辑。例如，Webpack 插件运行 webpack-dev-server 实例来提供实时重新加载和 HMR。
选项
所有标志都是可选的。
| 标记 | 值 | 描述 |
|---|---|---|
--app-path | 从工作目录到应用程序的路径 | 覆盖要启动的 Electron 应用程序的路径（默认为.） |
--enable-logging | 无 | 启用高级日志记录。这将记录内部 Electron 的东西 |
--run-as-node | 无 | 将 Electron 应用程序作为 Node.JS 脚本运行 |
--inspect-electron | 无 | 在 Electron 上触发检查模式以允许调试主进程 |
-- | 额外参数 | 要传递给 Electron 或应用程序本身的任何其他参数。例如-- --my-app-argument |
用法
bash
# 默认情况下，start命令对应于start npm脚本：
npm start --enable-logging
# 如果没有启动脚本
npx electron-forge start --enable-logging编程用法
Forge CLI 应该适合大多数用例，但我们确实公开了用于编程命令的软件包@electron-forge/core。
js
const { api } = require('@electron-forge/core');
const main = async () => {
await api.package({
// add package command options here
});
};
main();有关更多信息，请参阅 API 文档。