Skip to content

简介

CLI 模块,用于开发、构建、加密、打包和资源管理。提供 10 个命令管理 Electron 应用的完整生命周期。支持 CJS + ESM 双模块格式。

配置文件

所有命令读取项目配置文件:

bash
./cmd/bin.js

详见配置类型默认值获取完整的配置结构和默认值。

API

dev

启动开发模式。并发创建前端服务和 Electron 服务。

选项参数说明
--config<folder>自定义 bin.js 配置文件路径
--serve<mode>逗号分隔的服务启动项:frontendelectron 或两者(默认)
bash
ee-bin dev
ee-bin dev --serve=frontend
ee-bin dev --serve=electron

监听模式

./cmd/bin.js 中设置 dev.electron.watch: true 可启用文件监听,自动重新构建和重启。使用 dev.electron.delay 设置文件频繁变更时的防抖延迟。

build

构建前端、Electron 打包和平台包。

选项参数说明
--config<folder>自定义 bin.js 配置文件路径
--cmds<flag>逗号分隔的构建步骤(如 frontend,electron,win64
--env<env>构建环境:devprod(默认:prod
bash
ee-bin build --cmds=frontend
ee-bin build --cmds=frontend,electron
ee-bin build --cmds=frontend,electron,mac_arm64

构建步骤frontendelectron → 平台(win32win64win_ewin_7zmacmac_arm64linuxlinux_arm64)。

start

生产模式预览(需要先构建)。不执行打包,直接运行 Electron。

选项参数说明
--config<folder>自定义 bin.js 配置文件路径
bash
ee-bin start

exec

执行用户在 exec 配置部分定义的自定义命令。

选项参数说明
--config<folder>自定义 bin.js 配置文件路径
--cmds<flag>逗号分隔的自定义命令名称
bash
ee-bin exec --cmds=go

move

在目录之间复制资源(执行复制而非移动)。支持原子备份策略。

选项参数说明
--config<folder>自定义 bin.js 配置文件路径
--flag<flag>逗号分隔的 move 配置键名(如 frontend_dist
bash
ee-bin move --flag=frontend_dist
ee-bin move --flag=go_static,go_config,go_package,go_images

encrypt

使用 javascript-obfuscator 和 bytenode 进行代码加密。

选项参数说明
--config<folder>自定义 bin.js 配置文件路径
--out<folder>输出目录(默认:./

加密类型:

类型说明
confusion仅混淆(javascript-obfuscator)
bytecode仅字节码(bytenode,仅限 Electron)
strict混淆 + 字节码组合
none不加密
bash
ee-bin encrypt
ee-bin encrypt --out ./public

前端与 Electron

  • 前端:仅支持 confusion(浏览器 V8 ≠ 编译时 V8,字节码不兼容)
  • Electron:支持 confusionbytecodestrict

clean

清除加密输出文件。

选项参数说明
-d / --dir<folder>要清除的目录(默认:./public/electron
bash
ee-bin clean
ee-bin clean --dir ./public/electron

icon

从源图片生成各平台的应用图标。

选项参数说明
-i / --input<file>源图片(默认:/public/images/logo.png
-o / --output<folder>输出目录(默认:/build/icons/
-s / --size<flag>图标尺寸(默认:16,32,64,256,512
-c / --clear(boolean)生成前清除输出目录
-m / --images<flag>复制图标到 /public/images/

后处理:16px → tray.png,32px → 窗口图标,其余 → NxN.png

bash
# 安装依赖(可选)
npm install icon-gen -D

# 生成图标
ee-bin icon

注意

如果依赖安装失败,请使用其他软件

updater

生成增量更新包。

选项参数说明
--config<folder>自定义 bin.js 配置文件路径
--app-file<file>应用文件路径(如 app.asar)
--platform<flag>目标平台
--force<flag>强制更新标记
bash
ee-bin updater --platform=macos_apple

参见UpdaterConfig

ohos

提取构建产物到鸿蒙(OpenHarmony)HAP 资源目录。

选项参数说明
--config<folder>自定义 bin.js 配置文件路径
--cmds<flag>逗号分隔的 ohos 配置键名(如 resources
bash
ee-bin ohos --cmds=resources

参见OhosConfig