Bazel 标志备忘单

报告问题 查看源代码

Nightly · 9.0 · 8.6 · 8.5 · 8.4 · 8.3 · 8.2 · 7.7

浏览 Bazel 的大量命令行标志可能是一项挑战。 本页重点介绍您需要了解的最关键标志。

提示： 选择表格中的标志名称，即可前往命令行参考中的相应条目。

实用的常规选项

以下标志需要在命令行中明确设置。

标志	说明
--config	您可以将 .bazelrc 文件中的标志整理到配置中， 例如用于调试或发布 build 的配置。您可以使用 选择其他配置组--config=<group>。
--keep_going	Bazel 应尽可能继续执行 build 和测试。 默认情况下，Bazel 会尽早失败。
--remote_download_outputs	使用远程执行或缓存（磁盘和远程）时，您可以向 Bazel 发出信号，表明您 想要下载 所有 （中间）构建工件，如下所示： --remote_download_outputs=all 默认情况下，Bazel 仅下载顶级工件（例如最终二进制文件） 以及本地操作所需的中间工件。
--stamp	向二进制文件添加 build 信息（用户、时间戳）。 注意： 由于这会增加 build 时间，因此仅适用于发布 build。

发现 build 和测试问题

以下标志可帮助您更好地了解 Bazel build 或测试错误。

标志	说明
--announce_rc	显示通过用户定义、 机器定义或项目定义的 .bazelrc 文件隐式设置的标志。
--auto_output_filter	默认情况下，Bazel 会尝试阻止日志垃圾内容，并且仅针对在命令行中请求的软件包和子软件包输出编译器 警告和 Starlark 调试输出。如需停用所有过滤，请设置 --auto_output_filter=none.
--sandbox_debug	让您可以深入了解沙盒错误。如需详细了解 Bazel 默认对 build 进行沙盒处理的原因以及沙盒处理的内容，请参阅我们的沙盒文档。 提示： 如果您认为错误可能是由沙盒处理引起的， 请尝试暂时关闭沙盒处理。 为此，请将 --spawn_strategy=standalone 添加到您的命令。
--subcommands (-s)	显示 Bazel 在 build 期间运行的每个命令的完整列表， 无论命令是成功还是失败

启动

注意： 启动标志需要在命令之前传递，并且会导致 服务器重启。请谨慎切换这些标志。

标志	说明
--bazelrc	您可以在 .bazelrc 文件中指定默认 Bazel 选项。如果存在 多个 .bazelrc 文件，您可以通过添加 --bazelrc=<path to the .bazelrc file> 来选择要使用的 .bazelrc 文件。 提示： --bazelrc=dev/null 会停用对 .bazelrc 文件的搜索。 这非常适合需要确保 build 环境干净的场景（例如发布 build），并防止任何意外的配置 更改来自 .bazelrc 文件
--host_jvm_args	限制 Bazel 服务器使用的 RAM 量。 例如，以下命令将 Bazel 堆大小限制为 3GB： --host_jvm_args=-Xmx3g 注意： -Xmx 用于设置 Java 虚拟机 (JVM) 的最大堆大小。堆是分配对象的内存区域。此选项的正确格式为 -Xmx<size> ，其中 <size> 是最大堆大小，并使用以下单位指定： m 表示兆字节 g 表示千兆字节 k 表示千字节
--output_base	控制 Bazel 的输出树。Bazel 不会将 build 输出（包括日志）存储在源代码树本身中。 而是使用不同的输出树来实现此 目的。 提示： 在一个 Bazel 工作区中使用多个输出库，可让您同时运行 多个 Bazel 服务器。这在尝试避免 分析抖动时非常有用。如需了解详情， 请参阅选择输出库。

Bazel 测试

以下标志与 Bazel 测试相关

标志	说明
--java_debug	使 Java 测试在执行之前等待调试器连接。
--runs_per_test	运行测试的次数。例如，如需运行测试 N 次，请添加 --runs_per_test=N。这有助于调试 不稳定的测试，并查看修复是否会导致测试始终通过。
--test_output	指定输出模式。默认情况下，Bazel 会在 本地日志文件中捕获测试输出。在迭代失败的测试时，您通常需要使用 --test_output=streamed来实时查看测试输出。

Bazel 运行

以下标志与 Bazel 运行相关。

标志	说明
--run_under	更改可执行文件的调用方式。例如，--run_under="strace -c" 通常用于调试。

用户专用的 bazelrc 选项

以下标志与用户专用的 .bazelrc 选项相关。

标志	说明
--disk_cache	Bazel 可读取和写入操作及操作输出的目录的路径。 如果该目录不存在，系统会创建该目录。 您可以在多个分支或工作区之间共享 build 工件，并通过添加 加快 Bazel build 速度 --disk_cache=<path>到您的命令。
--jobs	要运行的并发作业数。 这通常仅在使用远程执行时需要，因为远程 build 集群执行的作业数比您在本地拥有的核心数多。
--local_resources	限制本地运行的操作占用的 CPU 或 RAM 量。 注意： 这不会影响 Bazel 服务器本身用于分析和 build 编排等任务的 CPU 或 RAM 量。
--sandbox_base	让沙盒在此路径下创建其沙盒目录。默认情况下，Bazel 会对本地操作进行沙盒处理，这会增加 build 的开销。 提示： 如果您的 build 或测试有许多输入文件，请在 tmpfs 上指定路径（例如 /run/shm），以 尽可能大幅提升性能。

项目专用的 bazelrc 选项

以下标志与项目专用的 .bazelrc 选项相关。

标志	说明
--flaky_test_attempts	如果任何 测试失败，请重试每个测试，重试次数上限为指定次数。这在持续集成中尤其有用。需要多次尝试才能通过的测试在测试摘要中标记为 FLAKY 。
--remote_cache	缓存端点的 URI。设置远程缓存是加快 Bazel build 速度的绝佳方式。它可以与本地磁盘缓存结合使用。
--remote_download_regex	强制下载路径与此模式匹配的远程 build 输出， 无论 --remote_download_outputs 设置如何。您可以通过重复此标志来指定多个模式。
--remote_executor	HOST 或 HOST:PORT 的远程执行端点。如果您使用的是 远程执行服务，请传递此标志。您通常需要添加 --remote_instance_name=<name>。
--remote_instance_name	要在远程执行 API 中作为 instance_name 传递的值。
--show-timestamps	如果指定了此标志，系统会在 Bazel 生成的每条消息中添加时间戳，以指定 显示消息的时间。这在 CI 系统中非常有用，可让您 快速了解哪个步骤花费了多长时间。
--spawn_strategy	即使使用远程执行，在本地运行某些 build 操作也可能会更快。 这取决于 build 集群的容量、网速和 网络延迟等因素。 提示： 如需在本地和远程运行操作并接受 较快的结果，请将 --spawn_strategy=dynamic 添加到 build 命令。