跳至主要内容

支持的命令行开关

Electron 支持的命令行开关。

您可以在应用程序的主脚本中,在 ready 事件发出之前,使用 app.commandLine.appendSwitch 来追加它们。

const { app } = require('electron')
app.commandLine.appendSwitch('remote-debugging-port', '8315')
app.commandLine.appendSwitch('host-rules', 'MAP * 127.0.0.1')

app.whenReady().then(() => {
// Your code here
})

Electron CLI 标志

--auth-server-whitelist=url

启用集成身份验证的服务器的逗号分隔列表。

例如

--auth-server-whitelist='*example.com, *foobar.com, *baz'

然后,任何以 example.comfoobar.combaz 结尾的 url 都将被视为集成身份验证。如果没有 * 前缀,则 URL 必须完全匹配。

--auth-negotiate-delegate-whitelist=url

需要委托用户凭据的服务器的逗号分隔列表。如果没有 * 前缀,则 URL 必须完全匹配。

--disable-ntlm-v2

对于 posix 平台禁用 NTLM v2,其他地方无效。

--disable-http-cache

禁用 HTTP 请求的磁盘缓存。

--disable-http2

禁用 HTTP/2 和 SPDY/3.1 协议。

--disable-renderer-backgrounding

阻止 Chromium 降低不可见页面的渲染器进程的优先级。

此标志对所有渲染器进程全局有效,如果您只想在一个窗口中禁用节流,您可以使用 播放静音音频 的方法。

--disk-cache-size=size

强制磁盘缓存使用的最大磁盘空间(以字节为单位)。

--enable-logging[=file]

将 Chromium 的日志打印到 stderr(或日志文件)。

ELECTRON_ENABLE_LOGGING 环境变量与传递 --enable-logging 的效果相同。

传递 --enable-logging 将导致日志打印到 stderr。传递 --enable-logging=file 将导致日志保存到 --log-file=... 指定的文件中,或者如果未指定 --log-file,则保存到用户数据目录中的 electron_debug.log 中。

注意:在 Windows 上,子进程的日志无法发送到 stderr。将日志记录到文件是收集 Windows 上日志最可靠的方法。

另请参阅 --log-file--log-level--v--vmodule

--force-fieldtrials=trials

要强制启用或禁用的现场试验。

例如:WebRTC-Audio-Red-For-Opus/Enabled/

--host-rules=rules

控制主机名映射方式的 rules 的逗号分隔列表。

例如

  • MAP * 127.0.0.1 强制所有主机名映射到 127.0.0.1
  • MAP *.google.com proxy 强制所有 google.com 子域解析到“proxy”。
  • MAP test.com [::1]:77 强制“test.com”解析到 IPv6 环回地址。还将强制生成的套接字地址的端口为 77。
  • MAP * baz, EXCLUDE www.google.com 将所有内容重新映射到“baz”,除了“www.google.com”。

这些映射适用于 net 请求中的端点主机(直接连接中的 TCP 连接和主机解析器,以及 HTTP 代理连接中的 CONNECT,以及 SOCKS 代理连接中的端点主机)。

--host-resolver-rules=rules

--host-rules 类似,但这些 rules 仅适用于主机解析器。

--ignore-certificate-errors

忽略与证书相关的错误。

--ignore-connections-limit=domains

忽略以 , 分隔的 domains 列表的连接限制。

--js-flags=flags

指定传递给 V8 引擎 的标志。为了在主进程中启用 flags,必须在启动时传递此开关。

$ electron --js-flags="--harmony_proxies --harmony_collections" your-app

在您的终端中运行 node --v8-optionselectron --js-flags="--help" 以获取可用标志的列表。这些可用于启用早期阶段的 JavaScript 功能,或记录和操作垃圾回收等。

例如,要跟踪 V8 优化和反优化

$ electron --js-flags="--trace-opt --trace-deopt" your-app

--lang

设置自定义区域设置。

--log-file=path

如果指定了 --enable-logging,则日志将写入给定路径。父目录必须存在。

设置 ELECTRON_LOG_FILE 环境变量等效于传递此标志。如果两者都存在,则命令行开关优先。

--log-net-log=path

启用 net 日志事件保存并将其写入 path

--log-level=N

--enable-logging 一起使用时,设置日志记录的详细程度。N 应为 Chrome 的 LogSeverities 之一。

请注意,Chromium 中的两种互补的日志记录机制——LOG()VLOG()——由不同的开关控制。--log-level 控制 LOG() 消息,而 --v--vmodule 控制 VLOG() 消息。因此,根据所需的粒度和正在尝试监视的代码调用的日志记录,您可能需要使用这三个开关的组合。

有关 LOG()VLOG() 如何交互的更多信息,请参阅 Chromium 日志记录源代码。简单来说,VLOG() 可以被认为是 LOG(INFO) 内部的子级别/每个模块级别,以控制 LOG(INFO) 数据的洪流。

另请参阅 --enable-logging--log-level--v--vmodule

--no-proxy-server

不要使用代理服务器,始终建立直接连接。覆盖传递的任何其他代理服务器标志。

--no-sandbox

禁用 Chromium 沙箱。强制渲染器进程和 Chromium 辅助进程以非沙箱模式运行。仅应用于测试。

--proxy-bypass-list=hosts

指示 Electron 绕过给定以分号分隔的主机列表的代理服务器。仅当与 --proxy-server 结合使用时,此标志才有效。

例如

const { app } = require('electron')
app.commandLine.appendSwitch('proxy-bypass-list', '<local>;*.google.com;*foo.com;1.2.3.4:5678')

将使用代理服务器访问所有主机,除了本地地址(localhost127.0.0.1 等)、google.com 子域、包含后缀 foo.com 的主机以及 1.2.3.4:5678 上的所有内容。

--proxy-pac-url=url

使用指定 url 上的 PAC 脚本。

--proxy-server=address:port

使用指定的代理服务器,这将覆盖系统设置。此开关仅影响使用 HTTP 协议的请求,包括 HTTPS 和 WebSocket 请求。还值得注意的是,并非所有代理服务器都支持 HTTPS 和 WebSocket 请求。代理 URL 不支持用户名和密码身份验证 根据 Chromium 问题

--remote-debugging-port=port

在指定的 port 上通过 HTTP 启用远程调试。

--v=log_level

给出默认的最大活动 V 日志记录级别;0 为默认值。通常,正值用于 V 日志记录级别。

此开关仅在也传递了 --enable-logging 时才有效。

另请参阅 --enable-logging--log-level--vmodule

--vmodule=pattern

给出每个模块的最大 V 日志记录级别以覆盖 --v 给出的值。例如,my_module=2,foo*=3 将更改源文件中所有代码的日志记录级别 my_module.*foo*.*

任何包含正斜杠或反斜杠的模式都将针对整个路径名进行测试,而不仅仅是模块。例如,*/foo/bar/*=2 将更改 foo/bar 目录下源文件中所有代码的日志记录级别。

此开关仅在也传递了 --enable-logging 时才有效。

另请参阅 --enable-logging--log-level--v

--force_high_performance_gpu

当有多个 GPU 可用时,强制使用独立显卡。

--force_low_power_gpu

当有多个 GPU 可用时,强制使用集成显卡。

Node.js 标志

Electron 支持 Node.js 支持的一些 CLI 标志

注意:当 Electron 未在 ELECTRON_RUN_AS_NODE 中运行时,传递不支持的命令行开关将无效。

--inspect-brk\[=\[host:]port]

在主机上激活检查器:port并在用户脚本开始时中断。默认主机:port是 127.0.0.1:9229。

别名为 --debug-brk=[host:]port

--inspect-brk-node[=[host:]port]

host:port 上激活检查器,并在检查器可用时执行的第一个内部 JavaScript 脚本开始时中断。默认 host:port127.0.0.1:9229

--inspect-port=\[host:]port

设置激活检查器时使用的 host:port。在通过发送 SIGUSR1 信号激活检查器时很有用。默认主机是 127.0.0.1

别名为 --debug-port=[host:]port

--inspect\[=\[host:]port]

host:port 上激活检查器。默认为 127.0.0.1:9229

V8 检查器集成允许 Chrome DevTools 和 IDE 等工具调试和分析 Electron 实例。这些工具通过 TCP 端口附加到 Electron 实例,并使用 Chrome DevTools 协议 进行通信。

有关更多详细信息,请参阅 调试主进程 指南。

别名为 --debug[=[host:]port

--inspect-publish-uid=stderr,http

指定检查器 Web Socket URL 公开的方式。

默认情况下,检查器 Web Socket URL 在 stderr 中可用,并在 http://host:port/json/list 上的 /json/list 端点下可用。

--no-deprecation

取消弃用警告。

--throw-deprecation

针对弃用抛出错误。

--trace-deprecation

打印弃用的堆栈跟踪。

--trace-warnings

打印进程警告(包括弃用)的堆栈跟踪。

--dns-result-order=order

设置 Node.js dns.lookup()dnsPromises.lookup() 函数中 verbatim 参数的默认值。该值可以是

  • ipv4first:将默认 verbatim 设置为 false
  • verbatim:将默认 verbatim 设置为 true

默认为 verbatim,并且 dns.setDefaultResultOrder() 优先于 --dns-result-order