跳转到主要内容

支持的命令行开关

Electron 支持的命令行开关。

您可以使用 app.commandLine.appendSwitch 在您的应用主脚本中,在 ready 事件被 app 模块发出之前,添加这些开关。

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 开关。

--host-resolver-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”。

这些 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 log 事件保存并将它们写入 path

--log-level=N

--enable-logging 结合使用时,设置日志的详细程度。N 应该是 Chrome 的 LogSeverities 中的一个。

请注意,Chromium 中的两种互补的日志记录机制 -- LOG()VLOG() -- 由不同的开关控制。--log-level 控制 LOG() 消息,而 --v--vmodule 控制 VLOG() 消息。因此,您可能需要使用这三个开关的组合,具体取决于您想要的粒度和代码尝试记录的内容。

有关 LOG()VLOG() 如何交互的更多信息,请参阅 Chromium Logging 源代码。 广义地说,可以将 VLOG() 视为 LOG(INFO) 内部的子级别/每模块级别,以控制 LOG(INFO) 数据的洪流。

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

--no-proxy-server

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

--no-sandbox

禁用 Chromium 沙盒。强制渲染器进程和 Chromium 辅助进程以未沙盒的方式运行。仅应用于测试。

--no-stdio-init

禁用节点初始化期间的 stdio 初始化。用于避免在 Windows 平台上禁用 nul 设备时节点初始化崩溃。

--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 issue

--remote-debugging-port=port

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

--v=log_level

给出默认的最大活动 V-logging 级别;0 是默认值。通常使用正值作为 V-logging 级别。

只有在传递 --enable-logging 时,此开关才有效。

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

--vmodule=pattern

为特定模块设置最大 V-logging 级别,以覆盖 --v 给定的值。例如,my_module=2,foo*=3 会更改源文件 my_module.*foo*.* 中所有代码的 logging 级别。

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

只有在传递 --enable-logging 时,此开关才有效。

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

--force_high_performance_gpu

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

--force_low_power_gpu

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

--xdg-portal-required-version=version

为了在 Linux 上使用 portal 后端进行文件对话,将 XDG portal 实现的最低所需版本设置为 version。当所需版本不可用时,文件对话将回退到使用 gtk 或 kde,具体取决于桌面环境。当前默认值设置为 3

Node.js 标志

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

注意

当 Electron 未以 ELECTRON_RUN_AS_NODE 模式运行时,将不支持的命令行开关传递给 Electron 将不会产生任何效果。

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

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

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

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

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

--inspect-port=[host:]port

设置激活 inspector 时要使用的 host:port。当通过发送 SIGUSR1 信号激活 inspector 时很有用。默认主机是 127.0.0.1

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

--inspect[=[host:]port]

host:port 上激活 inspector。默认值为 127.0.0.1:9229

V8 inspector 集成允许使用 Chrome DevTools 和 IDE 等工具调试和分析 Electron 实例。这些工具通过 TCP 端口连接到 Electron 实例,并使用 Chrome DevTools Protocol 进行通信。

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

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

--inspect-publish-uid=stderr,http

指定 inspector web socket url 暴露的方式。

默认情况下,inspector websocket url 在 stderr 中可用,并且在 http://host:port/json/list 上的 /json/list 端点下可用。

--experimental-network-inspection

启用对 DevTools 网络 inspector 事件的支持,以便了解由 Node.js httphttps 模块发出的请求。

--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 更高的优先级。

--diagnostic-dir=directory

设置写入所有 Node.js 诊断输出文件的目录。默认值为当前工作目录。

影响 v8.setHeapSnapshotNearHeapLimit 的默认输出目录。

--no-experimental-global-navigator

禁用从 Node.js 在全局范围内暴露 Navigator API

Chromium 标志

没有文档记录的 Chromium 开关列表,但有一些方法可以找到它们。

最简单的方法是通过 Chromium 的 flags 页面,可以通过 about://flags 访问。这些 flags 不直接匹配开关名称,但它们会显示在进程的命令行参数中。

要查看这些参数,请在 about://flags 中启用一个 flag,然后转到 Chromium 中的 about://version。您将找到一个命令行参数列表,包括 --flag-switches-begin --your --list --flag-switches-end,其中包含您启用的 flag 开关列表。

大多数 flags 都包含在 --enable-features= 中,但有些是独立的开关,例如 --enable-experimental-web-platform-features

完整的 flags 列表存在于 Chromium 的 flag 元数据页面 中,但此列表包括平台、环境和 GPU 特定的、已过期的以及可能非功能的 flags,因此其中许多 flags 可能并不总能在每种情况下都起作用。

请记住,独立的开关有时可以拆分为单个 features,因此没有完整的开关列表。

最后,您需要确保 Electron 中的 Chromium 版本与您用于交叉引用开关的浏览器版本匹配。