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，我們建議您遵循開始使用或匯入現有專案指南。

Init

我們建議使用 create-electron-app 指令碼（使用此命令）來開始，而不是直接執行 Init。

此命令將在給定的目錄中初始化一個新的由 Forge 驅動的應用程式（預設為 .，目前的目錄）。

請注意，如果您想使用非內建的樣板，則必須在執行 init 命令之前將其全域安裝。

選項

所有標誌都是可選的。

標誌	值	描述
--template	樣板名稱	用來建立此新應用程式的樣板名稱
--copy-ci-files	N/A	如果您要複製樣板化的 CI 檔案，請設定此項 (即將推出)

用法

npx electron-forge init --template=webpack

Import

此命令將嘗試取得現有的 Electron 應用程式，使其與 Forge 相容。通常，這只會建立基本的 Electron Forge 設定，並新增所需的相依性。

選項

Import 命令沒有任何選項。

用法

npx electron-forge import

建置命令

Package、Make 和 Publish 命令是 Electron Forge 建置管道的三個主要步驟。每個步驟都依賴於上一個步驟的輸出，因此它們預設是階層式的（例如，執行 publish 將首先執行 package，然後是 make）。

有關更多概念性詳細資訊，請參閱建置生命週期指南。

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"

Make

此命令會根據您的 Forge 設定和您傳入的參數來製作應用程式的可散發版本。

如果您在 Make 執行之間不需要重新封裝您的應用程式，請使用 --skip-package 標誌。

選項

所有標誌都是可選的。

標誌	值	描述
--arch	架構，例如 x64	要製作的目標架構。預設為您正在執行的架構（「主機」架構）。允許的值為：「ia32」、「x64」、「armv7l」、「arm64」、「universal」或「mips64el」。多個值應以逗號分隔。
--platform	平台，例如 mas	要製作的目標平台，請注意，您通常只能從平台 X 針對平台 X。這預設為您正在執行的平台（「主機」平台）。
--targets	以逗號分隔的製作器名稱列表	覆寫此執行的製作目標。製作器名稱是完整的 Node 模組名稱，例如 @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"

Publish

此命令會嘗試將 Forge 應用程式封裝、製作並發佈到您 Forge 設定中定義的發佈目標。

如果您想在發佈之前驗證 Make 步驟中的成品，您可以使用下面說明的試執行選項。

選項

所有標誌都是可選的。

標誌	值	描述
--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

開發命令

Start

此命令會使用給定目錄中的 electron 二進位檔，在開發模式下啟動您的應用程式（預設為 .）。

如果您在執行 start 命令的同一個終端機中輸入 rs（並按下 Enter 鍵），則正在執行的應用程式將會終止並重新啟動。

Forge 外掛程式可以覆寫此命令以執行自訂開發邏輯。例如，Webpack 外掛程式會執行 webpack-dev-server 實例以提供即時重新載入和 HMR。

選項

所有標誌都是可選的。

標誌	值	描述
--app-path	從工作目錄到您的應用程式的路徑	覆寫要啟動的 Electron 應用程式的路徑（預設為 .）
--enable-logging	N/A	啟用進階記錄。這將記錄 Electron 內部事項
--run-as-node	N/A	將 Electron 應用程式作為 Node.JS 腳本執行
--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 文件。