Command-Line Reference

bazel [<startup options>] <command> [<args>]
or
bazel [<startup options>] <command> [<args>] -- [<target patterns>]
See the User's Guide for the target patterns syntax.

Option Syntax

Options can be passed to Bazel in different ways. Options that require a value can be passed with either an equals sign or a space:

--<option>=<value>
--<option> <value>
Some options have a single character short form; in that case, the short form has to be passed with a single dash and a space.
-<short_form> <value>

Boolean options can be enabled as follows:

--<option>
--<option>=[true|yes|1]
and disabled as follows:
--no<option>
--<option>=[false|no|0]

Tristate options are usually set to automatic by default, and can be force-enabled as follows:

--<option>=[true|yes|1]
or force-disabled as follows:
--no<option>
--<option>=[false|no|0]

Commands

analyze-profile Analyzes build profile data.
aquery Analyzes the given targets and queries the action graph.
build Builds the specified targets.
canonicalize-flags Canonicalizes a list of bazel options.
clean Removes output files and optionally stops the server.
coverage Generates code coverage report for specified test targets.
cquery Loads, analyzes, and queries the specified targets w/ configurations.
dump Dumps the internal state of the bazel server process.
fetch Fetches external repositories that are prerequisites to the targets.
help Prints help for commands, or the index.
info Displays runtime info about the bazel server.
license Prints the license of this software.
mobile-install Installs targets to mobile devices.
mod Queries the Bzlmod external dependency graph
print_action Prints the command line args for compiling a file.
query Executes a dependency graph query.
run Runs the specified target.
shutdown Stops the bazel server.
sync Syncs all repositories specified in the workspace file
test Builds and runs the specified test targets.
version Prints version information for bazel.

Startup Options

Options that appear before the command and are parsed by the client:
--[no]autodetect_server_javabase default: "true"
When --noautodetect_server_javabase is passed, Bazel does not fall back to the local JDK for running the bazel server and instead exits.
Tags: affects_outputs, loses_incremental_state
--[no]batch default: "false"
If set, Bazel will be run as just a client process without a server, instead of in the standard client/server mode. This is deprecated and will be removed, please prefer shutting down the server explicitly if you wish to avoid lingering servers.
Tags: loses_incremental_state, bazel_internal_configuration, deprecated
--[no]batch_cpu_scheduling default: "false"
Only on Linux; use 'batch' CPU scheduling for Blaze. This policy is useful for workloads that are non-interactive, but do not want to lower their nice value. See 'man 2 sched_setscheduler'. If false, then Bazel does not perform a system call.
Tags: host_machine_resource_optimizations
--bazelrc=<path> default: see description
The location of the user .bazelrc file containing default values of Bazel options. /dev/null indicates that all further `--bazelrc`s will be ignored, which is useful to disable the search for a user rc file, e.g. in release builds. This option can also be specified multiple times. E.g. with `--bazelrc=x.rc --bazelrc=y.rc --bazelrc=/dev/null --bazelrc=z.rc`, 1) x.rc and y.rc are read. 2) z.rc is ignored due to the prior /dev/null. If unspecified, Bazel uses the first .bazelrc file it finds in the following two locations: the workspace directory, then the user's home directory. Note: command line options will always supersede any option in bazelrc.
Tags: changes_inputs
--[no]block_for_lock default: "true"
When --noblock_for_lock is passed, Bazel does not wait for a running command to complete, but instead exits immediately.
Tags: eagerness_to_exit
--[no]client_debug default: "false"
If true, log debug information from the client to stderr. Changing this option will not cause the server to restart.
Tags: affects_outputs, bazel_monitoring
--connect_timeout_secs=<an integer> default: "30"
The amount of time the client waits for each attempt to connect to the server
Tags: bazel_internal_configuration
--[no]expand_configs_in_place default: "true"
Changed the expansion of --config flags to be done in-place, as opposed to in a fixed point expansion between normal rc options and command-line specified options.
Tags: no_op, deprecated
--failure_detail_out=<path> default: see description
If set, specifies a location to write a failure_detail protobuf message if the server experiences a failure and cannot report it via gRPC, as normal. Otherwise, the location will be ${OUTPUT_BASE}/failure_detail.rawproto.
Tags: affects_outputs, loses_incremental_state
--[no]home_rc default: "true"
Whether or not to look for the home bazelrc file at $HOME/.bazelrc
Tags: changes_inputs
--[no]idle_server_tasks default: "true"
Run System.gc() when the server is idle
Tags: loses_incremental_state, host_machine_resource_optimizations
--[no]ignore_all_rc_files default: "false"
Disables all rc files, regardless of the values of other rc-modifying flags, even if these flags come later in the list of startup options.
Tags: changes_inputs
--io_nice_level={-1,0,1,2,3,4,5,6,7} default: "-1"
Only on Linux; set a level from 0-7 for best-effort IO scheduling using the sys_ioprio_set system call. 0 is highest priority, 7 is lowest. The anticipatory scheduler may only honor up to priority 4. If set to a negative value, then Bazel does not perform a system call.
Tags: host_machine_resource_optimizations
--local_startup_timeout_secs=<an integer> default: "120"
The maximum amount of time the client waits to connect to the server
Tags: bazel_internal_configuration
--macos_qos_class=<a string> default: "default"
Sets the QoS service class of the bazel server when running on macOS. This flag has no effect on all other platforms but is supported to ensure rc files can be shared among them without changes. Possible values are: user-interactive, user-initiated, default, utility, and background.
Tags: host_machine_resource_optimizations
--max_idle_secs=<integer> default: "10800"
The number of seconds the build server will wait idling before shutting down. Zero means that the server will never shutdown. This is only read on server-startup, changing this option will not cause the server to restart.
Tags: eagerness_to_exit, loses_incremental_state
--output_base=<path> default: see description
If set, specifies the output location to which all build output will be written. Otherwise, the location will be ${OUTPUT_ROOT}/_blaze_${USER}/${MD5_OF_WORKSPACE_ROOT}. Note: If you specify a different option from one to the next Bazel invocation for this value, you'll likely start up a new, additional Bazel server. Bazel starts exactly one server per specified output base. Typically there is one output base per workspace - however, with this option you may have multiple output bases per workspace and thereby run multiple builds for the same client on the same machine concurrently. See 'bazel help shutdown' on how to shutdown a Bazel server.
Tags: affects_outputs, loses_incremental_state
--output_user_root=<path> default: see description
The user-specific directory beneath which all build outputs are written; by default, this is a function of $USER, but by specifying a constant, build outputs can be shared between collaborating users.
Tags: affects_outputs, loses_incremental_state
--[no]preemptible default: "false"
If true, the command can be preempted if another command is started.
Tags: eagerness_to_exit
--server_jvm_out=<path> default: see description
The location to write the server's JVM's output. If unset then defaults to a location in output_base.
Tags: affects_outputs, loses_incremental_state
--[no]shutdown_on_low_sys_mem default: "false"
If max_idle_secs is set and the build server has been idle for a while, shut down the server when the system is low on free RAM. Linux only.
Tags: eagerness_to_exit, loses_incremental_state
--[no]system_rc default: "true"
Whether or not to look for the system-wide bazelrc.
Tags: changes_inputs
--[no]unlimit_coredumps default: "false"
Raises the soft coredump limit to the hard limit to make coredumps of the server (including the JVM) and the client possible under common conditions. Stick this flag in your bazelrc once and forget about it so that you get coredumps when you actually encounter a condition that triggers them.
Tags: bazel_internal_configuration
--[no]watchfs default: "false"
If true, bazel tries to use the operating system's file watch service for local changes instead of scanning every file for a change.
Tags: deprecated
If true, real symbolic links will be created on Windows instead of file copying. Requires Windows developer mode to be enabled and Windows 10 version 1703 or greater.
Tags: bazel_internal_configuration
--[no]workspace_rc default: "true"
Whether or not to look for the workspace bazelrc file at $workspace/.bazelrc
Tags: changes_inputs
Miscellaneous options, not otherwise categorized.:
--host_jvm_args=<jvm_arg> multiple uses are accumulated
Flags to pass to the JVM executing Blaze.
--host_jvm_debug
Convenience option to add some additional JVM startup flags, which cause the JVM to wait during startup until you connect from a JDWP-compliant debugger (like Eclipse) to port 5005.
Expands to:
  --host_jvm_args=-Xdebug
  --host_jvm_args=-Xrunjdwp:transport=dt_socket,server=y,address=5005
--host_jvm_profile=<profiler_name> default: ""
Convenience option to add some profiler/debugger-specific JVM startup flags. Bazel has a list of known values that it maps to hard-coded JVM startup flags, possibly searching some hardcoded paths for certain files.
--server_javabase=<jvm path> default: ""
Path to the JVM used to execute Bazel itself.

Options Common to all Commands

Options that control build execution:
--experimental_ui_max_stdouterr_bytes=<an integer in (-1)-1073741819 range> default: "1048576"
The maximum size of the stdout / stderr files that will be printed to the console. -1 implies no limit.
Tags: execution
If set to true and --incompatible_remote_symlinks is also true, symlinks in action outputs are allowed to dangle.
Tags: execution, incompatible_change
If set to true, Bazel will represent symlinks in action outputs in the remote caching/execution protocol as such. Otherwise, symlinks will be followed and represented as files or directories. See #6631 for details.
Tags: execution, incompatible_change
Options that configure the toolchain used for action execution:
--[no]incompatible_enable_proto_toolchain_resolution default: "false"
If true, proto lang rules define toolchains from rules_proto, rules_java, rules_cc repositories.
Tags: loading_and_analysis, incompatible_change
Options that let the user configure the intended output, affecting its value, as opposed to its existence:
--bep_maximum_open_remote_upload_files=<an integer> default: "-1"
Maximum number of open files allowed during BEP artifact upload.
Tags: affects_outputs
--remote_download_all
Downloads all remote outputs to the local machine. This flag is an alias for --remote_download_outputs=all.
Expands to:
  --remote_download_outputs=all

Tags: affects_outputs
--remote_download_minimal
Does not download any remote build outputs to the local machine. This flag is an alias for --remote_download_outputs=minimal.
Expands to:
  --remote_download_outputs=minimal

Tags: affects_outputs
--remote_download_outputs=<all, minimal or toplevel> default: "toplevel"
If set to 'minimal' doesn't download any remote build outputs to the local machine, except the ones required by local actions. If set to 'toplevel' behaves like'minimal' except that it also downloads outputs of top level targets to the local machine. Both options can significantly reduce build times if network bandwidth is a bottleneck.
Tags: affects_outputs
Instead of downloading remote build outputs to the local machine, create symbolic links. The target of the symbolic links can be specified in the form of a template string. This template string may contain {hash} and {size_bytes} that expand to the hash of the object and the size in bytes, respectively. These symbolic links may, for example, point to a FUSE file system that loads objects from the CAS on demand.
Tags: affects_outputs
--remote_download_toplevel
Only downloads remote outputs of top level targets to the local machine. This flag is an alias for --remote_download_outputs=toplevel.
Expands to:
  --remote_download_outputs=toplevel

Tags: affects_outputs
--repo_env=<a 'name=value' assignment with an optional value part> multiple uses are accumulated
Specifies additional environment variables to be available only for repository rules. Note that repository rules see the full environment anyway, but in this way configuration information can be passed to repositories through options without invalidating the action graph.
Tags: action_command_lines
Options that affect how strictly Bazel enforces valid build inputs (rule definitions, flag combinations, etc.):
--[no]check_bzl_visibility default: "true"
If disabled, .bzl load visibility errors are demoted to warnings.
Tags: build_file_semantics
This option affects semantics of the Starlark language or the build API accessible to BUILD files, .bzl files, or WORKSPACE files.:
--[no]enable_bzlmod default: "true"
If true, enables the Bzlmod dependency management system, taking precedence over WORKSPACE. See https://bazel.build/docs/bzlmod for more information.
Tags: loading_and_analysis
--[no]experimental_action_resource_set default: "true"
If set to true, ctx.actions.run() and ctx.actions.run_shell() accept a resource_set parameter for local execution. Otherwise it will default to 250 MB for memory and 1 cpu.
Tags: execution, build_file_semantics, experimental
--[no]experimental_bzl_visibility default: "true"
If enabled, adds a `visibility()` function that .bzl files may call during top-level evaluation to set their visibility for the purpose of load() statements.
Tags: loading_and_analysis, experimental
--[no]experimental_cc_shared_library default: "false"
If set to true, rule attributes and Starlark API methods needed for the rule cc_shared_library will be available
Tags: build_file_semantics, loading_and_analysis, experimental
--[no]experimental_disable_external_package default: "false"
If set to true, the auto-generated //external package will not be available anymore. Bazel will still be unable to parse the file 'external/BUILD', but globs reaching into external/ from the unnamed package will work.
Tags: loading_and_analysis, loses_incremental_state, experimental
--[no]experimental_enable_android_migration_apis default: "false"
If set to true, enables the APIs required to support the Android Starlark migration.
Tags: build_file_semantics
--[no]experimental_enable_scl_dialect default: "false"
If set to true, .scl files may be used in load() statements.
Tags: build_file_semantics
--[no]experimental_google_legacy_api default: "false"
If set to true, exposes a number of experimental pieces of Starlark build API pertaining to Google legacy code.
Tags: loading_and_analysis, experimental
--[no]experimental_isolated_extension_usages default: "false"
If true, enables the <code>isolate</code> parameter in the <a href="https://bazel.build/rules/lib/globals/module#use_extension"><code>use_extension</code></a> function.
Tags: loading_and_analysis
--[no]experimental_java_library_export default: "false"
If enabled, experimental_java_library_export_do_not_use module is available.
Tags: loading_and_analysis, incompatible_change
--[no]experimental_platforms_api default: "false"
If set to true, enables a number of platform-related Starlark APIs useful for debugging.
Tags: loading_and_analysis, experimental
--[no]experimental_repo_remote_exec default: "false"
If set to true, repository_rule gains some remote execution capabilities.
Tags: build_file_semantics, loading_and_analysis, experimental
--[no]experimental_sibling_repository_layout default: "false"
If set to true, non-main repositories are planted as symlinks to the main repository in the execution root. That is, all repositories are direct children of the $output_base/execution_root directory. This has the side effect of freeing up $output_base/execution_root/__main__/external for the real top-level 'external' directory.
Tags: action_command_lines, bazel_internal_configuration, loading_and_analysis, loses_incremental_state, experimental
--[no]incompatible_allow_tags_propagation default: "true"
If set to true, tags will be propagated from a target to the actions' execution requirements; otherwise tags are not propagated. See https://github.com/bazelbuild/bazel/issues/8830 for details.
Tags: build_file_semantics, experimental
--[no]incompatible_always_check_depset_elements default: "true"
Check the validity of elements added to depsets, in all constructors. Elements must be immutable, but historically the depset(direct=...) constructor forgot to check. Use tuples instead of lists in depset elements. See https://github.com/bazelbuild/bazel/issues/10313 for details.
Tags: build_file_semantics, incompatible_change
When true, Bazel no longer returns a list from linking_context.libraries_to_link but returns a depset instead.
Tags: loading_and_analysis, incompatible_change
--[no]incompatible_disable_objc_library_transition default: "true"
Disable objc_library's custom transition and inherit from the top level target instead
Tags: build_file_semantics, incompatible_change
--[no]incompatible_disable_starlark_host_transitions default: "false"
If set to true, rule attributes cannot set 'cfg = "host"'. Rules should set 'cfg = "exec"' instead.
Tags: loading_and_analysis, incompatible_change
--[no]incompatible_disable_target_default_provider_fields default: "false"
If set to true, disable the ability to access providers on 'target' objects via field syntax. Use provider-key syntax instead. For example, instead of using `ctx.attr.dep.my_info` to access `my_info` from inside a rule implementation function, use `ctx.attr.dep[MyInfo]`. See https://github.com/bazelbuild/bazel/issues/9014 for details.
Tags: build_file_semantics, incompatible_change
--[no]incompatible_disable_target_provider_fields default: "false"
If set to true, disable the ability to utilize the default provider via field syntax. Use provider-key syntax instead. For example, instead of using `ctx.attr.dep.files` to access `files`, utilize `ctx.attr.dep[DefaultInfo].files See https://github.com/bazelbuild/bazel/issues/9014 for details.
Tags: build_file_semantics, incompatible_change
--[no]incompatible_disallow_empty_glob default: "false"
If set to true, the default value of the `allow_empty` argument of glob() is False.
Tags: build_file_semantics, incompatible_change
--[no]incompatible_disallow_struct_provider_syntax default: "false"
If set to true, rule implementation functions may not return a struct. They must instead return a list of provider instances.
Tags: build_file_semantics, incompatible_change
--[no]incompatible_existing_rules_immutable_view default: "true"
If set to true, native.existing_rule and native.existing_rules return lightweight immutable view objects instead of mutable dicts.
Tags: build_file_semantics, loading_and_analysis, incompatible_change
--[no]incompatible_fail_on_unknown_attributes default: "true"
If enabled, targets that have unknown attributes set to None fail.
Tags: loading_and_analysis, incompatible_change
--[no]incompatible_fix_package_group_reporoot_syntax default: "true"
In package_group's `packages` attribute, changes the meaning of the value "//..." to refer to all packages in the current repository instead of all packages in any repository. You can use the special value "public" in place of "//..." to obtain the old behavior. This flag requires that --incompatible_package_group_has_public_syntax also be enabled.
Tags: build_file_semantics, incompatible_change
--[no]incompatible_java_common_parameters default: "true"
If set to true, the output_jar, and host_javabase parameters in pack_sources and host_javabase in compile will all be removed.
Tags: build_file_semantics, incompatible_change
--[no]incompatible_merge_fixed_and_default_shell_env default: "true"
If enabled, actions registered with ctx.actions.run and ctx.actions.run_shell with both 'env' and 'use_default_shell_env = True' specified will use an environment obtained from the default shell environment by overriding with the values passed in to 'env'. If disabled, the value of 'env' is completely ignored in this case.
Tags: loading_and_analysis, incompatible_change
--[no]incompatible_no_attr_license default: "true"
If set to true, disables the function `attr.license`.
Tags: build_file_semantics, incompatible_change
--[no]incompatible_no_implicit_file_export default: "false"
If set, (used) source files are are package private unless exported explicitly. See https://github.com/bazelbuild/proposals/blob/master/designs/2019-10-24-file-visibility.md
Tags: build_file_semantics, incompatible_change
--[no]incompatible_no_rule_outputs_param default: "false"
If set to true, disables the `outputs` parameter of the `rule()` Starlark function.
Tags: build_file_semantics, incompatible_change
--[no]incompatible_objc_provider_remove_linking_info default: "false"
If set to true, the ObjcProvider's APIs for linking info will be removed.
Tags: build_file_semantics, incompatible_change
--[no]incompatible_package_group_has_public_syntax default: "true"
In package_group's `packages` attribute, allows writing "public" or "private" to refer to all packages or no packages respectively.
Tags: build_file_semantics, incompatible_change
--[no]incompatible_require_linker_input_cc_api default: "true"
If set to true, rule create_linking_context will require linker_inputs instead of libraries_to_link. The old getters of linking_context will also be disabled and just linker_inputs will be available.
Tags: build_file_semantics, loading_and_analysis, incompatible_change
--[no]incompatible_run_shell_command_string default: "true"
If set to true, the command parameter of actions.run_shell will only accept string
Tags: build_file_semantics, incompatible_change
--[no]incompatible_stop_exporting_language_modules default: "false"
If enabled, certain language-specific modules (such as `cc_common`) are unavailable in user .bzl files and may only be called from their respective rules repositories.
Tags: loading_and_analysis, incompatible_change
--[no]incompatible_struct_has_no_methods default: "false"
Disables the to_json and to_proto methods of struct, which pollute the struct field namespace. Instead, use json.encode or json.encode_indent for JSON, or proto.encode_text for textproto.
Tags: build_file_semantics, incompatible_change
--[no]incompatible_top_level_aspects_require_providers default: "false"
If set to true, the top level aspect will honor its required providers and only run on top level targets whose rules' advertised providers satisfy the required providers of the aspect.
Tags: loading_and_analysis, incompatible_change
--[no]incompatible_unambiguous_label_stringification default: "true"
When true, Bazel will stringify the label @//foo:bar to @//foo:bar, instead of //foo:bar. This only affects the behavior of str(), the % operator, and so on; the behavior of repr() is unchanged. See https://github.com/bazelbuild/bazel/issues/15916 for more information.
Tags: loading_and_analysis, incompatible_change
--[no]incompatible_use_cc_configure_from_rules_cc default: "false"
When true, Bazel will no longer allow using cc_configure from @bazel_tools. Please see https://github.com/bazelbuild/bazel/issues/10134 for details and migration instructions.
Tags: loading_and_analysis, incompatible_change
--[no]incompatible_visibility_private_attributes_at_definition default: "true"
If set to true, the visibility of private rule attributes is checked with respect to the rule definition, falling back to rule usage if not visible.
Tags: build_file_semantics, incompatible_change
--max_computation_steps=<a long integer> default: "0"
The maximum number of Starlark computation steps that may be executed by a BUILD file (zero means no limit).
Tags: build_file_semantics
--nested_set_depth_limit=<an integer> default: "3500"
The maximum depth of the graph internal to a depset (also known as NestedSet), above which the depset() constructor will fail.
Tags: loading_and_analysis
--[no]separate_aspect_deps default: "false"
If enabled, the dependencies of the main aspect in an aspect path will be separated from those of the target and the base aspects. ctx.attr.{attr_name} will always get the attribute value from the main aspect and ctx.rule.attr.{attr_name} will get the value from the rule if it has an attribute with that name or from the base aspects attributes (first one in the aspects path wins).
Tags: loading_and_analysis
Options that trigger optimizations of the build time:
--[no]heuristically_drop_nodes default: "false"
If true, Blaze will remove FileState and DirectoryListingState nodes after related File and DirectoryListing node is done to save memory. We expect that it is less likely that these nodes will be needed again. If so, the program will re-evaluate them.
Tags: loses_incremental_state
--[no]incompatible_do_not_split_linking_cmdline default: "true"
When true, Bazel no longer modifies command line flags used for linking, and also doesn't selectively decide which flags go to the param file and which don't. See https://github.com/bazelbuild/bazel/issues/7670 for details.
Tags: loading_and_analysis, incompatible_change
--[no]keep_state_after_build default: "true"
If false, Blaze will discard the inmemory state from this build when the build finishes. Subsequent builds will not have any incrementality with respect to this one.
Tags: loses_incremental_state
--[no]track_incremental_state default: "true"
If false, Blaze will not persist data that allows for invalidation and re-evaluation on incremental builds in order to save memory on this build. Subsequent builds will not have any incrementality with respect to this one. Usually you will want to specify --batch when setting this to false.
Tags: loses_incremental_state
Options that affect the verbosity, format or location of logging:
--[no]announce_rc default: "false"
Whether to announce rc options.
Tags: affects_outputs
--[no]attempt_to_print_relative_paths default: "false"
When printing the location part of messages, attempt to use a path relative to the workspace directory or one of the directories specified by --package_path.
Tags: terminal_output
--bes_backend=<a string> default: ""
Specifies the build event service (BES) backend endpoint in the form [SCHEME://]HOST[:PORT]. The default is to disable BES uploads. Supported schemes are grpc and grpcs (grpc with TLS enabled). If no scheme is provided, Bazel assumes grpcs.
Tags: affects_outputs
--[no]bes_check_preceding_lifecycle_events default: "false"
Sets the field check_preceding_lifecycle_events_present on PublishBuildToolEventStreamRequest which tells BES to check whether it previously received InvocationAttemptStarted and BuildEnqueued events matching the current tool event.
Tags: affects_outputs
--bes_header=<a 'name=value' assignment> multiple uses are accumulated
Specify a header in NAME=VALUE form that will be included in BES requests. Multiple headers can be passed by specifying the flag multiple times. Multiple values for the same name will be converted to a comma-separated list.
Tags: affects_outputs
--bes_instance_name=<a string> default: see description
Specifies the instance name under which the BES will persist uploaded BEP. Defaults to null.
Tags: affects_outputs
--bes_keywords=<comma-separated list of options> multiple uses are accumulated
Specifies a list of notification keywords to be added the default set of keywords published to BES ("command_name=<command_name> ", "protocol_name=BEP"). Defaults to none.
Tags: affects_outputs
--[no]bes_lifecycle_events default: "true"
Specifies whether to publish BES lifecycle events. (defaults to 'true').
Tags: affects_outputs
--bes_oom_finish_upload_timeout=<An immutable length of time.> default: "10m"
Specifies how long bazel should wait for the BES/BEP upload to complete while OOMing. This flag ensures termination when the JVM is severely GC thrashing and cannot make progress on any user thread.
Tags: bazel_monitoring
--bes_outerr_buffer_size=<an integer> default: "10240"
Specifies the maximal size of stdout or stderr to be buffered in BEP, before it is reported as a progress event. Individual writes are still reported in a single event, even if larger than the specified value up to --bes_outerr_chunk_size.
Tags: affects_outputs
--bes_outerr_chunk_size=<an integer> default: "1048576"
Specifies the maximal size of stdout or stderr to be sent to BEP in a single message.
Tags: affects_outputs
--bes_proxy=<a string> default: see description
Connect to the Build Event Service through a proxy. Currently this flag can only be used to configure a Unix domain socket (unix:/path/to/socket).
--bes_results_url=<a string> default: ""
Specifies the base URL where a user can view the information streamed to the BES backend. Bazel will output the URL appended by the invocation id to the terminal.
Tags: terminal_output
--bes_system_keywords=<comma-separated list of options> multiple uses are accumulated
Specifies a list of notification keywords to be included directly, without the "user_keyword=" prefix included for keywords supplied via --bes_keywords. Intended for Build service operators that set --bes_lifecycle_events=false and include keywords when calling PublishLifecycleEvent. Build service operators using this flag should prevent users from overriding the flag value.
Tags: affects_outputs
--bes_timeout=<An immutable length of time.> default: "0s"
Specifies how long bazel should wait for the BES/BEP upload to complete after the build and tests have finished. A valid timeout is a natural number followed by a unit: Days (d), hours (h), minutes (m), seconds (s), and milliseconds (ms). The default value is '0' which means that there is no timeout.
Tags: affects_outputs
--bes_upload_mode=<wait_for_upload_complete, nowait_for_upload_complete or fully_async> default: "wait_for_upload_complete"
Specifies whether the Build Event Service upload should block the build completion or should end the invocation immediately and finish the upload in the background. Either 'wait_for_upload_complete' (default), 'nowait_for_upload_complete', or 'fully_async'.
Tags: eagerness_to_exit
--build_event_binary_file=<a string> default: ""
If non-empty, write a varint delimited binary representation of representation of the build event protocol to that file. This option implies --bes_upload_mode=wait_for_upload_complete.
Tags: affects_outputs
--[no]build_event_binary_file_path_conversion default: "true"
Convert paths in the binary file representation of the build event protocol to more globally valid URIs whenever possible; if disabled, the file:// uri scheme will always be used
Tags: affects_outputs
--build_event_binary_file_upload_mode=<wait_for_upload_complete, nowait_for_upload_complete or fully_async> default: "wait_for_upload_complete"
Specifies whether the Build Event Service upload for --build_event_binary_file should block the build completion or should end the invocation immediately and finish the upload in the background. Either 'wait_for_upload_complete' (default), 'nowait_for_upload_complete', or 'fully_async'.
Tags: eagerness_to_exit
--build_event_json_file=<a string> default: ""
If non-empty, write a JSON serialisation of the build event protocol to that file. This option implies --bes_upload_mode=wait_for_upload_complete.
Tags: affects_outputs
--[no]build_event_json_file_path_conversion default: "true"
Convert paths in the json file representation of the build event protocol to more globally valid URIs whenever possible; if disabled, the file:// uri scheme will always be used
Tags: affects_outputs
--build_event_json_file_upload_mode=<wait_for_upload_complete, nowait_for_upload_complete or fully_async> default: "wait_for_upload_complete"
Specifies whether the Build Event Service upload for --build_event_json_file should block the build completion or should end the invocation immediately and finish the upload in the background. Either 'wait_for_upload_complete' (default), 'nowait_for_upload_complete', or 'fully_async'.
Tags: eagerness_to_exit
--build_event_max_named_set_of_file_entries=<an integer> default: "5000"
The maximum number of entries for a single named_set_of_files event; values smaller than 2 are ignored and no event splitting is performed. This is intended for limiting the maximum event size in the build event protocol, although it does not directly control event size. The total event size is a function of the structure of the set as well as the file and uri lengths, which may in turn depend on the hash function.
Tags: affects_outputs
--[no]build_event_publish_all_actions default: "false"
Whether all actions should be published.
Tags: affects_outputs
--build_event_text_file=<a string> default: ""
If non-empty, write a textual representation of the build event protocol to that file
Tags: affects_outputs
--[no]build_event_text_file_path_conversion default: "true"
Convert paths in the text file representation of the build event protocol to more globally valid URIs whenever possible; if disabled, the file:// uri scheme will always be used
Tags: affects_outputs
--build_event_text_file_upload_mode=<wait_for_upload_complete, nowait_for_upload_complete or fully_async> default: "wait_for_upload_complete"
Specifies whether the Build Event Service upload for --build_event_text_file should block the build completion or should end the invocation immediately and finish the upload in the background. Either 'wait_for_upload_complete' (default), 'nowait_for_upload_complete', or 'fully_async'.
Tags: eagerness_to_exit
--[no]experimental_announce_profile_path default: "false"
If enabled, adds the JSON profile path to the log.
Tags: bazel_monitoring
--[no]experimental_bep_target_summary default: "false"
Whether to publish TargetSummary events.
--[no]experimental_build_event_expand_filesets default: "false"
If true, expand Filesets in the BEP when presenting output files.
Tags: affects_outputs
If true, fully resolve relative Fileset symlinks in the BEP when presenting output files. Requires --experimental_build_event_expand_filesets.
Tags: affects_outputs
--experimental_build_event_upload_max_retries=<an integer> default: "4"
The maximum number of times Bazel should retry uploading a build event.
Tags: bazel_internal_configuration
--experimental_build_event_upload_retry_minimum_delay=<An immutable length of time.> default: "1s"
Initial, minimum delay for exponential backoff retries when BEP upload fails. (exponent: 1.6)
Tags: bazel_internal_configuration
--experimental_build_event_upload_strategy=<a string> default: see description
Selects how to upload artifacts referenced in the build event protocol.
Tags: affects_outputs
--[no]experimental_collect_load_average_in_profiler default: "true"
If enabled, the profiler collects the system's overall load average.
Tags: bazel_monitoring
--[no]experimental_collect_pressure_stall_indicators default: "false"
If enabled, the profiler collects the Linux PSI data.
Tags: bazel_monitoring
--[no]experimental_collect_resource_estimation default: "false"
If enabled, the profiler collects CPU and memory usage estimation for local actions.
Tags: bazel_monitoring
--[no]experimental_collect_system_network_usage default: "false"
If enabled, the profiler collects the system's network usage.
Tags: bazel_monitoring
--[no]experimental_collect_worker_data_in_profiler default: "false"
If enabled, the profiler collects worker's aggregated resource data.
Tags: bazel_monitoring
--experimental_profile_additional_tasks=<phase, action, action_check, action_lock, action_release, action_update, action_complete, bzlmod, info, create_package, remote_execution, local_execution, scanner, local_parse, upload_time, remote_process_time, remote_queue, remote_setup, fetch, local_process_time, vfs_stat, vfs_dir, vfs_readlink, vfs_md5, vfs_xattr, vfs_delete, vfs_open, vfs_read, vfs_write, vfs_glob, vfs_vmfs_stat, vfs_vmfs_dir, vfs_vmfs_read, wait, thread_name, thread_sort_index, skyframe_eval, skyfunction, critical_path, critical_path_component, handle_gc_notification, action_counts, action_cache_counts, local_cpu_usage, system_cpu_usage, cpu_usage_estimation, local_memory_usage, system_memory_usage, memory_usage_estimation, system_network_up_usage, system_network_down_usage, workers_memory_usage, system_load_average, starlark_parser, starlark_user_fn, starlark_builtin_fn, starlark_user_compiled_fn, starlark_repository_fn, action_fs_staging, remote_cache_check, remote_download, remote_network, filesystem_traversal, worker_execution, worker_setup, worker_borrow, worker_working, worker_copying_outputs, credential_helper, pressure_stall_io, pressure_stall_memory, conflict_check, dynamic_lock or unknown> multiple uses are accumulated
Specifies additional profile tasks to be included in the profile.
Tags: bazel_monitoring
--[no]experimental_profile_include_primary_output default: "false"
Includes the extra "out" attribute in action events that contains the exec path to the action's primary output.
Tags: bazel_monitoring
--[no]experimental_profile_include_target_label default: "false"
Includes target label in action events' JSON profile data.
Tags: bazel_monitoring
--[no]experimental_run_bep_event_include_residue default: "false"
Whether to include the command-line residue in run build events which could contain the residue. By default, the residue is not included in run command build events that could contain the residue.
Tags: affects_outputs
--[no]experimental_stream_log_file_uploads default: "false"
Stream log file uploads directly to the remote storage rather than writing them to disk.
Tags: affects_outputs
--experimental_workspace_rules_log_file=<a path> default: see description
Log certain Workspace Rules events into this file as delimited WorkspaceEvent protos.
--[no]generate_json_trace_profile default: "auto"
If enabled, Bazel profiles the build and writes a JSON-format profile into a file in the output base. View profile by loading into chrome://tracing. By default Bazel writes the profile for all build-like commands and query.
Tags: bazel_monitoring
--[no]heap_dump_on_oom default: "false"
Whether to manually output a heap dump if an OOM is thrown (including manual OOMs due to reaching --gc_thrashing_limits). The dump will be written to <output_base>/<invocation_id>.heapdump.hprof. This option effectively replaces -XX:+HeapDumpOnOutOfMemoryError, which has no effect for manual OOMs.
Tags: bazel_monitoring
--[no]legacy_important_outputs default: "true"
Use this to suppress generation of the legacy important_outputs field in the TargetComplete event. important_outputs are required for Bazel to ResultStore integration.
Tags: affects_outputs
--logging=<0 <= an integer <= 6> default: "3"
The logging level.
Tags: affects_outputs
--memory_profile=<a path> default: see description
If set, write memory usage data to the specified file at phase ends and stable heap to master log at end of build.
Tags: bazel_monitoring
--memory_profile_stable_heap_parameters=<integers, separated by a comma expected in pairs> default: "1,0"
Tune memory profile's computation of stable heap at end of build. Should be and even number of integers separated by commas. In each pair the first integer is the number of GCs to perform. The second integer in each pair is the number of seconds to wait between GCs. Ex: 2,4,4,0 would 2 GCs with a 4sec pause, followed by 4 GCs with zero second pause
Tags: bazel_monitoring
--profile=<a path> default: see description
If set, profile Bazel and write data to the specified file. Use bazel analyze-profile to analyze the profile.
Tags: bazel_monitoring
--[no]record_full_profiler_data default: "false"
By default, Bazel profiler will record only aggregated data for fast but numerous events (such as statting the file). If this option is enabled, profiler will record each event - resulting in more precise profiling data but LARGE performance hit. Option only has effect if --profile used as well.
Tags: bazel_monitoring
--remote_print_execution_messages=<failure, success or all> default: "failure"
Choose when to print remote execution messages. Valid values are `failure`, to print only on failures, `success` to print only on successes and `all` to print always.
Tags: terminal_output
--[no]slim_profile default: "true"
Slims down the size of the JSON profile by merging events if the profile gets too large.
Tags: bazel_monitoring
--starlark_cpu_profile=<a string> default: ""
Writes into the specified file a pprof profile of CPU usage by all Starlark threads.
Tags: bazel_monitoring
--tool_tag=<a string> default: ""
A tool name to attribute this Bazel invocation to.
Tags: affects_outputs, bazel_monitoring
--ui_event_filters=<Convert list of comma separated event kind to list of filters> multiple uses are accumulated
Specifies which events to show in the UI. It is possible to add or remove events to the default ones using leading +/-, or override the default set completely with direct assignment. The set of supported event kinds include INFO, DEBUG, ERROR and more.
Tags: terminal_output
Remote caching and execution options:
--experimental_circuit_breaker_strategy=<failure> default: see description
Specifies the strategy for the circuit breaker to use. Available strategies are "failure". On invalid value for the option the behavior same as the option is not set.
Tags: execution
--[no]experimental_guard_against_concurrent_changes default: "false"
Turn this off to disable checking the ctime of input files of an action before uploading it to a remote cache. There may be cases where the Linux kernel delays writing of files, which could cause false positives.
--[no]experimental_remote_cache_async default: "false"
If true, remote cache I/O will happen in the background instead of taking place as the part of a spawn.
--[no]experimental_remote_cache_lease_extension default: "false"
If set to true, Bazel will extend the lease for outputs of remote actions during the build by sending `FindMissingBlobs` calls periodically to remote cache. The frequency is based on the value of `--experimental_remote_cache_ttl`.
--experimental_remote_cache_ttl=<An immutable length of time.> default: "3h"
The guaranteed minimal TTL of blobs in the remote cache after their digests are recently referenced e.g. by an ActionResult or FindMissingBlobs. Bazel does several optimizations based on the blobs' TTL e.g. doesn't repeatedly call GetActionResult in an incremental build. The value should be set slightly less than the real TTL since there is a gap between when the server returns the digests and when Bazel receives them.
Tags: execution
--experimental_remote_capture_corrupted_outputs=<a path> default: see description
A path to a directory where the corrupted outputs will be captured to.
--[no]experimental_remote_discard_merkle_trees default: "true"
If set to true, discard in-memory copies of the input root's Merkle tree and associated input mappings during calls to GetActionResult() and Execute(). This reduces memory usage significantly, but does require Bazel to recompute them upon remote cache misses and retries.
--experimental_remote_downloader=<a string> default: see description
A Remote Asset API endpoint URI, to be used as a remote download proxy. The supported schemas are grpc, grpcs (grpc with TLS enabled) and unix (local UNIX sockets). If no schema is provided Bazel will default to grpcs. See: https://github.com/bazelbuild/remote-apis/blob/master/build/bazel/remote/asset/v1/remote_asset.proto
--[no]experimental_remote_downloader_local_fallback default: "false"
Whether to fall back to the local downloader if remote downloader fails.
--[no]experimental_remote_execution_keepalive default: "false"
Whether to use keepalive for remote execution calls.
--experimental_remote_failure_rate_threshold=<an integer in 0-100 range> default: "10"
Sets the allowed number of failure rate in percentage for a specific time window after which it stops calling to the remote cache/executor. By default the value is 10. Setting this to 0 means no limitation.
Tags: execution
--experimental_remote_failure_window_interval=<An immutable length of time.> default: "60s"
The interval in which the failure rate of the remote requests are computed. On zero or negative value the failure duration is computed the whole duration of the execution.Following units can be used: Days (d), hours (h), minutes (m), seconds (s), and milliseconds (ms). If the unit is omitted, the value is interpreted as seconds.
Tags: execution
--[no]experimental_remote_mark_tool_inputs default: "false"
If set to true, Bazel will mark inputs as tool inputs for the remote executor. This can be used to implement remote persistent workers.
--[no]experimental_remote_merkle_tree_cache default: "false"
If set to true, Merkle tree calculations will be memoized to improve the remote cache hit checking speed. The memory foot print of the cache is controlled by --experimental_remote_merkle_tree_cache_size.
--experimental_remote_merkle_tree_cache_size=<a long integer> default: "1000"
The number of Merkle trees to memoize to improve the remote cache hit checking speed. Even though the cache is automatically pruned according to Java's handling of soft references, out-of-memory errors can occur if set too high. If set to 0 the cache size is unlimited. Optimal value varies depending on project's size. Default to 1000.
--[no]experimental_remote_require_cached default: "false"
If set to true, enforce that all actions that can run remotely are cached, or else fail the build. This is useful to troubleshoot non-determinism issues as it allows checking whether actions that should be cached are actually cached without spuriously injecting new results into the cache.
--experimental_remote_scrubbing_config=<Converts to a Scrubber> default: see description
Enables remote cache key scrubbing with the supplied configuration file, which must be a ScrubbingConfig protocol buffer in text format. This feature is intended to facilitate sharing a remote/disk cache between actions executing on different platforms but targeting the same platform. It should be used with extreme care, as improper settings may cause accidental sharing of cache entries and result in incorrect builds. Scrubbing does not affect how an action is executed, only how its remote/disk cache key is computed for the purpose of retrieving or storing an action result. It cannot be used in conjunction with remote execution. Modifying the scrubbing configuration does not invalidate outputs present in the local filesystem or internal caches; a clean build is required to reexecute affected actions. In order to successfully use this feature, you likely want to set a custom --host_platform together with --experimental_platform_in_output_dir (to normalize output prefixes) and --incompatible_strict_action_env (to normalize environment variables).
--[no]incompatible_remote_build_event_upload_respect_no_cache default: "false"
Deprecated. No-op. Use --remote_build_event_upload=minimal instead.
--[no]incompatible_remote_downloader_send_all_headers default: "true"
Whether to send all values of a multi-valued header to the remote downloader instead of just the first.
Tags: incompatible_change
--[no]incompatible_remote_output_paths_relative_to_input_root default: "false"
If set to true, output paths are relative to input root instead of working directory.
Tags: incompatible_change
--[no]incompatible_remote_results_ignore_disk default: "true"
No-op
Tags: incompatible_change
--[no]remote_accept_cached default: "true"
Whether to accept remotely cached action results.
--remote_build_event_upload=<all or minimal> default: "minimal"
If set to 'all', all local outputs referenced by BEP are uploaded to remote cache. If set to 'minimal', local outputs referenced by BEP are not uploaded to the remote cache, except for files that are important to the consumers of BEP (e.g. test logs and timing profile). bytestream:// scheme is always used for the uri of files even if they are missing from remote cache. Default to 'minimal'.
--remote_bytestream_uri_prefix=<a string> default: see description
The hostname and instance name to be used in bytestream:// URIs that are written into build event streams. This option can be set when builds are performed using a proxy, which causes the values of --remote_executor and --remote_instance_name to no longer correspond to the canonical name of the remote execution service. When not set, it will default to "${hostname}/${instance_name}".
--remote_cache=<a string> default: see description
A URI of a caching endpoint. The supported schemas are http, https, grpc, grpcs (grpc with TLS enabled) and unix (local UNIX sockets). If no schema is provided Bazel will default to grpcs. Specify grpc://, http:// or unix: schema to disable TLS. See https://bazel.build/remote/caching
--[no]remote_cache_compression default: "false"
If enabled, compress/decompress cache blobs with zstd.
--remote_cache_header=<a 'name=value' assignment> multiple uses are accumulated
Specify a header that will be included in cache requests: --remote_cache_header=Name=Value. Multiple headers can be passed by specifying the flag multiple times. Multiple values for the same name will be converted to a comma-separated list.
--remote_default_exec_properties=<a 'name=value' assignment> multiple uses are accumulated
Set the default exec properties to be used as the remote execution platform if an execution platform does not already set exec_properties.
Tags: affects_outputs
--remote_default_platform_properties=<a string> default: ""
Set the default platform properties to be set for the remote execution API, if the execution platform does not already set remote_execution_properties. This value will also be used if the host platform is selected as the execution platform for remote execution.
--remote_download_regex=<a string> multiple uses are accumulated
Force Bazel to download the artifacts that match the given regexp. To be used in conjunction with Build without the Bytes (or the internal equivalent) to allow the client to request certain artifacts that might be needed locally (e.g. IDE support). Multiple regexes can be specified by repeating this flag.
Tags: affects_outputs
--remote_downloader_header=<a 'name=value' assignment> multiple uses are accumulated
Specify a header that will be included in remote downloader requests: --remote_downloader_header=Name=Value. Multiple headers can be passed by specifying the flag multiple times. Multiple values for the same name will be converted to a comma-separated list.
--remote_exec_header=<a 'name=value' assignment> multiple uses are accumulated
Specify a header that will be included in execution requests: --remote_exec_header=Name=Value. Multiple headers can be passed by specifying the flag multiple times. Multiple values for the same name will be converted to a comma-separated list.
--remote_execution_priority=<an integer> default: "0"
The relative priority of actions to be executed remotely. The semantics of the particular priority values are server-dependent.
--remote_executor=<a string> default: see description
HOST or HOST:PORT of a remote execution endpoint. The supported schemas are grpc, grpcs (grpc with TLS enabled) and unix (local UNIX sockets). If no schema is provided Bazel will default to grpcs. Specify grpc:// or unix: schema to disable TLS.
--remote_grpc_log=<a path> default: see description
If specified, a path to a file to log gRPC call related details. This log consists of a sequence of serialized com.google.devtools.build.lib.remote.logging.RemoteExecutionLog.LogEntry protobufs with each message prefixed by a varint denoting the size of the following serialized protobuf message, as performed by the method LogEntry.writeDelimitedTo(OutputStream).
--remote_header=<a 'name=value' assignment> multiple uses are accumulated
Specify a header that will be included in requests: --remote_header=Name=Value. Multiple headers can be passed by specifying the flag multiple times. Multiple values for the same name will be converted to a comma-separated list.
--remote_instance_name=<a string> default: ""
Value to pass as instance_name in the remote execution API.
--[no]remote_local_fallback default: "false"
Whether to fall back to standalone local execution strategy if remote execution fails.
--remote_local_fallback_strategy=<a string> default: "local"
No-op, deprecated. See https://github.com/bazelbuild/bazel/issues/7480 for details.
--remote_max_connections=<an integer> default: "100"
Limit the max number of concurrent connections to remote cache/executor. By default the value is 100. Setting this to 0 means no limitation. For HTTP remote cache, one TCP connection could handle one request at one time, so Bazel could make up to --remote_max_connections concurrent requests. For gRPC remote cache/executor, one gRPC channel could usually handle 100+ concurrent requests, so Bazel could make around `--remote_max_connections * 100` concurrent requests.
Tags: host_machine_resource_optimizations
--remote_proxy=<a string> default: see description
Connect to the remote cache through a proxy. Currently this flag can only be used to configure a Unix domain socket (unix:/path/to/socket).
--remote_result_cache_priority=<an integer> default: "0"
The relative priority of remote actions to be stored in remote cache. The semantics of the particular priority values are server-dependent.
--remote_retries=<an integer> default: "5"
The maximum number of attempts to retry a transient error. If set to 0, retries are disabled.
--remote_retry_max_delay=<An immutable length of time.> default: "5s"
The maximum backoff delay between remote retry attempts. Following units can be used: Days (d), hours (h), minutes (m), seconds (s), and milliseconds (ms). If the unit is omitted, the value is interpreted as seconds.
--remote_timeout=<An immutable length of time.> default: "60s"
The maximum amount of time to wait for remote execution and cache calls. For the REST cache, this is both the connect and the read timeout. Following units can be used: Days (d), hours (h), minutes (m), seconds (s), and milliseconds (ms). If the unit is omitted, the value is interpreted as seconds.
--[no]remote_upload_local_results default: "true"
Whether to upload locally executed action results to the remote cache if the remote cache supports it and the user is authorized to do so.
--[no]remote_verify_downloads default: "true"
If set to true, Bazel will compute the hash sum of all remote downloads and discard the remotely cached values if they don't match the expected value.
Miscellaneous options, not otherwise categorized.:
--build_metadata=<a 'name=value' assignment> multiple uses are accumulated
Custom key-value string pairs to supply in a build event.
Tags: terminal_output
--color=<yes, no or auto> default: "auto"
Use terminal controls to colorize output.
--config=<a string> multiple uses are accumulated
Selects additional config sections from the rc files; for every <command>, it also pulls in the options from <command>:<config> if such a section exists; if this section doesn't exist in any .rc file, Blaze fails with an error. The config sections and flag combinations they are equivalent to are located in the tools/*.blazerc config files.
--credential_helper=<Path to a credential helper. It may be absolute, relative to the PATH environment variable, or %workspace%-relative. The path be optionally prefixed by a scope followed by an '='. The scope is a domain name, optionally with a single leading '*' wildcard component. A helper applies to URIs matching its scope, with more specific scopes preferred. If a helper has no scope, it applies to every URI.> multiple uses are accumulated
Configures a credential helper to use for retrieving authorization credentials for repository fetching, remote caching and execution, and the build event service. Credentials supplied by a helper take precedence over credentials supplied by --google_default_credentials, --google_credentials, a .netrc file, or the auth parameter to repository_ctx.download and repository_ctx.download_and_extract. May be specified multiple times to set up multiple helpers. See https://github.com/bazelbuild/proposals/blob/main/designs/2022-06-07-bazel-credential-helpers.md for details.
--credential_helper_cache_duration=<An immutable length of time.> default: "30m"
The duration for which credentials supplied by a credential helper are cached. Invoking with a different value will adjust the lifetime of preexisting entries; pass zero to clear the cache. A clean command always clears the cache, regardless of this flag.
--credential_helper_timeout=<An immutable length of time.> default: "10s"
Configures the timeout for a credential helper. Credential helpers failing to respond within this timeout will fail the invocation.
--curses=<yes, no or auto> default: "auto"
Use terminal cursor controls to minimize scrolling output.
--disk_cache=<a path> default: see description
A path to a directory where Bazel can read and write actions and action outputs. If the directory does not exist, it will be created.
--[no]enable_platform_specific_config default: "false"
If true, Bazel picks up host-OS-specific config lines from bazelrc files. For example, if the host OS is Linux and you run bazel build, Bazel picks up lines starting with build:linux. Supported OS identifiers are linux, macos, windows, freebsd, and openbsd. Enabling this flag is equivalent to using --config=linux on Linux, --config=windows on Windows, etc.
--[no]experimental_rule_extension_api default: "false"
Enable experimental rule extension API and subrule APIs
Tags: loading_and_analysis, experimental
--[no]experimental_windows_watchfs default: "false"
If true, experimental Windows support for --watchfs is enabled. Otherwise --watchfsis a non-op on Windows. Make sure to also enable --watchfs.
--google_auth_scopes=<comma-separated list of options> default: "https://www.googleapis.com/auth/cloud-platform"
A comma-separated list of Google Cloud authentication scopes.
--google_credentials=<a string> default: see description
Specifies the file to get authentication credentials from. See https://cloud.google.com/docs/authentication for details.
--[no]google_default_credentials default: "false"
Whether to use 'Google Application Default Credentials' for authentication. See https://cloud.google.com/docs/authentication for details. Disabled by default.
--grpc_keepalive_time=<An immutable length of time.> default: see description
Configures keep-alive pings for outgoing gRPC connections. If this is set, then Bazel sends pings after this much time of no read operations on the connection, but only if there is at least one pending gRPC call. Times are treated as second granularity; it is an error to set a value less than one second. By default, keep-alive pings are disabled. You should coordinate with the service owner before enabling this setting. For example to set a value of 30 seconds to this flag, it should be done as this --grpc_keepalive_time=30s
--grpc_keepalive_timeout=<An immutable length of time.> default: "20s"
Configures a keep-alive timeout for outgoing gRPC connections. If keep-alive pings are enabled with --grpc_keepalive_time, then Bazel times out a connection if it does not receive a ping reply after this much time. Times are treated as second granularity; it is an error to set a value less than one second. If keep-alive pings are disabled, then this setting is ignored.
--[no]incompatible_disable_non_executable_java_binary default: "false"
If true, java_binary is always executable. create_executable attribute is removed.
Tags: loading_and_analysis, incompatible_change
No-op.
Tags: loading_and_analysis, incompatible_change
--[no]progress_in_terminal_title default: "false"
Show the command progress in the terminal title. Useful to see what bazel is doing when having multiple terminal tabs.
--[no]show_progress default: "true"
Display progress messages during a build.
--show_progress_rate_limit=<a double> default: "0.2"
Minimum number of seconds between progress messages in the output.
--[no]show_timestamps default: "false"
Include timestamps in messages
--tls_certificate=<a string> default: see description
Specify a path to a TLS certificate that is trusted to sign server certificates.
--tls_client_certificate=<a string> default: see description
Specify the TLS client certificate to use; you also need to provide a client key to enable client authentication.
--tls_client_key=<a string> default: see description
Specify the TLS client key to use; you also need to provide a client certificate to enable client authentication.
--ui_actions_shown=<an integer> default: "8"
Number of concurrent actions shown in the detailed progress bar; each action is shown on a separate line. The progress bar always shows at least one one, all numbers less than 1 are mapped to 1.
Tags: terminal_output
--[no]watchfs default: "false"
On Linux/macOS: If true, bazel tries to use the operating system's file watch service for local changes instead of scanning every file for a change. On Windows: this flag currently is a non-op but can be enabled in conjunction with --experimental_windows_watchfs. On any OS: The behavior is undefined if your workspace is on a network file system, and files are edited on a remote machine.

Analyze-profile Options

Options that appear before the command and are parsed by the client:
--distdir=<a path> multiple uses are accumulated
Additional places to search for archives before accessing the network to download them.
Tags: bazel_internal_configuration
If set, the repository cache will hardlink the file in case of a cache hit, rather than copying. This is intended to save disk space.
Tags: bazel_internal_configuration
--experimental_repository_downloader_retries=<an integer> default: "0"
The maximum number of attempts to retry a download error. If set to 0, retries are disabled.
Tags: experimental
--experimental_scale_timeouts=<a double> default: "1.0"
Scale all timeouts in Starlark repository rules by this factor. In this way, external repositories can be made working on machines that are slower than the rule author expected, without changing the source code
Tags: bazel_internal_configuration, experimental
--http_connector_attempts=<an integer> default: "8"
The maximum number of attempts for http downloads.
Tags: bazel_internal_configuration
--http_connector_retry_max_timeout=<An immutable length of time.> default: "0s"
The maximum timeout for http download retries. With a value of 0, no timeout maximum is defined.
Tags: bazel_internal_configuration
--http_timeout_scaling=<a double> default: "1.0"
Scale all timeouts related to http downloads by the given factor
Tags: bazel_internal_configuration
--repository_cache=<a path> default: see description
Specifies the cache location of the downloaded values obtained during the fetching of external repositories. An empty string as argument requests the cache to be disabled, otherwise the default of '<output_user_root>/cache/repos/v1' is used
Tags: bazel_internal_configuration
--[no]repository_disable_download default: "false"
If set, downloading using ctx.download{,_and_extract} is not allowed during repository fetching. Note that network access is not completely disabled; ctx.execute could still run an arbitrary executable that accesses the Internet.
Tags: bazel_internal_configuration
Options that control build execution:
--gc_thrashing_threshold=<an integer in 0-100 range> default: "100"
The percent of tenured space occupied (0-100) above which GcThrashingDetector considers memory pressure events against its limits (--gc_thrashing_limits). If set to 100, GcThrashingDetector is disabled.
Tags: host_machine_resource_optimizations
This option affects semantics of the Starlark language or the build API accessible to BUILD files, .bzl files, or WORKSPACE files.:
--[no]incompatible_depset_for_java_output_source_jars default: "true"
No-op.
Tags: loading_and_analysis, incompatible_change
--[no]incompatible_new_actions_api default: "true"
No-op
Tags: no_op, incompatible_change
Options relating to Bzlmod output and semantics:
--allow_yanked_versions=<a string> multiple uses are accumulated
Specified the module versions in the form of `<module1>@<version1>,<module2>@<version2>` that will be allowed in the resolved dependency graph even if they are declared yanked in the registry where they come from (if they are not coming from a NonRegistryOverride). Otherwise, yanked versions will cause the resolution to fail. You can also define allowed yanked version with the `BZLMOD_ALLOW_YANKED_VERSIONS` environment variable. You can disable this check by using the keyword 'all' (not recommended).
Tags: loading_and_analysis
--check_bazel_compatibility=<error, warning or off> default: "error"
Check bazel version compatibility of Bazel modules. Valid values are `error` to escalate it to a resolution failure, `off` to disable the check, or `warning` to print a warning when mismatch detected.
Tags: loading_and_analysis
--check_direct_dependencies=<off, warning or error> default: "warning"
Check if the direct `bazel_dep` dependencies declared in the root module are the same versions you get in the resolved dependency graph. Valid values are `off` to disable the check, `warning` to print a warning when mismatch detected or `error` to escalate it to a resolution failure.
Tags: loading_and_analysis
--[no]ignore_dev_dependency default: "false"
If true, Bazel ignores `bazel_dep` and `use_extension` declared as `dev_dependency` in the MODULE.bazel of the root module. Note that, those dev dependencies are always ignored in the MODULE.bazel if it's not the root module regardless of the value of this flag.
Tags: loading_and_analysis
--lockfile_mode=<off, update or error> default: "update"
Specifies how and whether or not to use the lockfile. Valid values are `update` to use the lockfile and update it if there are changes, `error` to use the lockfile but throw an error if it's not up-to-date, or `off` to neither read from or write to the lockfile.
Tags: loading_and_analysis
--override_module=<an equals-separated mapping of module name to path> multiple uses are accumulated
Override a module with a local path in the form of <module name>=<path>. If the given path is an absolute path, it will be used as it is. If the given path is a relative path, it is relative to the current working directory. If the given path starts with '%workspace%, it is relative to the workspace root, which is the output of `bazel info workspace`
--registry=<a string> multiple uses are accumulated
Specifies the registries to use to locate Bazel module dependencies. The order is important: modules will be looked up in earlier registries first, and only fall back to later registries when they're missing from the earlier ones.
Tags: changes_inputs
Options that trigger optimizations of the build time:
--gc_thrashing_limits=<comma separated pairs of <period>:<count>> default: "1s:2,20s:3,1m:5"
Limits which, if reached, cause GcThrashingDetector to crash Bazel with an OOM. Each limit is specified as <period>:<count> where period is a duration and count is a positive integer. If more than --gc_thrashing_threshold percent of tenured space (old gen heap) remains occupied after <count> consecutive full GCs within <period>, an OOM is triggered. Multiple limits can be specified separated by commas.
Tags: host_machine_resource_optimizations
--skyframe_high_water_mark_full_gc_drops_per_invocation=<an integer, >= 0> default: "2147483647"
Flag for advanced configuration of Bazel's internal Skyframe engine. If Bazel detects its retained heap percentage usage exceeds the threshold set by --skyframe_high_water_mark_threshold, when a full GC event occurs, it will drop unnecessary temporary Skyframe state, up to this many times per invocation. Defaults to Integer.MAX_VALUE; effectively unlimited. Zero means that full GC events will never trigger drops. If the limit is reached, Skyframe state will no longer be dropped when a full GC event occurs and that retained heap percentage threshold is exceeded.
Tags: host_machine_resource_optimizations
--skyframe_high_water_mark_minor_gc_drops_per_invocation=<an integer, >= 0> default: "2147483647"
Flag for advanced configuration of Bazel's internal Skyframe engine. If Bazel detects its retained heap percentage usage exceeds the threshold set by --skyframe_high_water_mark_threshold, when a minor GC event occurs, it will drop unnecessary temporary Skyframe state, up to this many times per invocation. Defaults to Integer.MAX_VALUE; effectively unlimited. Zero means that minor GC events will never trigger drops. If the limit is reached, Skyframe state will no longer be dropped when a minor GC event occurs and that retained heap percentage threshold is exceeded.
Tags: host_machine_resource_optimizations
--skyframe_high_water_mark_threshold=<an integer> default: "85"
Flag for advanced configuration of Bazel's internal Skyframe engine. If Bazel detects its retained heap percentage usage is at least this threshold, it will drop unnecessary temporary Skyframe state. Tweaking this may let you mitigate wall time impact of GC thrashing, when the GC thrashing is (i) caused by the memory usage of this temporary state and (ii) more costly than reconstituting the state when it is needed.
Tags: host_machine_resource_optimizations
Options that affect the verbosity, format or location of logging:
--dump=<text or raw> [-d] default: see description
output full profile data dump either in human-readable 'text' format or script-friendly 'raw' format.
Tags: affects_outputs
--[no]experimental_command_profile default: "false"
Records a Java Flight Recorder CPU profile into a profile.jfr file in the output base directory. The syntax and semantics of this flag might change in the future to support different profile types or output formats; use at your own risk.
--[no]experimental_record_metrics_for_all_mnemonics default: "false"
By default the number of action types is limited to the 20 mnemonics with the largest number of executed actions. Setting this option will write statistics for all mnemonics.
Options specifying or altering a generic input to a Bazel command that does not fall into other categories.:
--experimental_resolved_file_instead_of_workspace=<a string> default: ""
If non-empty read the specified resolved file instead of the WORKSPACE file
Tags: changes_inputs
Remote caching and execution options:
--experimental_downloader_config=<a string> default: see description
Specify a file to configure the remote downloader with. This file consists of lines, each of which starts with a directive (`allow`, `block` or `rewrite`) followed by either a host name (for `allow` and `block`) or two patterns, one to match against, and one to use as a substitute URL, with back-references starting from `$1`. It is possible for multiple `rewrite` directives for the same URL to be give, and in this case multiple URLs will be returned.
--experimental_worker_for_repo_fetching=<off, platform or virtual> default: "off"
The threading mode to use for repo fetching. If set to 'off', no worker thread is used, and the repo fetching is subject to restarts. Otherwise, uses a platform thread (i.e. OS thread) if set to 'platform' or a virtual thread if set to 'virtual'.
Miscellaneous options, not otherwise categorized.:
--override_repository=<an equals-separated mapping of repository name to path> multiple uses are accumulated
Override a repository with a local path in the form of <repository name>=<path>. If the given path is an absolute path, it will be used as it is. If the given path is a relative path, it is relative to the current working directory. If the given path starts with '%workspace%, it is relative to the workspace root, which is the output of `bazel info workspace`

Aquery Options

Inherits all options from build.

Options that appear before the command and are parsed by the client:
--distdir=<a path> multiple uses are accumulated
Additional places to search for archives before accessing the network to download them.
Tags: bazel_internal_configuration
If set, the repository cache will hardlink the file in case of a cache hit, rather than copying. This is intended to save disk space.
Tags: bazel_internal_configuration
--experimental_repository_downloader_retries=<an integer> default: "0"
The maximum number of attempts to retry a download error. If set to 0, retries are disabled.
Tags: experimental
--experimental_scale_timeouts=<a double> default: "1.0"
Scale all timeouts in Starlark repository rules by this factor. In this way, external repositories can be made working on machines that are slower than the rule author expected, without changing the source code
Tags: bazel_internal_configuration, experimental
--http_connector_attempts=<an integer> default: "8"
The maximum number of attempts for http downloads.
Tags: bazel_internal_configuration
--http_connector_retry_max_timeout=<An immutable length of time.> default: "0s"
The maximum timeout for http download retries. With a value of 0, no timeout maximum is defined.
Tags: bazel_internal_configuration
--http_timeout_scaling=<a double> default: "1.0"
Scale all timeouts related to http downloads by the given factor
Tags: bazel_internal_configuration
--repository_cache=<a path> default: see description
Specifies the cache location of the downloaded values obtained during the fetching of external repositories. An empty string as argument requests the cache to be disabled, otherwise the default of '<output_user_root>/cache/repos/v1' is used
Tags: bazel_internal_configuration
--[no]repository_disable_download default: "false"
If set, downloading using ctx.download{,_and_extract} is not allowed during repository fetching. Note that network access is not completely disabled; ctx.execute could still run an arbitrary executable that accesses the Internet.
Tags: bazel_internal_configuration
Options that control build execution:
--gc_thrashing_threshold=<an integer in 0-100 range> default: "100"
The percent of tenured space occupied (0-100) above which GcThrashingDetector considers memory pressure events against its limits (--gc_thrashing_limits). If set to 100, GcThrashingDetector is disabled.
Tags: host_machine_resource_optimizations
This option affects semantics of the Starlark language or the build API accessible to BUILD files, .bzl files, or WORKSPACE files.:
--[no]incompatible_depset_for_java_output_source_jars default: "true"
No-op.
Tags: loading_and_analysis, incompatible_change
--[no]incompatible_new_actions_api default: "true"
No-op
Tags: no_op, incompatible_change
Options relating to query output and semantics:
--aspect_deps=<off, conservative or precise> default: "conservative"
How to resolve aspect dependencies when the output format is one of {xml,proto,record}. 'off' means no aspect dependencies are resolved, 'conservative' (the default) means all declared aspect dependencies are added regardless of whether they are given the rule class of direct dependencies, 'precise' means that only those aspects are added that are possibly active given the rule class of the direct dependencies. Note that precise mode requires loading other packages to evaluate a single target thus making it slower than the other modes. Also note that even precise mode is not completely precise: the decision whether to compute an aspect is decided in the analysis phase, which is not run during 'bazel query'.
Tags: build_file_semantics
--[no]consistent_labels default: "false"
If enabled, every query command emits labels as if by the Starlark <code>str</code> function applied to a <code>Label</code> instance. This is useful for tools that need to match the output of different query commands and/or labels emitted by rules. If not enabled, output formatters are free to emit apparent repository names (relative to the main repository) instead to make the output more readable.
Tags: terminal_output
--[no]graph:factored default: "true"
If true, then the graph will be emitted 'factored', i.e. topologically-equivalent nodes will be merged together and their labels concatenated. This option is only applicable to --output=graph.
Tags: terminal_output
--graph:node_limit=<an integer> default: "512"
The maximum length of the label string for a graph node in the output. Longer labels will be truncated; -1 means no truncation. This option is only applicable to --output=graph.
Tags: terminal_output
--[no]implicit_deps default: "true"
If enabled, implicit dependencies will be included in the dependency graph over which the query operates. An implicit dependency is one that is not explicitly specified in the BUILD file but added by bazel. For cquery, this option controls filtering resolved toolchains.
Tags: build_file_semantics
--[no]include_artifacts default: "true"
Includes names of the action inputs and outputs in the output (potentially large).
Tags: terminal_output
--[no]include_aspects default: "true"
aquery, cquery: whether to include aspect-generated actions in the output. query: no-op (aspects are always followed).
Tags: terminal_output
--[no]include_commandline default: "true"
Includes the content of the action command lines in the output (potentially large).
Tags: terminal_output
--[no]include_file_write_contents default: "false"
Include the file contents for the FileWrite, SourceSymlinkManifest, and RepoMappingManifest actions (potentially large).
Tags: terminal_output
--[no]include_param_files default: "false"
Include the content of the param files used in the command (potentially large). Note: Enabling this flag will automatically enable the --include_commandline flag.
Tags: terminal_output
--[no]include_scheduling_dependencies default: "false"
Includes names of the scheduling dependencies of actions (potentially large). Only takes effect if --include_artifacts is also set.
Tags: terminal_output
--[no]incompatible_package_group_includes_double_slash default: "true"
If enabled, when outputting package_group's `packages` attribute, the leading `//` will not be omitted.
Tags: terminal_output, incompatible_change
--[no]infer_universe_scope default: "false"
If set and --universe_scope is unset, then a value of --universe_scope will be inferred as the list of unique target patterns in the query expression. Note that the --universe_scope value inferred for a query expression that uses universe-scoped functions (e.g.`allrdeps`) may not be what you want, so you should use this option only if you know what you are doing. See https://bazel.build/reference/query#sky-query for details and examples. If --universe_scope is set, then this option's value is ignored. Note: this option applies only to `query` (i.e. not `cquery`).
Tags: loading_and_analysis
--[no]line_terminator_null default: "false"
Whether each format is terminated with \0 instead of newline.
Tags: terminal_output
--[no]nodep_deps default: "true"
If enabled, deps from "nodep" attributes will be included in the dependency graph over which the query operates. A common example of a "nodep" attribute is "visibility". Run and parse the output of `info build-language` to learn about all the "nodep" attributes in the build language.
Tags: build_file_semantics
--output=<a string> default: "text"
The format in which the aquery results should be printed. Allowed values for aquery are: text, textproto, proto, streamed_proto, jsonproto.
Tags: terminal_output
--[no]proto:default_values default: "true"
If true, attributes whose value is not explicitly specified in the BUILD file are included; otherwise they are omitted. This option is applicable to --output=proto
Tags: terminal_output
--[no]proto:definition_stack default: "false"
Populate the definition_stack proto field, which records for each rule instance the Starlark call stack at the moment the rule's class was defined.
Tags: terminal_output
--[no]proto:flatten_selects default: "true"
If enabled, configurable attributes created by select() are flattened. For list types the flattened representation is a list containing each value of the select map exactly once. Scalar types are flattened to null.
Tags: build_file_semantics
--[no]proto:include_attribute_source_aspects default: "false"
Populate the source_aspect_name proto field of each Attribute with the source aspect that the attribute came from (empty string if it did not).
Tags: terminal_output
--[no]proto:include_synthetic_attribute_hash default: "false"
Whether or not to calculate and populate the $internal_attr_hash attribute.
Tags: terminal_output
--[no]proto:instantiation_stack default: "false"
Populate the instantiation call stack of each rule. Note that this requires the stack to be present
Tags: terminal_output
--[no]proto:locations default: "true"
Whether to output location information in proto output at all.
Tags: terminal_output
--proto:output_rule_attrs=<comma-separated list of options> default: "all"
Comma separated list of attributes to include in output. Defaults to all attributes. Set to empty string to not output any attribute. This option is applicable to --output=proto.
Tags: terminal_output
--[no]proto:rule_inputs_and_outputs default: "true"
Whether or not to populate the rule_input and rule_output fields.
Tags: terminal_output
--query_file=<a string> default: ""
If set, query will read the query from the file named here, rather than on the command line. It is an error to specify a file here as well as a command-line query.
Tags: changes_inputs
--[no]relative_locations default: "false"
If true, the location of BUILD files in xml and proto outputs will be relative. By default, the location output is an absolute path and will not be consistent across machines. You can set this option to true to have a consistent result across machines.
Tags: terminal_output
--[no]skyframe_state default: "false"
Without performing extra analysis, dump the current Action Graph from Skyframe. Note: Specifying a target with --skyframe_state is currently not supported. This flag is only available with --output=proto or --output=textproto.
Tags: terminal_output
--[no]tool_deps default: "true"
Query: If disabled, dependencies on 'exec configuration' will not be included in the dependency graph over which the query operates. An 'exec configuration' dependency edge, such as the one from any 'proto_library' rule to the Protocol Compiler, usually points to a tool executed during the build rather than a part of the same 'target' program. Cquery: If disabled, filters out all configured targets which cross an execution transition from the top-level target that discovered this configured target. That means if the top-level target is in the target configuration, only configured targets also in the target configuration will be returned. If the top-level target is in the exec configuration, only exec configured targets will be returned. This option will NOT exclude resolved toolchains.
Tags: build_file_semantics
--universe_scope=<comma-separated list of options> default: ""
A comma-separated set of target patterns (additive and subtractive). The query may be performed in the universe defined by the transitive closure of the specified targets. This option is used for the query and cquery commands. For cquery, the input to this option is the targets all answers are built under and so this option may affect configurations and transitions. If this option is not specified, the top-level targets are assumed to be the targets parsed from the query expression. Note: For cquery, not specifying this option may cause the build to break if targets parsed from the query expression are not buildable with top-level options.
Tags: loading_and_analysis
Options relating to Bzlmod output and semantics:
--allow_yanked_versions=<a string> multiple uses are accumulated
Specified the module versions in the form of `<module1>@<version1>,<module2>@<version2>` that will be allowed in the resolved dependency graph even if they are declared yanked in the registry where they come from (if they are not coming from a NonRegistryOverride). Otherwise, yanked versions will cause the resolution to fail. You can also define allowed yanked version with the `BZLMOD_ALLOW_YANKED_VERSIONS` environment variable. You can disable this check by using the keyword 'all' (not recommended).
Tags: loading_and_analysis
--check_bazel_compatibility=<error, warning or off> default: "error"
Check bazel version compatibility of Bazel modules. Valid values are `error` to escalate it to a resolution failure, `off` to disable the check, or `warning` to print a warning when mismatch detected.
Tags: loading_and_analysis
--check_direct_dependencies=<off, warning or error> default: "warning"
Check if the direct `bazel_dep` dependencies declared in the root module are the same versions you get in the resolved dependency graph. Valid values are `off` to disable the check, `warning` to print a warning when mismatch detected or `error` to escalate it to a resolution failure.
Tags: loading_and_analysis
--[no]ignore_dev_dependency default: "false"
If true, Bazel ignores `bazel_dep` and `use_extension` declared as `dev_dependency` in the MODULE.bazel of the root module. Note that, those dev dependencies are always ignored in the MODULE.bazel if it's not the root module regardless of the value of this flag.
Tags: loading_and_analysis
--lockfile_mode=<off, update or error> default: "update"
Specifies how and whether or not to use the lockfile. Valid values are `update` to use the lockfile and update it if there are changes, `error` to use the lockfile but throw an error if it's not up-to-date, or `off` to neither read from or write to the lockfile.
Tags: loading_and_analysis
--override_module=<an equals-separated mapping of module name to path> multiple uses are accumulated
Override a module with a local path in the form of <module name>=<path>. If the given path is an absolute path, it will be used as it is. If the given path is a relative path, it is relative to the current working directory. If the given path starts with '%workspace%, it is relative to the workspace root, which is the output of `bazel info workspace`
--registry=<a string> multiple uses are accumulated
Specifies the registries to use to locate Bazel module dependencies. The order is important: modules will be looked up in earlier registries first, and only fall back to later registries when they're missing from the earlier ones.
Tags: changes_inputs
Options that trigger optimizations of the build time:
--gc_thrashing_limits=<comma separated pairs of <period>:<count>> default: "1s:2,20s:3,1m:5"
Limits which, if reached, cause GcThrashingDetector to crash Bazel with an OOM. Each limit is specified as <period>:<count> where period is a duration and count is a positive integer. If more than --gc_thrashing_threshold percent of tenured space (old gen heap) remains occupied after <count> consecutive full GCs within <period>, an OOM is triggered. Multiple limits can be specified separated by commas.
Tags: host_machine_resource_optimizations
--skyframe_high_water_mark_full_gc_drops_per_invocation=<an integer, >= 0> default: "2147483647"
Flag for advanced configuration of Bazel's internal Skyframe engine. If Bazel detects its retained heap percentage usage exceeds the threshold set by --skyframe_high_water_mark_threshold, when a full GC event occurs, it will drop unnecessary temporary Skyframe state, up to this many times per invocation. Defaults to Integer.MAX_VALUE; effectively unlimited. Zero means that full GC events will never trigger drops. If the limit is reached, Skyframe state will no longer be dropped when a full GC event occurs and that retained heap percentage threshold is exceeded.
Tags: host_machine_resource_optimizations
--skyframe_high_water_mark_minor_gc_drops_per_invocation=<an integer, >= 0> default: "2147483647"
Flag for advanced configuration of Bazel's internal Skyframe engine. If Bazel detects its retained heap percentage usage exceeds the threshold set by --skyframe_high_water_mark_threshold, when a minor GC event occurs, it will drop unnecessary temporary Skyframe state, up to this many times per invocation. Defaults to Integer.MAX_VALUE; effectively unlimited. Zero means that minor GC events will never trigger drops. If the limit is reached, Skyframe state will no longer be dropped when a minor GC event occurs and that retained heap percentage threshold is exceeded.
Tags: host_machine_resource_optimizations
--skyframe_high_water_mark_threshold=<an integer> default: "85"
Flag for advanced configuration of Bazel's internal Skyframe engine. If Bazel detects its retained heap percentage usage is at least this threshold, it will drop unnecessary temporary Skyframe state. Tweaking this may let you mitigate wall time impact of GC thrashing, when the GC thrashing is (i) caused by the memory usage of this temporary state and (ii) more costly than reconstituting the state when it is needed.
Tags: host_machine_resource_optimizations
Options that affect the verbosity, format or location of logging:
--[no]experimental_command_profile default: "false"
Records a Java Flight Recorder CPU profile into a profile.jfr file in the output base directory. The syntax and semantics of this flag might change in the future to support different profile types or output formats; use at your own risk.
--[no]experimental_record_metrics_for_all_mnemonics default: "false"
By default the number of action types is limited to the 20 mnemonics with the largest number of executed actions. Setting this option will write statistics for all mnemonics.
Options specifying or altering a generic input to a Bazel command that does not fall into other categories.:
--experimental_resolved_file_instead_of_workspace=<a string> default: ""
If non-empty read the specified resolved file instead of the WORKSPACE file
Tags: changes_inputs
Remote caching and execution options:
--experimental_downloader_config=<a string> default: see description
Specify a file to configure the remote downloader with. This file consists of lines, each of which starts with a directive (`allow`, `block` or `rewrite`) followed by either a host name (for `allow` and `block`) or two patterns, one to match against, and one to use as a substitute URL, with back-references starting from `$1`. It is possible for multiple `rewrite` directives for the same URL to be give, and in this case multiple URLs will be returned.
--experimental_worker_for_repo_fetching=<off, platform or virtual> default: "off"
The threading mode to use for repo fetching. If set to 'off', no worker thread is used, and the repo fetching is subject to restarts. Otherwise, uses a platform thread (i.e. OS thread) if set to 'platform' or a virtual thread if set to 'virtual'.
Miscellaneous options, not otherwise categorized.:
--override_repository=<an equals-separated mapping of repository name to path> multiple uses are accumulated
Override a repository with a local path in the form of <repository name>=<path>. If the given path is an absolute path, it will be used as it is. If the given path is a relative path, it is relative to the current working directory. If the given path starts with '%workspace%, it is relative to the workspace root, which is the output of `bazel info workspace`
Options that control build execution:
Whether to make direct file system calls to create symlink trees
Tags: loading_and_analysis, execution, experimental
--[no]experimental_persistent_aar_extractor default: "false"
Enable persistent aar extractor by using workers.
Tags: execution
--[no]experimental_remotable_source_manifests default: "false"
Whether to make source manifest actions remotable
Tags: loading_and_analysis, execution, experimental
--[no]experimental_split_coverage_postprocessing default: "false"
If true, then Bazel will run coverage postprocessing for test in a new spawn.
Tags: execution
--[no]experimental_strict_fileset_output default: "false"
If this option is enabled, filesets will treat all output artifacts as regular files. They will not traverse directories or be sensitive to symlinks.
Tags: execution
--modify_execution_info=<regex=[+-]key,regex=[+-]key,...> default: ""
Add or remove keys from an action's execution info based on action mnemonic. Applies only to actions which support execution info. Many common actions support execution info, e.g. Genrule, CppCompile, Javac, StarlarkAction, TestRunner. When specifying multiple values, order matters because many regexes may apply to the same mnemonic. Syntax: "regex=[+-]key,regex=[+-]key,...". Examples: '.*=+x,.*=-y,.*=+z' adds 'x' and 'z' to, and removes 'y' from, the execution info for all actions. 'Genrule=+requires-x' adds 'requires-x' to the execution info for all Genrule actions. '(?!Genrule).*=-requires-x' removes 'requires-x' from the execution info for all non-Genrule actions.
Tags: execution, affects_outputs, loading_and_analysis
--persistent_android_dex_desugar
Enable persistent Android dex and desugar actions by using workers.
Expands to:
  --internal_persistent_android_dex_desugar
  --strategy=Desugar=worker
  --strategy=DexBuilder=worker

Tags: host_machine_resource_optimizations, execution
--persistent_android_resource_processor
Enable persistent Android resource processor by using workers.
Expands to:
  --internal_persistent_busybox_tools
  --strategy=AaptPackage=worker
  --strategy=AndroidResourceParser=worker
  --strategy=AndroidResourceValidator=worker
  --strategy=AndroidResourceCompiler=worker
  --strategy=RClassGenerator=worker
  --strategy=AndroidResourceLink=worker
  --strategy=AndroidAapt2=worker
  --strategy=AndroidAssetMerger=worker
  --strategy=AndroidResourceMerger=worker
  --strategy=AndroidCompiledResourceMerger=worker
  --strategy=ManifestMerger=worker
  --strategy=AndroidManifestMerger=worker
  --strategy=Aapt2Optimize=worker
  --strategy=AARGenerator=worker
  --strategy=ProcessDatabinding=worker
  --strategy=GenerateDataBindingBaseClasses=worker

Tags: host_machine_resource_optimizations, execution
--persistent_multiplex_android_dex_desugar
Enable persistent multiplexed Android dex and desugar actions by using workers.
Expands to:
  --persistent_android_dex_desugar
  --internal_persistent_multiplex_android_dex_desugar

Tags: host_machine_resource_optimizations, execution
--persistent_multiplex_android_resource_processor
Enable persistent multiplexed Android resource processor by using workers.
Expands to:
  --persistent_android_resource_processor
  --modify_execution_info=AaptPackage=+supports-multiplex-workers
  --modify_execution_info=AndroidResourceParser=+supports-multiplex-workers
  --modify_execution_info=AndroidResourceValidator=+supports-multiplex-workers
  --modify_execution_info=AndroidResourceCompiler=+supports-multiplex-workers
  --modify_execution_info=RClassGenerator=+supports-multiplex-workers
  --modify_execution_info=AndroidResourceLink=+supports-multiplex-workers
  --modify_execution_info=AndroidAapt2=+supports-multiplex-workers
  --modify_execution_info=AndroidAssetMerger=+supports-multiplex-workers
  --modify_execution_info=AndroidResourceMerger=+supports-multiplex-workers
  --modify_execution_info=AndroidCompiledResourceMerger=+supports-multiplex-workers
  --modify_execution_info=ManifestMerger=+supports-multiplex-workers
  --modify_execution_info=AndroidManifestMerger=+supports-multiplex-workers
  --modify_execution_info=Aapt2Optimize=+supports-multiplex-workers
  --modify_execution_info=AARGenerator=+supports-multiplex-workers

Tags: host_machine_resource_optimizations, execution
--persistent_multiplex_android_tools
Enable persistent and multiplexed Android tools (dexing, desugaring, resource processing).
Expands to:
  --internal_persistent_multiplex_busybox_tools
  --persistent_multiplex_android_resource_processor
  --persistent_multiplex_android_dex_desugar

Tags: host_machine_resource_optimizations, execution
--[no]use_target_platform_for_tests default: "false"
If true, then Bazel will use the target platform for running tests rather than the test exec group.
Tags: execution
Options that configure the toolchain used for action execution:
--android_compiler=<a string> default: see description
The Android target compiler.
Tags: affects_outputs, loading_and_analysis, loses_incremental_state
--android_crosstool_top=<a build target label> default: "//external:android/crosstool"
The location of the C++ compiler used for Android builds.
Tags: affects_outputs, changes_inputs, loading_and_analysis, loses_incremental_state
--android_grte_top=<a label> default: see description
The Android target grte_top.
Tags: changes_inputs, loading_and_analysis, loses_incremental_state
--android_manifest_merger=<legacy, android or force_android> default: "android"
Selects the manifest merger to use for android_binary rules. Flag to help thetransition to the Android manifest merger from the legacy merger.
Tags: affects_outputs, loading_and_analysis, loses_incremental_state
--android_platforms=<a build target label> default: ""
Sets the platforms that android_binary targets use. If multiple platforms are specified, then the binary is a fat APKs, which contains native binaries for each specified target platform.
Tags: changes_inputs, loading_and_analysis, loses_incremental_state
--android_sdk=<a build target label> default: "@bazel_tools//tools/android:sdk"
Specifies Android SDK/platform that is used to build Android applications.
Tags: changes_inputs, loading_and_analysis, loses_incremental_state
--apple_crosstool_top=<a build target label> default: "@bazel_tools//tools/cpp:toolchain"
The label of the crosstool package to be used in Apple and Objc rules and their dependencies.
Tags: loses_incremental_state, changes_inputs
--cc_output_directory_tag=<a string> default: ""
Specifies a suffix to be added to the configuration directory.
Tags: affects_outputs
--compiler=<a string> default: see description
The C++ compiler to use for compiling the target.
Tags: loading_and_analysis, execution
--coverage_output_generator=<a build target label> default: "@bazel_tools//tools/test:lcov_merger"
Location of the binary that is used to postprocess raw coverage reports. This must currently be a filegroup that contains a single file, the binary. Defaults to '//tools/test:lcov_merger'.
Tags: changes_inputs, affects_outputs, loading_and_analysis
--coverage_report_generator=<a build target label> default: "@bazel_tools//tools/test:coverage_report_generator"
Location of the binary that is used to generate coverage reports. This must currently be a filegroup that contains a single file, the binary. Defaults to '//tools/test:coverage_report_generator'.
Tags: changes_inputs, affects_outputs, loading_and_analysis
--coverage_support=<a build target label> default: "@bazel_tools//tools/test:coverage_support"
Location of support files that are required on the inputs of every test action that collects code coverage. Defaults to '//tools/test:coverage_support'.
Tags: changes_inputs, affects_outputs, loading_and_analysis
--custom_malloc=<a build target label> default: see description
Specifies a custom malloc implementation. This setting overrides malloc attributes in build rules.
Tags: changes_inputs, affects_outputs
--experimental_add_exec_constraints_to_targets=<a '<RegexFilter>=<label1>[,<label2>,...]' assignment> multiple uses are accumulated
List of comma-separated regular expressions, each optionally prefixed by - (negative expression), assigned (=) to a list of comma-separated constraint value targets. If a target matches no negative expression and at least one positive expression its toolchain resolution will be performed as if it had declared the constraint values as execution constraints. Example: //demo,-test=@platforms//cpus:x86_64 will add 'x86_64' to any target under //demo except for those whose name contains 'test'.
Tags: loading_and_analysis
--[no]experimental_include_xcode_execution_requirements default: "false"
If set, add a "requires-xcode:{version}" execution requirement to every Xcode action. If the xcode version has a hyphenated label, also add a "requires-xcode-label:{version_label}" execution requirement.
Tags: loses_incremental_state, loading_and_analysis, execution
--[no]experimental_prefer_mutual_xcode default: "true"
If true, use the most recent Xcode that is available both locally and remotely. If false, or if there are no mutual available versions, use the local Xcode version selected via xcode-select.
Tags: loses_incremental_state
--extra_execution_platforms=<comma-separated list of options> default: ""
The platforms that are available as execution platforms to run actions. Platforms can be specified by exact target, or as a target pattern. These platforms will be considered before those declared in the WORKSPACE file by register_execution_platforms(). This option may only be set once; later instances will override earlier flag settings.
Tags: execution
--extra_toolchains=<comma-separated list of options> multiple uses are accumulated
The toolchain rules to be considered during toolchain resolution. Toolchains can be specified by exact target, or as a target pattern. These toolchains will be considered before those declared in the WORKSPACE file by register_toolchains().
Tags: affects_outputs, changes_inputs, loading_and_analysis
--grte_top=<a label> default: see description
A label to a checked-in libc library. The default value is selected by the crosstool toolchain, and you almost never need to override it.
Tags: action_command_lines, affects_outputs
--host_compiler=<a string> default: see description
No-op flag. Will be removed in a future release.
Tags: loading_and_analysis, execution
--host_grte_top=<a label> default: see description
If specified, this setting overrides the libc top-level directory (--grte_top) for the exec configuration.
Tags: action_command_lines, affects_outputs
--host_platform=<a build target label> default: "@local_config_platform//:host"
The label of a platform rule that describes the host system.
Tags: affects_outputs, changes_inputs, loading_and_analysis
--[no]incompatible_dont_enable_host_nonhost_crosstool_features default: "true"
If true, Bazel will not enable 'host' and 'nonhost' features in the c++ toolchain (see https://github.com/bazelbuild/bazel/issues/7407 for more information).
Tags: loading_and_analysis, incompatible_change
--[no]incompatible_enable_android_toolchain_resolution default: "true"
Use toolchain resolution to select the Android SDK for android rules (Starlark and native)
Tags: loading_and_analysis, incompatible_change
--[no]incompatible_enable_apple_toolchain_resolution default: "false"
Use toolchain resolution to select the Apple SDK for apple rules (Starlark and native)
Tags: loading_and_analysis, incompatible_change
--[no]incompatible_make_thinlto_command_lines_standalone default: "true"
If true, Bazel will not reuse C++ link action command lines for lto indexing command lines (see https://github.com/bazelbuild/bazel/issues/6791 for more information).
Tags: loading_and_analysis, incompatible_change
--[no]incompatible_remove_legacy_whole_archive default: "true"
If true, Bazel will not link library dependencies as whole archive by default (see https://github.com/bazelbuild/bazel/issues/7362 for migration instructions).
Tags: loading_and_analysis, incompatible_change
--[no]incompatible_require_ctx_in_configure_features default: "true"
This flag is a noop and scheduled for removal.
Tags: no_op, incompatible_change
--[no]interface_shared_objects default: "true"
Use interface shared objects if supported by the toolchain. All ELF toolchains currently support this setting.
Tags: loading_and_analysis, affects_outputs, affects_outputs
--ios_sdk_version=<a dotted version (for example '2.3' or '3.3alpha2.4')> default: see description
Specifies the version of the iOS SDK to use to build iOS applications. If unspecified, uses default iOS SDK version from 'xcode_version'.
Tags: loses_incremental_state
--macos_sdk_version=<a dotted version (for example '2.3' or '3.3alpha2.4')> default: see description
Specifies the version of the macOS SDK to use to build macOS applications. If unspecified, uses default macOS SDK version from 'xcode_version'.
Tags: loses_incremental_state
--minimum_os_version=<a string> default: see description
The minimum OS version which your compilation targets.
Tags: loading_and_analysis, affects_outputs
--platform_mappings=<a relative path> default: ""
The location of a mapping file that describes which platform to use if none is set or which flags to set when a platform already exists. Must be relative to the main workspace root. Defaults to 'platform_mappings' (a file directly under the workspace root).
Tags: affects_outputs, changes_inputs, loading_and_analysis
--platforms=<a build target label> default: ""
The labels of the platform rules describing the target platforms for the current command.
Tags: affects_outputs, changes_inputs, loading_and_analysis
--python2_path=<a string> default: see description
Deprecated, no-op. Disabled by `--incompatible_use_python_toolchains`.
Tags: no_op, deprecated
--python3_path=<a string> default: see description
Deprecated, no-op. Disabled by `--incompatible_use_python_toolchains`.
Tags: no_op, deprecated
--python_path=<a string> default: see description
The absolute path of the Python interpreter invoked to run Python targets on the target platform. Deprecated; disabled by --incompatible_use_python_toolchains.
Tags: loading_and_analysis, affects_outputs
--python_top=<a build target label> default: see description
The label of a py_runtime representing the Python interpreter invoked to run Python targets on the target platform. Deprecated; disabled by --incompatible_use_python_toolchains.
Tags: loading_and_analysis, affects_outputs
--tvos_sdk_version=<a dotted version (for example '2.3' or '3.3alpha2.4')> default: see description
Specifies the version of the tvOS SDK to use to build tvOS applications. If unspecified, uses default tvOS SDK version from 'xcode_version'.
Tags: loses_incremental_state
--watchos_sdk_version=<a dotted version (for example '2.3' or '3.3alpha2.4')> default: see description
Specifies the version of the watchOS SDK to use to build watchOS applications. If unspecified, uses default watchOS SDK version from 'xcode_version'.
Tags: loses_incremental_state
--xcode_version=<a string> default: see description
If specified, uses Xcode of the given version for relevant build actions. If unspecified, uses the executor default version of Xcode.
Tags: loses_incremental_state
--xcode_version_config=<a build target label> default: "@bazel_tools//tools/cpp:host_xcodes"
The label of the xcode_config rule to be used for selecting the Xcode version in the build configuration.
Tags: loses_incremental_state, loading_and_analysis
Options that control the output of the command:
--[no]apple_generate_dsym default: "false"
Whether to generate debug symbol(.dSYM) file(s).
Tags: affects_outputs, action_command_lines
If true, build runfiles symlink forests for all targets. If false, write them only when required by a local action, test or run command.
Tags: affects_outputs
--[no]build_runfile_manifests default: "true"
If true, write runfiles manifests for all targets. If false, omit them. Local tests will fail to run when false.
Tags: affects_outputs
--[no]build_test_dwp default: "false"
If enabled, when building C++ tests statically and with fission the .dwp file for the test binary will be automatically built as well.
Tags: loading_and_analysis, affects_outputs
--cc_proto_library_header_suffixes=<comma-separated set of options> default: ".pb.h"
Sets the suffixes of header files that a cc_proto_library creates.
Tags: affects_outputs, loading_and_analysis
--cc_proto_library_source_suffixes=<comma-separated set of options> default: ".pb.cc"
Sets the suffixes of source files that a cc_proto_library creates.
Tags: affects_outputs, loading_and_analysis
--[no]experimental_proto_descriptor_sets_include_source_info default: "false"
Run extra actions for alternative Java api versions in a proto_library.
Tags: affects_outputs, loading_and_analysis, experimental
--[no]experimental_proto_extra_actions default: "false"
Run extra actions for alternative Java api versions in a proto_library.
Tags: affects_outputs, loading_and_analysis, experimental
--[no]experimental_save_feature_state default: "false"
Save the state of enabled and requested feautres as an output of compilation.
Tags: affects_outputs, experimental
--fission=<a set of compilation modes> default: "no"
Specifies which compilation modes use fission for C++ compilations and links. May be any combination of {'fastbuild', 'dbg', 'opt'} or the special values 'yes' to enable all modes and 'no' to disable all modes.
Tags: loading_and_analysis, action_command_lines, affects_outputs
--[no]incompatible_always_include_files_in_data default: "true"
If true, native rules add <code>DefaultInfo.files</code> of data dependencies to their runfiles, which matches the recommended behavior for Starlark rules (https://bazel.build/extending/rules#runfiles_features_to_avoid).
Tags: affects_outputs, incompatible_change
--[no]legacy_external_runfiles default: "true"
If true, build runfiles symlink forests for external repositories under .runfiles/wsname/external/repo (in addition to .runfiles/repo).
Tags: affects_outputs
--[no]objc_generate_linkmap default: "false"
Specifies whether to generate a linkmap file.
Tags: affects_outputs
--[no]save_temps default: "false"
If set, temporary outputs from gcc will be saved. These include .s files (assembler code), .i files (preprocessed C) and .ii files (preprocessed C++).
Tags: affects_outputs
Options that let the user configure the intended output, affecting its value, as opposed to its existence:
--action_env=<a 'name=value' assignment with an optional value part> multiple uses are accumulated
Specifies the set of environment variables available to actions with target configuration. Variables can be either specified by name, in which case the value will be taken from the invocation environment, or by the name=value pair which sets the value independent of the invocation environment. This option can be used multiple times; for options given for the same variable, the latest wins, options for different variables accumulate.
Tags: action_command_lines
--android_cpu=<a string> default: "armeabi-v7a"
The Android target CPU.
Tags: affects_outputs, loading_and_analysis, loses_incremental_state
--[no]android_databinding_use_androidx default: "true"
Generate AndroidX-compatible data-binding files. This is only used with databinding v2. This flag is a no-op.
Tags: affects_outputs, loading_and_analysis, loses_incremental_state, experimental
--[no]android_databinding_use_v3_4_args default: "true"
Use android databinding v2 with 3.4.0 argument. This flag is a no-op.
Tags: affects_outputs, loading_and_analysis, loses_incremental_state, experimental
--android_dynamic_mode=<off, default or fully> default: "off"
Determines whether C++ deps of Android rules will be linked dynamically when a cc_binary does not explicitly create a shared library. 'default' means bazel will choose whether to link dynamically. 'fully' means all libraries will be linked dynamically. 'off' means that all libraries will be linked in mostly static mode.
Tags: affects_outputs, loading_and_analysis
--android_manifest_merger_order=<alphabetical, alphabetical_by_configuration or dependency> default: "alphabetical"
Sets the order of manifests passed to the manifest merger for Android binaries. ALPHABETICAL means manifests are sorted by path relative to the execroot. ALPHABETICAL_BY_CONFIGURATION means manifests are sorted by paths relative to the configuration directory within the output directory. DEPENDENCY means manifests are ordered with each library's manifest coming before the manifests of its dependencies.
Tags: action_command_lines, execution
--[no]android_resource_shrinking default: "false"
Enables resource shrinking for android_binary APKs that use ProGuard.
Tags: affects_outputs, loading_and_analysis
--[no]build_python_zip default: "auto"
Build python executable zip; on on Windows, off on other platforms
Tags: affects_outputs
--catalyst_cpus=<comma-separated list of options> multiple uses are accumulated
Comma-separated list of architectures for which to build Apple Catalyst binaries.
Tags: loses_incremental_state, loading_and_analysis
--[no]collect_code_coverage default: "false"
If specified, Bazel will instrument code (using offline instrumentation where possible) and will collect coverage information during tests. Only targets that match --instrumentation_filter will be affected. Usually this option should not be specified directly - 'bazel coverage' command should be used instead.
Tags: affects_outputs
--compilation_mode=<fastbuild, dbg or opt> [-c] default: "fastbuild"
Specify the mode the binary will be built in. Values: 'fastbuild', 'dbg', 'opt'.
Tags: affects_outputs, action_command_lines
--conlyopt=<a string> multiple uses are accumulated
Additional option to pass to gcc when compiling C source files.
Tags: action_command_lines, affects_outputs
--copt=<a string> multiple uses are accumulated
Additional options to pass to gcc.
Tags: action_command_lines, affects_outputs
--cpu=<a string> default: ""
The target CPU.
Tags: changes_inputs, affects_outputs
--cs_fdo_absolute_path=<a string> default: see description
Use CSFDO profile information to optimize compilation. Specify the absolute path name of the zip file containing the profile file, a raw or an indexed LLVM profile file.
Tags: affects_outputs
--cs_fdo_instrument=<a string> default: see description
Generate binaries with context sensitive FDO instrumentation. With Clang/LLVM compiler, it also accepts the directory name under which the raw profile file(s) will be dumped at runtime.
Tags: affects_outputs
--cs_fdo_profile=<a build target label> default: see description
The cs_fdo_profile representing the context sensitive profile to be used for optimization.
Tags: affects_outputs
--cxxopt=<a string> multiple uses are accumulated
Additional option to pass to gcc when compiling C++ source files.
Tags: action_command_lines, affects_outputs
--define=<a 'name=value' assignment> multiple uses are accumulated
Each --define option specifies an assignment for a build variable. In case of multiple values for a variable, the last one wins.
Tags: changes_inputs, affects_outputs
--dynamic_mode=<off, default or fully> default: "default"
Determines whether C++ binaries will be linked dynamically. 'default' means Bazel will choose whether to link dynamically. 'fully' means all libraries will be linked dynamically. 'off' means that all libraries will be linked in mostly static mode.
Tags: loading_and_analysis, affects_outputs
--[no]enable_fdo_profile_absolute_path default: "true"
If set, use of fdo_absolute_profile_path will raise an error.
Tags: affects_outputs
--[no]enable_runfiles default: "auto"
Enable runfiles symlink tree; By default, it's off on Windows, on on other platforms.
Tags: affects_outputs
--experimental_action_listener=<a build target label> multiple uses are accumulated
Deprecated in favor of aspects. Use action_listener to attach an extra_action to existing build actions.
Tags: execution, experimental
--[no]experimental_android_compress_java_resources default: "false"
Compress Java resources in APKs
Tags: affects_outputs, loading_and_analysis, experimental
--[no]experimental_android_databinding_v2 default: "true"
Use android databinding v2. This flag is a no-op.
Tags: affects_outputs, loading_and_analysis, loses_incremental_state, experimental
--[no]experimental_android_resource_shrinking default: "false"
Enables resource shrinking for android_binary APKs that use ProGuard.
Tags: affects_outputs, loading_and_analysis
--[no]experimental_android_rewrite_dexes_with_rex default: "false"
use rex tool to rewrite dex files
Tags: affects_outputs, loading_and_analysis, loses_incremental_state, experimental
--[no]experimental_collect_code_coverage_for_generated_files default: "false"
If specified, Bazel will also generate collect coverage information for generated files.
Tags: affects_outputs
--experimental_objc_fastbuild_options=<comma-separated list of options> default: "-O0,-DDEBUG=1"
Uses these strings as objc fastbuild compiler options.
Tags: action_command_lines
--[no]experimental_omitfp default: "false"
If true, use libunwind for stack unwinding, and compile with -fomit-frame-pointer and -fasynchronous-unwind-tables.
Tags: action_command_lines, affects_outputs, experimental
--experimental_output_paths=<off, content or strip> default: "off"
Which model to use for where in the output tree rules write their outputs, particularly for multi-platform / multi-configuration builds. This is highly experimental. See https://github.com/bazelbuild/bazel/issues/6526 for details. Starlark actions canopt into path mapping by adding the key 'supports-path-mapping' to the 'execution_requirements' dict.
Tags: loses_incremental_state, bazel_internal_configuration, affects_outputs, execution
--experimental_override_name_platform_in_output_dir=<a 'label=value' assignment> multiple uses are accumulated
Each entry should be of the form label=value where label refers to a platform and values is the desired shortname to use in the output path. Only used when --experimental_platform_in_output_dir is true. Has highest naming priority.
Tags: affects_outputs, experimental
--[no]experimental_platform_in_output_dir default: "false"
If true, a shortname for the target platform is used in the output directory name instead of the CPU. The exact scheme is experimental and subject to change: First, in the rare case the --platforms option does not have exactly one value, a hash of the platforms option is used. Next, if any shortname for the current platform was registered by --experimental_override_name_platform_in_output_dir, then that shortname is used. Then, if --experimental_use_platforms_in_output_dir_legacy_heuristic is set, use a shortname based off the current platform Label. Finally, a hash of the platform option is used as a last resort.
Tags: affects_outputs, experimental
--[no]experimental_use_llvm_covmap default: "false"
If specified, Bazel will generate llvm-cov coverage map information rather than gcov when collect_code_coverage is enabled.
Tags: changes_inputs, affects_outputs, loading_and_analysis, experimental
--[no]experimental_use_platforms_in_output_dir_legacy_heuristic default: "true"
Please only use this flag as part of a suggested migration or testing strategy. Note that the heuristic has known deficiencies and it is suggested to migrate to relying on just --experimental_override_name_platform_in_output_dir.
Tags: affects_outputs, experimental
--fat_apk_cpu=<comma-separated set of options> default: "armeabi-v7a"
Setting this option enables fat APKs, which contain native binaries for all specified target architectures, e.g., --fat_apk_cpu=x86,armeabi-v7a. If this flag is specified, then --android_cpu is ignored for dependencies of android_binary rules.
Tags: affects_outputs, loading_and_analysis, loses_incremental_state
--[no]fat_apk_hwasan default: "false"
Whether to create HWASAN splits.
Tags: affects_outputs, loading_and_analysis, loses_incremental_state
--fdo_instrument=<a string> default: see description
Generate binaries with FDO instrumentation. With Clang/LLVM compiler, it also accepts the directory name under which the raw profile file(s) will be dumped at runtime.
Tags: affects_outputs
--fdo_optimize=<a string> default: see description
Use FDO profile information to optimize compilation. Specify the name of a zip file containing a .gcda file tree, an afdo file containing an auto profile, or an LLVM profile file. This flag also accepts files specified as labels (e.g. `//foo/bar:file.afdo` - you may need to add an `exports_files` directive to the corresponding package) and labels pointing to `fdo_profile` targets. This flag will be superseded by the `fdo_profile` rule.
Tags: affects_outputs
--fdo_prefetch_hints=<a build target label> default: see description
Use cache prefetch hints.
Tags: affects_outputs
--fdo_profile=<a build target label> default: see description
The fdo_profile representing the profile to be used for optimization.
Tags: affects_outputs
--features=<a string> multiple uses are accumulated
The given features will be enabled or disabled by default for targets built in the target configuration. Specifying -<feature> will disable the feature. Negative features always override positive ones. See also --host_features
Tags: changes_inputs, affects_outputs
--[no]force_pic default: "false"
If enabled, all C++ compilations produce position-independent code ("-fPIC"), links prefer PIC pre-built libraries over non-PIC libraries, and links produce position-independent executables ("-pie").
Tags: loading_and_analysis, affects_outputs
--host_action_env=<a 'name=value' assignment with an optional value part> multiple uses are accumulated
Specifies the set of environment variables available to actions with execution configurations. Variables can be either specified by name, in which case the value will be taken from the invocation environment, or by the name=value pair which sets the value independent of the invocation environment. This option can be used multiple times; for options given for the same variable, the latest wins, options for different variables accumulate.
Tags: action_command_lines
--host_compilation_mode=<fastbuild, dbg or opt> default: "opt"
Specify the mode the tools used during the build will be built in. Values: 'fastbuild', 'dbg', 'opt'.
Tags: affects_outputs, action_command_lines
--host_conlyopt=<a string> multiple uses are accumulated
Additional option to pass to the C compiler when compiling C (but not C++) source files in the exec configurations.
Tags: action_command_lines, affects_outputs
--host_copt=<a string> multiple uses are accumulated
Additional options to pass to the C compiler for tools built in the exec configurations.
Tags: action_command_lines, affects_outputs
--host_cpu=<a string> default: ""
The host CPU.
Tags: changes_inputs, affects_outputs
--host_cxxopt=<a string> multiple uses are accumulated
Additional options to pass to C++ compiler for tools built in the exec configurations.
Tags: action_command_lines, affects_outputs
--host_features=<a string> multiple uses are accumulated
The given features will be enabled or disabled by default for targets built in the exec configuration. Specifying -<feature> will disable the feature. Negative features always override positive ones.
Tags: changes_inputs, affects_outputs
--host_force_python=<PY2 or PY3> default: see description
Overrides the Python version for the exec configuration. Can be "PY2" or "PY3".
Tags: loading_and_analysis, affects_outputs
--host_linkopt=<a string> multiple uses are accumulated
Additional option to pass to linker when linking tools in the exec configurations.
Tags: action_command_lines, affects_outputs
--host_macos_minimum_os=<a dotted version (for example '2.3' or '3.3alpha2.4')> default: see description
Minimum compatible macOS version for host targets. If unspecified, uses 'macos_sdk_version'.
Tags: loses_incremental_state
--host_per_file_copt=<a comma-separated list of regex expressions with prefix '-' specifying excluded paths followed by an @ and a comma separated list of options> multiple uses are accumulated
Additional options to selectively pass to the C/C++ compiler when compiling certain files in the exec configurations. This option can be passed multiple times. Syntax: regex_filter@option_1,option_2,...,option_n. Where regex_filter stands for a list of include and exclude regular expression patterns (Also see --instrumentation_filter). option_1 to option_n stand for arbitrary command line options. If an option contains a comma it has to be quoted with a backslash. Options can contain @. Only the first @ is used to split the string. Example: --host_per_file_copt=//foo/.*\.cc,-//foo/bar\.cc@-O0 adds the -O0 command line option to the gcc command line of all cc files in //foo/ except bar.cc.
Tags: action_command_lines, affects_outputs
--[no]incompatible_auto_exec_groups default: "false"
When enabled, an exec groups is automatically created for each toolchain used by a rule. For this to work rule needs to specify `toolchain` parameter on its actions. For more information, see https://github.com/bazelbuild/bazel/issues/17134.
Tags: affects_outputs, incompatible_change
--[no]incompatible_merge_genfiles_directory default: "true"
If true, the genfiles directory is folded into the bin directory.
Tags: affects_outputs, incompatible_change
--[no]incompatible_use_host_features default: "true"
If true, use --features only for the target configuration and --host_features for the exec configuration.
Tags: changes_inputs, affects_outputs, incompatible_change
--[no]instrument_test_targets default: "false"
When coverage is enabled, specifies whether to consider instrumenting test rules. When set, test rules included by --instrumentation_filter are instrumented. Otherwise, test rules are always excluded from coverage instrumentation.
Tags: affects_outputs
--instrumentation_filter=<a comma-separated list of regex expressions with prefix '-' specifying excluded paths> default: "-/javatests[/:],-/test/java[/:]"
When coverage is enabled, only rules with names included by the specified regex-based filter will be instrumented. Rules prefixed with '-' are excluded instead. Note that only non-test rules are instrumented unless --instrument_test_targets is enabled.
Tags: affects_outputs
--ios_minimum_os=<a dotted version (for example '2.3' or '3.3alpha2.4')> default: see description
Minimum compatible iOS version for target simulators and devices. If unspecified, uses 'ios_sdk_version'.
Tags: loses_incremental_state
--ios_multi_cpus=<comma-separated list of options> multiple uses are accumulated
Comma-separated list of architectures to build an ios_application with. The result is a universal binary containing all specified architectures.
Tags: loses_incremental_state, loading_and_analysis
--[no]legacy_whole_archive default: "true"
Deprecated, superseded by --incompatible_remove_legacy_whole_archive (see https://github.com/bazelbuild/bazel/issues/7362 for details). When on, use --whole-archive for cc_binary rules that have linkshared=True and either linkstatic=True or '-static' in linkopts. This is for backwards compatibility only. A better alternative is to use alwayslink=1 where required.
Tags: action_command_lines, affects_outputs, deprecated
--linkopt=<a string> multiple uses are accumulated
Additional option to pass to gcc when linking.
Tags: action_command_lines, affects_outputs
--ltobackendopt=<a string> multiple uses are accumulated
Additional option to pass to the LTO backend step (under --features=thin_lto).
Tags: action_command_lines, affects_outputs
--ltoindexopt=<a string> multiple uses are accumulated
Additional option to pass to the LTO indexing step (under --features=thin_lto).
Tags: action_command_lines, affects_outputs
--macos_cpus=<comma-separated list of options> multiple uses are accumulated
Comma-separated list of architectures for which to build Apple macOS binaries.
Tags: loses_incremental_state, loading_and_analysis
--macos_minimum_os=<a dotted version (for example '2.3' or '3.3alpha2.4')> default: see description
Minimum compatible macOS version for targets. If unspecified, uses 'macos_sdk_version'.
Tags: loses_incremental_state
--memprof_profile=<a build target label> default: see description
Use memprof profile.
Tags: affects_outputs
--[no]objc_debug_with_GLIBCXX default: "false"
If set, and compilation mode is set to 'dbg', define GLIBCXX_DEBUG, GLIBCXX_DEBUG_PEDANTIC and GLIBCPP_CONCEPT_CHECKS.
Tags: action_command_lines
--[no]objc_enable_binary_stripping default: "false"
Whether to perform symbol and dead-code strippings on linked binaries. Binary strippings will be performed if both this flag and --compilation_mode=opt are specified.
Tags: action_command_lines
--objccopt=<a string> multiple uses are accumulated
Additional options to pass to gcc when compiling Objective-C/C++ source files.
Tags: action_command_lines
--per_file_copt=<a comma-separated list of regex expressions with prefix '-' specifying excluded paths followed by an @ and a comma separated list of options> multiple uses are accumulated
Additional options to selectively pass to gcc when compiling certain files. This option can be passed multiple times. Syntax: regex_filter@option_1,option_2,...,option_n. Where regex_filter stands for a list of include and exclude regular expression patterns (Also see --instrumentation_filter). option_1 to option_n stand for arbitrary command line options. If an option contains a comma it has to be quoted with a backslash. Options can contain @. Only the first @ is used to split the string. Example: --per_file_copt=//foo/.*\.cc,-//foo/bar\.cc@-O0 adds the -O0 command line option to the gcc command line of all cc files in //foo/ except bar.cc.
Tags: action_command_lines, affects_outputs
--per_file_ltobackendopt=<a comma-separated list of regex expressions with prefix '-' specifying excluded paths followed by an @ and a comma separated list of options> multiple uses are accumulated
Additional options to selectively pass to LTO backend (under --features=thin_lto) when compiling certain backend objects. This option can be passed multiple times. Syntax: regex_filter@option_1,option_2,...,option_n. Where regex_filter stands for a list of include and exclude regular expression patterns. option_1 to option_n stand for arbitrary command line options. If an option contains a comma it has to be quoted with a backslash. Options can contain @. Only the first @ is used to split the string. Example: --per_file_ltobackendopt=//foo/.*\.o,-//foo/bar\.o@-O0 adds the -O0 command line option to the LTO backend command line of all o files in //foo/ except bar.o.
Tags: action_command_lines, affects_outputs
--platform_suffix=<a string> default: see description
Specifies a suffix to be added to the configuration directory.
Tags: loses_incremental_state, affects_outputs, loading_and_analysis
--propeller_optimize=<a build target label> default: see description
Use Propeller profile information to optimize the build target.A propeller profile must consist of at least one of two files, a cc profile and a ld profile. This flag accepts a build label which must refer to the propeller profile input files. For example, the BUILD file that defines the label, in a/b/BUILD:propeller_optimize( name = "propeller_profile", cc_profile = "propeller_cc_profile.txt", ld_profile = "propeller_ld_profile.txt",)An exports_files directive may have to be added to the corresponding package to make these files visible to Bazel. The option must be used as: --propeller_optimize=//a/b:propeller_profile
Tags: action_command_lines, affects_outputs
--propeller_optimize_absolute_cc_profile=<a string> default: see description
Absolute path name of cc_profile file for Propeller Optimized builds.
Tags: affects_outputs
--propeller_optimize_absolute_ld_profile=<a string> default: see description
Absolute path name of ld_profile file for Propeller Optimized builds.
Tags: affects_outputs
--run_under=<a prefix in front of command> default: see description
Prefix to insert before the executables for the 'test' and 'run' commands. If the value is 'foo -bar', and the execution command line is 'test_binary -baz', then the final command line is 'foo -bar test_binary -baz'.This can also be a label to an executable target. Some examples are: 'valgrind', 'strace', 'strace -c', 'valgrind --quiet --num-callers=20', '//package:target', '//package:target --options'.
Tags: action_command_lines
--[no]share_native_deps default: "true"
If true, native libraries that contain identical functionality will be shared among different targets
Tags: loading_and_analysis, affects_outputs
--[no]stamp default: "false"
Stamp binaries with the date, username, hostname, workspace information, etc.
Tags: affects_outputs
--strip=<always, sometimes or never> default: "sometimes"
Specifies whether to strip binaries and shared libraries (using "-Wl,--strip-debug"). The default value of 'sometimes' means strip iff --compilation_mode=fastbuild.
Tags: affects_outputs
--stripopt=<a string> multiple uses are accumulated
Additional options to pass to strip when generating a '<name>.stripped' binary.
Tags: action_command_lines, affects_outputs
--swiftcopt=<a string> multiple uses are accumulated
Additional options to pass to Swift compilation.
Tags: action_command_lines
--tvos_cpus=<comma-separated list of options> multiple uses are accumulated
Comma-separated list of architectures for which to build Apple tvOS binaries.
Tags: loses_incremental_state, loading_and_analysis
--tvos_minimum_os=<a dotted version (for example '2.3' or '3.3alpha2.4')> default: see description
Minimum compatible tvOS version for target simulators and devices. If unspecified, uses 'tvos_sdk_version'.
Tags: loses_incremental_state
--visionos_cpus=<comma-separated list of options> multiple uses are accumulated
Comma-separated list of architectures for which to build Apple visionOS binaries.
Tags: loses_incremental_state, loading_and_analysis
--watchos_cpus=<comma-separated list of options> multiple uses are accumulated
Comma-separated list of architectures for which to build Apple watchOS binaries.
Tags: loses_incremental_state, loading_and_analysis
--watchos_minimum_os=<a dotted version (for example '2.3' or '3.3alpha2.4')> default: see description
Minimum compatible watchOS version for target simulators and devices. If unspecified, uses 'watchos_sdk_version'.
Tags: loses_incremental_state
--xbinary_fdo=<a build target label> default: see description
Use XbinaryFDO profile information to optimize compilation. Specify the name of default cross binary profile. When the option is used together with --fdo_instrument/--fdo_optimize/--fdo_profile, those options will always prevail as if xbinary_fdo is never specified.
Tags: affects_outputs
Options that affect how strictly Bazel enforces valid build inputs (rule definitions, flag combinations, etc.):
--auto_cpu_environment_group=<a build target label> default: ""
Declare the environment_group to use for automatically mapping cpu values to target_environment values.
Tags: changes_inputs, loading_and_analysis, experimental
--[no]check_licenses default: "false"
Check that licensing constraints imposed by dependent packages do not conflict with distribution modes of the targets being built. By default, licenses are not checked.
Tags: build_file_semantics
--[no]check_visibility default: "true"
If disabled, visibility errors in target dependencies are demoted to warnings.
Tags: build_file_semantics
--[no]desugar_for_android default: "true"
Whether to desugar Java 8 bytecode before dexing.
Tags: affects_outputs, loading_and_analysis, loses_incremental_state
--[no]desugar_java8_libs default: "false"
Whether to include supported Java 8 libraries in apps for legacy devices.
Tags: affects_outputs, loading_and_analysis, loses_incremental_state, experimental
--[no]enforce_constraints default: "true"
Checks the environments each target is compatible with and reports errors if any target has dependencies that don't support the same environments
Tags: build_file_semantics
--[no]experimental_check_desugar_deps default: "true"
Whether to double-check correct desugaring at Android binary level.
Tags: eagerness_to_exit, loading_and_analysis, experimental
--experimental_import_deps_checking=<off, warning or error> default: "OFF"
When enabled, check whether the dependencies of an aar_import are complete. This enforcement can break the build, or can just result in warnings.
Tags: loading_and_analysis
--experimental_strict_java_deps=<off, warn, error, strict or default> default: "default"
If true, checks that a Java target explicitly declares all directly used targets as dependencies.
Tags: build_file_semantics, eagerness_to_exit
--[no]incompatible_check_testonly_for_output_files default: "false"
If enabled, check testonly for prerequisite targets that are output files by looking up the testonly of the generating rule. This matches visibility checking.
Tags: build_file_semantics, incompatible_change
--[no]incompatible_check_visibility_for_toolchains default: "false"
If enabled, visibility checking also applies to toolchain implementations.
Tags: build_file_semantics, incompatible_change
--[no]incompatible_disable_native_android_rules default: "false"
If enabled, direct usage of the native Android rules is disabled. Please use the Starlark Android rules from https://github.com/bazelbuild/rules_android
Tags: eagerness_to_exit, incompatible_change
--[no]incompatible_disable_native_apple_binary_rule default: "false"
No-op. Kept here for backwards compatibility.
Tags: eagerness_to_exit, incompatible_change
--[no]incompatible_python_disable_py2 default: "true"
If true, using Python 2 settings will cause an error. This includes python_version=PY2, srcs_version=PY2, and srcs_version=PY2ONLY. See https://github.com/bazelbuild/bazel/issues/15684 for more information.
Tags: loading_and_analysis, incompatible_change
--[no]incompatible_validate_top_level_header_inclusions default: "true"
If true, Bazel will also validate top level directory header inclusions (see https://github.com/bazelbuild/bazel/issues/10047 for more information).
Tags: loading_and_analysis, incompatible_change
--python_native_rules_allowlist=<a build target label> default: see description
An allowlist (package_group target) to use when enforcing --incompatible_python_disallow_native_rules.
Tags: loading_and_analysis
--[no]strict_filesets default: "false"
If this option is enabled, filesets crossing package boundaries are reported as errors.
Tags: build_file_semantics, eagerness_to_exit
--strict_proto_deps=<off, warn, error, strict or default> default: "error"
Unless OFF, checks that a proto_library target explicitly declares all directly used targets as dependencies.
Tags: build_file_semantics, eagerness_to_exit, incompatible_change
--strict_public_imports=<off, warn, error, strict or default> default: "off"
Unless OFF, checks that a proto_library target explicitly declares all targets used in 'import public' as exported.
Tags: build_file_semantics, eagerness_to_exit, incompatible_change
--[no]strict_system_includes default: "false"
If true, headers found through system include paths (-isystem) are also required to be declared.
Tags: loading_and_analysis, eagerness_to_exit
--target_environment=<a build target label> multiple uses are accumulated
Declares this build's target environment. Must be a label reference to an "environment" rule. If specified, all top-level targets must be compatible with this environment.
Tags: changes_inputs
Options that affect the signing outputs of a build:
--apk_signing_method=<v1, v2, v1_v2 or v4> default: "v1_v2"
Implementation to use to sign APKs
Tags: action_command_lines, affects_outputs, loading_and_analysis
--[no]device_debug_entitlements default: "true"
If set, and compilation mode is not 'opt', objc apps will include debug entitlements when signing.
Tags: changes_inputs
--ios_signing_cert_name=<a string> default: see description
Certificate name to use for iOS signing. If not set will fall back to provisioning profile. May be the certificate's keychain identity preference or (substring) of the certificate's common name, as per codesign's man page (SIGNING IDENTITIES).
Tags: action_command_lines
This option affects semantics of the Starlark language or the build API accessible to BUILD files, .bzl files, or WORKSPACE files.:
--[no]incompatible_disallow_legacy_py_provider default: "true"
No-op, will be removed soon.
Tags: loading_and_analysis, incompatible_change
--[no]incompatible_disallow_sdk_frameworks_attributes default: "false"
If true, disallow sdk_frameworks and weak_sdk_frameworks attributes in objc_library andobjc_import.
Tags: build_file_semantics, incompatible_change
If true, make the default value true for alwayslink attributes in objc_library and objc_import.
Tags: build_file_semantics, incompatible_change
--[no]incompatible_python_disallow_native_rules default: "false"
When true, an error occurs when using the builtin py_* rules; instead the rule_python rules should be used. See https://github.com/bazelbuild/bazel/issues/17773 for more information and migration instructions.
Tags: loading_and_analysis, incompatible_change
Options that govern the behavior of the test environment or test runner:
--[no]allow_analysis_failures default: "false"
If true, an analysis failure of a rule target results in the target's propagation of an instance of AnalysisFailureInfo containing the error description, instead of resulting in a build failure.
Tags: loading_and_analysis, experimental
--analysis_testing_deps_limit=<an integer> default: "2000"
Sets the maximum number of transitive dependencies through a rule attribute with a for_analysis_testing configuration transition. Exceeding this limit will result in a rule error.
Tags: loading_and_analysis
--[no]break_build_on_parallel_dex2oat_failure default: "false"
If true dex2oat action failures will cause the build to break instead of executing dex2oat during test runtime.
Tags: loading_and_analysis, experimental
--[no]experimental_android_use_parallel_dex2oat default: "false"
Use dex2oat in parallel to possibly speed up android_test.
Tags: loading_and_analysis, host_machine_resource_optimizations, experimental
--[no]ios_memleaks default: "false"
Enable checking for memory leaks in ios_test targets.
Tags: action_command_lines
--ios_simulator_device=<a string> default: see description
The device to simulate when running an iOS application in the simulator, e.g. 'iPhone 6'. You can get a list of devices by running 'xcrun simctl list devicetypes' on the machine the simulator will be run on.
Tags: test_runner
--ios_simulator_version=<a dotted version (for example '2.3' or '3.3alpha2.4')> default: see description
The version of iOS to run on the simulator when running or testing. This is ignored for ios_test rules if a target device is specified in the rule.
Tags: test_runner
--runs_per_test=<a positive integer or test_regex@runs. This flag may be passed more than once> multiple uses are accumulated
Specifies number of times to run each test. If any of those attempts fail for any reason, the whole test is considered failed. Normally the value specified is just an integer. Example: --runs_per_test=3 will run all tests 3 times. Alternate syntax: regex_filter@runs_per_test. Where runs_per_test stands for an integer value and regex_filter stands for a list of include and exclude regular expression patterns (Also see --instrumentation_filter). Example: --runs_per_test=//foo/.*,-//foo/bar/.*@3 runs all tests in //foo/ except those under foo/bar three times. This option can be passed multiple times. The most recently passed argument that matches takes precedence. If nothing matches, the test is only run once.
--test_env=<a 'name=value' assignment with an optional value part> multiple uses are accumulated
Specifies additional environment variables to be injected into the test runner environment. Variables can be either specified by name, in which case its value will be read from the Bazel client environment, or by the name=value pair. This option can be used multiple times to specify several variables. Used only by the 'bazel test' command.
Tags: test_runner
--test_timeout=<a single integer or comma-separated list of 4 integers> default: "-1"
Override the default test timeout values for test timeouts (in secs). If a single positive integer value is specified it will override all categories. If 4 comma-separated integers are specified, they will override the timeouts for short, moderate, long and eternal (in that order). In either form, a value of -1 tells blaze to use its default timeouts for that category.
--[no]zip_undeclared_test_outputs default: "true"
If true, undeclared test outputs will be archived in a zip file.
Tags: test_runner
Options relating to query output and semantics:
--aspect_deps=<off, conservative or precise> default: "conservative"
How to resolve aspect dependencies when the output format is one of {xml,proto,record}. 'off' means no aspect dependencies are resolved, 'conservative' (the default) means all declared aspect dependencies are added regardless of whether they are given the rule class of direct dependencies, 'precise' means that only those aspects are added that are possibly active given the rule class of the direct dependencies. Note that precise mode requires loading other packages to evaluate a single target thus making it slower than the other modes. Also note that even precise mode is not completely precise: the decision whether to compute an aspect is decided in the analysis phase, which is not run during 'bazel query'.
Tags: build_file_semantics
--[no]consistent_labels default: "false"
If enabled, every query command emits labels as if by the Starlark <code>str</code> function applied to a <code>Label</code> instance. This is useful for tools that need to match the output of different query commands and/or labels emitted by rules. If not enabled, output formatters are free to emit apparent repository names (relative to the main repository) instead to make the output more readable.
Tags: terminal_output
--[no]graph:factored default: "true"
If true, then the graph will be emitted 'factored', i.e. topologically-equivalent nodes will be merged together and their labels concatenated. This option is only applicable to --output=graph.
Tags: terminal_output
--graph:node_limit=<an integer> default: "512"
The maximum length of the label string for a graph node in the output. Longer labels will be truncated; -1 means no truncation. This option is only applicable to --output=graph.
Tags: terminal_output
--[no]implicit_deps default: "true"
If enabled, implicit dependencies will be included in the dependency graph over which the query operates. An implicit dependency is one that is not explicitly specified in the BUILD file but added by bazel. For cquery, this option controls filtering resolved toolchains.
Tags: build_file_semantics
--[no]include_artifacts default: "true"
Includes names of the action inputs and outputs in the output (potentially large).
Tags: terminal_output
--[no]include_aspects default: "true"
aquery, cquery: whether to include aspect-generated actions in the output. query: no-op (aspects are always followed).
Tags: terminal_output
--[no]include_commandline default: "true"
Includes the content of the action command lines in the output (potentially large).
Tags: terminal_output
--[no]include_file_write_contents default: "false"
Include the file contents for the FileWrite, SourceSymlinkManifest, and RepoMappingManifest actions (potentially large).
Tags: terminal_output
--[no]include_param_files default: "false"
Include the content of the param files used in the command (potentially large). Note: Enabling this flag will automatically enable the --include_commandline flag.
Tags: terminal_output
--[no]include_scheduling_dependencies default: "false"
Includes names of the scheduling dependencies of actions (potentially large). Only takes effect if --include_artifacts is also set.
Tags: terminal_output
--[no]incompatible_package_group_includes_double_slash default: "true"
If enabled, when outputting package_group's `packages` attribute, the leading `//` will not be omitted.
Tags: terminal_output, incompatible_change
--[no]infer_universe_scope default: "false"
If set and --universe_scope is unset, then a value of --universe_scope will be inferred as the list of unique target patterns in the query expression. Note that the --universe_scope value inferred for a query expression that uses universe-scoped functions (e.g.`allrdeps`) may not be what you want, so you should use this option only if you know what you are doing. See https://bazel.build/reference/query#sky-query for details and examples. If --universe_scope is set, then this option's value is ignored. Note: this option applies only to `query` (i.e. not `cquery`).
Tags: loading_and_analysis
--[no]line_terminator_null default: "false"
Whether each format is terminated with \0 instead of newline.
Tags: terminal_output
--[no]nodep_deps default: "true"
If enabled, deps from "nodep" attributes will be included in the dependency graph over which the query operates. A common example of a "nodep" attribute is "visibility". Run and parse the output of `info build-language` to learn about all the "nodep" attributes in the build language.
Tags: build_file_semantics
--output=<a string> default: "text"
The format in which the aquery results should be printed. Allowed values for aquery are: text, textproto, proto, streamed_proto, jsonproto.
Tags: terminal_output
--[no]proto:default_values default: "true"
If true, attributes whose value is not explicitly specified in the BUILD file are included; otherwise they are omitted. This option is applicable to --output=proto
Tags: terminal_output
--[no]proto:definition_stack default: "false"
Populate the definition_stack proto field, which records for each rule instance the Starlark call stack at the moment the rule's class was defined.
Tags: terminal_output
--[no]proto:flatten_selects default: "true"
If enabled, configurable attributes created by select() are flattened. For list types the flattened representation is a list containing each value of the select map exactly once. Scalar types are flattened to null.
Tags: build_file_semantics
--[no]proto:include_attribute_source_aspects default: "false"
Populate the source_aspect_name proto field of each Attribute with the source aspect that the attribute came from (empty string if it did not).
Tags: terminal_output
--[no]proto:include_synthetic_attribute_hash default: "false"
Whether or not to calculate and populate the $internal_attr_hash attribute.
Tags: terminal_output
--[no]proto:instantiation_stack default: "false"
Populate the instantiation call stack of each rule. Note that this requires the stack to be present
Tags: terminal_output
--[no]proto:locations default: "true"
Whether to output location information in proto output at all.
Tags: terminal_output
--proto:output_rule_attrs=<comma-separated list of options> default: "all"
Comma separated list of attributes to include in output. Defaults to all attributes. Set to empty string to not output any attribute. This option is applicable to --output=proto.
Tags: terminal_output
--[no]proto:rule_inputs_and_outputs default: "true"
Whether or not to populate the rule_input and rule_output fields.
Tags: terminal_output
--query_file=<a string> default: ""
If set, query will read the query from the file named here, rather than on the command line. It is an error to specify a file here as well as a command-line query.
Tags: changes_inputs
--[no]relative_locations default: "false"
If true, the location of BUILD files in xml and proto outputs will be relative. By default, the location output is an absolute path and will not be consistent across machines. You can set this option to true to have a consistent result across machines.
Tags: terminal_output
--[no]skyframe_state default: "false"
Without performing extra analysis, dump the current Action Graph from Skyframe. Note: Specifying a target with --skyframe_state is currently not supported. This flag is only available with --output=proto or --output=textproto.
Tags: terminal_output
--[no]tool_deps default: "true"
Query: If disabled, dependencies on 'exec configuration' will not be included in the dependency graph over which the query operates. An 'exec configuration' dependency edge, such as the one from any 'proto_library' rule to the Protocol Compiler, usually points to a tool executed during the build rather than a part of the same 'target' program. Cquery: If disabled, filters out all configured targets which cross an execution transition from the top-level target that discovered this configured target. That means if the top-level target is in the target configuration, only configured targets also in the target configuration will be returned. If the top-level target is in the exec configuration, only exec configured targets will be returned. This option will NOT exclude resolved toolchains.
Tags: build_file_semantics
--universe_scope=<comma-separated list of options> default: ""
A comma-separated set of target patterns (additive and subtractive). The query may be performed in the universe defined by the transitive closure of the specified targets. This option is used for the query and cquery commands. For cquery, the input to this option is the targets all answers are built under and so this option may affect configurations and transitions. If this option is not specified, the top-level targets are assumed to be the targets parsed from the query expression. Note: For cquery, not specifying this option may cause the build to break if targets parsed from the query expression are not buildable with top-level options.
Tags: loading_and_analysis
Options that trigger optimizations of the build time:
--[no]experimental_filter_library_jar_with_program_jar default: "false"
Filter the ProGuard ProgramJar to remove any classes also present in the LibraryJar.
Tags: action_command_lines
--[no]experimental_inmemory_dotd_files default: "true"
If enabled, C++ .d files will be passed through in memory directly from the remote build nodes instead of being written to disk.
Tags: loading_and_analysis, execution, affects_outputs, experimental
--[no]experimental_inmemory_jdeps_files default: "true"
If enabled, the dependency (.jdeps) files generated from Java compilations will be passed through in memory directly from the remote build nodes instead of being written to disk.
Tags: loading_and_analysis, execution, affects_outputs, experimental
--[no]experimental_objc_include_scanning default: "false"
Whether to perform include scanning for objective C/C++.
Tags: loading_and_analysis, execution, changes_inputs
--[no]experimental_retain_test_configuration_across_testonly default: "false"
When enabled, --trim_test_configuration will not trim the test configuration for rules marked testonly=1. This is meant to reduce action conflict issues when non-test rules depend on cc_test rules. No effect if --trim_test_configuration is false.
Tags: loading_and_analysis, loses_incremental_state
--[no]experimental_starlark_cc_import default: "false"
If enabled, the Starlark version of cc_import can be used.
Tags: loading_and_analysis, experimental
--[no]experimental_unsupported_and_brittle_include_scanning default: "false"
Whether to narrow inputs to C/C++ compilation by parsing #include lines from input files. This can improve performance and incrementality by decreasing the size of compilation input trees. However, it can also break builds because the include scanner does not fully implement C preprocessor semantics. In particular, it does not understand dynamic #include directives and ignores preprocessor conditional logic. Use at your own risk. Any issues relating to this flag that are filed will be closed.
Tags: loading_and_analysis, execution, changes_inputs
--[no]incremental_dexing default: "true"
Does most of the work for dexing separately for each Jar file.
Tags: affects_outputs, loading_and_analysis, loses_incremental_state
--[no]objc_use_dotd_pruning default: "true"
If set, .d files emitted by clang will be used to prune the set of inputs passed into objc compiles.
Tags: changes_inputs, loading_and_analysis
--[no]process_headers_in_dependencies default: "false"
When building a target //a:a, process headers in all targets that //a:a depends on (if header processing is enabled for the toolchain).
Tags: execution
--[no]trim_test_configuration default: "true"
When enabled, test-related options will be cleared below the top level of the build. When this flag is active, tests cannot be built as dependencies of non-test rules, but changes to test-related options will not cause non-test rules to be re-analyzed.
Tags: loading_and_analysis, loses_incremental_state
Options that affect the verbosity, format or location of logging:
--toolchain_resolution_debug=<a comma-separated list of regex expressions with prefix '-' specifying excluded paths> default: "-.*"
Print debug information during toolchain resolution. The flag takes a regex, which is checked against toolchain types and specific targets to see which to debug. Multiple regexes may be separated by commas, and then each regex is checked separately. Note: The output of this flag is very complex and will likely only be useful to experts in toolchain resolution.
Tags: terminal_output
Options specifying or altering a generic input to a Bazel command that does not fall into other categories.:
--flag_alias=<a 'name=value' flag alias> multiple uses are accumulated
Sets a shorthand name for a Starlark flag. It takes a single key-value pair in the form "<key>=<value>" as an argument.
Tags: changes_inputs
--[no]incompatible_default_to_explicit_init_py default: "false"
This flag changes the default behavior so that __init__.py files are no longer automatically created in the runfiles of Python targets. Precisely, when a py_binary or py_test target has legacy_create_init set to "auto" (the default), it is treated as false if and only if this flag is set. See https://github.com/bazelbuild/bazel/issues/10076.
Tags: affects_outputs, incompatible_change
--[no]incompatible_py2_outputs_are_suffixed default: "true"
If true, targets built in the Python 2 configuration will appear under an output root that includes the suffix '-py2', while targets built for Python 3 will appear in a root with no Python-related suffix. This means that the `bazel-bin` convenience symlink will point to Python 3 targets rather than Python 2. If you enable this option it is also recommended to enable `--incompatible_py3_is_default`.
Tags: affects_outputs, incompatible_change
--[no]incompatible_py3_is_default default: "true"
If true, `py_binary` and `py_test` targets that do not set their `python_version` (or `default_python_version`) attribute will default to PY3 rather than to PY2. If you set this flag it is also recommended to set `--incompatible_py2_outputs_are_suffixed`.
Tags: loading_and_analysis, affects_outputs, incompatible_change
--[no]incompatible_use_python_toolchains default: "true"
If set to true, executable native Python rules will use the Python runtime specified by the Python toolchain, rather than the runtime given by legacy flags like --python_top.
Tags: loading_and_analysis, incompatible_change
--python_version=<PY2 or PY3> default: see description
The Python major version mode, either `PY2` or `PY3`. Note that this is overridden by `py_binary` and `py_test` targets (even if they don't explicitly specify a version) so there is usually not much reason to supply this flag.
Tags: loading_and_analysis, affects_outputs
Miscellaneous options, not otherwise categorized.:
--[no]cache_test_results [-t] default: "auto"
If set to 'auto', Bazel reruns a test if and only if: (1) Bazel detects changes in the test or its dependencies, (2) the test is marked as external, (3) multiple test runs were requested with --runs_per_test, or(4) the test previously failed. If set to 'yes', Bazel caches all test results except for tests marked as external. If set to 'no', Bazel does not cache any test results.
--[no]experimental_cancel_concurrent_tests default: "false"
If true, then Blaze will cancel concurrently running tests on the first successful run. This is only useful in combination with --runs_per_test_detects_flakes.
Tags: affects_outputs, loading_and_analysis
--[no]experimental_fetch_all_coverage_outputs default: "false"
If true, then Bazel fetches the entire coverage data directory for each test during a coverage run.
Tags: affects_outputs, loading_and_analysis
--[no]experimental_generate_llvm_lcov default: "false"
If true, coverage for clang will generate an LCOV report.
Tags: affects_outputs, loading_and_analysis
--[no]experimental_j2objc_header_map default: "true"
Whether to generate J2ObjC header map in parallel of J2ObjC transpilation.
--[no]experimental_j2objc_shorter_header_path default: "false"
Whether to generate with shorter header path (uses "_ios" instead of "_j2objc").
Tags: affects_outputs
--experimental_java_classpath=<off, javabuilder or bazel> default: "javabuilder"
Enables reduced classpaths for Java compilations.
--[no]experimental_limit_android_lint_to_android_constrained_java default: "false"
Limit --experimental_run_android_lint_on_java_rules to Android-compatible libraries.
Tags: affects_outputs
--[no]experimental_run_android_lint_on_java_rules default: "false"
Whether to validate java_* sources.
Tags: affects_outputs
--[no]explicit_java_test_deps default: "false"
Explicitly specify a dependency to JUnit or Hamcrest in a java_test instead of accidentally obtaining from the TestRunner's deps. Only works for bazel right now.
--host_java_launcher=<a build target label> default: see description
The Java launcher used by tools that are executed during a build.
--host_javacopt=<a string> multiple uses are accumulated
Additional options to pass to javac when building tools that are executed during a build.
--host_jvmopt=<a string> multiple uses are accumulated
Additional options to pass to the Java VM when building tools that are executed during the build. These options will get added to the VM startup options of each java_binary target.
--[no]incompatible_check_sharding_support default: "true"
If true, Bazel will fail a sharded test if the test runner does not indicate that it supports sharding by touching the file at the path in TEST_SHARD_STATUS_FILE. If false, a test runner that does not support sharding will lead to all tests running in each shard.
Tags: incompatible_change
--[no]incompatible_exclusive_test_sandboxed default: "true"
If true, exclusive tests will run with sandboxed strategy. Add 'local' tag to force an exclusive test run locally
Tags: incompatible_change
--[no]incompatible_strict_action_env default: "false"
If true, Bazel uses an environment with a static value for PATH and does not inherit LD_LIBRARY_PATH. Use --action_env=ENV_VARIABLE if you want to inherit specific environment variables from the client, but note that doing so can prevent cross-user caching if a shared cache is used.
Tags: loading_and_analysis, incompatible_change
--j2objc_translation_flags=<comma-separated list of options> multiple uses are accumulated
Additional options to pass to the J2ObjC tool.
--java_debug
Causes the Java virtual machine of a java test to wait for a connection from a JDWP-compliant debugger (such as jdb) before starting the test. Implies -test_output=streamed.
Expands to:
  --test_arg=--wrapper_script_flag=--debug
  --test_output=streamed
  --test_strategy=exclusive
  --test_timeout=9999
  --nocache_test_results
--[no]java_deps default: "true"
Generate dependency information (for now, compile-time classpath) per Java target.
--[no]java_header_compilation default: "true"
Compile ijars directly from source.
--java_language_version=<a string> default: ""
The Java language version
--java_launcher=<a build target label> default: see description
The Java launcher to use when building Java binaries. If this flag is set to the empty string, the JDK launcher is used. The "launcher" attribute overrides this flag.
--java_runtime_version=<a string> default: "local_jdk"
The Java runtime version
--javacopt=<a string> multiple uses are accumulated
Additional options to pass to javac.
--jvmopt=<a string> multiple uses are accumulated
Additional options to pass to the Java VM. These options will get added to the VM startup options of each java_binary target.
--legacy_main_dex_list_generator=<a build target label> default: see description
Specifies a binary to use to generate the list of classes that must be in the main dex when compiling legacy multidex.
--optimizing_dexer=<a build target label> default: see description
Specifies a binary to use to do dexing without sharding.
--plugin=<a build target label> multiple uses are accumulated
Plugins to use in the build. Currently works with java_plugin.
--proguard_top=<a build target label> default: see description
Specifies which version of ProGuard to use for code removal when building a Java binary.
--proto_compiler=<a build target label> default: "@bazel_tools//tools/proto:protoc"
The label of the proto-compiler.
Tags: affects_outputs, loading_and_analysis
--proto_toolchain_for_cc=<a build target label> default: "@bazel_tools//tools/proto:cc_toolchain"
Label of proto_lang_toolchain() which describes how to compile C++ protos
Tags: affects_outputs, loading_and_analysis
--proto_toolchain_for_j2objc=<a build target label> default: "@bazel_tools//tools/j2objc:j2objc_proto_toolchain"
Label of proto_lang_toolchain() which describes how to compile j2objc protos
Tags: affects_outputs, loading_and_analysis
--proto_toolchain_for_java=<a build target label> default: "@bazel_tools//tools/proto:java_toolchain"
Label of proto_lang_toolchain() which describes how to compile Java protos
Tags: affects_outputs, loading_and_analysis
--proto_toolchain_for_javalite=<a build target label> default: "@bazel_tools//tools/proto:javalite_toolchain"
Label of proto_lang_toolchain() which describes how to compile JavaLite protos
Tags: affects_outputs, loading_and_analysis
--protocopt=<a string> multiple uses are accumulated
Additional options to pass to the protobuf compiler.
Tags: affects_outputs
--[no]runs_per_test_detects_flakes default: "false"
If true, any shard in which at least one run/attempt passes and at least one run/attempt fails gets a FLAKY status.
--shell_executable=<a path> default: see description
Absolute path to the shell executable for Bazel to use. If this is unset, but the BAZEL_SH environment variable is set on the first Bazel invocation (that starts up a Bazel server), Bazel uses that. If neither is set, Bazel uses a hard-coded default path depending on the operating system it runs on (Windows: c:/tools/msys64/usr/bin/bash.exe, FreeBSD: /usr/local/bin/bash, all others: /bin/bash). Note that using a shell that is not compatible with bash may lead to build failures or runtime failures of the generated binaries.
Tags: loading_and_analysis
--test_arg=<a string> multiple uses are accumulated
Specifies additional options and arguments that should be passed to the test executable. Can be used multiple times to specify several arguments. If multiple tests are executed, each of them will receive identical arguments. Used only by the 'bazel test' command.
--test_filter=<a string> default: see description
Specifies a filter to forward to the test framework. Used to limit the tests run. Note that this does not affect which targets are built.
--test_result_expiration=<an integer> default: "-1"
This option is deprecated and has no effect.
--[no]test_runner_fail_fast default: "false"
Forwards fail fast option to the test runner. The test runner should stop execution upon first failure.
--test_sharding_strategy=<explicit, disabled or forced=k where k is the number of shards to enforce> default: "explicit"
Specify strategy for test sharding: 'explicit' to only use sharding if the 'shard_count' BUILD attribute is present. 'disabled' to never use test sharding. 'forced=k' to enforce 'k' shards for testing regardless of the 'shard_count' BUILD attribute.
--tool_java_language_version=<a string> default: ""
The Java language version used to execute the tools that are needed during a build
--tool_java_runtime_version=<a string> default: "remotejdk_11"
The Java runtime version used to execute tools during the build
--[no]use_ijars default: "true"
If enabled, this option causes Java compilation to use interface jars. This will result in faster incremental compilation, but error messages can be different.

Build Options

Options that appear before the command and are parsed by the client:
--distdir=<a path> multiple uses are accumulated
Additional places to search for archives before accessing the network to download them.
Tags: bazel_internal_configuration
If set, the repository cache will hardlink the file in case of a cache hit, rather than copying. This is intended to save disk space.
Tags: bazel_internal_configuration
--experimental_repository_downloader_retries=<an integer> default: "0"
The maximum number of attempts to retry a download error. If set to 0, retries are disabled.
Tags: experimental
--experimental_scale_timeouts=<a double> default: "1.0"
Scale all timeouts in Starlark repository rules by this factor. In this way, external repositories can be made working on machines that are slower than the rule author expected, without changing the source code
Tags: bazel_internal_configuration, experimental
--http_connector_attempts=<an integer> default: "8"
The maximum number of attempts for http downloads.
Tags: bazel_internal_configuration
--http_connector_retry_max_timeout=<An immutable length of time.> default: "0s"
The maximum timeout for http download retries. With a value of 0, no timeout maximum is defined.
Tags: bazel_internal_configuration
--http_timeout_scaling=<a double> default: "1.0"
Scale all timeouts related to http downloads by the given factor
Tags: bazel_internal_configuration
--repository_cache=<a path> default: see description
Specifies the cache location of the downloaded values obtained during the fetching of external repositories. An empty string as argument requests the cache to be disabled, otherwise the default of '<output_user_root>/cache/repos/v1' is used
Tags: bazel_internal_configuration
--[no]repository_disable_download default: "false"
If set, downloading using ctx.download{,_and_extract} is not allowed during repository fetching. Note that network access is not completely disabled; ctx.execute could still run an arbitrary executable that accesses the Internet.
Tags: bazel_internal_configuration
Options that control build execution:
--[no]check_up_to_date default: "false"
Don't perform the build, just check if it is up-to-date. If all targets are up-to-date, the build completes successfully. If any step needs to be executed an error is reported and the build fails.
Tags: execution
--dynamic_local_execution_delay=<an integer> default: "1000"
How many milliseconds should local execution be delayed, if remote execution was faster during a build at least once?
Tags: execution, host_machine_resource_optimizations
--dynamic_local_strategy=<a '[name=]value1[,..,valueN]' assignment> multiple uses are accumulated
The local strategies, in order, to use for the given mnemonic - the first applicable strategy is used. For example, `worker,sandboxed` runs actions that support persistent workers using the worker strategy, and all others using the sandboxed strategy. If no mnemonic is given, the list of strategies is used as the fallback for all mnemonics. The default fallback list is `worker,sandboxed`, or`worker,sandboxed,standalone` if `experimental_local_lockfree_output` is set. Takes [mnemonic=]local_strategy[,local_strategy,...]
Tags: execution, host_machine_resource_optimizations
--dynamic_remote_strategy=<a '[name=]value1[,..,valueN]' assignment> multiple uses are accumulated
The remote strategies, in order, to use for the given mnemonic - the first applicable strategy is used. If no mnemonic is given, the list of strategies is used as the fallback for all mnemonics. The default fallback list is `remote`, so this flag usually does not need to be set explicitly. Takes [mnemonic=]remote_strategy[,remote_strategy,...]
Tags: execution, host_machine_resource_optimizations
--experimental_docker_image=<a string> default: ""
Specify a Docker image name (e.g. "ubuntu:latest") that should be used to execute a sandboxed action when using the docker strategy and the action itself doesn't already have a container-image attribute in its remote_execution_properties in the platform description. The value of this flag is passed verbatim to 'docker run', so it supports the same syntax and mechanisms as Docker itself.
Tags: execution
--[no]experimental_docker_use_customized_images default: "true"
If enabled, injects the uid and gid of the current user into the Docker image before using it. This is required if your build / tests depend on the user having a name and home directory inside the container. This is on by default, but you can disable it in case the automatic image customization feature doesn't work in your case or you know that you don't need it.
Tags: execution
--[no]experimental_dynamic_exclude_tools default: "true"
When set, targets that are build "for tool" are not subject to dynamic execution. Such targets are extremely unlikely to be built incrementally and thus not worth spending local cycles on.
Tags: execution, host_machine_resource_optimizations
--experimental_dynamic_local_load_factor=<a double> default: "0"
Controls how much load from dynamic execution to put on the local machine. This flag adjusts how many actions in dynamic execution we will schedule concurrently. It is based on the number of CPUs Blaze thinks is available, which can be controlled with the --local_cpu_resources flag. If this flag is 0, all actions are scheduled locally immediately. If > 0, the amount of actions scheduled locally is limited by the number of CPUs available. If < 1, the load factor is used to reduce the number of locally scheduled actions when the number of actions waiting to schedule is high. This lessens the load on the local machine in the clean build case, where the local machine does not contribute much.
Tags: execution, host_machine_resource_optimizations
--experimental_dynamic_slow_remote_time=<An immutable length of time.> default: "0"
If >0, the time a dynamically run action must run remote-only before we prioritize its local execution to avoid remote timeouts. This may hide some problems on the remote execution system. Do not turn this on without monitoring of remote execution issues.
Tags: execution, host_machine_resource_optimizations
--[no]experimental_enable_docker_sandbox default: "false"
Enable Docker-based sandboxing. This option has no effect if Docker is not installed.
Tags: execution
--experimental_sandbox_async_tree_delete_idle_threads=<an integer, or a keyword ("auto", "HOST_CPUS", "HOST_RAM"), optionally followed by an operation ([-|*]<float>) eg. "auto", "HOST_CPUS*.5"> default: "4"
If 0, delete sandbox trees as soon as an action completes (causing completion of the action to be delayed). If greater than zero, execute the deletion of such threes on an asynchronous thread pool that has size 1 when the build is running and grows to the size specified by this flag when the server is idle.
Tags: host_machine_resource_optimizations, execution
--experimental_sandbox_memory_limit_mb=<an integer number of MBs, or "HOST_RAM", optionally followed by [-|*]<float>.> default: "0"
If > 0, each Linux sandbox will be limited to the given amount of memory (in MB). Requires cgroups v1 or v2 and permissions for the users to the cgroups dir.
Tags: execution
--[no]experimental_shrink_worker_pool default: "false"
If enabled, could shrink worker pool if worker memory pressure is high. This flag works only when flag experimental_total_worker_memory_limit_mb is enabled.
Tags: execution, host_machine_resource_optimizations
--[no]experimental_split_xml_generation default: "true"
If this flag is set, and a test action does not generate a test.xml file, then Bazel uses a separate action to generate a dummy test.xml file containing the test log. Otherwise, Bazel generates a test.xml as part of the test action.
Tags: execution
--experimental_total_worker_memory_limit_mb=<an integer number of MBs, or "HOST_RAM", optionally followed by [-|*]<float>.> default: "0"
If this limit is greater than zero idle workers might be killed if the total memory usage of all workers exceed the limit.
Tags: execution, host_machine_resource_optimizations
--[no]experimental_use_hermetic_linux_sandbox default: "false"
If set to true, do not mount root, only mount whats provided with sandbox_add_mount_pair. Input files will be hardlinked to the sandbox instead of symlinked to from the sandbox. If action input files are located on a filesystem different from the sandbox, then the input files will be copied instead.
Tags: execution
--[no]experimental_use_semaphore_for_jobs default: "false"
If set to true, additionally use semaphore to limit number of concurrent jobs.
Tags: host_machine_resource_optimizations, execution
--[no]experimental_use_windows_sandbox default: "false"
Use Windows sandbox to run actions. If "yes", the binary provided by --experimental_windows_sandbox_path must be valid and correspond to a supported version of sandboxfs. If "auto", the binary may be missing or not compatible.
Tags: execution
--experimental_windows_sandbox_path=<a string> default: "BazelSandbox.exe"
Path to the Windows sandbox binary to use when --experimental_use_windows_sandbox is true. If a bare name, use the first binary of that name found in the PATH.
Tags: execution
--experimental_worker_allowlist=<comma-separated set of options> default: see description
If non-empty, only allow using persistent workers with the given worker key mnemonic.
Tags: execution, host_machine_resource_optimizations
--[no]experimental_worker_as_resource default: "true"
No-op, will be removed soon.
Tags: no_op
--[no]experimental_worker_cancellation default: "false"
If enabled, Bazel may send cancellation requests to workers that support them.
Tags: execution
--experimental_worker_memory_limit_mb=<an integer number of MBs, or "HOST_RAM", optionally followed by [-|*]<float>.> default: "0"
If this limit is greater than zero, workers might be killed if the memory usage of the worker exceeds the limit. If not used together with dynamic execution and `--experimental_dynamic_ignore_local_signals=9`, this may crash your build.
Tags: execution, host_machine_resource_optimizations
--experimental_worker_metrics_poll_interval=<An immutable length of time.> default: "5s"
The interval between collecting worker metrics and possibly attempting evictions. Cannot effectively be less than 1s for performance reasons.
Tags: execution, host_machine_resource_optimizations
--[no]experimental_worker_multiplex_sandboxing default: "false"
If enabled, multiplex workers will be sandboxed, using a separate sandbox directory per work request. Only workers that have the 'supports-multiplex-sandboxing' execution requirement will be sandboxed.
Tags: execution
--[no]experimental_worker_sandbox_hardening default: "false"
If enabled, workers are run in a hardened sandbox, if the implementation allows it.
Tags: execution
--[no]experimental_worker_strict_flagfiles default: "false"
If enabled, actions arguments for workers that do not follow the worker specification will cause an error. Worker arguments must have exactly one @flagfile argument as the last of its list of arguments.
Tags: execution
--gc_thrashing_threshold=<an integer in 0-100 range> default: "100"
The percent of tenured space occupied (0-100) above which GcThrashingDetector considers memory pressure events against its limits (--gc_thrashing_limits). If set to 100, GcThrashingDetector is disabled.
Tags: host_machine_resource_optimizations
--genrule_strategy=<comma-separated list of options> default: ""
Specify how to execute genrules. This flag will be phased out. Instead, use --spawn_strategy=<value> to control all actions or --strategy=Genrule=<value> to control genrules only.
Tags: execution
--high_priority_workers=<a string> multiple uses are accumulated
No-op, will be removed soon.
Tags: execution
If set to true and --incompatible_remote_symlinks is also true, symlinks in action outputs are allowed to dangle.
Tags: execution, incompatible_change
If set to true, Bazel will represent symlinks in action outputs in the remote caching/execution protocol as such. Otherwise, symlinks will be followed and represented as files or directories. See #6631 for details.
Tags: execution, incompatible_change
--[no]incompatible_sandbox_hermetic_tmp default: "true"
If set to true, each Linux sandbox will have its own dedicated empty directory mounted as /tmp rather than sharing /tmp with the host filesystem. Use --sandbox_add_mount_pair=/tmp to keep seeing the host's /tmp in all sandboxes.
Tags: execution
--[no]internal_spawn_scheduler default: "false"
Placeholder option so that we can tell in Blaze whether the spawn scheduler was enabled.
Tags: execution, host_machine_resource_optimizations
--jobs=<an integer, or a keyword ("auto", "HOST_CPUS", "HOST_RAM"), optionally followed by an operation ([-|*]<float>) eg. "auto", "HOST_CPUS*.5"> [-j] default: "auto"
The number of concurrent jobs to run. Takes an integer, or a keyword ("auto", "HOST_CPUS", "HOST_RAM"), optionally followed by an operation ([-|*]<float>) eg. "auto", "HOST_CPUS*.5". Values must be between 1 and 5000. Values above 2500 may cause memory issues. "auto" calculates a reasonable default based on host resources.
Tags: host_machine_resource_optimizations, execution
--[no]keep_going [-k] default: "false"
Continue as much as possible after an error. While the target that failed and those that depend on it cannot be analyzed, other prerequisites of these targets can be.
Tags: eagerness_to_exit
--loading_phase_threads=<an integer, or a keyword ("auto", "HOST_CPUS", "HOST_RAM"), optionally followed by an operation ([-|*]<float>) eg. "auto", "HOST_CPUS*.5"> default: "auto"
Number of parallel threads to use for the loading/analysis phase.Takes an integer, or a keyword ("auto", "HOST_CPUS", "HOST_RAM"), optionally followed by an operation ([-|*]<float>) eg. "auto", "HOST_CPUS*.5". "auto" sets a reasonable default based on host resources. Must be at least 1.
Tags: bazel_internal_configuration
--[no]reuse_sandbox_directories default: "true"
If set to true, directories used by sandboxed non-worker execution may be reused to avoid unnecessary setup costs.
Tags: host_machine_resource_optimizations, execution
--sandbox_base=<a string> default: ""
Lets the sandbox create its sandbox directories underneath this path. Specify a path on tmpfs (like /run/shm) to possibly improve performance a lot when your build / tests have many input files. Note: You need enough RAM and free space on the tmpfs to hold output and intermediate files generated by running actions.
Tags: host_machine_resource_optimizations, execution
--[no]sandbox_explicit_pseudoterminal default: "false"
Explicitly enable the creation of pseudoterminals for sandboxed actions. Some linux distributions require setting the group id of the process to 'tty' inside the sandbox in order for pseudoterminals to function. If this is causing issues, this flag can be disabled to enable other groups to be used.
Tags: execution
--sandbox_tmpfs_path=<an absolute path> multiple uses are accumulated
For sandboxed actions, mount an empty, writable directory at this absolute path (if supported by the sandboxing implementation, ignored otherwise).
Tags: host_machine_resource_optimizations, execution
--[no]skip_incompatible_explicit_targets default: "false"
Skip incompatible targets that are explicitly listed on the command line. By default, building such targets results in an error but they are silently skipped when this option is enabled. See: https://bazel.build/extending/platforms#skipping-incompatible-targets
Tags: loading_and_analysis
--spawn_strategy=<comma-separated list of options> default: ""
Specify how spawn actions are executed by default. Accepts a comma-separated list of strategies from highest to lowest priority. For each action Bazel picks the strategy with the highest priority that can execute the action. The default value is "remote,worker,sandboxed,local". See https://blog.bazel.build/2019/06/19/list-strategy.html for details.
Tags: execution
--strategy=<a '[name=]value1[,..,valueN]' assignment> multiple uses are accumulated
Specify how to distribute compilation of other spawn actions. Accepts a comma-separated list of strategies from highest to lowest priority. For each action Bazel picks the strategy with the highest priority that can execute the action. The default value is "remote,worker,sandboxed,local". This flag overrides the values set by --spawn_strategy (and --genrule_strategy if used with mnemonic Genrule). See https://blog.bazel.build/2019/06/19/list-strategy.html for details.
Tags: execution
--strategy_regexp=<a '<RegexFilter>=value[,value]' assignment> multiple uses are accumulated
Override which spawn strategy should be used to execute spawn actions that have descriptions matching a certain regex_filter. See --per_file_copt for details onregex_filter matching. The last regex_filter that matches the description is used. This option overrides other flags for specifying strategy. Example: --strategy_regexp=//foo.*\.cc,-//foo/bar=local means to run actions using local strategy if their descriptions match //foo.*.cc but not //foo/bar. Example: --strategy_regexp='Compiling.*/bar=local --strategy_regexp=Compiling=sandboxed will run 'Compiling //foo/bar/baz' with the 'local' strategy, but reversing the order would run it with 'sandboxed'.
Tags: execution
--worker_extra_flag=<a 'name=value' assignment> multiple uses are accumulated
Extra command-flags that will be passed to worker processes in addition to --persistent_worker, keyed by mnemonic (e.g. --worker_extra_flag=Javac=--debug.
Tags: execution, host_machine_resource_optimizations
--worker_max_instances=<[name=]value, where value is an integer, or a keyword ("auto", "HOST_CPUS", "HOST_RAM"), optionally followed by an operation ([-|*]<float>) eg. "auto", "HOST_CPUS*.5"> multiple uses are accumulated
How many instances of each kind of persistent worker may be launched if you use the 'worker' strategy. May be specified as [name=value] to give a different value per mnemonic. The limit is based on worker keys, which are differentiated based on mnemonic, but also on startup flags and environment, so there can in some cases be more workers per mnemonic than this flag specifies. Takes an integer, or a keyword ("auto", "HOST_CPUS", "HOST_RAM"), optionally followed by an operation ([-|*]<float>) eg. "auto", "HOST_CPUS*.5". 'auto' calculates a reasonable default based on machine capacity. "=value" sets a default for unspecified mnemonics.
Tags: execution, host_machine_resource_optimizations
--worker_max_multiplex_instances=<[name=]value, where value is an integer, or a keyword ("auto", "HOST_CPUS", "HOST_RAM"), optionally followed by an operation ([-|*]<float>) eg. "auto", "HOST_CPUS*.5"> multiple uses are accumulated
How many WorkRequests a multiplex worker process may receive in parallel if you use the 'worker' strategy with --worker_multiplex. May be specified as [name=value] to give a different value per mnemonic. The limit is based on worker keys, which are differentiated based on mnemonic, but also on startup flags and environment, so there can in some cases be more workers per mnemonic than this flag specifies. Takes an integer, or a keyword ("auto", "HOST_CPUS", "HOST_RAM"), optionally followed by an operation ([-|*]<float>) eg. "auto", "HOST_CPUS*.5". 'auto' calculates a reasonable default based on machine capacity. "=value" sets a default for unspecified mnemonics.
Tags: execution, host_machine_resource_optimizations
--[no]worker_multiplex default: "true"
If enabled, workers will use multiplexing if they support it.
Tags: execution, host_machine_resource_optimizations
--[no]worker_quit_after_build default: "false"
If enabled, all workers quit after a build is done.
Tags: execution, host_machine_resource_optimizations
--[no]worker_sandboxing default: "false"
If enabled, workers will be executed in a sandboxed environment.
Tags: execution
--[no]worker_verbose default: "false"
If enabled, prints verbose messages when workers are started, shutdown, ...
Options that configure the toolchain used for action execution:
--target_platform_fallback=<a string> default: ""
This option is deprecated and has no effect.
Tags: affects_outputs, changes_inputs, loading_and_analysis
Options that control the output of the command:
--[no]build default: "true"
Execute the build; this is the usual behaviour. Specifying --nobuild causes the build to stop before executing the build actions, returning zero iff the package loading and analysis phases completed successfully; this mode is useful for testing those phases.
Tags: execution, affects_outputs
--[no]experimental_use_validation_aspect default: "false"
Whether to run validation actions using aspect (for parallelism with tests).
Tags: execution, affects_outputs
--output_groups=<comma-separated list of options> multiple uses are accumulated
A list of comma-separated output group names, each of which optionally prefixed by a + or a -. A group prefixed by + is added to the default set of output groups, while a group prefixed by - is removed from the default set. If at least one group is not prefixed, the default set of output groups is omitted. For example, --output_groups=+foo,+bar builds the union of the default set, foo, and bar, while --output_groups=foo,bar overrides the default set such that only foo and bar are built.
Tags: execution, affects_outputs
--[no]run_validations default: "true"
Whether to run validation actions as part of the build. See https://bazel.build/extending/rules#validation_actions
Tags: execution, affects_outputs
Options that let the user configure the intended output, affecting its value, as opposed to its existence:
--aspects=<comma-separated list of options> multiple uses are accumulated
Comma-separated list of aspects to be applied to top-level targets. In the list, if aspect some_aspect specifies required aspect providers via required_aspect_providers, some_aspect will run after every aspect that was mentioned before it in the aspects list whose advertised providers satisfy some_aspect required aspect providers. Moreover, some_aspect will run after all its required aspects specified by requires attribute. some_aspect will then have access to the values of those aspects' providers. <bzl-file-label>%<aspect_name>, for example '//tools:my_def.bzl%my_aspect', where 'my_aspect' is a top-level value from a file tools/my_def.bzl
--bep_maximum_open_remote_upload_files=<an integer> default: "-1"
Maximum number of open files allowed during BEP artifact upload.
Tags: affects_outputs
This flag controls how the convenience symlinks (the symlinks that appear in the workspace after the build) will be managed. Possible values: normal (default): Each kind of convenience symlink will be created or deleted, as determined by the build. clean: All symlinks will be unconditionally deleted. ignore: Symlinks will be left alone. log_only: Generate log messages as if 'normal' were passed, but don't actually perform any filesystem operations (useful for tools). Note that only symlinks whose names are generated by the current value of --symlink_prefix can be affected; if the prefix changes, any pre-existing symlinks will be left alone.
Tags: affects_outputs
This flag controls whether or not we will post the build eventConvenienceSymlinksIdentified to the BuildEventProtocol. If the value is true, the BuildEventProtocol will have an entry for convenienceSymlinksIdentified, listing all of the convenience symlinks created in your workspace. If false, then the convenienceSymlinksIdentified entry in the BuildEventProtocol will be empty.
Tags: affects_outputs
--remote_download_all
Downloads all remote outputs to the local machine. This flag is an alias for --remote_download_outputs=all.
Expands to:
  --remote_download_outputs=all

Tags: affects_outputs
--remote_download_minimal
Does not download any remote build outputs to the local machine. This flag is an alias for --remote_download_outputs=minimal.
Expands to:
  --remote_download_outputs=minimal

Tags: affects_outputs
--remote_download_outputs=<all, minimal or toplevel> default: "toplevel"
If set to 'minimal' doesn't download any remote build outputs to the local machine, except the ones required by local actions. If set to 'toplevel' behaves like'minimal' except that it also downloads outputs of top level targets to the local machine. Both options can significantly reduce build times if network bandwidth is a bottleneck.
Tags: affects_outputs
Instead of downloading remote build outputs to the local machine, create symbolic links. The target of the symbolic links can be specified in the form of a template string. This template string may contain {hash} and {size_bytes} that expand to the hash of the object and the size in bytes, respectively. These symbolic links may, for example, point to a FUSE file system that loads objects from the CAS on demand.
Tags: affects_outputs
--remote_download_toplevel
Only downloads remote outputs of top level targets to the local machine. This flag is an alias for --remote_download_outputs=toplevel.
Expands to:
  --remote_download_outputs=toplevel

Tags: affects_outputs
The prefix that is prepended to any of the convenience symlinks that are created after a build. If omitted, the default value is the name of the build tool followed by a hyphen. If '/' is passed, then no symlinks are created and no warning is emitted. Warning: the special functionality for '/' will be deprecated soon; use --experimental_convenience_symlinks=ignore instead.
Tags: affects_outputs
Options that affect how strictly Bazel enforces valid build inputs (rule definitions, flag combinations, etc.):
--[no]experimental_docker_privileged default: "false"
If enabled, Bazel will pass the --privileged flag to 'docker run' when running actions. This might be required by your build, but it might also result in reduced hermeticity.
Tags: execution
No-op
Tags: host_machine_resource_optimizations, execution
--[no]incompatible_legacy_local_fallback default: "false"
If set to true, enables the legacy implicit fallback from sandboxed to local strategy. This flag will eventually default to false and then become a no-op. Use --strategy, --spawn_strategy, or --dynamic_local_strategy to configure fallbacks instead.
Tags: execution, incompatible_change
--sandbox_add_mount_pair=<a single path or a 'source:target' pair> multiple uses are accumulated
Add additional path pair to mount in sandbox.
Tags: execution
--sandbox_block_path=<a string> multiple uses are accumulated
For sandboxed actions, disallow access to this path.
Tags: execution
--[no]sandbox_default_allow_network default: "true"
Allow network access by default for actions; this may not work with all sandboxing implementations.
Tags: execution
--[no]sandbox_fake_hostname default: "false"
Change the current hostname to 'localhost' for sandboxed actions.
Tags: execution
--[no]sandbox_fake_username default: "false"
Change the current username to 'nobody' for sandboxed actions.
Tags: execution
--sandbox_writable_path=<a string> multiple uses are accumulated
For sandboxed actions, make an existing directory writable in the sandbox (if supported by the sandboxing implementation, ignored otherwise).
Tags: execution
This option affects semantics of the Starlark language or the build API accessible to BUILD files, .bzl files, or WORKSPACE files.:
--[no]incompatible_config_setting_private_default_visibility default: "false"
If incompatible_enforce_config_setting_visibility=false, this is a noop. Else, if this flag is false, any config_setting without an explicit visibility attribute is //visibility:public. If this flag is true, config_setting follows the same visibility logic as all other rules. See https://github.com/bazelbuild/bazel/issues/12933.
Tags: loading_and_analysis, incompatible_change
--[no]incompatible_depset_for_java_output_source_jars default: "true"
No-op.
Tags: loading_and_analysis, incompatible_change
--[no]incompatible_enforce_config_setting_visibility default: "true"
If true, enforce config_setting visibility restrictions. If false, every config_setting is visible to every target. See https://github.com/bazelbuild/bazel/issues/12932.
Tags: loading_and_analysis, incompatible_change
--[no]incompatible_new_actions_api default: "true"
No-op
Tags: no_op, incompatible_change
Options that govern the behavior of the test environment or test runner:
--[no]check_tests_up_to_date default: "false"
Don't run tests, just check if they are up-to-date. If all tests results are up-to-date, the testing completes successfully. If any test needs to be built or executed, an error is reported and the testing fails. This option implies --check_up_to_date behavior.
Tags: execution
--flaky_test_attempts=<a positive integer, the string "default", or test_regex@attempts. This flag may be passed more than once> multiple uses are accumulated
Each test will be retried up to the specified number of times in case of any test failure. Tests that required more than one attempt to pass are marked as 'FLAKY' in the test summary. Normally the value specified is just an integer or the string 'default'. If an integer, then all tests will be run up to N times. If 'default', then only a single test attempt will be made for regular tests and three for tests marked explicitly as flaky by their rule (flaky=1 attribute). Alternate syntax: regex_filter@flaky_test_attempts. Where flaky_test_attempts is as above and regex_filter stands for a list of include and exclude regular expression patterns (Also see --runs_per_test). Example: --flaky_test_attempts=//foo/.*,-//foo/bar/.*@3 deflakes all tests in //foo/ except those under foo/bar three times. This option can be passed multiple times. The most recently passed argument that matches takes precedence. If nothing matches, behavior is as if 'default' above.
Tags: execution
--local_test_jobs=<an integer, or a keyword ("auto", "HOST_CPUS", "HOST_RAM"), optionally followed by an operation ([-|*]<float>) eg. "auto", "HOST_CPUS*.5"> default: "auto"
The max number of local test jobs to run concurrently. Takes an integer, or a keyword ("auto", "HOST_CPUS", "HOST_RAM"), optionally followed by an operation ([-|*]<float>) eg. "auto", "HOST_CPUS*.5". 0 means local resources will limit the number of local test jobs to run concurrently instead. Setting this greater than the value for --jobs is ineffectual.
Tags: execution
--[no]test_keep_going default: "true"
When disabled, any non-passing test will cause the entire build to stop. By default all tests are run, even if some do not pass.
Tags: execution
--test_strategy=<a string> default: ""
Specifies which strategy to use when running tests.
Tags: execution
--test_tmpdir=<a path> default: see description
Specifies the base temporary directory for 'bazel test' to use.
Options relating to query output and semantics:
--[no]experimental_parallel_aquery_output default: "true"
No-op.
Options relating to Bzlmod output and semantics:
--allow_yanked_versions=<a string> multiple uses are accumulated
Specified the module versions in the form of `<module1>@<version1>,<module2>@<version2>` that will be allowed in the resolved dependency graph even if they are declared yanked in the registry where they come from (if they are not coming from a NonRegistryOverride). Otherwise, yanked versions will cause the resolution to fail. You can also define allowed yanked version with the `BZLMOD_ALLOW_YANKED_VERSIONS` environment variable. You can disable this check by using the keyword 'all' (not recommended).
Tags: loading_and_analysis
--check_bazel_compatibility=<error, warning or off> default: "error"
Check bazel version compatibility of Bazel modules. Valid values are `error` to escalate it to a resolution failure, `off` to disable the check, or `warning` to print a warning when mismatch detected.
Tags: loading_and_analysis
--check_direct_dependencies=<off, warning or error> default: "warning"
Check if the direct `bazel_dep` dependencies declared in the root module are the same versions you get in the resolved dependency graph. Valid values are `off` to disable the check, `warning` to print a warning when mismatch detected or `error` to escalate it to a resolution failure.
Tags: loading_and_analysis
--[no]ignore_dev_dependency default: "false"
If true, Bazel ignores `bazel_dep` and `use_extension` declared as `dev_dependency` in the MODULE.bazel of the root module. Note that, those dev dependencies are always ignored in the MODULE.bazel if it's not the root module regardless of the value of this flag.
Tags: loading_and_analysis
--lockfile_mode=<off, update or error> default: "update"
Specifies how and whether or not to use the lockfile. Valid values are `update` to use the lockfile and update it if there are changes, `error` to use the lockfile but throw an error if it's not up-to-date, or `off` to neither read from or write to the lockfile.
Tags: loading_and_analysis
--override_module=<an equals-separated mapping of module name to path> multiple uses are accumulated
Override a module with a local path in the form of <module name>=<path>. If the given path is an absolute path, it will be used as it is. If the given path is a relative path, it is relative to the current working directory. If the given path starts with '%workspace%, it is relative to the workspace root, which is the output of `bazel info workspace`
--registry=<a string> multiple uses are accumulated
Specifies the registries to use to locate Bazel module dependencies. The order is important: modules will be looked up in earlier registries first, and only fall back to later registries when they're missing from the earlier ones.
Tags: changes_inputs
Options that trigger optimizations of the build time:
--experimental_dynamic_ignore_local_signals=<a comma-separated list of signal numbers> default: see description
Takes a list of OS signal numbers. If a local branch of dynamic execution gets killed with any of these signals, the remote branch will be allowed to finish instead. For persistent workers, this only affects signals that kill the worker process.
Tags: execution
--gc_thrashing_limits=<comma separated pairs of <period>:<count>> default: "1s:2,20s:3,1m:5"
Limits which, if reached, cause GcThrashingDetector to crash Bazel with an OOM. Each limit is specified as <period>:<count> where period is a duration and count is a positive integer. If more than --gc_thrashing_threshold percent of tenured space (old gen heap) remains occupied after <count> consecutive full GCs within <period>, an OOM is triggered. Multiple limits can be specified separated by commas.
Tags: host_machine_resource_optimizations
--local_cpu_resources=<an integer, or "HOST_CPUS", optionally followed by [-|*]<float>.> default: "HOST_CPUS"
Explicitly set the total number of local CPU cores available to Bazel to spend on build actions executed locally. Takes an integer, or "HOST_CPUS", optionally followed by [-|*]<float> (eg. HOST_CPUS*.5 to use half the available CPU cores).By default, ("HOST_CPUS"), Bazel will query system configuration to estimate the number of CPU cores available.
Tags: host_machine_resource_optimizations
--local_extra_resources=<a named float, 'name=value'> multiple uses are accumulated
Set the number of extra resources available to Bazel. Takes in a string-float pair. Can be used multiple times to specify multiple types of extra resources. Bazel will limit concurrently running actions based on the available extra resources and the extra resources required. Tests can declare the amount of extra resources they need by using a tag of the "resources:<resoucename>:<amount>" format. Available CPU, RAM and resources cannot be set with this flag.
Tags: host_machine_resource_optimizations
--local_ram_resources=<an integer number of MBs, or "HOST_RAM", optionally followed by [-|*]<float>.> default: "HOST_RAM*.67"
Explicitly set the total amount of local host RAM (in MB) available to Bazel to spend on build actions executed locally. Takes an integer, or "HOST_RAM", optionally followed by [-|*]<float> (eg. HOST_RAM*.5 to use half the available RAM). By default, ("HOST_RAM*.67"), Bazel will query system configuration to estimate the amount of RAM available and will use 67% of it.
Tags: host_machine_resource_optimizations
--skyframe_high_water_mark_full_gc_drops_per_invocation=<an integer, >= 0> default: "2147483647"
Flag for advanced configuration of Bazel's internal Skyframe engine. If Bazel detects its retained heap percentage usage exceeds the threshold set by --skyframe_high_water_mark_threshold, when a full GC event occurs, it will drop unnecessary temporary Skyframe state, up to this many times per invocation. Defaults to Integer.MAX_VALUE; effectively unlimited. Zero means that full GC events will never trigger drops. If the limit is reached, Skyframe state will no longer be dropped when a full GC event occurs and that retained heap percentage threshold is exceeded.
Tags: host_machine_resource_optimizations
--skyframe_high_water_mark_minor_gc_drops_per_invocation=<an integer, >= 0> default: "2147483647"
Flag for advanced configuration of Bazel's internal Skyframe engine. If Bazel detects its retained heap percentage usage exceeds the threshold set by --skyframe_high_water_mark_threshold, when a minor GC event occurs, it will drop unnecessary temporary Skyframe state, up to this many times per invocation. Defaults to Integer.MAX_VALUE; effectively unlimited. Zero means that minor GC events will never trigger drops. If the limit is reached, Skyframe state will no longer be dropped when a minor GC event occurs and that retained heap percentage threshold is exceeded.
Tags: host_machine_resource_optimizations
--skyframe_high_water_mark_threshold=<an integer> default: "85"
Flag for advanced configuration of Bazel's internal Skyframe engine. If Bazel detects its retained heap percentage usage is at least this threshold, it will drop unnecessary temporary Skyframe state. Tweaking this may let you mitigate wall time impact of GC thrashing, when the GC thrashing is (i) caused by the memory usage of this temporary state and (ii) more costly than reconstituting the state when it is needed.
Tags: host_machine_resource_optimizations
Options that affect the verbosity, format or location of logging:
--[no]debug_spawn_scheduler default: "false"
--[no]experimental_bep_target_summary default: "false"
Whether to publish TargetSummary events.
--[no]experimental_build_event_expand_filesets default: "false"
If true, expand Filesets in the BEP when presenting output files.
Tags: affects_outputs
If true, fully resolve relative Fileset symlinks in the BEP when presenting output files. Requires --experimental_build_event_expand_filesets.
Tags: affects_outputs
--experimental_build_event_upload_max_retries=<an integer> default: "4"
The maximum number of times Bazel should retry uploading a build event.
Tags: bazel_internal_configuration
--experimental_build_event_upload_retry_minimum_delay=<An immutable length of time.> default: "1s"
Initial, minimum delay for exponential backoff retries when BEP upload fails. (exponent: 1.6)
Tags: bazel_internal_configuration
--experimental_build_event_upload_strategy=<a string> default: see description
Selects how to upload artifacts referenced in the build event protocol.
Tags: affects_outputs
--[no]experimental_collect_local_sandbox_action_metrics default: "true"
Deprecated no-op.
Tags: execution
--[no]experimental_command_profile default: "false"
Records a Java Flight Recorder CPU profile into a profile.jfr file in the output base directory. The syntax and semantics of this flag might change in the future to support different profile types or output formats; use at your own risk.
--[no]experimental_docker_verbose default: "false"
If enabled, Bazel will print more verbose messages about the Docker sandbox strategy.
Tags: execution
--[no]experimental_materialize_param_files_directly default: "false"
If materializing param files, do so with direct writes to disk.
Tags: execution
--[no]experimental_record_metrics_for_all_mnemonics default: "false"
By default the number of action types is limited to the 20 mnemonics with the largest number of executed actions. Setting this option will write statistics for all mnemonics.
--experimental_repository_resolved_file=<a string> default: ""
If non-empty, write a Starlark value with the resolved information of all Starlark repository rules that were executed.
Tags: affects_outputs
--[no]experimental_run_bep_event_include_residue default: "false"
Whether to include the command-line residue in run build events which could contain the residue. By default, the residue is not included in run command build events that could contain the residue.
Tags: affects_outputs
--[no]experimental_stream_log_file_uploads default: "false"
Stream log file uploads directly to the remote storage rather than writing them to disk.
Tags: affects_outputs
--explain=<a path> default: see description
Causes the build system to explain each executed step of the build. The explanation is written to the specified log file.
Tags: affects_outputs
--[no]ignore_unsupported_sandboxing default: "false"
Do not print a warning when sandboxed execution is not supported on this system.
Tags: terminal_output
--[no]legacy_important_outputs default: "true"
Use this to suppress generation of the legacy important_outputs field in the TargetComplete event. important_outputs are required for Bazel to ResultStore integration.
Tags: affects_outputs
--[no]materialize_param_files default: "false"
Writes intermediate parameter files to output tree even when using remote action execution. Useful when debugging actions. This is implied by --subcommands and --verbose_failures.
Tags: execution
--max_config_changes_to_show=<an integer> default: "3"
When discarding the analysis cache due to a change in the build options, displays up to the given number of changed option names. If the number given is -1, all changed options will be displayed.
Tags: terminal_output
--max_test_output_bytes=<an integer> default: "-1"
Specifies maximum per-test-log size that can be emitted when --test_output is 'errors' or 'all'. Useful for avoiding overwhelming the output with excessively noisy test output. The test header is included in the log size. Negative values imply no limit. Output is all or nothing.
Tags: test_runner, terminal_output, execution
--output_filter=<a valid Java regular expression> default: see description
Only shows warnings and action outputs for rules with a name matching the provided regular expression.
Tags: affects_outputs
--progress_report_interval=<an integer in 0-3600 range> default: "0"
The number of seconds to wait between reports on still running jobs. The default value 0 means the first report will be printed after 10 seconds, then 30 seconds and after that progress is reported once every minute. When --curses is enabled, progress is reported every second.
Tags: affects_outputs
--remote_print_execution_messages=<failure, success or all> default: "failure"
Choose when to print remote execution messages. Valid values are `failure`, to print only on failures, `success` to print only on successes and `all` to print always.
Tags: terminal_output
--[no]sandbox_debug default: "false"
Enables debugging features for the sandboxing feature. This includes two things: first, the sandbox root contents are left untouched after a build; and second, prints extra debugging information on execution. This can help developers of Bazel or Starlark rules with debugging failures due to missing input files, etc.
Tags: terminal_output
--show_result=<an integer> default: "1"
Show the results of the build. For each target, state whether or not it was brought up-to-date, and if so, a list of output files that were built. The printed files are convenient strings for copy+pasting to the shell, to execute them. This option requires an integer argument, which is the threshold number of targets above which result information is not printed. Thus zero causes suppression of the message and MAX_INT causes printing of the result to occur always. The default is one. If nothing was built for a target its results may be omitted to keep the output under the threshold.
Tags: affects_outputs
--[no]subcommands [-s] default: "false"
Display the subcommands executed during a build. Related flags: --execution_log_json_file, --execution_log_binary_file (for logging subcommands to a file in a tool-friendly format).
Tags: terminal_output
--test_output=<summary, errors, all or streamed> default: "summary"
Specifies desired output mode. Valid values are 'summary' to output only test status summary, 'errors' to also print test logs for failed tests, 'all' to print logs for all tests and 'streamed' to output logs for all tests in real time (this will force tests to be executed locally one at a time regardless of --test_strategy value).
Tags: test_runner, terminal_output, execution
--test_summary=<short, terse, detailed, none or testcase> default: "short"
Specifies the desired format of the test summary. Valid values are 'short' to print information only about tests executed, 'terse', to print information only about unsuccessful tests that were run, 'detailed' to print detailed information about failed test cases, 'testcase' to print summary in test case resolution, do not print detailed information about failed test cases and 'none' to omit the summary.
Tags: terminal_output
--[no]verbose_explanations default: "false"
Increases the verbosity of the explanations issued if --explain is enabled. Has no effect if --explain is not enabled.
Tags: affects_outputs
--[no]verbose_failures default: "false"
If a command fails, print out the full command line.
Tags: terminal_output
Options specifying or altering a generic input to a Bazel command that does not fall into other categories.:
--aspects_parameters=<a 'name=value' assignment> multiple uses are accumulated
Specifies the values of the command-line aspects parameters. Each parameter value is specified via <param_name>=<param_value>, for example 'my_param=my_val' where 'my_param' is a parameter of some aspect in --aspects list or required by an aspect in the list. This option can be used multiple times. However, it is not allowed to assign values to the same parameter more than once.
Tags: loading_and_analysis
--experimental_resolved_file_instead_of_workspace=<a string> default: ""
If non-empty read the specified resolved file instead of the WORKSPACE file
Tags: changes_inputs
--target_pattern_file=<a string> default: ""
If set, build will read patterns from the file named here, rather than on the command line. It is an error to specify a file here as well as command-line patterns.
Tags: changes_inputs
Remote caching and execution options:
--experimental_circuit_breaker_strategy=<failure> default: see description
Specifies the strategy for the circuit breaker to use. Available strategies are "failure". On invalid value for the option the behavior same as the option is not set.
Tags: execution
--experimental_downloader_config=<a string> default: see description
Specify a file to configure the remote downloader with. This file consists of lines, each of which starts with a directive (`allow`, `block` or `rewrite`) followed by either a host name (for `allow` and `block`) or two patterns, one to match against, and one to use as a substitute URL, with back-references starting from `$1`. It is possible for multiple `rewrite` directives for the same URL to be give, and in this case multiple URLs will be returned.
--[no]experimental_guard_against_concurrent_changes default: "false"
Turn this off to disable checking the ctime of input files of an action before uploading it to a remote cache. There may be cases where the Linux kernel delays writing of files, which could cause false positives.
--[no]experimental_remote_cache_async default: "false"
If true, remote cache I/O will happen in the background instead of taking place as the part of a spawn.
--experimental_remote_cache_eviction_retries=<an integer> default: "0"
The maximum number of attempts to retry if the build encountered remote cache eviction error. A non-zero value will implicitly set --incompatible_remote_use_new_exit_code_for_lost_inputs to true. A new invocation id will be generated for each attempt. If you generate invocation id and provide it to Bazel with --invocation_id, you should not use this flag. Instead, set flag --incompatible_remote_use_new_exit_code_for_lost_inputs and check for the exit code 39.
Tags: execution
--[no]experimental_remote_cache_lease_extension default: "false"
If set to true, Bazel will extend the lease for outputs of remote actions during the build by sending `FindMissingBlobs` calls periodically to remote cache. The frequency is based on the value of `--experimental_remote_cache_ttl`.
--experimental_remote_cache_ttl=<An immutable length of time.> default: "3h"
The guaranteed minimal TTL of blobs in the remote cache after their digests are recently referenced e.g. by an ActionResult or FindMissingBlobs. Bazel does several optimizations based on the blobs' TTL e.g. doesn't repeatedly call GetActionResult in an incremental build. The value should be set slightly less than the real TTL since there is a gap between when the server returns the digests and when Bazel receives them.
Tags: execution
--experimental_remote_capture_corrupted_outputs=<a path> default: see description
A path to a directory where the corrupted outputs will be captured to.
--[no]experimental_remote_discard_merkle_trees default: "true"
If set to true, discard in-memory copies of the input root's Merkle tree and associated input mappings during calls to GetActionResult() and Execute(). This reduces memory usage significantly, but does require Bazel to recompute them upon remote cache misses and retries.
--experimental_remote_downloader=<a string> default: see description
A Remote Asset API endpoint URI, to be used as a remote download proxy. The supported schemas are grpc, grpcs (grpc with TLS enabled) and unix (local UNIX sockets). If no schema is provided Bazel will default to grpcs. See: https://github.com/bazelbuild/remote-apis/blob/master/build/bazel/remote/asset/v1/remote_asset.proto
--[no]experimental_remote_downloader_local_fallback default: "false"
Whether to fall back to the local downloader if remote downloader fails.
--[no]experimental_remote_execution_keepalive default: "false"
Whether to use keepalive for remote execution calls.
--experimental_remote_failure_rate_threshold=<an integer in 0-100 range> default: "10"
Sets the allowed number of failure rate in percentage for a specific time window after which it stops calling to the remote cache/executor. By default the value is 10. Setting this to 0 means no limitation.
Tags: execution
--experimental_remote_failure_window_interval=<An immutable length of time.> default: "60s"
The interval in which the failure rate of the remote requests are computed. On zero or negative value the failure duration is computed the whole duration of the execution.Following units can be used: Days (d), hours (h), minutes (m), seconds (s), and milliseconds (ms). If the unit is omitted, the value is interpreted as seconds.
Tags: execution
--[no]experimental_remote_mark_tool_inputs default: "false"
If set to true, Bazel will mark inputs as tool inputs for the remote executor. This can be used to implement remote persistent workers.
--[no]experimental_remote_merkle_tree_cache default: "false"
If set to true, Merkle tree calculations will be memoized to improve the remote cache hit checking speed. The memory foot print of the cache is controlled by --experimental_remote_merkle_tree_cache_size.
--experimental_remote_merkle_tree_cache_size=<a long integer> default: "1000"
The number of Merkle trees to memoize to improve the remote cache hit checking speed. Even though the cache is automatically pruned according to Java's handling of soft references, out-of-memory errors can occur if set too high. If set to 0 the cache size is unlimited. Optimal value varies depending on project's size. Default to 1000.
--[no]experimental_remote_require_cached default: "false"
If set to true, enforce that all actions that can run remotely are cached, or else fail the build. This is useful to troubleshoot non-determinism issues as it allows checking whether actions that should be cached are actually cached without spuriously injecting new results into the cache.
--experimental_remote_scrubbing_config=<Converts to a Scrubber> default: see description
Enables remote cache key scrubbing with the supplied configuration file, which must be a ScrubbingConfig protocol buffer in text format. This feature is intended to facilitate sharing a remote/disk cache between actions executing on different platforms but targeting the same platform. It should be used with extreme care, as improper settings may cause accidental sharing of cache entries and result in incorrect builds. Scrubbing does not affect how an action is executed, only how its remote/disk cache key is computed for the purpose of retrieving or storing an action result. It cannot be used in conjunction with remote execution. Modifying the scrubbing configuration does not invalidate outputs present in the local filesystem or internal caches; a clean build is required to reexecute affected actions. In order to successfully use this feature, you likely want to set a custom --host_platform together with --experimental_platform_in_output_dir (to normalize output prefixes) and --incompatible_strict_action_env (to normalize environment variables).
--experimental_worker_for_repo_fetching=<off, platform or virtual> default: "off"
The threading mode to use for repo fetching. If set to 'off', no worker thread is used, and the repo fetching is subject to restarts. Otherwise, uses a platform thread (i.e. OS thread) if set to 'platform' or a virtual thread if set to 'virtual'.
--[no]incompatible_remote_build_event_upload_respect_no_cache default: "false"
Deprecated. No-op. Use --remote_build_event_upload=minimal instead.
--[no]incompatible_remote_downloader_send_all_headers default: "true"
Whether to send all values of a multi-valued header to the remote downloader instead of just the first.
Tags: incompatible_change
--[no]incompatible_remote_output_paths_relative_to_input_root default: "false"
If set to true, output paths are relative to input root instead of working directory.
Tags: incompatible_change
--[no]incompatible_remote_results_ignore_disk default: "true"
No-op
Tags: incompatible_change
--[no]incompatible_remote_use_new_exit_code_for_lost_inputs default: "true"
If set to true, Bazel will use new exit code 39 instead of 34 if remote cache evicts blobs during the build.
Tags: incompatible_change
--[no]remote_accept_cached default: "true"
Whether to accept remotely cached action results.
--remote_build_event_upload=<all or minimal> default: "minimal"
If set to 'all', all local outputs referenced by BEP are uploaded to remote cache. If set to 'minimal', local outputs referenced by BEP are not uploaded to the remote cache, except for files that are important to the consumers of BEP (e.g. test logs and timing profile). bytestream:// scheme is always used for the uri of files even if they are missing from remote cache. Default to 'minimal'.
--remote_bytestream_uri_prefix=<a string> default: see description
The hostname and instance name to be used in bytestream:// URIs that are written into build event streams. This option can be set when builds are performed using a proxy, which causes the values of --remote_executor and --remote_instance_name to no longer correspond to the canonical name of the remote execution service. When not set, it will default to "${hostname}/${instance_name}".
--remote_cache=<a string> default: see description
A URI of a caching endpoint. The supported schemas are http, https, grpc, grpcs (grpc with TLS enabled) and unix (local UNIX sockets). If no schema is provided Bazel will default to grpcs. Specify grpc://, http:// or unix: schema to disable TLS. See https://bazel.build/remote/caching
--[no]remote_cache_compression default: "false"
If enabled, compress/decompress cache blobs with zstd.
--remote_cache_header=<a 'name=value' assignment> multiple uses are accumulated
Specify a header that will be included in cache requests: --remote_cache_header=Name=Value. Multiple headers can be passed by specifying the flag multiple times. Multiple values for the same name will be converted to a comma-separated list.
--remote_default_exec_properties=<a 'name=value' assignment> multiple uses are accumulated
Set the default exec properties to be used as the remote execution platform if an execution platform does not already set exec_properties.
Tags: affects_outputs
--remote_default_platform_properties=<a string> default: ""
Set the default platform properties to be set for the remote execution API, if the execution platform does not already set remote_execution_properties. This value will also be used if the host platform is selected as the execution platform for remote execution.
--remote_download_regex=<a string> multiple uses are accumulated
Force Bazel to download the artifacts that match the given regexp. To be used in conjunction with Build without the Bytes (or the internal equivalent) to allow the client to request certain artifacts that might be needed locally (e.g. IDE support). Multiple regexes can be specified by repeating this flag.
Tags: affects_outputs
--remote_downloader_header=<a 'name=value' assignment> multiple uses are accumulated
Specify a header that will be included in remote downloader requests: --remote_downloader_header=Name=Value. Multiple headers can be passed by specifying the flag multiple times. Multiple values for the same name will be converted to a comma-separated list.
--remote_exec_header=<a 'name=value' assignment> multiple uses are accumulated
Specify a header that will be included in execution requests: --remote_exec_header=Name=Value. Multiple headers can be passed by specifying the flag multiple times. Multiple values for the same name will be converted to a comma-separated list.
--remote_execution_priority=<an integer> default: "0"
The relative priority of actions to be executed remotely. The semantics of the particular priority values are server-dependent.
--remote_executor=<a string> default: see description
HOST or HOST:PORT of a remote execution endpoint. The supported schemas are grpc, grpcs (grpc with TLS enabled) and unix (local UNIX sockets). If no schema is provided Bazel will default to grpcs. Specify grpc:// or unix: schema to disable TLS.
--remote_grpc_log=<a path> default: see description
If specified, a path to a file to log gRPC call related details. This log consists of a sequence of serialized com.google.devtools.build.lib.remote.logging.RemoteExecutionLog.LogEntry protobufs with each message prefixed by a varint denoting the size of the following serialized protobuf message, as performed by the method LogEntry.writeDelimitedTo(OutputStream).
--remote_header=<a 'name=value' assignment> multiple uses are accumulated
Specify a header that will be included in requests: --remote_header=Name=Value. Multiple headers can be passed by specifying the flag multiple times. Multiple values for the same name will be converted to a comma-separated list.
--remote_instance_name=<a string> default: ""
Value to pass as instance_name in the remote execution API.
--[no]remote_local_fallback default: "false"
Whether to fall back to standalone local execution strategy if remote execution fails.
--remote_local_fallback_strategy=<a string> default: "local"
No-op, deprecated. See https://github.com/bazelbuild/bazel/issues/7480 for details.
--remote_max_connections=<an integer> default: "100"
Limit the max number of concurrent connections to remote cache/executor. By default the value is 100. Setting this to 0 means no limitation. For HTTP remote cache, one TCP connection could handle one request at one time, so Bazel could make up to --remote_max_connections concurrent requests. For gRPC remote cache/executor, one gRPC channel could usually handle 100+ concurrent requests, so Bazel could make around `--remote_max_connections * 100` concurrent requests.
Tags: host_machine_resource_optimizations
--remote_proxy=<a string> default: see description
Connect to the remote cache through a proxy. Currently this flag can only be used to configure a Unix domain socket (unix:/path/to/socket).
--remote_result_cache_priority=<an integer> default: "0"
The relative priority of remote actions to be stored in remote cache. The semantics of the particular priority values are server-dependent.
--remote_retries=<an integer> default: "5"
The maximum number of attempts to retry a transient error. If set to 0, retries are disabled.
--remote_retry_max_delay=<An immutable length of time.> default: "5s"
The maximum backoff delay between remote retry attempts. Following units can be used: Days (d), hours (h), minutes (m), seconds (s), and milliseconds (ms). If the unit is omitted, the value is interpreted as seconds.
--remote_timeout=<An immutable length of time.> default: "60s"
The maximum amount of time to wait for remote execution and cache calls. For the REST cache, this is both the connect and the read timeout. Following units can be used: Days (d), hours (h), minutes (m), seconds (s), and milliseconds (ms). If the unit is omitted, the value is interpreted as seconds.
--[no]remote_upload_local_results default: "true"
Whether to upload locally executed action results to the remote cache if the remote cache supports it and the user is authorized to do so.
--[no]remote_verify_downloads default: "true"
If set to true, Bazel will compute the hash sum of all remote downloads and discard the remotely cached values if they don't match the expected value.
Miscellaneous options, not otherwise categorized.:
--[no]allow_analysis_cache_discard default: "true"
If discarding the analysis cache due to a change in the build system, setting this option to false will cause bazel to exit, rather than continuing with the build. This option has no effect when 'discard_analysis_cache' is also set.
Tags: eagerness_to_exit
--auto_output_filter=<none, all, packages or subpackages> default: "none"
If --output_filter is not specified, then the value for this option is used create a filter automatically. Allowed values are 'none' (filter nothing / show everything), 'all' (filter everything / show nothing), 'packages' (include output from rules in packages mentioned on the Blaze command line), and 'subpackages' (like 'packages', but also include subpackages). For the 'packages' and 'subpackages' values //java/foo and //javatests/foo are treated as one package)'.
--[no]build_manual_tests default: "false"
Forces test targets tagged 'manual' to be built. 'manual' tests are excluded from processing. This option forces them to be built (but not executed).
--build_tag_filters=<comma-separated list of options> default: ""
Specifies a comma-separated list of tags. Each tag can be optionally preceded with '-' to specify excluded tags. Only those targets will be built that contain at least one included tag and do not contain any excluded tags. This option does not affect the set of tests executed with the 'test' command; those are be governed by the test filtering options, for example '--test_tag_filters'
--[no]build_tests_only default: "false"
If specified, only *_test and test_suite rules will be built and other targets specified on the command line will be ignored. By default everything that was requested will be built.
--combined_report=<none or lcov> default: "none"
Specifies desired cumulative coverage report type. At this point only LCOV is supported.
--[no]compile_one_dependency default: "false"
Compile a single dependency of the argument files. This is useful for syntax checking source files in IDEs, for example, by rebuilding a single target that depends on the source file to detect errors as early as possible in the edit/build/test cycle. This argument affects the way all non-flag arguments are interpreted; instead of being targets to build they are source filenames. For each source filename an arbitrary target that depends on it will be built.
--deleted_packages=<comma-separated list of package names> multiple uses are accumulated
A comma-separated list of names of packages which the build system will consider non-existent, even if they are visible somewhere on the package path. Use this option when deleting a subpackage 'x/y' of an existing package 'x'. For example, after deleting x/y/BUILD in your client, the build system may complain if it encounters a label '//x:y/z' if that is still provided by another package_path entry. Specifying --deleted_packages x/y avoids this problem.
--[no]discard_analysis_cache default: "false"
Discard the analysis cache immediately after the analysis phase completes. Reduces memory usage by ~10%, but makes further incremental builds slower.
--disk_cache=<a path> default: see description
A path to a directory where Bazel can read and write actions and action outputs. If the directory does not exist, it will be created.
--embed_label=<a one-line string> default: ""
Embed source control revision or release label in binary
--execution_log_binary_file=<a path> default: see description
Log the executed spawns into this file as delimited Spawn protos, according to src/main/protobuf/spawn.proto. Related flags: --execution_log_json_file (text JSON format; mutually exclusive), --execution_log_sort (whether to sort the execution log), --subcommands (for displaying subcommands in terminal output).
--execution_log_json_file=<a path> default: see description
Log the executed spawns into this file as a JSON representation of the delimited Spawn protos, according to src/main/protobuf/spawn.proto. Related flags: --execution_log_binary_file (binary protobuf format; mutually exclusive), --execution_log_sort (whether to sort the execution log), --subcommands (for displaying subcommands in terminal output).
--[no]execution_log_sort default: "true"
Whether to sort the execution log, making it easier to compare logs across invocations. Set to false to avoid potentially significant CPU and memory usage at the end of the invocation, at the cost of producing the log in nondeterministic execution order.
--[no]expand_test_suites default: "true"
Expand test_suite targets into their constituent tests before analysis. When this flag is turned on (the default), negative target patterns will apply to the tests belonging to the test suite, otherwise they will not. Turning off this flag is useful when top-level aspects are applied at command line: then they can analyze test_suite targets.
Tags: loading_and_analysis
--experimental_extra_action_filter=<a comma-separated list of regex expressions with prefix '-' specifying excluded paths> default: ""
Deprecated in favor of aspects. Filters set of targets to schedule extra_actions for.
--[no]experimental_extra_action_top_level_only default: "false"
Deprecated in favor of aspects. Only schedules extra_actions for top level targets.
--experimental_spawn_scheduler
Enable dynamic execution by running actions locally and remotely in parallel. Bazel spawns each action locally and remotely and picks the one that completes first. If an action supports workers, the local action will be run in the persistent worker mode. To enable dynamic execution for an individual action mnemonic, use the `--internal_spawn_scheduler` and `--strategy=<mnemonic>=dynamic` flags instead.
Expands to:
  --internal_spawn_scheduler
  --spawn_strategy=dynamic
--[no]incompatible_dont_use_javasourceinfoprovider default: "false"
No-op
Tags: incompatible_change
--local_termination_grace_seconds=<an integer> default: "15"
Time to wait between terminating a local process due to timeout and forcefully shutting it down.
--override_repository=<an equals-separated mapping of repository name to path> multiple uses are accumulated
Override a repository with a local path in the form of <repository name>=<path>. If the given path is an absolute path, it will be used as it is. If the given path is a relative path, it is relative to the current working directory. If the given path starts with '%workspace%, it is relative to the workspace root, which is the output of `bazel info workspace`
--package_path=<colon-separated list of options> default: "%workspace%"
A colon-separated list of where to look for packages. Elements beginning with '%workspace%' are relative to the enclosing workspace. If omitted or empty, the default is the output of 'bazel info default-package-path'.
--[no]show_loading_progress default: "true"
If enabled, causes Bazel to print "Loading package:" messages.
--test_lang_filters=<comma-separated list of options> default: ""
Specifies a comma-separated list of test languages. Each language can be optionally preceded with '-' to specify excluded languages. Only those test targets will be found that are written in the specified languages. The name used for each language should be the same as the language prefix in the *_test rule, e.g. one of 'cc', 'java', 'py', etc. This option affects --build_tests_only behavior and the test command.
--test_size_filters=<comma-separated list of values: small, medium, large or enormous> default: ""
Specifies a comma-separated list of test sizes. Each size can be optionally preceded with '-' to specify excluded sizes. Only those test targets will be found that contain at least one included size and do not contain any excluded sizes. This option affects --build_tests_only behavior and the test command.
--test_tag_filters=<comma-separated list of options> default: ""
Specifies a comma-separated list of test tags. Each tag can be optionally preceded with '-' to specify excluded tags. Only those test targets will be found that contain at least one included tag and do not contain any excluded tags. This option affects --build_tests_only behavior and the test command.
--test_timeout_filters=<comma-separated list of values: short, moderate, long or eternal> default: ""
Specifies a comma-separated list of test timeouts. Each timeout can be optionally preceded with '-' to specify excluded timeouts. Only those test targets will be found that contain at least one included timeout and do not contain any excluded timeouts. This option affects --build_tests_only behavior and the test command.
--workspace_status_command=<path> default: ""
A command invoked at the beginning of the build to provide status information about the workspace in the form of key/value pairs. See the User's Manual for the full specification. Also see tools/buildstamp/get_workspace_status for an example.
Options that control build execution:
--[no]check_up_to_date default: "false"
Don't perform the build, just check if it is up-to-date. If all targets are up-to-date, the build completes successfully. If any step needs to be executed an error is reported and the build fails.
Tags: execution
Whether to make direct file system calls to create symlink trees
Tags: loading_and_analysis, execution, experimental
--[no]experimental_persistent_aar_extractor default: "false"
Enable persistent aar extractor by using workers.
Tags: execution
--[no]experimental_remotable_source_manifests default: "false"
Whether to make source manifest actions remotable
Tags: loading_and_analysis, execution, experimental
--[no]experimental_split_coverage_postprocessing default: "false"
If true, then Bazel will run coverage postprocessing for test in a new spawn.
Tags: execution
--[no]experimental_split_xml_generation default: "true"
If this flag is set, and a test action does not generate a test.xml file, then Bazel uses a separate action to generate a dummy test.xml file containing the test log. Otherwise, Bazel generates a test.xml as part of the test action.
Tags: execution
--[no]experimental_strict_fileset_output default: "false"
If this option is enabled, filesets will treat all output artifacts as regular files. They will not traverse directories or be sensitive to symlinks.
Tags: execution
--[no]experimental_use_semaphore_for_jobs default: "false"
If set to true, additionally use semaphore to limit number of concurrent jobs.
Tags: host_machine_resource_optimizations, execution
--genrule_strategy=<comma-separated list of options> default: ""
Specify how to execute genrules. This flag will be phased out. Instead, use --spawn_strategy=<value> to control all actions or --strategy=Genrule=<value> to control genrules only.
Tags: execution
--jobs=<an integer, or a keyword ("auto", "HOST_CPUS", "HOST_RAM"), optionally followed by an operation ([-|*]<float>) eg. "auto", "HOST_CPUS*.5"> [-j] default: "auto"
The number of concurrent jobs to run. Takes an integer, or a keyword ("auto", "HOST_CPUS", "HOST_RAM"), optionally followed by an operation ([-|*]<float>) eg. "auto", "HOST_CPUS*.5". Values must be between 1 and 5000. Values above 2500 may cause memory issues. "auto" calculates a reasonable default based on host resources.
Tags: host_machine_resource_optimizations, execution
--[no]keep_going [-k] default: "false"
Continue as much as possible after an error. While the target that failed and those that depend on it cannot be analyzed, other prerequisites of these targets can be.
Tags: eagerness_to_exit
--loading_phase_threads=<an integer, or a keyword ("auto", "HOST_CPUS", "HOST_RAM"), optionally followed by an operation ([-|*]<float>) eg. "auto", "HOST_CPUS*.5"> default: "auto"
Number of parallel threads to use for the loading/analysis phase.Takes an integer, or a keyword ("auto", "HOST_CPUS", "HOST_RAM"), optionally followed by an operation ([-|*]<float>) eg. "auto", "HOST_CPUS*.5". "auto" sets a reasonable default based on host resources. Must be at least 1.
Tags: bazel_internal_configuration
--modify_execution_info=<regex=[+-]key,regex=[+-]key,...> default: ""
Add or remove keys from an action's execution info based on action mnemonic. Applies only to actions which support execution info. Many common actions support execution info, e.g. Genrule, CppCompile, Javac, StarlarkAction, TestRunner. When specifying multiple values, order matters because many regexes may apply to the same mnemonic. Syntax: "regex=[+-]key,regex=[+-]key,...". Examples: '.*=+x,.*=-y,.*=+z' adds 'x' and 'z' to, and removes 'y' from, the execution info for all actions. 'Genrule=+requires-x' adds 'requires-x' to the execution info for all Genrule actions. '(?!Genrule).*=-requires-x' removes 'requires-x' from the execution info for all non-Genrule actions.
Tags: execution, affects_outputs, loading_and_analysis
--persistent_android_dex_desugar
Enable persistent Android dex and desugar actions by using workers.
Expands to:
  --internal_persistent_android_dex_desugar
  --strategy=Desugar=worker
  --strategy=DexBuilder=worker

Tags: host_machine_resource_optimizations, execution
--persistent_android_resource_processor
Enable persistent Android resource processor by using workers.
Expands to:
  --internal_persistent_busybox_tools
  --strategy=AaptPackage=worker
  --strategy=AndroidResourceParser=worker
  --strategy=AndroidResourceValidator=worker
  --strategy=AndroidResourceCompiler=worker
  --strategy=RClassGenerator=worker
  --strategy=AndroidResourceLink=worker
  --strategy=AndroidAapt2=worker
  --strategy=AndroidAssetMerger=worker
  --strategy=AndroidResourceMerger=worker
  --strategy=AndroidCompiledResourceMerger=worker
  --strategy=ManifestMerger=worker
  --strategy=AndroidManifestMerger=worker
  --strategy=Aapt2Optimize=worker
  --strategy=AARGenerator=worker
  --strategy=ProcessDatabinding=worker
  --strategy=GenerateDataBindingBaseClasses=worker

Tags: host_machine_resource_optimizations, execution
--persistent_multiplex_android_dex_desugar
Enable persistent multiplexed Android dex and desugar actions by using workers.
Expands to:
  --persistent_android_dex_desugar
  --internal_persistent_multiplex_android_dex_desugar

Tags: host_machine_resource_optimizations, execution
--persistent_multiplex_android_resource_processor
Enable persistent multiplexed Android resource processor by using workers.
Expands to:
  --persistent_android_resource_processor
  --modify_execution_info=AaptPackage=+supports-multiplex-workers
  --modify_execution_info=AndroidResourceParser=+supports-multiplex-workers
  --modify_execution_info=AndroidResourceValidator=+supports-multiplex-workers
  --modify_execution_info=AndroidResourceCompiler=+supports-multiplex-workers
  --modify_execution_info=RClassGenerator=+supports-multiplex-workers
  --modify_execution_info=AndroidResourceLink=+supports-multiplex-workers
  --modify_execution_info=AndroidAapt2=+supports-multiplex-workers
  --modify_execution_info=AndroidAssetMerger=+supports-multiplex-workers
  --modify_execution_info=AndroidResourceMerger=+supports-multiplex-workers
  --modify_execution_info=AndroidCompiledResourceMerger=+supports-multiplex-workers
  --modify_execution_info=ManifestMerger=+supports-multiplex-workers
  --modify_execution_info=AndroidManifestMerger=+supports-multiplex-workers
  --modify_execution_info=Aapt2Optimize=+supports-multiplex-workers
  --modify_execution_info=AARGenerator=+supports-multiplex-workers

Tags: host_machine_resource_optimizations, execution
--persistent_multiplex_android_tools
Enable persistent and multiplexed Android tools (dexing, desugaring, resource processing).
Expands to:
  --internal_persistent_multiplex_busybox_tools
  --persistent_multiplex_android_resource_processor
  --persistent_multiplex_android_dex_desugar

Tags: host_machine_resource_optimizations, execution
--[no]skip_incompatible_explicit_targets default: "false"
Skip incompatible targets that are explicitly listed on the command line. By default, building such targets results in an error but they are silently skipped when this option is enabled. See: https://bazel.build/extending/platforms#skipping-incompatible-targets
Tags: loading_and_analysis
--spawn_strategy=<comma-separated list of options> default: ""
Specify how spawn actions are executed by default. Accepts a comma-separated list of strategies from highest to lowest priority. For each action Bazel picks the strategy with the highest priority that can execute the action. The default value is "remote,worker,sandboxed,local". See https://blog.bazel.build/2019/06/19/list-strategy.html for details.
Tags: execution
--strategy=<a '[name=]value1[,..,valueN]' assignment> multiple uses are accumulated
Specify how to distribute compilation of other spawn actions. Accepts a comma-separated list of strategies from highest to lowest priority. For each action Bazel picks the strategy with the highest priority that can execute the action. The default value is "remote,worker,sandboxed,local". This flag overrides the values set by --spawn_strategy (and --genrule_strategy if used with mnemonic Genrule). See https://blog.bazel.build/2019/06/19/list-strategy.html for details.
Tags: execution
--strategy_regexp=<a '<RegexFilter>=value[,value]' assignment> multiple uses are accumulated
Override which spawn strategy should be used to execute spawn actions that have descriptions matching a certain regex_filter. See --per_file_copt for details onregex_filter matching. The last regex_filter that matches the description is used. This option overrides other flags for specifying strategy. Example: --strategy_regexp=//foo.*\.cc,-//foo/bar=local means to run actions using local strategy if their descriptions match //foo.*.cc but not //foo/bar. Example: --strategy_regexp='Compiling.*/bar=local --strategy_regexp=Compiling=sandboxed will run 'Compiling //foo/bar/baz' with the 'local' strategy, but reversing the order would run it with 'sandboxed'.
Tags: execution
--[no]use_target_platform_for_tests default: "false"
If true, then Bazel will use the target platform for running tests rather than the test exec group.
Tags: execution
Options that configure the toolchain used for action execution:
--android_compiler=<a string> default: see description
The Android target compiler.
Tags: affects_outputs, loading_and_analysis, loses_incremental_state
--android_crosstool_top=<a build target label> default: "//external:android/crosstool"
The location of the C++ compiler used for Android builds.
Tags: affects_outputs, changes_inputs, loading_and_analysis, loses_incremental_state
--android_grte_top=<a label> default: see description
The Android target grte_top.
Tags: changes_inputs, loading_and_analysis, loses_incremental_state
--android_manifest_merger=<legacy, android or force_android> default: "android"
Selects the manifest merger to use for android_binary rules. Flag to help thetransition to the Android manifest merger from the legacy merger.
Tags: affects_outputs, loading_and_analysis, loses_incremental_state
--android_platforms=<a build target label> default: ""
Sets the platforms that android_binary targets use. If multiple platforms are specified, then the binary is a fat APKs, which contains native binaries for each specified target platform.
Tags: changes_inputs, loading_and_analysis, loses_incremental_state
--android_sdk=<a build target label> default: "@bazel_tools//tools/android:sdk"
Specifies Android SDK/platform that is used to build Android applications.
Tags: changes_inputs, loading_and_analysis, loses_incremental_state
--apple_crosstool_top=<a build target label> default: "@bazel_tools//tools/cpp:toolchain"
The label of the crosstool package to be used in Apple and Objc rules and their dependencies.
Tags: loses_incremental_state, changes_inputs
--cc_output_directory_tag=<a string> default: ""
Specifies a suffix to be added to the configuration directory.
Tags: affects_outputs
--compiler=<a string> default: see description
The C++ compiler to use for compiling the target.
Tags: loading_and_analysis, execution
--coverage_output_generator=<a build target label> default: "@bazel_tools//tools/test:lcov_merger"
Location of the binary that is used to postprocess raw coverage reports. This must currently be a filegroup that contains a single file, the binary. Defaults to '//tools/test:lcov_merger'.
Tags: changes_inputs, affects_outputs, loading_and_analysis
--coverage_report_generator=<a build target label> default: "@bazel_tools//tools/test:coverage_report_generator"
Location of the binary that is used to generate coverage reports. This must currently be a filegroup that contains a single file, the binary. Defaults to '//tools/test:coverage_report_generator'.
Tags: changes_inputs, affects_outputs, loading_and_analysis
--coverage_support=<a build target label> default: "@bazel_tools//tools/test:coverage_support"
Location of support files that are required on the inputs of every test action that collects code coverage. Defaults to '//tools/test:coverage_support'.
Tags: changes_inputs, affects_outputs, loading_and_analysis
--custom_malloc=<a build target label> default: see description
Specifies a custom malloc implementation. This setting overrides malloc attributes in build rules.
Tags: changes_inputs, affects_outputs
--experimental_add_exec_constraints_to_targets=<a '<RegexFilter>=<label1>[,<label2>,...]' assignment> multiple uses are accumulated
List of comma-separated regular expressions, each optionally prefixed by - (negative expression), assigned (=) to a list of comma-separated constraint value targets. If a target matches no negative expression and at least one positive expression its toolchain resolution will be performed as if it had declared the constraint values as execution constraints. Example: //demo,-test=@platforms//cpus:x86_64 will add 'x86_64' to any target under //demo except for those whose name contains 'test'.
Tags: loading_and_analysis
--[no]experimental_include_xcode_execution_requirements default: "false"
If set, add a "requires-xcode:{version}" execution requirement to every Xcode action. If the xcode version has a hyphenated label, also add a "requires-xcode-label:{version_label}" execution requirement.
Tags: loses_incremental_state, loading_and_analysis, execution
--[no]experimental_prefer_mutual_xcode default: "true"
If true, use the most recent Xcode that is available both locally and remotely. If false, or if there are no mutual available versions, use the local Xcode version selected via xcode-select.
Tags: loses_incremental_state
--extra_execution_platforms=<comma-separated list of options> default: ""
The platforms that are available as execution platforms to run actions. Platforms can be specified by exact target, or as a target pattern. These platforms will be considered before those declared in the WORKSPACE file by register_execution_platforms(). This option may only be set once; later instances will override earlier flag settings.
Tags: execution
--extra_toolchains=<comma-separated list of options> multiple uses are accumulated
The toolchain rules to be considered during toolchain resolution. Toolchains can be specified by exact target, or as a target pattern. These toolchains will be considered before those declared in the WORKSPACE file by register_toolchains().
Tags: affects_outputs, changes_inputs, loading_and_analysis
--grte_top=<a label> default: see description
A label to a checked-in libc library. The default value is selected by the crosstool toolchain, and you almost never need to override it.
Tags: action_command_lines, affects_outputs
--host_compiler=<a string> default: see description
No-op flag. Will be removed in a future release.
Tags: loading_and_analysis, execution
--host_grte_top=<a label> default: see description
If specified, this setting overrides the libc top-level directory (--grte_top) for the exec configuration.
Tags: action_command_lines, affects_outputs
--host_platform=<a build target label> default: "@local_config_platform//:host"
The label of a platform rule that describes the host system.
Tags: affects_outputs, changes_inputs, loading_and_analysis
--[no]incompatible_dont_enable_host_nonhost_crosstool_features default: "true"
If true, Bazel will not enable 'host' and 'nonhost' features in the c++ toolchain (see https://github.com/bazelbuild/bazel/issues/7407 for more information).
Tags: loading_and_analysis, incompatible_change
--[no]incompatible_enable_android_toolchain_resolution default: "true"
Use toolchain resolution to select the Android SDK for android rules (Starlark and native)
Tags: loading_and_analysis, incompatible_change
--[no]incompatible_enable_apple_toolchain_resolution default: "false"
Use toolchain resolution to select the Apple SDK for apple rules (Starlark and native)
Tags: loading_and_analysis, incompatible_change
--[no]incompatible_make_thinlto_command_lines_standalone default: "true"
If true, Bazel will not reuse C++ link action command lines for lto indexing command lines (see https://github.com/bazelbuild/bazel/issues/6791 for more information).
Tags: loading_and_analysis, incompatible_change
--[no]incompatible_remove_legacy_whole_archive default: "true"
If true, Bazel will not link library dependencies as whole archive by default (see https://github.com/bazelbuild/bazel/issues/7362 for migration instructions).
Tags: loading_and_analysis, incompatible_change
--[no]incompatible_require_ctx_in_configure_features default: "true"
This flag is a noop and scheduled for removal.
Tags: no_op, incompatible_change
--[no]interface_shared_objects default: "true"
Use interface shared objects if supported by the toolchain. All ELF toolchains currently support this setting.
Tags: loading_and_analysis, affects_outputs, affects_outputs
--ios_sdk_version=<a dotted version (for example '2.3' or '3.3alpha2.4')> default: see description
Specifies the version of the iOS SDK to use to build iOS applications. If unspecified, uses default iOS SDK version from 'xcode_version'.
Tags: loses_incremental_state
--macos_sdk_version=<a dotted version (for example '2.3' or '3.3alpha2.4')> default: see description
Specifies the version of the macOS SDK to use to build macOS applications. If unspecified, uses default macOS SDK version from 'xcode_version'.
Tags: loses_incremental_state
--minimum_os_version=<a string> default: see description
The minimum OS version which your compilation targets.
Tags: loading_and_analysis, affects_outputs
--platform_mappings=<a relative path> default: ""
The location of a mapping file that describes which platform to use if none is set or which flags to set when a platform already exists. Must be relative to the main workspace root. Defaults to 'platform_mappings' (a file directly under the workspace root).
Tags: affects_outputs, changes_inputs, loading_and_analysis
--platforms=<a build target label> default: ""
The labels of the platform rules describing the target platforms for the current command.
Tags: affects_outputs, changes_inputs, loading_and_analysis
--python2_path=<a string> default: see description
Deprecated, no-op. Disabled by `--incompatible_use_python_toolchains`.
Tags: no_op, deprecated
--python3_path=<a string> default: see description
Deprecated, no-op. Disabled by `--incompatible_use_python_toolchains`.
Tags: no_op, deprecated
--python_path=<a string> default: see description
The absolute path of the Python interpreter invoked to run Python targets on the target platform. Deprecated; disabled by --incompatible_use_python_toolchains.
Tags: loading_and_analysis, affects_outputs
--python_top=<a build target label> default: see description
The label of a py_runtime representing the Python interpreter invoked to run Python targets on the target platform. Deprecated; disabled by --incompatible_use_python_toolchains.
Tags: loading_and_analysis, affects_outputs
--tvos_sdk_version=<a dotted version (for example '2.3' or '3.3alpha2.4')> default: see description
Specifies the version of the tvOS SDK to use to build tvOS applications. If unspecified, uses default tvOS SDK version from 'xcode_version'.
Tags: loses_incremental_state
--watchos_sdk_version=<a dotted version (for example '2.3' or '3.3alpha2.4')> default: see description
Specifies the version of the watchOS SDK to use to build watchOS applications. If unspecified, uses default watchOS SDK version from 'xcode_version'.
Tags: loses_incremental_state
--xcode_version=<a string> default: see description
If specified, uses Xcode of the given version for relevant build actions. If unspecified, uses the executor default version of Xcode.
Tags: loses_incremental_state
--xcode_version_config=<a build target label> default: "@bazel_tools//tools/cpp:host_xcodes"
The label of the xcode_config rule to be used for selecting the Xcode version in the build configuration.
Tags: loses_incremental_state, loading_and_analysis
Options that control the output of the command:
--[no]apple_generate_dsym default: "false"
Whether to generate debug symbol(.dSYM) file(s).
Tags: affects_outputs, action_command_lines
--[no]build default: "true"
Execute the build; this is the usual behaviour. Specifying --nobuild causes the build to stop before executing the build actions, returning zero iff the package loading and analysis phases completed successfully; this mode is useful for testing those phases.
Tags: execution, affects_outputs
If true, build runfiles symlink forests for all targets. If false, write them only when required by a local action, test or run command.
Tags: affects_outputs
--[no]build_runfile_manifests default: "true"
If true, write runfiles manifests for all targets. If false, omit them. Local tests will fail to run when false.
Tags: affects_outputs
--[no]build_test_dwp default: "false"
If enabled, when building C++ tests statically and with fission the .dwp file for the test binary will be automatically built as well.
Tags: loading_and_analysis, affects_outputs
--cc_proto_library_header_suffixes=<comma-separated set of options> default: ".pb.h"
Sets the suffixes of header files that a cc_proto_library creates.
Tags: affects_outputs, loading_and_analysis
--cc_proto_library_source_suffixes=<comma-separated set of options> default: ".pb.cc"
Sets the suffixes of source files that a cc_proto_library creates.
Tags: affects_outputs, loading_and_analysis
--[no]experimental_proto_descriptor_sets_include_source_info default: "false"
Run extra actions for alternative Java api versions in a proto_library.
Tags: affects_outputs, loading_and_analysis, experimental
--[no]experimental_proto_extra_actions default: "false"
Run extra actions for alternative Java api versions in a proto_library.
Tags: affects_outputs, loading_and_analysis, experimental
--[no]experimental_save_feature_state default: "false"
Save the state of enabled and requested feautres as an output of compilation.
Tags: affects_outputs, experimental
--[no]experimental_use_validation_aspect default: "false"
Whether to run validation actions using aspect (for parallelism with tests).
Tags: execution, affects_outputs
--fission=<a set of compilation modes> default: "no"
Specifies which compilation modes use fission for C++ compilations and links. May be any combination of {'fastbuild', 'dbg', 'opt'} or the special values 'yes' to enable all modes and 'no' to disable all modes.
Tags: loading_and_analysis, action_command_lines, affects_outputs
--[no]incompatible_always_include_files_in_data default: "true"
If true, native rules add <code>DefaultInfo.files</code> of data dependencies to their runfiles, which matches the recommended behavior for Starlark rules (https://bazel.build/extending/rules#runfiles_features_to_avoid).
Tags: affects_outputs, incompatible_change
--[no]legacy_external_runfiles default: "true"
If true, build runfiles symlink forests for external repositories under .runfiles/wsname/external/repo (in addition to .runfiles/repo).
Tags: affects_outputs
--[no]objc_generate_linkmap default: "false"
Specifies whether to generate a linkmap file.
Tags: affects_outputs
--output_groups=<comma-separated list of options> multiple uses are accumulated
A list of comma-separated output group names, each of which optionally prefixed by a + or a -. A group prefixed by + is added to the default set of output groups, while a group prefixed by - is removed from the default set. If at least one group is not prefixed, the default set of output groups is omitted. For example, --output_groups=+foo,+bar builds the union of the default set, foo, and bar, while --output_groups=foo,bar overrides the default set such that only foo and bar are built.
Tags: execution, affects_outputs
--[no]run_validations default: "true"
Whether to run validation actions as part of the build. See https://bazel.build/extending/rules#validation_actions
Tags: execution, affects_outputs
--[no]save_temps default: "false"
If set, temporary outputs from gcc will be saved. These include .s files (assembler code), .i files (preprocessed C) and .ii files (preprocessed C++).
Tags: affects_outputs
Options that let the user configure the intended output, affecting its value, as opposed to its existence:
--action_env=<a 'name=value' assignment with an optional value part> multiple uses are accumulated
Specifies the set of environment variables available to actions with target configuration. Variables can be either specified by name, in which case the value will be taken from the invocation environment, or by the name=value pair which sets the value independent of the invocation environment. This option can be used multiple times; for options given for the same variable, the latest wins, options for different variables accumulate.
Tags: action_command_lines
--android_cpu=<a string> default: "armeabi-v7a"
The Android target CPU.
Tags: affects_outputs, loading_and_analysis, loses_incremental_state
--[no]android_databinding_use_androidx default: "true"
Generate AndroidX-compatible data-binding files. This is only used with databinding v2. This flag is a no-op.
Tags: affects_outputs, loading_and_analysis, loses_incremental_state, experimental
--[no]android_databinding_use_v3_4_args default: "true"
Use android databinding v2 with 3.4.0 argument. This flag is a no-op.
Tags: affects_outputs, loading_and_analysis, loses_incremental_state, experimental
--android_dynamic_mode=<off, default or fully> default: "off"
Determines whether C++ deps of Android rules will be linked dynamically when a cc_binary does not explicitly create a shared library. 'default' means bazel will choose whether to link dynamically. 'fully' means all libraries will be linked dynamically. 'off' means that all libraries will be linked in mostly static mode.
Tags: affects_outputs, loading_and_analysis
--android_manifest_merger_order=<alphabetical, alphabetical_by_configuration or dependency> default: "alphabetical"
Sets the order of manifests passed to the manifest merger for Android binaries. ALPHABETICAL means manifests are sorted by path relative to the execroot. ALPHABETICAL_BY_CONFIGURATION means manifests are sorted by paths relative to the configuration directory within the output directory. DEPENDENCY means manifests are ordered with each library's manifest coming before the manifests of its dependencies.
Tags: action_command_lines, execution
--[no]android_resource_shrinking default: "false"
Enables resource shrinking for android_binary APKs that use ProGuard.
Tags: affects_outputs, loading_and_analysis
--aspects=<comma-separated list of options> multiple uses are accumulated
Comma-separated list of aspects to be applied to top-level targets. In the list, if aspect some_aspect specifies required aspect providers via required_aspect_providers, some_aspect will run after every aspect that was mentioned before it in the aspects list whose advertised providers satisfy some_aspect required aspect providers. Moreover, some_aspect will run after all its required aspects specified by requires attribute. some_aspect will then have access to the values of those aspects' providers. <bzl-file-label>%<aspect_name>, for example '//tools:my_def.bzl%my_aspect', where 'my_aspect' is a top-level value from a file tools/my_def.bzl
--[no]build_python_zip default: "auto"
Build python executable zip; on on Windows, off on other platforms
Tags: affects_outputs
--catalyst_cpus=<comma-separated list of options> multiple uses are accumulated
Comma-separated list of architectures for which to build Apple Catalyst binaries.
Tags: loses_incremental_state, loading_and_analysis
--[no]collect_code_coverage default: "false"
If specified, Bazel will instrument code (using offline instrumentation where possible) and will collect coverage information during tests. Only targets that match --instrumentation_filter will be affected. Usually this option should not be specified directly - 'bazel coverage' command should be used instead.
Tags: affects_outputs
--compilation_mode=<fastbuild, dbg or opt> [-c] default: "fastbuild"
Specify the mode the binary will be built in. Values: 'fastbuild', 'dbg', 'opt'.
Tags: affects_outputs, action_command_lines
--conlyopt=<a string> multiple uses are accumulated
Additional option to pass to gcc when compiling C source files.
Tags: action_command_lines, affects_outputs
--copt=<a string> multiple uses are accumulated
Additional options to pass to gcc.
Tags: action_command_lines, affects_outputs
--cpu=<a string> default: ""
The target CPU.
Tags: changes_inputs, affects_outputs
--cs_fdo_absolute_path=<a string> default: see description
Use CSFDO profile information to optimize compilation. Specify the absolute path name of the zip file containing the profile file, a raw or an indexed LLVM profile file.
Tags: affects_outputs
--cs_fdo_instrument=<a string> default: see description
Generate binaries with context sensitive FDO instrumentation. With Clang/LLVM compiler, it also accepts the directory name under which the raw profile file(s) will be dumped at runtime.
Tags: affects_outputs
--cs_fdo_profile=<a build target label> default: see description
The cs_fdo_profile representing the context sensitive profile to be used for optimization.
Tags: affects_outputs
--cxxopt=<a string> multiple uses are accumulated
Additional option to pass to gcc when compiling C++ source files.
Tags: action_command_lines, affects_outputs
--define=<a 'name=value' assignment> multiple uses are accumulated
Each --define option specifies an assignment for a build variable. In case of multiple values for a variable, the last one wins.
Tags: changes_inputs, affects_outputs
--dynamic_mode=<off, default or fully> default: "default"
Determines whether C++ binaries will be linked dynamically. 'default' means Bazel will choose whether to link dynamically. 'fully' means all libraries will be linked dynamically. 'off' means that all libraries will be linked in mostly static mode.
Tags: loading_and_analysis, affects_outputs
--[no]enable_fdo_profile_absolute_path default: "true"
If set, use of fdo_absolute_profile_path will raise an error.
Tags: affects_outputs
--[no]enable_runfiles default: "auto"
Enable runfiles symlink tree; By default, it's off on Windows, on on other platforms.
Tags: affects_outputs
--experimental_action_listener=<a build target label> multiple uses are accumulated
Deprecated in favor of aspects. Use action_listener to attach an extra_action to existing build actions.
Tags: execution, experimental
--[no]experimental_android_compress_java_resources default: "false"
Compress Java resources in APKs
Tags: affects_outputs, loading_and_analysis, experimental
--[no]experimental_android_databinding_v2 default: "true"
Use android databinding v2. This flag is a no-op.
Tags: affects_outputs, loading_and_analysis, loses_incremental_state, experimental
--[no]experimental_android_resource_shrinking default: "false"
Enables resource shrinking for android_binary APKs that use ProGuard.
Tags: affects_outputs, loading_and_analysis
--[no]experimental_android_rewrite_dexes_with_rex default: "false"
use rex tool to rewrite dex files
Tags: affects_outputs, loading_and_analysis, loses_incremental_state, experimental
--[no]experimental_collect_code_coverage_for_generated_files default: "false"
If specified, Bazel will also generate collect coverage information for generated files.
Tags: affects_outputs
This flag controls how the convenience symlinks (the symlinks that appear in the workspace after the build) will be managed. Possible values: normal (default): Each kind of convenience symlink will be created or deleted, as determined by the build. clean: All symlinks will be unconditionally deleted. ignore: Symlinks will be left alone. log_only: Generate log messages as if 'normal' were passed, but don't actually perform any filesystem operations (useful for tools). Note that only symlinks whose names are generated by the current value of --symlink_prefix can be affected; if the prefix changes, any pre-existing symlinks will be left alone.
Tags: affects_outputs
This flag controls whether or not we will post the build eventConvenienceSymlinksIdentified to the BuildEventProtocol. If the value is true, the BuildEventProtocol will have an entry for convenienceSymlinksIdentified, listing all of the convenience symlinks created in your workspace. If false, then the convenienceSymlinksIdentified entry in the BuildEventProtocol will be empty.
Tags: affects_outputs
--experimental_objc_fastbuild_options=<comma-separated list of options> default: "-O0,-DDEBUG=1"
Uses these strings as objc fastbuild compiler options.
Tags: action_command_lines
--[no]experimental_omitfp default: "false"
If true, use libunwind for stack unwinding, and compile with -fomit-frame-pointer and -fasynchronous-unwind-tables.
Tags: action_command_lines, affects_outputs, experimental
--experimental_output_paths=<off, content or strip> default: "off"
Which model to use for where in the output tree rules write their outputs, particularly for multi-platform / multi-configuration builds. This is highly experimental. See https://github.com/bazelbuild/bazel/issues/6526 for details. Starlark actions canopt into path mapping by adding the key 'supports-path-mapping' to the 'execution_requirements' dict.
Tags: loses_incremental_state, bazel_internal_configuration, affects_outputs, execution
--experimental_override_name_platform_in_output_dir=<a 'label=value' assignment> multiple uses are accumulated
Each entry should be of the form label=value where label refers to a platform and values is the desired shortname to use in the output path. Only used when --experimental_platform_in_output_dir is true. Has highest naming priority.
Tags: affects_outputs, experimental
--[no]experimental_platform_in_output_dir default: "false"
If true, a shortname for the target platform is used in the output directory name instead of the CPU. The exact scheme is experimental and subject to change: First, in the rare case the --platforms option does not have exactly one value, a hash of the platforms option is used. Next, if any shortname for the current platform was registered by --experimental_override_name_platform_in_output_dir, then that shortname is used. Then, if --experimental_use_platforms_in_output_dir_legacy_heuristic is set, use a shortname based off the current platform Label. Finally, a hash of the platform option is used as a last resort.
Tags: affects_outputs, experimental
--[no]experimental_use_llvm_covmap default: "false"
If specified, Bazel will generate llvm-cov coverage map information rather than gcov when collect_code_coverage is enabled.
Tags: changes_inputs, affects_outputs, loading_and_analysis, experimental
--[no]experimental_use_platforms_in_output_dir_legacy_heuristic default: "true"
Please only use this flag as part of a suggested migration or testing strategy. Note that the heuristic has known deficiencies and it is suggested to migrate to relying on just --experimental_override_name_platform_in_output_dir.
Tags: affects_outputs, experimental
--fat_apk_cpu=<comma-separated set of options> default: "armeabi-v7a"
Setting this option enables fat APKs, which contain native binaries for all specified target architectures, e.g., --fat_apk_cpu=x86,armeabi-v7a. If this flag is specified, then --android_cpu is ignored for dependencies of android_binary rules.
Tags: affects_outputs, loading_and_analysis, loses_incremental_state
--[no]fat_apk_hwasan default: "false"
Whether to create HWASAN splits.
Tags: affects_outputs, loading_and_analysis, loses_incremental_state
--fdo_instrument=<a string> default: see description
Generate binaries with FDO instrumentation. With Clang/LLVM compiler, it also accepts the directory name under which the raw profile file(s) will be dumped at runtime.
Tags: affects_outputs
--fdo_optimize=<a string> default: see description
Use FDO profile information to optimize compilation. Specify the name of a zip file containing a .gcda file tree, an afdo file containing an auto profile, or an LLVM profile file. This flag also accepts files specified as labels (e.g. `//foo/bar:file.afdo` - you may need to add an `exports_files` directive to the corresponding package) and labels pointing to `fdo_profile` targets. This flag will be superseded by the `fdo_profile` rule.
Tags: affects_outputs
--fdo_prefetch_hints=<a build target label> default: see description
Use cache prefetch hints.
Tags: affects_outputs
--fdo_profile=<a build target label> default: see description
The fdo_profile representing the profile to be used for optimization.
Tags: affects_outputs
--features=<a string> multiple uses are accumulated
The given features will be enabled or disabled by default for targets built in the target configuration. Specifying -<feature> will disable the feature. Negative features always override positive ones. See also --host_features
Tags: changes_inputs, affects_outputs
--[no]force_pic default: "false"
If enabled, all C++ compilations produce position-independent code ("-fPIC"), links prefer PIC pre-built libraries over non-PIC libraries, and links produce position-independent executables ("-pie").
Tags: loading_and_analysis, affects_outputs
--host_action_env=<a 'name=value' assignment with an optional value part> multiple uses are accumulated
Specifies the set of environment variables available to actions with execution configurations. Variables can be either specified by name, in which case the value will be taken from the invocation environment, or by the name=value pair which sets the value independent of the invocation environment. This option can be used multiple times; for options given for the same variable, the latest wins, options for different variables accumulate.
Tags: action_command_lines
--host_compilation_mode=<fastbuild, dbg or opt> default: "opt"
Specify the mode the tools used during the build will be built in. Values: 'fastbuild', 'dbg', 'opt'.
Tags: affects_outputs, action_command_lines
--host_conlyopt=<a string> multiple uses are accumulated
Additional option to pass to the C compiler when compiling C (but not C++) source files in the exec configurations.
Tags: action_command_lines, affects_outputs
--host_copt=<a string> multiple uses are accumulated
Additional options to pass to the C compiler for tools built in the exec configurations.
Tags: action_command_lines, affects_outputs
--host_cpu=<a string> default: ""
The host CPU.
Tags: changes_inputs, affects_outputs
--host_cxxopt=<a string> multiple uses are accumulated
Additional options to pass to C++ compiler for tools built in the exec configurations.
Tags: action_command_lines, affects_outputs
--host_features=<a string> multiple uses are accumulated
The given features will be enabled or disabled by default for targets built in the exec configuration. Specifying -<feature> will disable the feature. Negative features always override positive ones.
Tags: changes_inputs, affects_outputs
--host_force_python=<PY2 or PY3> default: see description
Overrides the Python version for the exec configuration. Can be "PY2" or "PY3".
Tags: loading_and_analysis, affects_outputs
--host_linkopt=<a string> multiple uses are accumulated
Additional option to pass to linker when linking tools in the exec configurations.
Tags: action_command_lines, affects_outputs
--host_macos_minimum_os=<a dotted version (for example '2.3' or '3.3alpha2.4')> default: see description
Minimum compatible macOS version for host targets. If unspecified, uses 'macos_sdk_version'.
Tags: loses_incremental_state
--host_per_file_copt=<a comma-separated list of regex expressions with prefix '-' specifying excluded paths followed by an @ and a comma separated list of options> multiple uses are accumulated
Additional options to selectively pass to the C/C++ compiler when compiling certain files in the exec configurations. This option can be passed multiple times. Syntax: regex_filter@option_1,option_2,...,option_n. Where regex_filter stands for a list of include and exclude regular expression patterns (Also see --instrumentation_filter). option_1 to option_n stand for arbitrary command line options. If an option contains a comma it has to be quoted with a backslash. Options can contain @. Only the first @ is used to split the string. Example: --host_per_file_copt=//foo/.*\.cc,-//foo/bar\.cc@-O0 adds the -O0 command line option to the gcc command line of all cc files in //foo/ except bar.cc.
Tags: action_command_lines, affects_outputs
--[no]incompatible_auto_exec_groups default: "false"
When enabled, an exec groups is automatically created for each toolchain used by a rule. For this to work rule needs to specify `toolchain` parameter on its actions. For more information, see https://github.com/bazelbuild/bazel/issues/17134.
Tags: affects_outputs, incompatible_change
--[no]incompatible_merge_genfiles_directory default: "true"
If true, the genfiles directory is folded into the bin directory.
Tags: affects_outputs, incompatible_change
--[no]incompatible_use_host_features default: "true"
If true, use --features only for the target configuration and --host_features for the exec configuration.
Tags: changes_inputs, affects_outputs, incompatible_change
--[no]instrument_test_targets default: "false"
When coverage is enabled, specifies whether to consider instrumenting test rules. When set, test rules included by --instrumentation_filter are instrumented. Otherwise, test rules are always excluded from coverage instrumentation.
Tags: affects_outputs
--instrumentation_filter=<a comma-separated list of regex expressions with prefix '-' specifying excluded paths> default: "-/javatests[/:],-/test/java[/:]"
When coverage is enabled, only rules with names included by the specified regex-based filter will be instrumented. Rules prefixed with '-' are excluded instead. Note that only non-test rules are instrumented unless --instrument_test_targets is enabled.
Tags: affects_outputs
--ios_minimum_os=<a dotted version (for example '2.3' or '3.3alpha2.4')> default: see description
Minimum compatible iOS version for target simulators and devices. If unspecified, uses 'ios_sdk_version'.
Tags: loses_incremental_state
--ios_multi_cpus=<comma-separated list of options> multiple uses are accumulated
Comma-separated list of architectures to build an ios_application with. The result is a universal binary containing all specified architectures.
Tags: loses_incremental_state, loading_and_analysis
--[no]legacy_whole_archive default: "true"
Deprecated, superseded by --incompatible_remove_legacy_whole_archive (see https://github.com/bazelbuild/bazel/issues/7362 for details). When on, use --whole-archive for cc_binary rules that have linkshared=True and either linkstatic=True or '-static' in linkopts. This is for backwards compatibility only. A better alternative is to use alwayslink=1 where required.
Tags: action_command_lines, affects_outputs, deprecated
--linkopt=<a string> multiple uses are accumulated
Additional option to pass to gcc when linking.
Tags: action_command_lines, affects_outputs
--ltobackendopt=<a string> multiple uses are accumulated
Additional option to pass to the LTO backend step (under --features=thin_lto).
Tags: action_command_lines, affects_outputs
--ltoindexopt=<a string> multiple uses are accumulated
Additional option to pass to the LTO indexing step (under --features=thin_lto).
Tags: action_command_lines, affects_outputs
--macos_cpus=<comma-separated list of options> multiple uses are accumulated
Comma-separated list of architectures for which to build Apple macOS binaries.
Tags: loses_incremental_state, loading_and_analysis
--macos_minimum_os=<a dotted version (for example '2.3' or '3.3alpha2.4')> default: see description
Minimum compatible macOS version for targets. If unspecified, uses 'macos_sdk_version'.
Tags: loses_incremental_state
--memprof_profile=<a build target label> default: see description
Use memprof profile.
Tags: affects_outputs
--[no]objc_debug_with_GLIBCXX default: "false"
If set, and compilation mode is set to 'dbg', define GLIBCXX_DEBUG, GLIBCXX_DEBUG_PEDANTIC and GLIBCPP_CONCEPT_CHECKS.
Tags: action_command_lines
--[no]objc_enable_binary_stripping default: "false"
Whether to perform symbol and dead-code strippings on linked binaries. Binary strippings will be performed if both this flag and --compilation_mode=opt are specified.
Tags: action_command_lines
--objccopt=<a string> multiple uses are accumulated
Additional options to pass to gcc when compiling Objective-C/C++ source files.
Tags: action_command_lines
--per_file_copt=<a comma-separated list of regex expressions with prefix '-' specifying excluded paths followed by an @ and a comma separated list of options> multiple uses are accumulated
Additional options to selectively pass to gcc when compiling certain files. This option can be passed multiple times. Syntax: regex_filter@option_1,option_2,...,option_n. Where regex_filter stands for a list of include and exclude regular expression patterns (Also see --instrumentation_filter). option_1 to option_n stand for arbitrary command line options. If an option contains a comma it has to be quoted with a backslash. Options can contain @. Only the first @ is used to split the string. Example: --per_file_copt=//foo/.*\.cc,-//foo/bar\.cc@-O0 adds the -O0 command line option to the gcc command line of all cc files in //foo/ except bar.cc.
Tags: action_command_lines, affects_outputs
--per_file_ltobackendopt=<a comma-separated list of regex expressions with prefix '-' specifying excluded paths followed by an @ and a comma separated list of options> multiple uses are accumulated
Additional options to selectively pass to LTO backend (under --features=thin_lto) when compiling certain backend objects. This option can be passed multiple times. Syntax: regex_filter@option_1,option_2,...,option_n. Where regex_filter stands for a list of include and exclude regular expression patterns. option_1 to option_n stand for arbitrary command line options. If an option contains a comma it has to be quoted with a backslash. Options can contain @. Only the first @ is used to split the string. Example: --per_file_ltobackendopt=//foo/.*\.o,-//foo/bar\.o@-O0 adds the -O0 command line option to the LTO backend command line of all o files in //foo/ except bar.o.
Tags: action_command_lines, affects_outputs
--platform_suffix=<a string> default: see description
Specifies a suffix to be added to the configuration directory.
Tags: loses_incremental_state, affects_outputs, loading_and_analysis
--propeller_optimize=<a build target label> default: see description
Use Propeller profile information to optimize the build target.A propeller profile must consist of at least one of two files, a cc profile and a ld profile. This flag accepts a build label which must refer to the propeller profile input files. For example, the BUILD file that defines the label, in a/b/BUILD:propeller_optimize( name = "propeller_profile", cc_profile = "propeller_cc_profile.txt", ld_profile = "propeller_ld_profile.txt",)An exports_files directive may have to be added to the corresponding package to make these files visible to Bazel. The option must be used as: --propeller_optimize=//a/b:propeller_profile
Tags: action_command_lines, affects_outputs
--propeller_optimize_absolute_cc_profile=<a string> default: see description
Absolute path name of cc_profile file for Propeller Optimized builds.
Tags: affects_outputs
--propeller_optimize_absolute_ld_profile=<a string> default: see description
Absolute path name of ld_profile file for Propeller Optimized builds.
Tags: affects_outputs
--run_under=<a prefix in front of command> default: see description
Prefix to insert before the executables for the 'test' and 'run' commands. If the value is 'foo -bar', and the execution command line is 'test_binary -baz', then the final command line is 'foo -bar test_binary -baz'.This can also be a label to an executable target. Some examples are: 'valgrind', 'strace', 'strace -c', 'valgrind --quiet --num-callers=20', '//package:target', '//package:target --options'.
Tags: action_command_lines
--[no]share_native_deps default: "true"
If true, native libraries that contain identical functionality will be shared among different targets
Tags: loading_and_analysis, affects_outputs
--[no]stamp default: "false"
Stamp binaries with the date, username, hostname, workspace information, etc.
Tags: affects_outputs
--strip=<always, sometimes or never> default: "sometimes"
Specifies whether to strip binaries and shared libraries (using "-Wl,--strip-debug"). The default value of 'sometimes' means strip iff --compilation_mode=fastbuild.
Tags: affects_outputs
--stripopt=<a string> multiple uses are accumulated
Additional options to pass to strip when generating a '<name>.stripped' binary.
Tags: action_command_lines, affects_outputs
--swiftcopt=<a string> multiple uses are accumulated
Additional options to pass to Swift compilation.
Tags: action_command_lines
The prefix that is prepended to any of the convenience symlinks that are created after a build. If omitted, the default value is the name of the build tool followed by a hyphen. If '/' is passed, then no symlinks are created and no warning is emitted. Warning: the special functionality for '/' will be deprecated soon; use --experimental_convenience_symlinks=ignore instead.
Tags: affects_outputs
--tvos_cpus=<comma-separated list of options> multiple uses are accumulated
Comma-separated list of architectures for which to build Apple tvOS binaries.
Tags: loses_incremental_state, loading_and_analysis
--tvos_minimum_os=<a dotted version (for example '2.3' or '3.3alpha2.4')> default: see description
Minimum compatible tvOS version for target simulators and devices. If unspecified, uses 'tvos_sdk_version'.
Tags: loses_incremental_state
--visionos_cpus=<comma-separated list of options> multiple uses are accumulated
Comma-separated list of architectures for which to build Apple visionOS binaries.
Tags: loses_incremental_state, loading_and_analysis
--watchos_cpus=<comma-separated list of options> multiple uses are accumulated
Comma-separated list of architectures for which to build Apple watchOS binaries.
Tags: loses_incremental_state, loading_and_analysis
--watchos_minimum_os=<a dotted version (for example '2.3' or '3.3alpha2.4')> default: see description
Minimum compatible watchOS version for target simulators and devices. If unspecified, uses 'watchos_sdk_version'.
Tags: loses_incremental_state
--xbinary_fdo=<a build target label> default: see description
Use XbinaryFDO profile information to optimize compilation. Specify the name of default cross binary profile. When the option is used together with --fdo_instrument/--fdo_optimize/--fdo_profile, those options will always prevail as if xbinary_fdo is never specified.
Tags: affects_outputs
Options that affect how strictly Bazel enforces valid build inputs (rule definitions, flag combinations, etc.):
--auto_cpu_environment_group=<a build target label> default: ""
Declare the environment_group to use for automatically mapping cpu values to target_environment values.
Tags: changes_inputs, loading_and_analysis, experimental
--[no]check_licenses default: "false"
Check that licensing constraints imposed by dependent packages do not conflict with distribution modes of the targets being built. By default, licenses are not checked.
Tags: build_file_semantics
--[no]check_visibility default: "true"
If disabled, visibility errors in target dependencies are demoted to warnings.
Tags: build_file_semantics
--[no]desugar_for_android default: "true"
Whether to desugar Java 8 bytecode before dexing.
Tags: affects_outputs, loading_and_analysis, loses_incremental_state
--[no]desugar_java8_libs default: "false"
Whether to include supported Java 8 libraries in apps for legacy devices.
Tags: affects_outputs, loading_and_analysis, loses_incremental_state, experimental
--[no]enforce_constraints default: "true"
Checks the environments each target is compatible with and reports errors if any target has dependencies that don't support the same environments
Tags: build_file_semantics
--[no]experimental_check_desugar_deps default: "true"
Whether to double-check correct desugaring at Android binary level.
Tags: eagerness_to_exit, loading_and_analysis, experimental
--experimental_import_deps_checking=<off, warning or error> default: "OFF"
When enabled, check whether the dependencies of an aar_import are complete. This enforcement can break the build, or can just result in warnings.
Tags: loading_and_analysis
--experimental_strict_java_deps=<off, warn, error, strict or default> default: "default"
If true, checks that a Java target explicitly declares all directly used targets as dependencies.
Tags: build_file_semantics, eagerness_to_exit
--[no]incompatible_check_testonly_for_output_files default: "false"
If enabled, check testonly for prerequisite targets that are output files by looking up the testonly of the generating rule. This matches visibility checking.
Tags: build_file_semantics, incompatible_change
--[no]incompatible_check_visibility_for_toolchains default: "false"
If enabled, visibility checking also applies to toolchain implementations.
Tags: build_file_semantics, incompatible_change
--[no]incompatible_disable_native_android_rules default: "false"
If enabled, direct usage of the native Android rules is disabled. Please use the Starlark Android rules from https://github.com/bazelbuild/rules_android
Tags: eagerness_to_exit, incompatible_change
--[no]incompatible_disable_native_apple_binary_rule default: "false"
No-op. Kept here for backwards compatibility.
Tags: eagerness_to_exit, incompatible_change
--[no]incompatible_python_disable_py2 default: "true"
If true, using Python 2 settings will cause an error. This includes python_version=PY2, srcs_version=PY2, and srcs_version=PY2ONLY. See https://github.com/bazelbuild/bazel/issues/15684 for more information.
Tags: loading_and_analysis, incompatible_change
--[no]incompatible_validate_top_level_header_inclusions default: "true"
If true, Bazel will also validate top level directory header inclusions (see https://github.com/bazelbuild/bazel/issues/10047 for more information).
Tags: loading_and_analysis, incompatible_change
--python_native_rules_allowlist=<a build target label> default: see description
An allowlist (package_group target) to use when enforcing --incompatible_python_disallow_native_rules.
Tags: loading_and_analysis
--[no]strict_filesets default: "false"
If this option is enabled, filesets crossing package boundaries are reported as errors.
Tags: build_file_semantics, eagerness_to_exit
--strict_proto_deps=<off, warn, error, strict or default> default: "error"
Unless OFF, checks that a proto_library target explicitly declares all directly used targets as dependencies.
Tags: build_file_semantics, eagerness_to_exit, incompatible_change
--strict_public_imports=<off, warn, error, strict or default> default: "off"
Unless OFF, checks that a proto_library target explicitly declares all targets used in 'import public' as exported.
Tags: build_file_semantics, eagerness_to_exit, incompatible_change
--[no]strict_system_includes default: "false"
If true, headers found through system include paths (-isystem) are also required to be declared.
Tags: loading_and_analysis, eagerness_to_exit
--target_environment=<a build target label> multiple uses are accumulated
Declares this build's target environment. Must be a label reference to an "environment" rule. If specified, all top-level targets must be compatible with this environment.
Tags: changes_inputs
Options that affect the signing outputs of a build:
--apk_signing_method=<v1, v2, v1_v2 or v4> default: "v1_v2"
Implementation to use to sign APKs
Tags: action_command_lines, affects_outputs, loading_and_analysis
--[no]device_debug_entitlements default: "true"
If set, and compilation mode is not 'opt', objc apps will include debug entitlements when signing.
Tags: changes_inputs
--ios_signing_cert_name=<a string> default: see description
Certificate name to use for iOS signing. If not set will fall back to provisioning profile. May be the certificate's keychain identity preference or (substring) of the certificate's common name, as per codesign's man page (SIGNING IDENTITIES).
Tags: action_command_lines
This option affects semantics of the Starlark language or the build API accessible to BUILD files, .bzl files, or WORKSPACE files.:
--[no]incompatible_config_setting_private_default_visibility default: "false"
If incompatible_enforce_config_setting_visibility=false, this is a noop. Else, if this flag is false, any config_setting without an explicit visibility attribute is //visibility:public. If this flag is true, config_setting follows the same visibility logic as all other rules. See https://github.com/bazelbuild/bazel/issues/12933.
Tags: loading_and_analysis, incompatible_change
--[no]incompatible_disallow_legacy_py_provider default: "true"
No-op, will be removed soon.
Tags: loading_and_analysis, incompatible_change
--[no]incompatible_disallow_sdk_frameworks_attributes default: "false"
If true, disallow sdk_frameworks and weak_sdk_frameworks attributes in objc_library andobjc_import.
Tags: build_file_semantics, incompatible_change
--[no]incompatible_enforce_config_setting_visibility default: "true"
If true, enforce config_setting visibility restrictions. If false, every config_setting is visible to every target. See https://github.com/bazelbuild/bazel/issues/12932.
Tags: loading_and_analysis, incompatible_change
If true, make the default value true for alwayslink attributes in objc_library and objc_import.
Tags: build_file_semantics, incompatible_change
--[no]incompatible_python_disallow_native_rules default: "false"
When true, an error occurs when using the builtin py_* rules; instead the rule_python rules should be used. See https://github.com/bazelbuild/bazel/issues/17773 for more information and migration instructions.
Tags: loading_and_analysis, incompatible_change
Options that govern the behavior of the test environment or test runner:
--[no]allow_analysis_failures default: "false"
If true, an analysis failure of a rule target results in the target's propagation of an instance of AnalysisFailureInfo containing the error description, instead of resulting in a build failure.
Tags: loading_and_analysis, experimental
--analysis_testing_deps_limit=<an integer> default: "2000"
Sets the maximum number of transitive dependencies through a rule attribute with a for_analysis_testing configuration transition. Exceeding this limit will result in a rule error.
Tags: loading_and_analysis
--[no]break_build_on_parallel_dex2oat_failure default: "false"
If true dex2oat action failures will cause the build to break instead of executing dex2oat during test runtime.
Tags: loading_and_analysis, experimental
--[no]check_tests_up_to_date default: "false"
Don't run tests, just check if they are up-to-date. If all tests results are up-to-date, the testing completes successfully. If any test needs to be built or executed, an error is reported and the testing fails. This option implies --check_up_to_date behavior.
Tags: execution
--[no]experimental_android_use_parallel_dex2oat default: "false"
Use dex2oat in parallel to possibly speed up android_test.
Tags: loading_and_analysis, host_machine_resource_optimizations, experimental
--flaky_test_attempts=<a positive integer, the string "default", or test_regex@attempts. This flag may be passed more than once> multiple uses are accumulated
Each test will be retried up to the specified number of times in case of any test failure. Tests that required more than one attempt to pass are marked as 'FLAKY' in the test summary. Normally the value specified is just an integer or the string 'default'. If an integer, then all tests will be run up to N times. If 'default', then only a single test attempt will be made for regular tests and three for tests marked explicitly as flaky by their rule (flaky=1 attribute). Alternate syntax: regex_filter@flaky_test_attempts. Where flaky_test_attempts is as above and regex_filter stands for a list of include and exclude regular expression patterns (Also see --runs_per_test). Example: --flaky_test_attempts=//foo/.*,-//foo/bar/.*@3 deflakes all tests in //foo/ except those under foo/bar three times. This option can be passed multiple times. The most recently passed argument that matches takes precedence. If nothing matches, behavior is as if 'default' above.
Tags: execution
--[no]ios_memleaks default: "false"
Enable checking for memory leaks in ios_test targets.
Tags: action_command_lines
--ios_simulator_device=<a string> default: see description
The device to simulate when running an iOS application in the simulator, e.g. 'iPhone 6'. You can get a list of devices by running 'xcrun simctl list devicetypes' on the machine the simulator will be run on.
Tags: test_runner
--ios_simulator_version=<a dotted version (for example '2.3' or '3.3alpha2.4')> default: see description
The version of iOS to run on the simulator when running or testing. This is ignored for ios_test rules if a target device is specified in the rule.
Tags: test_runner
--local_test_jobs=<an integer, or a keyword ("auto", "HOST_CPUS", "HOST_RAM"), optionally followed by an operation ([-|*]<float>) eg. "auto", "HOST_CPUS*.5"> default: "auto"
The max number of local test jobs to run concurrently. Takes an integer, or a keyword ("auto", "HOST_CPUS", "HOST_RAM"), optionally followed by an operation ([-|*]<float>) eg. "auto", "HOST_CPUS*.5". 0 means local resources will limit the number of local test jobs to run concurrently instead. Setting this greater than the value for --jobs is ineffectual.
Tags: execution
--runs_per_test=<a positive integer or test_regex@runs. This flag may be passed more than once> multiple uses are accumulated
Specifies number of times to run each test. If any of those attempts fail for any reason, the whole test is considered failed. Normally the value specified is just an integer. Example: --runs_per_test=3 will run all tests 3 times. Alternate syntax: regex_filter@runs_per_test. Where runs_per_test stands for an integer value and regex_filter stands for a list of include and exclude regular expression patterns (Also see --instrumentation_filter). Example: --runs_per_test=//foo/.*,-//foo/bar/.*@3 runs all tests in //foo/ except those under foo/bar three times. This option can be passed multiple times. The most recently passed argument that matches takes precedence. If nothing matches, the test is only run once.
--test_env=<a 'name=value' assignment with an optional value part> multiple uses are accumulated
Specifies additional environment variables to be injected into the test runner environment. Variables can be either specified by name, in which case its value will be read from the Bazel client environment, or by the name=value pair. This option can be used multiple times to specify several variables. Used only by the 'bazel test' command.
Tags: test_runner
--[no]test_keep_going default: "true"
When disabled, any non-passing test will cause the entire build to stop. By default all tests are run, even if some do not pass.
Tags: execution
--test_strategy=<a string> default: ""
Specifies which strategy to use when running tests.
Tags: execution
--test_timeout=<a single integer or comma-separated list of 4 integers> default: "-1"
Override the default test timeout values for test timeouts (in secs). If a single positive integer value is specified it will override all categories. If 4 comma-separated integers are specified, they will override the timeouts for short, moderate, long and eternal (in that order). In either form, a value of -1 tells blaze to use its default timeouts for that category.
--test_tmpdir=<a path> default: see description
Specifies the base temporary directory for 'bazel test' to use.
--[no]zip_undeclared_test_outputs default: "true"
If true, undeclared test outputs will be archived in a zip file.
Tags: test_runner
Options that trigger optimizations of the build time:
--[no]experimental_filter_library_jar_with_program_jar default: "false"
Filter the ProGuard ProgramJar to remove any classes also present in the LibraryJar.
Tags: action_command_lines
--[no]experimental_inmemory_dotd_files default: "true"
If enabled, C++ .d files will be passed through in memory directly from the remote build nodes instead of being written to disk.
Tags: loading_and_analysis, execution, affects_outputs, experimental
--[no]experimental_inmemory_jdeps_files default: "true"
If enabled, the dependency (.jdeps) files generated from Java compilations will be passed through in memory directly from the remote build nodes instead of being written to disk.
Tags: loading_and_analysis, execution, affects_outputs, experimental
--[no]experimental_objc_include_scanning default: "false"
Whether to perform include scanning for objective C/C++.
Tags: loading_and_analysis, execution, changes_inputs
--[no]experimental_retain_test_configuration_across_testonly default: "false"
When enabled, --trim_test_configuration will not trim the test configuration for rules marked testonly=1. This is meant to reduce action conflict issues when non-test rules depend on cc_test rules. No effect if --trim_test_configuration is false.
Tags: loading_and_analysis, loses_incremental_state
--[no]experimental_starlark_cc_import default: "false"
If enabled, the Starlark version of cc_import can be used.
Tags: loading_and_analysis, experimental
--[no]experimental_unsupported_and_brittle_include_scanning default: "false"
Whether to narrow inputs to C/C++ compilation by parsing #include lines from input files. This can improve performance and incrementality by decreasing the size of compilation input trees. However, it can also break builds because the include scanner does not fully implement C preprocessor semantics. In particular, it does not understand dynamic #include directives and ignores preprocessor conditional logic. Use at your own risk. Any issues relating to this flag that are filed will be closed.
Tags: loading_and_analysis, execution, changes_inputs
--[no]incremental_dexing default: "true"
Does most of the work for dexing separately for each Jar file.
Tags: affects_outputs, loading_and_analysis, loses_incremental_state
--local_cpu_resources=<an integer, or "HOST_CPUS", optionally followed by [-|*]<float>.> default: "HOST_CPUS"
Explicitly set the total number of local CPU cores available to Bazel to spend on build actions executed locally. Takes an integer, or "HOST_CPUS", optionally followed by [-|*]<float> (eg. HOST_CPUS*.5 to use half the available CPU cores).By default, ("HOST_CPUS"), Bazel will query system configuration to estimate the number of CPU cores available.
Tags: host_machine_resource_optimizations
--local_extra_resources=<a named float, 'name=value'> multiple uses are accumulated
Set the number of extra resources available to Bazel. Takes in a string-float pair. Can be used multiple times to specify multiple types of extra resources. Bazel will limit concurrently running actions based on the available extra resources and the extra resources required. Tests can declare the amount of extra resources they need by using a tag of the "resources:<resoucename>:<amount>" format. Available CPU, RAM and resources cannot be set with this flag.
Tags: host_machine_resource_optimizations
--local_ram_resources=<an integer number of MBs, or "HOST_RAM", optionally followed by [-|*]<float>.> default: "HOST_RAM*.67"
Explicitly set the total amount of local host RAM (in MB) available to Bazel to spend on build actions executed locally. Takes an integer, or "HOST_RAM", optionally followed by [-|*]<float> (eg. HOST_RAM*.5 to use half the available RAM). By default, ("HOST_RAM*.67"), Bazel will query system configuration to estimate the amount of RAM available and will use 67% of it.
Tags: host_machine_resource_optimizations
--[no]objc_use_dotd_pruning default: "true"
If set, .d files emitted by clang will be used to prune the set of inputs passed into objc compiles.
Tags: changes_inputs, loading_and_analysis
--[no]process_headers_in_dependencies default: "false"
When building a target //a:a, process headers in all targets that //a:a depends on (if header processing is enabled for the toolchain).
Tags: execution
--[no]trim_test_configuration default: "true"
When enabled, test-related options will be cleared below the top level of the build. When this flag is active, tests cannot be built as dependencies of non-test rules, but changes to test-related options will not cause non-test rules to be re-analyzed.
Tags: loading_and_analysis, loses_incremental_state
Options that affect the verbosity, format or location of logging:
--[no]experimental_bep_target_summary default: "false"
Whether to publish TargetSummary events.
--[no]experimental_build_event_expand_filesets default: "false"
If true, expand Filesets in the BEP when presenting output files.
Tags: affects_outputs
If true, fully resolve relative Fileset symlinks in the BEP when presenting output files. Requires --experimental_build_event_expand_filesets.
Tags: affects_outputs
--experimental_build_event_upload_max_retries=<an integer> default: "4"
The maximum number of times Bazel should retry uploading a build event.
Tags: bazel_internal_configuration
--experimental_build_event_upload_retry_minimum_delay=<An immutable length of time.> default: "1s"
Initial, minimum delay for exponential backoff retries when BEP upload fails. (exponent: 1.6)
Tags: bazel_internal_configuration
--experimental_build_event_upload_strategy=<a string> default: see description
Selects how to upload artifacts referenced in the build event protocol.
Tags: affects_outputs
--[no]experimental_materialize_param_files_directly default: "false"
If materializing param files, do so with direct writes to disk.
Tags: execution
--[no]experimental_run_bep_event_include_residue default: "false"
Whether to include the command-line residue in run build events which could contain the residue. By default, the residue is not included in run command build events that could contain the residue.
Tags: affects_outputs
--[no]experimental_stream_log_file_uploads default: "false"
Stream log file uploads directly to the remote storage rather than writing them to disk.
Tags: affects_outputs
--explain=<a path> default: see description
Causes the build system to explain each executed step of the build. The explanation is written to the specified log file.
Tags: affects_outputs
--[no]legacy_important_outputs default: "true"
Use this to suppress generation of the legacy important_outputs field in the TargetComplete event. important_outputs are required for Bazel to ResultStore integration.
Tags: affects_outputs
--[no]materialize_param_files default: "false"
Writes intermediate parameter files to output tree even when using remote action execution. Useful when debugging actions. This is implied by --subcommands and --verbose_failures.
Tags: execution
--max_config_changes_to_show=<an integer> default: "3"
When discarding the analysis cache due to a change in the build options, displays up to the given number of changed option names. If the number given is -1, all changed options will be displayed.
Tags: terminal_output
--max_test_output_bytes=<an integer> default: "-1"
Specifies maximum per-test-log size that can be emitted when --test_output is 'errors' or 'all'. Useful for avoiding overwhelming the output with excessively noisy test output. The test header is included in the log size. Negative values imply no limit. Output is all or nothing.
Tags: test_runner, terminal_output, execution
--output_filter=<a valid Java regular expression> default: see description
Only shows warnings and action outputs for rules with a name matching the provided regular expression.
Tags: affects_outputs
--progress_report_interval=<an integer in 0-3600 range> default: "0"
The number of seconds to wait between reports on still running jobs. The default value 0 means the first report will be printed after 10 seconds, then 30 seconds and after that progress is reported once every minute. When --curses is enabled, progress is reported every second.
Tags: affects_outputs
--show_result=<an integer> default: "1"
Show the results of the build. For each target, state whether or not it was brought up-to-date, and if so, a list of output files that were built. The printed files are convenient strings for copy+pasting to the shell, to execute them. This option requires an integer argument, which is the threshold number of targets above which result information is not printed. Thus zero causes suppression of the message and MAX_INT causes printing of the result to occur always. The default is one. If nothing was built for a target its results may be omitted to keep the output under the threshold.
Tags: affects_outputs
--[no]subcommands [-s] default: "false"
Display the subcommands executed during a build. Related flags: --execution_log_json_file, --execution_log_binary_file (for logging subcommands to a file in a tool-friendly format).
Tags: terminal_output
--test_output=<summary, errors, all or streamed> default: "summary"
Specifies desired output mode. Valid values are 'summary' to output only test status summary, 'errors' to also print test logs for failed tests, 'all' to print logs for all tests and 'streamed' to output logs for all tests in real time (this will force tests to be executed locally one at a time regardless of --test_strategy value).
Tags: test_runner, terminal_output, execution
--test_summary=<short, terse, detailed, none or testcase> default: "short"
Specifies the desired format of the test summary. Valid values are 'short' to print information only about tests executed, 'terse', to print information only about unsuccessful tests that were run, 'detailed' to print detailed information about failed test cases, 'testcase' to print summary in test case resolution, do not print detailed information about failed test cases and 'none' to omit the summary.
Tags: terminal_output
--toolchain_resolution_debug=<a comma-separated list of regex expressions with prefix '-' specifying excluded paths> default: "-.*"
Print debug information during toolchain resolution. The flag takes a regex, which is checked against toolchain types and specific targets to see which to debug. Multiple regexes may be separated by commas, and then each regex is checked separately. Note: The output of this flag is very complex and will likely only be useful to experts in toolchain resolution.
Tags: terminal_output
--[no]verbose_explanations default: "false"
Increases the verbosity of the explanations issued if --explain is enabled. Has no effect if --explain is not enabled.
Tags: affects_outputs
--[no]verbose_failures default: "false"
If a command fails, print out the full command line.
Tags: terminal_output
Options specifying or altering a generic input to a Bazel command that does not fall into other categories.:
--aspects_parameters=<a 'name=value' assignment> multiple uses are accumulated
Specifies the values of the command-line aspects parameters. Each parameter value is specified via <param_name>=<param_value>, for example 'my_param=my_val' where 'my_param' is a parameter of some aspect in --aspects list or required by an aspect in the list. This option can be used multiple times. However, it is not allowed to assign values to the same parameter more than once.
Tags: loading_and_analysis
--flag_alias=<a 'name=value' flag alias> multiple uses are accumulated
Sets a shorthand name for a Starlark flag. It takes a single key-value pair in the form "<key>=<value>" as an argument.
Tags: changes_inputs
--[no]incompatible_default_to_explicit_init_py default: "false"
This flag changes the default behavior so that __init__.py files are no longer automatically created in the runfiles of Python targets. Precisely, when a py_binary or py_test target has legacy_create_init set to "auto" (the default), it is treated as false if and only if this flag is set. See https://github.com/bazelbuild/bazel/issues/10076.
Tags: affects_outputs, incompatible_change
--[no]incompatible_py2_outputs_are_suffixed default: "true"
If true, targets built in the Python 2 configuration will appear under an output root that includes the suffix '-py2', while targets built for Python 3 will appear in a root with no Python-related suffix. This means that the `bazel-bin` convenience symlink will point to Python 3 targets rather than Python 2. If you enable this option it is also recommended to enable `--incompatible_py3_is_default`.
Tags: affects_outputs, incompatible_change
--[no]incompatible_py3_is_default default: "true"
If true, `py_binary` and `py_test` targets that do not set their `python_version` (or `default_python_version`) attribute will default to PY3 rather than to PY2. If you set this flag it is also recommended to set `--incompatible_py2_outputs_are_suffixed`.
Tags: loading_and_analysis, affects_outputs, incompatible_change
--[no]incompatible_use_python_toolchains default: "true"
If set to true, executable native Python rules will use the Python runtime specified by the Python toolchain, rather than the runtime given by legacy flags like --python_top.
Tags: loading_and_analysis, incompatible_change
--python_version=<PY2 or PY3> default: see description
The Python major version mode, either `PY2` or `PY3`. Note that this is overridden by `py_binary` and `py_test` targets (even if they don't explicitly specify a version) so there is usually not much reason to supply this flag.
Tags: loading_and_analysis, affects_outputs
--target_pattern_file=<a string> default: ""
If set, build will read patterns from the file named here, rather than on the command line. It is an error to specify a file here as well as command-line patterns.
Tags: changes_inputs
Remote caching and execution options:
--experimental_remote_cache_eviction_retries=<an integer> default: "0"
The maximum number of attempts to retry if the build encountered remote cache eviction error. A non-zero value will implicitly set --incompatible_remote_use_new_exit_code_for_lost_inputs to true. A new invocation id will be generated for each attempt. If you generate invocation id and provide it to Bazel with --invocation_id, you should not use this flag. Instead, set flag --incompatible_remote_use_new_exit_code_for_lost_inputs and check for the exit code 39.
Tags: execution
--[no]incompatible_remote_use_new_exit_code_for_lost_inputs default: "true"
If set to true, Bazel will use new exit code 39 instead of 34 if remote cache evicts blobs during the build.
Tags: incompatible_change
Miscellaneous options, not otherwise categorized.:
--[no]allow_analysis_cache_discard default: "true"
If discarding the analysis cache due to a change in the build system, setting this option to false will cause bazel to exit, rather than continuing with the build. This option has no effect when 'discard_analysis_cache' is also set.
Tags: eagerness_to_exit
--[no]build_manual_tests default: "false"
Forces test targets tagged 'manual' to be built. 'manual' tests are excluded from processing. This option forces them to be built (but not executed).
--build_tag_filters=<comma-separated list of options> default: ""
Specifies a comma-separated list of tags. Each tag can be optionally preceded with '-' to specify excluded tags. Only those targets will be built that contain at least one included tag and do not contain any excluded tags. This option does not affect the set of tests executed with the 'test' command; those are be governed by the test filtering options, for example '--test_tag_filters'
--[no]build_tests_only default: "false"
If specified, only *_test and test_suite rules will be built and other targets specified on the command line will be ignored. By default everything that was requested will be built.
--[no]cache_test_results [-t] default: "auto"
If set to 'auto', Bazel reruns a test if and only if: (1) Bazel detects changes in the test or its dependencies, (2) the test is marked as external, (3) multiple test runs were requested with --runs_per_test, or(4) the test previously failed. If set to 'yes', Bazel caches all test results except for tests marked as external. If set to 'no', Bazel does not cache any test results.
--[no]compile_one_dependency default: "false"
Compile a single dependency of the argument files. This is useful for syntax checking source files in IDEs, for example, by rebuilding a single target that depends on the source file to detect errors as early as possible in the edit/build/test cycle. This argument affects the way all non-flag arguments are interpreted; instead of being targets to build they are source filenames. For each source filename an arbitrary target that depends on it will be built.
--deleted_packages=<comma-separated list of package names> multiple uses are accumulated
A comma-separated list of names of packages which the build system will consider non-existent, even if they are visible somewhere on the package path. Use this option when deleting a subpackage 'x/y' of an existing package 'x'. For example, after deleting x/y/BUILD in your client, the build system may complain if it encounters a label '//x:y/z' if that is still provided by another package_path entry. Specifying --deleted_packages x/y avoids this problem.
--[no]discard_analysis_cache default: "false"
Discard the analysis cache immediately after the analysis phase completes. Reduces memory usage by ~10%, but makes further incremental builds slower.
--execution_log_binary_file=<a path> default: see description
Log the executed spawns into this file as delimited Spawn protos, according to src/main/protobuf/spawn.proto. Related flags: --execution_log_json_file (text JSON format; mutually exclusive), --execution_log_sort (whether to sort the execution log), --subcommands (for displaying subcommands in terminal output).
--execution_log_json_file=<a path> default: see description
Log the executed spawns into this file as a JSON representation of the delimited Spawn protos, according to src/main/protobuf/spawn.proto. Related flags: --execution_log_binary_file (binary protobuf format; mutually exclusive), --execution_log_sort (whether to sort the execution log), --subcommands (for displaying subcommands in terminal output).
--[no]execution_log_sort default: "true"
Whether to sort the execution log, making it easier to compare logs across invocations. Set to false to avoid potentially significant CPU and memory usage at the end of the invocation, at the cost of producing the log in nondeterministic execution order.
--[no]expand_test_suites default: "true"
Expand test_suite targets into their constituent tests before analysis. When this flag is turned on (the default), negative target patterns will apply to the tests belonging to the test suite, otherwise they will not. Turning off this flag is useful when top-level aspects are applied at command line: then they can analyze test_suite targets.
Tags: loading_and_analysis
--[no]experimental_cancel_concurrent_tests default: "false"
If true, then Blaze will cancel concurrently running tests on the first successful run. This is only useful in combination with --runs_per_test_detects_flakes.
Tags: affects_outputs, loading_and_analysis
--experimental_extra_action_filter=<a comma-separated list of regex expressions with prefix '-' specifying excluded paths> default: ""
Deprecated in favor of aspects. Filters set of targets to schedule extra_actions for.
--[no]experimental_extra_action_top_level_only default: "false"
Deprecated in favor of aspects. Only schedules extra_actions for top level targets.
--[no]experimental_fetch_all_coverage_outputs default: "false"
If true, then Bazel fetches the entire coverage data directory for each test during a coverage run.
Tags: affects_outputs, loading_and_analysis
--[no]experimental_generate_llvm_lcov default: "false"
If true, coverage for clang will generate an LCOV report.
Tags: affects_outputs, loading_and_analysis
--[no]experimental_j2objc_header_map default: "true"
Whether to generate J2ObjC header map in parallel of J2ObjC transpilation.
--[no]experimental_j2objc_shorter_header_path default: "false"
Whether to generate with shorter header path (uses "_ios" instead of "_j2objc").
Tags: affects_outputs
--experimental_java_classpath=<off, javabuilder or bazel> default: "javabuilder"
Enables reduced classpaths for Java compilations.
--[no]experimental_limit_android_lint_to_android_constrained_java default: "false"
Limit --experimental_run_android_lint_on_java_rules to Android-compatible libraries.
Tags: affects_outputs
--[no]experimental_run_android_lint_on_java_rules default: "false"
Whether to validate java_* sources.
Tags: affects_outputs
--[no]explicit_java_test_deps default: "false"
Explicitly specify a dependency to JUnit or Hamcrest in a java_test instead of accidentally obtaining from the TestRunner's deps. Only works for bazel right now.
--host_java_launcher=<a build target label> default: see description
The Java launcher used by tools that are executed during a build.
--host_javacopt=<a string> multiple uses are accumulated
Additional options to pass to javac when building tools that are executed during a build.
--host_jvmopt=<a string> multiple uses are accumulated
Additional options to pass to the Java VM when building tools that are executed during the build. These options will get added to the VM startup options of each java_binary target.
--[no]incompatible_check_sharding_support default: "true"
If true, Bazel will fail a sharded test if the test runner does not indicate that it supports sharding by touching the file at the path in TEST_SHARD_STATUS_FILE. If false, a test runner that does not support sharding will lead to all tests running in each shard.
Tags: incompatible_change
--[no]incompatible_exclusive_test_sandboxed default: "true"
If true, exclusive tests will run with sandboxed strategy. Add 'local' tag to force an exclusive test run locally
Tags: incompatible_change
--[no]incompatible_strict_action_env default: "false"
If true, Bazel uses an environment with a static value for PATH and does not inherit LD_LIBRARY_PATH. Use --action_env=ENV_VARIABLE if you want to inherit specific environment variables from the client, but note that doing so can prevent cross-user caching if a shared cache is used.
Tags: loading_and_analysis, incompatible_change
--j2objc_translation_flags=<comma-separated list of options> multiple uses are accumulated
Additional options to pass to the J2ObjC tool.
--java_debug
Causes the Java virtual machine of a java test to wait for a connection from a JDWP-compliant debugger (such as jdb) before starting the test. Implies -test_output=streamed.
Expands to:
  --test_arg=--wrapper_script_flag=--debug
  --test_output=streamed
  --test_strategy=exclusive
  --test_timeout=9999
  --nocache_test_results
--[no]java_deps default: "true"
Generate dependency information (for now, compile-time classpath) per Java target.
--[no]java_header_compilation default: "true"
Compile ijars directly from source.
--java_language_version=<a string> default: ""
The Java language version
--java_launcher=<a build target label> default: see description
The Java launcher to use when building Java binaries. If this flag is set to the empty string, the JDK launcher is used. The "launcher" attribute overrides this flag.
--java_runtime_version=<a string> default: "local_jdk"
The Java runtime version
--javacopt=<a string> multiple uses are accumulated
Additional options to pass to javac.
--jvmopt=<a string> multiple uses are accumulated
Additional options to pass to the Java VM. These options will get added to the VM startup options of each java_binary target.
--legacy_main_dex_list_generator=<a build target label> default: see description
Specifies a binary to use to generate the list of classes that must be in the main dex when compiling legacy multidex.
--local_termination_grace_seconds=<an integer> default: "15"
Time to wait between terminating a local process due to timeout and forcefully shutting it down.
--optimizing_dexer=<a build target label> default: see description
Specifies a binary to use to do dexing without sharding.
--package_path=<colon-separated list of options> default: "%workspace%"
A colon-separated list of where to look for packages. Elements beginning with '%workspace%' are relative to the enclosing workspace. If omitted or empty, the default is the output of 'bazel info default-package-path'.
--plugin=<a build target label> multiple uses are accumulated
Plugins to use in the build. Currently works with java_plugin.
--proguard_top=<a build target label> default: see description
Specifies which version of ProGuard to use for code removal when building a Java binary.
--proto_compiler=<a build target label> default: "@bazel_tools//tools/proto:protoc"
The label of the proto-compiler.
Tags: affects_outputs, loading_and_analysis
--proto_toolchain_for_cc=<a build target label> default: "@bazel_tools//tools/proto:cc_toolchain"
Label of proto_lang_toolchain() which describes how to compile C++ protos
Tags: affects_outputs, loading_and_analysis
--proto_toolchain_for_j2objc=<a build target label> default: "@bazel_tools//tools/j2objc:j2objc_proto_toolchain"
Label of proto_lang_toolchain() which describes how to compile j2objc protos
Tags: affects_outputs, loading_and_analysis
--proto_toolchain_for_java=<a build target label> default: "@bazel_tools//tools/proto:java_toolchain"
Label of proto_lang_toolchain() which describes how to compile Java protos
Tags: affects_outputs, loading_and_analysis
--proto_toolchain_for_javalite=<a build target label> default: "@bazel_tools//tools/proto:javalite_toolchain"
Label of proto_lang_toolchain() which describes how to compile JavaLite protos
Tags: affects_outputs, loading_and_analysis
--protocopt=<a string> multiple uses are accumulated
Additional options to pass to the protobuf compiler.
Tags: affects_outputs
--[no]runs_per_test_detects_flakes default: "false"
If true, any shard in which at least one run/attempt passes and at least one run/attempt fails gets a FLAKY status.
--shell_executable=<a path> default: see description
Absolute path to the shell executable for Bazel to use. If this is unset, but the BAZEL_SH environment variable is set on the first Bazel invocation (that starts up a Bazel server), Bazel uses that. If neither is set, Bazel uses a hard-coded default path depending on the operating system it runs on (Windows: c:/tools/msys64/usr/bin/bash.exe, FreeBSD: /usr/local/bin/bash, all others: /bin/bash). Note that using a shell that is not compatible with bash may lead to build failures or runtime failures of the generated binaries.
Tags: loading_and_analysis
--[no]show_loading_progress default: "true"
If enabled, causes Bazel to print "Loading package:" messages.
--test_arg=<a string> multiple uses are accumulated
Specifies additional options and arguments that should be passed to the test executable. Can be used multiple times to specify several arguments. If multiple tests are executed, each of them will receive identical arguments. Used only by the 'bazel test' command.
--test_filter=<a string> default: see description
Specifies a filter to forward to the test framework. Used to limit the tests run. Note that this does not affect which targets are built.
--test_lang_filters=<comma-separated list of options> default: ""
Specifies a comma-separated list of test languages. Each language can be optionally preceded with '-' to specify excluded languages. Only those test targets will be found that are written in the specified languages. The name used for each language should be the same as the language prefix in the *_test rule, e.g. one of 'cc', 'java', 'py', etc. This option affects --build_tests_only behavior and the test command.
--test_result_expiration=<an integer> default: "-1"
This option is deprecated and has no effect.
--[no]test_runner_fail_fast default: "false"
Forwards fail fast option to the test runner. The test runner should stop execution upon first failure.
--test_sharding_strategy=<explicit, disabled or forced=k where k is the number of shards to enforce> default: "explicit"
Specify strategy for test sharding: 'explicit' to only use sharding if the 'shard_count' BUILD attribute is present. 'disabled' to never use test sharding. 'forced=k' to enforce 'k' shards for testing regardless of the 'shard_count' BUILD attribute.
--test_size_filters=<comma-separated list of values: small, medium, large or enormous> default: ""
Specifies a comma-separated list of test sizes. Each size can be optionally preceded with '-' to specify excluded sizes. Only those test targets will be found that contain at least one included size and do not contain any excluded sizes. This option affects --build_tests_only behavior and the test command.
--test_tag_filters=<comma-separated list of options> default: ""
Specifies a comma-separated list of test tags. Each tag can be optionally preceded with '-' to specify excluded tags. Only those test targets will be found that contain at least one included tag and do not contain any excluded tags. This option affects --build_tests_only behavior and the test command.
--test_timeout_filters=<comma-separated list of values: short, moderate, long or eternal> default: ""
Specifies a comma-separated list of test timeouts. Each timeout can be optionally preceded with '-' to specify excluded timeouts. Only those test targets will be found that contain at least one included timeout and do not contain any excluded timeouts. This option affects --build_tests_only behavior and the test command.
--tool_java_language_version=<a string> default: ""
The Java language version used to execute the tools that are needed during a build
--tool_java_runtime_version=<a string> default: "remotejdk_11"
The Java runtime version used to execute tools during the build
--[no]use_ijars default: "true"
If enabled, this option causes Java compilation to use interface jars. This will result in faster incremental compilation, but error messages can be different.

Canonicalize-flags Options

Inherits all options from build.

Options that appear before the command and are parsed by the client:
--distdir=<a path> multiple uses are accumulated
Additional places to search for archives before accessing the network to download them.
Tags: bazel_internal_configuration
If set, the repository cache will hardlink the file in case of a cache hit, rather than copying. This is intended to save disk space.
Tags: bazel_internal_configuration
--experimental_repository_downloader_retries=<an integer> default: "0"
The maximum number of attempts to retry a download error. If set to 0, retries are disabled.
Tags: experimental
--experimental_scale_timeouts=<a double> default: "1.0"
Scale all timeouts in Starlark repository rules by this factor. In this way, external repositories can be made working on machines that are slower than the rule author expected, without changing the source code
Tags: bazel_internal_configuration, experimental
--http_connector_attempts=<an integer> default: "8"
The maximum number of attempts for http downloads.
Tags: bazel_internal_configuration
--http_connector_retry_max_timeout=<An immutable length of time.> default: "0s"
The maximum timeout for http download retries. With a value of 0, no timeout maximum is defined.
Tags: bazel_internal_configuration
--http_timeout_scaling=<a double> default: "1.0"
Scale all timeouts related to http downloads by the given factor
Tags: bazel_internal_configuration
--repository_cache=<a path> default: see description
Specifies the cache location of the downloaded values obtained during the fetching of external repositories. An empty string as argument requests the cache to be disabled, otherwise the default of '<output_user_root>/cache/repos/v1' is used
Tags: bazel_internal_configuration
--[no]repository_disable_download default: "false"
If set, downloading using ctx.download{,_and_extract} is not allowed during repository fetching. Note that network access is not completely disabled; ctx.execute could still run an arbitrary executable that accesses the Internet.
Tags: bazel_internal_configuration
Options that control build execution:
--gc_thrashing_threshold=<an integer in 0-100 range> default: "100"
The percent of tenured space occupied (0-100) above which GcThrashingDetector considers memory pressure events against its limits (--gc_thrashing_limits). If set to 100, GcThrashingDetector is disabled.
Tags: host_machine_resource_optimizations
Options that control the output of the command:
--[no]canonicalize_policy default: "false"
Output the canonical policy, after expansion and filtering. To keep the output clean, the canonicalized command arguments will NOT be shown when this option is set to true. Note that the command specified by --for_command affects the filtered policy, and if none is specified, the default command is 'build'.
Tags: affects_outputs, terminal_output
--[no]experimental_include_default_values default: "false"
Whether Starlark options set to their default values are included in the output.
Tags: affects_outputs, terminal_output
This option affects semantics of the Starlark language or the build API accessible to BUILD files, .bzl files, or WORKSPACE files.:
--[no]incompatible_config_setting_private_default_visibility default: "false"
If incompatible_enforce_config_setting_visibility=false, this is a noop. Else, if this flag is false, any config_setting without an explicit visibility attribute is //visibility:public. If this flag is true, config_setting follows the same visibility logic as all other rules. See https://github.com/bazelbuild/bazel/issues/12933.
Tags: loading_and_analysis, incompatible_change
--[no]incompatible_depset_for_java_output_source_jars default: "true"
No-op.
Tags: loading_and_analysis, incompatible_change
--[no]incompatible_enforce_config_setting_visibility default: "true"
If true, enforce config_setting visibility restrictions. If false, every config_setting is visible to every target. See https://github.com/bazelbuild/bazel/issues/12932.
Tags: loading_and_analysis, incompatible_change
--[no]incompatible_new_actions_api default: "true"
No-op
Tags: no_op, incompatible_change
Options relating to Bzlmod output and semantics:
--allow_yanked_versions=<a string> multiple uses are accumulated
Specified the module versions in the form of `<module1>@<version1>,<module2>@<version2>` that will be allowed in the resolved dependency graph even if they are declared yanked in the registry where they come from (if they are not coming from a NonRegistryOverride). Otherwise, yanked versions will cause the resolution to fail. You can also define allowed yanked version with the `BZLMOD_ALLOW_YANKED_VERSIONS` environment variable. You can disable this check by using the keyword 'all' (not recommended).
Tags: loading_and_analysis
--check_bazel_compatibility=<error, warning or off> default: "error"
Check bazel version compatibility of Bazel modules. Valid values are `error` to escalate it to a resolution failure, `off` to disable the check, or `warning` to print a warning when mismatch detected.
Tags: loading_and_analysis
--check_direct_dependencies=<off, warning or error> default: "warning"
Check if the direct `bazel_dep` dependencies declared in the root module are the same versions you get in the resolved dependency graph. Valid values are `off` to disable the check, `warning` to print a warning when mismatch detected or `error` to escalate it to a resolution failure.
Tags: loading_and_analysis
--[no]ignore_dev_dependency default: "false"
If true, Bazel ignores `bazel_dep` and `use_extension` declared as `dev_dependency` in the MODULE.bazel of the root module. Note that, those dev dependencies are always ignored in the MODULE.bazel if it's not the root module regardless of the value of this flag.
Tags: loading_and_analysis
--lockfile_mode=<off, update or error> default: "update"
Specifies how and whether or not to use the lockfile. Valid values are `update` to use the lockfile and update it if there are changes, `error` to use the lockfile but throw an error if it's not up-to-date, or `off` to neither read from or write to the lockfile.
Tags: loading_and_analysis
--override_module=<an equals-separated mapping of module name to path> multiple uses are accumulated
Override a module with a local path in the form of <module name>=<path>. If the given path is an absolute path, it will be used as it is. If the given path is a relative path, it is relative to the current working directory. If the given path starts with '%workspace%, it is relative to the workspace root, which is the output of `bazel info workspace`
--registry=<a string> multiple uses are accumulated
Specifies the registries to use to locate Bazel module dependencies. The order is important: modules will be looked up in earlier registries first, and only fall back to later registries when they're missing from the earlier ones.
Tags: changes_inputs
Options that trigger optimizations of the build time:
--gc_thrashing_limits=<comma separated pairs of <period>:<count>> default: "1s:2,20s:3,1m:5"
Limits which, if reached, cause GcThrashingDetector to crash Bazel with an OOM. Each limit is specified as <period>:<count> where period is a duration and count is a positive integer. If more than --gc_thrashing_threshold percent of tenured space (old gen heap) remains occupied after <count> consecutive full GCs within <period>, an OOM is triggered. Multiple limits can be specified separated by commas.
Tags: host_machine_resource_optimizations
--skyframe_high_water_mark_full_gc_drops_per_invocation=<an integer, >= 0> default: "2147483647"
Flag for advanced configuration of Bazel's internal Skyframe engine. If Bazel detects its retained heap percentage usage exceeds the threshold set by --skyframe_high_water_mark_threshold, when a full GC event occurs, it will drop unnecessary temporary Skyframe state, up to this many times per invocation. Defaults to Integer.MAX_VALUE; effectively unlimited. Zero means that full GC events will never trigger drops. If the limit is reached, Skyframe state will no longer be dropped when a full GC event occurs and that retained heap percentage threshold is exceeded.
Tags: host_machine_resource_optimizations
--skyframe_high_water_mark_minor_gc_drops_per_invocation=<an integer, >= 0> default: "2147483647"
Flag for advanced configuration of Bazel's internal Skyframe engine. If Bazel detects its retained heap percentage usage exceeds the threshold set by --skyframe_high_water_mark_threshold, when a minor GC event occurs, it will drop unnecessary temporary Skyframe state, up to this many times per invocation. Defaults to Integer.MAX_VALUE; effectively unlimited. Zero means that minor GC events will never trigger drops. If the limit is reached, Skyframe state will no longer be dropped when a minor GC event occurs and that retained heap percentage threshold is exceeded.
Tags: host_machine_resource_optimizations
--skyframe_high_water_mark_threshold=<an integer> default: "85"
Flag for advanced configuration of Bazel's internal Skyframe engine. If Bazel detects its retained heap percentage usage is at least this threshold, it will drop unnecessary temporary Skyframe state. Tweaking this may let you mitigate wall time impact of GC thrashing, when the GC thrashing is (i) caused by the memory usage of this temporary state and (ii) more costly than reconstituting the state when it is needed.
Tags: host_machine_resource_optimizations
Options that affect the verbosity, format or location of logging:
--[no]experimental_command_profile default: "false"
Records a Java Flight Recorder CPU profile into a profile.jfr file in the output base directory. The syntax and semantics of this flag might change in the future to support different profile types or output formats; use at your own risk.
--[no]experimental_record_metrics_for_all_mnemonics default: "false"
By default the number of action types is limited to the 20 mnemonics with the largest number of executed actions. Setting this option will write statistics for all mnemonics.
Options specifying or altering a generic input to a Bazel command that does not fall into other categories.:
--experimental_resolved_file_instead_of_workspace=<a string> default: ""
If non-empty read the specified resolved file instead of the WORKSPACE file
Tags: changes_inputs
--for_command=<a string> default: "build"
The command for which the options should be canonicalized.
Tags: affects_outputs, terminal_output
--invocation_policy=<a string> default: ""
Applies an invocation policy to the options to be canonicalized.
Tags: affects_outputs, terminal_output
Remote caching and execution options:
--experimental_downloader_config=<a string> default: see description
Specify a file to configure the remote downloader with. This file consists of lines, each of which starts with a directive (`allow`, `block` or `rewrite`) followed by either a host name (for `allow` and `block`) or two patterns, one to match against, and one to use as a substitute URL, with back-references starting from `$1`. It is possible for multiple `rewrite` directives for the same URL to be give, and in this case multiple URLs will be returned.
--experimental_worker_for_repo_fetching=<off, platform or virtual> default: "off"
The threading mode to use for repo fetching. If set to 'off', no worker thread is used, and the repo fetching is subject to restarts. Otherwise, uses a platform thread (i.e. OS thread) if set to 'platform' or a virtual thread if set to 'virtual'.
Miscellaneous options, not otherwise categorized.:
--deleted_packages=<comma-separated list of package names> multiple uses are accumulated
A comma-separated list of names of packages which the build system will consider non-existent, even if they are visible somewhere on the package path. Use this option when deleting a subpackage 'x/y' of an existing package 'x'. For example, after deleting x/y/BUILD in your client, the build system may complain if it encounters a label '//x:y/z' if that is still provided by another package_path entry. Specifying --deleted_packages x/y avoids this problem.
--override_repository=<an equals-separated mapping of repository name to path> multiple uses are accumulated
Override a repository with a local path in the form of <repository name>=<path>. If the given path is an absolute path, it will be used as it is. If the given path is a relative path, it is relative to the current working directory. If the given path starts with '%workspace%, it is relative to the workspace root, which is the output of `bazel info workspace`
--package_path=<colon-separated list of options> default: "%workspace%"
A colon-separated list of where to look for packages. Elements beginning with '%workspace%' are relative to the enclosing workspace. If omitted or empty, the default is the output of 'bazel info default-package-path'.
--[no]show_loading_progress default: "true"
If enabled, causes Bazel to print "Loading package:" messages.

Clean Options

Inherits all options from build.

Options that appear before the command and are parsed by the client:
--distdir=<a path> multiple uses are accumulated
Additional places to search for archives before accessing the network to download them.
Tags: bazel_internal_configuration
If set, the repository cache will hardlink the file in case of a cache hit, rather than copying. This is intended to save disk space.
Tags: bazel_internal_configuration
--experimental_repository_downloader_retries=<an integer> default: "0"
The maximum number of attempts to retry a download error. If set to 0, retries are disabled.
Tags: experimental
--experimental_scale_timeouts=<a double> default: "1.0"
Scale all timeouts in Starlark repository rules by this factor. In this way, external repositories can be made working on machines that are slower than the rule author expected, without changing the source code
Tags: bazel_internal_configuration, experimental
--http_connector_attempts=<an integer> default: "8"
The maximum number of attempts for http downloads.
Tags: bazel_internal_configuration
--http_connector_retry_max_timeout=<An immutable length of time.> default: "0s"
The maximum timeout for http download retries. With a value of 0, no timeout maximum is defined.
Tags: bazel_internal_configuration
--http_timeout_scaling=<a double> default: "1.0"
Scale all timeouts related to http downloads by the given factor
Tags: bazel_internal_configuration
--repository_cache=<a path> default: see description
Specifies the cache location of the downloaded values obtained during the fetching of external repositories. An empty string as argument requests the cache to be disabled, otherwise the default of '<output_user_root>/cache/repos/v1' is used
Tags: bazel_internal_configuration
--[no]repository_disable_download default: "false"
If set, downloading using ctx.download{,_and_extract} is not allowed during repository fetching. Note that network access is not completely disabled; ctx.execute could still run an arbitrary executable that accesses the Internet.
Tags: bazel_internal_configuration
Options that control build execution:
--gc_thrashing_threshold=<an integer in 0-100 range> default: "100"
The percent of tenured space occupied (0-100) above which GcThrashingDetector considers memory pressure events against its limits (--gc_thrashing_limits). If set to 100, GcThrashingDetector is disabled.
Tags: host_machine_resource_optimizations
Options that control the output of the command:
--[no]async default: "false"
If true, output cleaning is asynchronous. When this command completes, it will be safe to execute new commands in the same client, even though the deletion may continue in the background.
Tags: host_machine_resource_optimizations
--[no]expunge default: "false"
If true, clean removes the entire working tree for this bazel instance, which includes all bazel-created temporary and build output files, and stops the bazel server if it is running.
Tags: host_machine_resource_optimizations
--expunge_async
If specified, clean asynchronously removes the entire working tree for this bazel instance, which includes all bazel-created temporary and build output files, and stops the bazel server if it is running. When this command completes, it will be safe to execute new commands in the same client, even though the deletion may continue in the background.
Expands to:
  --expunge
  --async

Tags: host_machine_resource_optimizations
This option affects semantics of the Starlark language or the build API accessible to BUILD files, .bzl files, or WORKSPACE files.:
--[no]incompatible_depset_for_java_output_source_jars default: "true"
No-op.
Tags: loading_and_analysis, incompatible_change
--[no]incompatible_new_actions_api default: "true"
No-op
Tags: no_op, incompatible_change
Options relating to Bzlmod output and semantics:
--allow_yanked_versions=<a string> multiple uses are accumulated
Specified the module versions in the form of `<module1>@<version1>,<module2>@<version2>` that will be allowed in the resolved dependency graph even if they are declared yanked in the registry where they come from (if they are not coming from a NonRegistryOverride). Otherwise, yanked versions will cause the resolution to fail. You can also define allowed yanked version with the `BZLMOD_ALLOW_YANKED_VERSIONS` environment variable. You can disable this check by using the keyword 'all' (not recommended).
Tags: loading_and_analysis
--check_bazel_compatibility=<error, warning or off> default: "error"
Check bazel version compatibility of Bazel modules. Valid values are `error` to escalate it to a resolution failure, `off` to disable the check, or `warning` to print a warning when mismatch detected.
Tags: loading_and_analysis
--check_direct_dependencies=<off, warning or error> default: "warning"
Check if the direct `bazel_dep` dependencies declared in the root module are the same versions you get in the resolved dependency graph. Valid values are `off` to disable the check, `warning` to print a warning when mismatch detected or `error` to escalate it to a resolution failure.
Tags: loading_and_analysis
--[no]ignore_dev_dependency default: "false"
If true, Bazel ignores `bazel_dep` and `use_extension` declared as `dev_dependency` in the MODULE.bazel of the root module. Note that, those dev dependencies are always ignored in the MODULE.bazel if it's not the root module regardless of the value of this flag.
Tags: loading_and_analysis
--lockfile_mode=<off, update or error> default: "update"
Specifies how and whether or not to use the lockfile. Valid values are `update` to use the lockfile and update it if there are changes, `error` to use the lockfile but throw an error if it's not up-to-date, or `off` to neither read from or write to the lockfile.
Tags: loading_and_analysis
--override_module=<an equals-separated mapping of module name to path> multiple uses are accumulated
Override a module with a local path in the form of <module name>=<path>. If the given path is an absolute path, it will be used as it is. If the given path is a relative path, it is relative to the current working directory. If the given path starts with '%workspace%, it is relative to the workspace root, which is the output of `bazel info workspace`
--registry=<a string> multiple uses are accumulated
Specifies the registries to use to locate Bazel module dependencies. The order is important: modules will be looked up in earlier registries first, and only fall back to later registries when they're missing from the earlier ones.
Tags: changes_inputs
Options that trigger optimizations of the build time:
--gc_thrashing_limits=<comma separated pairs of <period>:<count>> default: "1s:2,20s:3,1m:5"
Limits which, if reached, cause GcThrashingDetector to crash Bazel with an OOM. Each limit is specified as <period>:<count> where period is a duration and count is a positive integer. If more than --gc_thrashing_threshold percent of tenured space (old gen heap) remains occupied after <count> consecutive full GCs within <period>, an OOM is triggered. Multiple limits can be specified separated by commas.
Tags: host_machine_resource_optimizations
--skyframe_high_water_mark_full_gc_drops_per_invocation=<an integer, >= 0> default: "2147483647"
Flag for advanced configuration of Bazel's internal Skyframe engine. If Bazel detects its retained heap percentage usage exceeds the threshold set by --skyframe_high_water_mark_threshold, when a full GC event occurs, it will drop unnecessary temporary Skyframe state, up to this many times per invocation. Defaults to Integer.MAX_VALUE; effectively unlimited. Zero means that full GC events will never trigger drops. If the limit is reached, Skyframe state will no longer be dropped when a full GC event occurs and that retained heap percentage threshold is exceeded.
Tags: host_machine_resource_optimizations
--skyframe_high_water_mark_minor_gc_drops_per_invocation=<an integer, >= 0> default: "2147483647"
Flag for advanced configuration of Bazel's internal Skyframe engine. If Bazel detects its retained heap percentage usage exceeds the threshold set by --skyframe_high_water_mark_threshold, when a minor GC event occurs, it will drop unnecessary temporary Skyframe state, up to this many times per invocation. Defaults to Integer.MAX_VALUE; effectively unlimited. Zero means that minor GC events will never trigger drops. If the limit is reached, Skyframe state will no longer be dropped when a minor GC event occurs and that retained heap percentage threshold is exceeded.
Tags: host_machine_resource_optimizations
--skyframe_high_water_mark_threshold=<an integer> default: "85"
Flag for advanced configuration of Bazel's internal Skyframe engine. If Bazel detects its retained heap percentage usage is at least this threshold, it will drop unnecessary temporary Skyframe state. Tweaking this may let you mitigate wall time impact of GC thrashing, when the GC thrashing is (i) caused by the memory usage of this temporary state and (ii) more costly than reconstituting the state when it is needed.
Tags: host_machine_resource_optimizations
Options that affect the verbosity, format or location of logging:
--[no]experimental_command_profile default: "false"
Records a Java Flight Recorder CPU profile into a profile.jfr file in the output base directory. The syntax and semantics of this flag might change in the future to support different profile types or output formats; use at your own risk.
--[no]experimental_record_metrics_for_all_mnemonics default: "false"
By default the number of action types is limited to the 20 mnemonics with the largest number of executed actions. Setting this option will write statistics for all mnemonics.
Options specifying or altering a generic input to a Bazel command that does not fall into other categories.:
--experimental_resolved_file_instead_of_workspace=<a string> default: ""
If non-empty read the specified resolved file instead of the WORKSPACE file
Tags: changes_inputs
Remote caching and execution options:
--experimental_downloader_config=<a string> default: see description
Specify a file to configure the remote downloader with. This file consists of lines, each of which starts with a directive (`allow`, `block` or `rewrite`) followed by either a host name (for `allow` and `block`) or two patterns, one to match against, and one to use as a substitute URL, with back-references starting from `$1`. It is possible for multiple `rewrite` directives for the same URL to be give, and in this case multiple URLs will be returned.
--experimental_worker_for_repo_fetching=<off, platform or virtual> default: "off"
The threading mode to use for repo fetching. If set to 'off', no worker thread is used, and the repo fetching is subject to restarts. Otherwise, uses a platform thread (i.e. OS thread) if set to 'platform' or a virtual thread if set to 'virtual'.
Miscellaneous options, not otherwise categorized.:
--override_repository=<an equals-separated mapping of repository name to path> multiple uses are accumulated
Override a repository with a local path in the form of <repository name>=<path>. If the given path is an absolute path, it will be used as it is. If the given path is a relative path, it is relative to the current working directory. If the given path starts with '%workspace%, it is relative to the workspace root, which is the output of `bazel info workspace`

Config Options

Coverage Options

Inherits all options from test.

Options that appear before the command and are parsed by the client:
--distdir=<a path> multiple uses are accumulated
Additional places to search for archives before accessing the network to download them.
Tags: bazel_internal_configuration
If set, the repository cache will hardlink the file in case of a cache hit, rather than copying. This is intended to save disk space.
Tags: bazel_internal_configuration
--experimental_repository_downloader_retries=<an integer> default: "0"
The maximum number of attempts to retry a download error. If set to 0, retries are disabled.
Tags: experimental
--experimental_scale_timeouts=<a double> default: "1.0"
Scale all timeouts in Starlark repository rules by this factor. In this way, external repositories can be made working on machines that are slower than the rule author expected, without changing the source code
Tags: bazel_internal_configuration, experimental
--http_connector_attempts=<an integer> default: "8"
The maximum number of attempts for http downloads.
Tags: bazel_internal_configuration
--http_connector_retry_max_timeout=<An immutable length of time.> default: "0s"
The maximum timeout for http download retries. With a value of 0, no timeout maximum is defined.
Tags: bazel_internal_configuration
--http_timeout_scaling=<a double> default: "1.0"
Scale all timeouts related to http downloads by the given factor
Tags: bazel_internal_configuration
--repository_cache=<a path> default: see description
Specifies the cache location of the downloaded values obtained during the fetching of external repositories. An empty string as argument requests the cache to be disabled, otherwise the default of '<output_user_root>/cache/repos/v1' is used
Tags: bazel_internal_configuration
--[no]repository_disable_download default: "false"
If set, downloading using ctx.download{,_and_extract} is not allowed during repository fetching. Note that network access is not completely disabled; ctx.execute could still run an arbitrary executable that accesses the Internet.
Tags: bazel_internal_configuration
Options that control build execution:
--gc_thrashing_threshold=<an integer in 0-100 range> default: "100"
The percent of tenured space occupied (0-100) above which GcThrashingDetector considers memory pressure events against its limits (--gc_thrashing_limits). If set to 100, GcThrashingDetector is disabled.
Tags: host_machine_resource_optimizations
This option affects semantics of the Starlark language or the build API accessible to BUILD files, .bzl files, or WORKSPACE files.:
--[no]incompatible_depset_for_java_output_source_jars default: "true"
No-op.
Tags: loading_and_analysis, incompatible_change
--[no]incompatible_new_actions_api default: "true"
No-op
Tags: no_op, incompatible_change
Options relating to Bzlmod output and semantics:
--allow_yanked_versions=<a string> multiple uses are accumulated
Specified the module versions in the form of `<module1>@<version1>,<module2>@<version2>` that will be allowed in the resolved dependency graph even if they are declared yanked in the registry where they come from (if they are not coming from a NonRegistryOverride). Otherwise, yanked versions will cause the resolution to fail. You can also define allowed yanked version with the `BZLMOD_ALLOW_YANKED_VERSIONS` environment variable. You can disable this check by using the keyword 'all' (not recommended).
Tags: loading_and_analysis
--check_bazel_compatibility=<error, warning or off> default: "error"
Check bazel version compatibility of Bazel modules. Valid values are `error` to escalate it to a resolution failure, `off` to disable the check, or `warning` to print a warning when mismatch detected.
Tags: loading_and_analysis
--check_direct_dependencies=<off, warning or error> default: "warning"
Check if the direct `bazel_dep` dependencies declared in the root module are the same versions you get in the resolved dependency graph. Valid values are `off` to disable the check, `warning` to print a warning when mismatch detected or `error` to escalate it to a resolution failure.
Tags: loading_and_analysis
--[no]ignore_dev_dependency default: "false"
If true, Bazel ignores `bazel_dep` and `use_extension` declared as `dev_dependency` in the MODULE.bazel of the root module. Note that, those dev dependencies are always ignored in the MODULE.bazel if it's not the root module regardless of the value of this flag.
Tags: loading_and_analysis
--lockfile_mode=<off, update or error> default: "update"
Specifies how and whether or not to use the lockfile. Valid values are `update` to use the lockfile and update it if there are changes, `error` to use the lockfile but throw an error if it's not up-to-date, or `off` to neither read from or write to the lockfile.
Tags: loading_and_analysis
--override_module=<an equals-separated mapping of module name to path> multiple uses are accumulated
Override a module with a local path in the form of <module name>=<path>. If the given path is an absolute path, it will be used as it is. If the given path is a relative path, it is relative to the current working directory. If the given path starts with '%workspace%, it is relative to the workspace root, which is the output of `bazel info workspace`
--registry=<a string> multiple uses are accumulated
Specifies the registries to use to locate Bazel module dependencies. The order is important: modules will be looked up in earlier registries first, and only fall back to later registries when they're missing from the earlier ones.
Tags: changes_inputs
Options that trigger optimizations of the build time:
--gc_thrashing_limits=<comma separated pairs of <period>:<count>> default: "1s:2,20s:3,1m:5"
Limits which, if reached, cause GcThrashingDetector to crash Bazel with an OOM. Each limit is specified as <period>:<count> where period is a duration and count is a positive integer. If more than --gc_thrashing_threshold percent of tenured space (old gen heap) remains occupied after <count> consecutive full GCs within <period>, an OOM is triggered. Multiple limits can be specified separated by commas.
Tags: host_machine_resource_optimizations
--skyframe_high_water_mark_full_gc_drops_per_invocation=<an integer, >= 0> default: "2147483647"
Flag for advanced configuration of Bazel's internal Skyframe engine. If Bazel detects its retained heap percentage usage exceeds the threshold set by --skyframe_high_water_mark_threshold, when a full GC event occurs, it will drop unnecessary temporary Skyframe state, up to this many times per invocation. Defaults to Integer.MAX_VALUE; effectively unlimited. Zero means that full GC events will never trigger drops. If the limit is reached, Skyframe state will no longer be dropped when a full GC event occurs and that retained heap percentage threshold is exceeded.
Tags: host_machine_resource_optimizations
--skyframe_high_water_mark_minor_gc_drops_per_invocation=<an integer, >= 0> default: "2147483647"
Flag for advanced configuration of Bazel's internal Skyframe engine. If Bazel detects its retained heap percentage usage exceeds the threshold set by --skyframe_high_water_mark_threshold, when a minor GC event occurs, it will drop unnecessary temporary Skyframe state, up to this many times per invocation. Defaults to Integer.MAX_VALUE; effectively unlimited. Zero means that minor GC events will never trigger drops. If the limit is reached, Skyframe state will no longer be dropped when a minor GC event occurs and that retained heap percentage threshold is exceeded.
Tags: host_machine_resource_optimizations
--skyframe_high_water_mark_threshold=<an integer> default: "85"
Flag for advanced configuration of Bazel's internal Skyframe engine. If Bazel detects its retained heap percentage usage is at least this threshold, it will drop unnecessary temporary Skyframe state. Tweaking this may let you mitigate wall time impact of GC thrashing, when the GC thrashing is (i) caused by the memory usage of this temporary state and (ii) more costly than reconstituting the state when it is needed.
Tags: host_machine_resource_optimizations
Options that affect the verbosity, format or location of logging:
--[no]experimental_command_profile default: "false"
Records a Java Flight Recorder CPU profile into a profile.jfr file in the output base directory. The syntax and semantics of this flag might change in the future to support different profile types or output formats; use at your own risk.
--[no]experimental_record_metrics_for_all_mnemonics default: "false"
By default the number of action types is limited to the 20 mnemonics with the largest number of executed actions. Setting this option will write statistics for all mnemonics.
Options specifying or altering a generic input to a Bazel command that does not fall into other categories.:
--experimental_resolved_file_instead_of_workspace=<a string> default: ""
If non-empty read the specified resolved file instead of the WORKSPACE file
Tags: changes_inputs
Remote caching and execution options:
--experimental_downloader_config=<a string> default: see description
Specify a file to configure the remote downloader with. This file consists of lines, each of which starts with a directive (`allow`, `block` or `rewrite`) followed by either a host name (for `allow` and `block`) or two patterns, one to match against, and one to use as a substitute URL, with back-references starting from `$1`. It is possible for multiple `rewrite` directives for the same URL to be give, and in this case multiple URLs will be returned.
--experimental_worker_for_repo_fetching=<off, platform or virtual> default: "off"
The threading mode to use for repo fetching. If set to 'off', no worker thread is used, and the repo fetching is subject to restarts. Otherwise, uses a platform thread (i.e. OS thread) if set to 'platform' or a virtual thread if set to 'virtual'.
Miscellaneous options, not otherwise categorized.:
--override_repository=<an equals-separated mapping of repository name to path> multiple uses are accumulated
Override a repository with a local path in the form of <repository name>=<path>. If the given path is an absolute path, it will be used as it is. If the given path is a relative path, it is relative to the current working directory. If the given path starts with '%workspace%, it is relative to the workspace root, which is the output of `bazel info workspace`

Cquery Options

Inherits all options from test.

Options that appear before the command and are parsed by the client:
--distdir=<a path> multiple uses are accumulated
Additional places to search for archives before accessing the network to download them.
Tags: bazel_internal_configuration
If set, the repository cache will hardlink the file in case of a cache hit, rather than copying. This is intended to save disk space.
Tags: bazel_internal_configuration
--experimental_repository_downloader_retries=<an integer> default: "0"
The maximum number of attempts to retry a download error. If set to 0, retries are disabled.
Tags: experimental
--experimental_scale_timeouts=<a double> default: "1.0"
Scale all timeouts in Starlark repository rules by this factor. In this way, external repositories can be made working on machines that are slower than the rule author expected, without changing the source code
Tags: bazel_internal_configuration, experimental
--http_connector_attempts=<an integer> default: "8"
The maximum number of attempts for http downloads.
Tags: bazel_internal_configuration
--http_connector_retry_max_timeout=<An immutable length of time.> default: "0s"
The maximum timeout for http download retries. With a value of 0, no timeout maximum is defined.
Tags: bazel_internal_configuration
--http_timeout_scaling=<a double> default: "1.0"
Scale all timeouts related to http downloads by the given factor
Tags: bazel_internal_configuration
--repository_cache=<a path> default: see description
Specifies the cache location of the downloaded values obtained during the fetching of external repositories. An empty string as argument requests the cache to be disabled, otherwise the default of '<output_user_root>/cache/repos/v1' is used
Tags: bazel_internal_configuration
--[no]repository_disable_download default: "false"
If set, downloading using ctx.download{,_and_extract} is not allowed during repository fetching. Note that network access is not completely disabled; ctx.execute could still run an arbitrary executable that accesses the Internet.
Tags: bazel_internal_configuration
Options that control build execution:
--gc_thrashing_threshold=<an integer in 0-100 range> default: "100"
The percent of tenured space occupied (0-100) above which GcThrashingDetector considers memory pressure events against its limits (--gc_thrashing_limits). If set to 100, GcThrashingDetector is disabled.
Tags: host_machine_resource_optimizations
This option affects semantics of the Starlark language or the build API accessible to BUILD files, .bzl files, or WORKSPACE files.:
--[no]incompatible_depset_for_java_output_source_jars default: "true"
No-op.
Tags: loading_and_analysis, incompatible_change
--[no]incompatible_new_actions_api default: "true"
No-op
Tags: no_op, incompatible_change
Options relating to query output and semantics:
--aspect_deps=<off, conservative or precise> default: "conservative"
How to resolve aspect dependencies when the output format is one of {xml,proto,record}. 'off' means no aspect dependencies are resolved, 'conservative' (the default) means all declared aspect dependencies are added regardless of whether they are given the rule class of direct dependencies, 'precise' means that only those aspects are added that are possibly active given the rule class of the direct dependencies. Note that precise mode requires loading other packages to evaluate a single target thus making it slower than the other modes. Also note that even precise mode is not completely precise: the decision whether to compute an aspect is decided in the analysis phase, which is not run during 'bazel query'.
Tags: build_file_semantics
--[no]consistent_labels default: "false"
If enabled, every query command emits labels as if by the Starlark <code>str</code> function applied to a <code>Label</code> instance. This is useful for tools that need to match the output of different query commands and/or labels emitted by rules. If not enabled, output formatters are free to emit apparent repository names (relative to the main repository) instead to make the output more readable.
Tags: terminal_output
--[no]graph:factored default: "true"
If true, then the graph will be emitted 'factored', i.e. topologically-equivalent nodes will be merged together and their labels concatenated. This option is only applicable to --output=graph.
Tags: terminal_output
--graph:node_limit=<an integer> default: "512"
The maximum length of the label string for a graph node in the output. Longer labels will be truncated; -1 means no truncation. This option is only applicable to --output=graph.
Tags: terminal_output
--[no]implicit_deps default: "true"
If enabled, implicit dependencies will be included in the dependency graph over which the query operates. An implicit dependency is one that is not explicitly specified in the BUILD file but added by bazel. For cquery, this option controls filtering resolved toolchains.
Tags: build_file_semantics
--[no]include_aspects default: "true"
aquery, cquery: whether to include aspect-generated actions in the output. query: no-op (aspects are always followed).
Tags: terminal_output
--[no]incompatible_package_group_includes_double_slash default: "true"
If enabled, when outputting package_group's `packages` attribute, the leading `//` will not be omitted.
Tags: terminal_output, incompatible_change
--[no]infer_universe_scope default: "false"
If set and --universe_scope is unset, then a value of --universe_scope will be inferred as the list of unique target patterns in the query expression. Note that the --universe_scope value inferred for a query expression that uses universe-scoped functions (e.g.`allrdeps`) may not be what you want, so you should use this option only if you know what you are doing. See https://bazel.build/reference/query#sky-query for details and examples. If --universe_scope is set, then this option's value is ignored. Note: this option applies only to `query` (i.e. not `cquery`).
Tags: loading_and_analysis
--[no]line_terminator_null default: "false"
Whether each format is terminated with \0 instead of newline.
Tags: terminal_output
--[no]nodep_deps default: "true"
If enabled, deps from "nodep" attributes will be included in the dependency graph over which the query operates. A common example of a "nodep" attribute is "visibility". Run and parse the output of `info build-language` to learn about all the "nodep" attributes in the build language.
Tags: build_file_semantics
--output=<a string> default: "label"
The format in which the cquery results should be printed. Allowed values for cquery are: label, label_kind, textproto, transitions, proto, streamed_proto, jsonproto. If you select 'transitions', you also have to specify the --transitions=(lite|full) option.
Tags: terminal_output
--[no]proto:default_values default: "true"
If true, attributes whose value is not explicitly specified in the BUILD file are included; otherwise they are omitted. This option is applicable to --output=proto
Tags: terminal_output
--[no]proto:definition_stack default: "false"
Populate the definition_stack proto field, which records for each rule instance the Starlark call stack at the moment the rule's class was defined.
Tags: terminal_output
--[no]proto:flatten_selects default: "true"
If enabled, configurable attributes created by select() are flattened. For list types the flattened representation is a list containing each value of the select map exactly once. Scalar types are flattened to null.
Tags: build_file_semantics
--[no]proto:include_attribute_source_aspects default: "false"
Populate the source_aspect_name proto field of each Attribute with the source aspect that the attribute came from (empty string if it did not).
Tags: terminal_output
--[no]proto:include_configurations default: "true"
if enabled, proto output will include information about configurations. When disabled,cquery proto output format resembles query output format.
Tags: affects_outputs
--[no]proto:include_synthetic_attribute_hash default: "false"
Whether or not to calculate and populate the $internal_attr_hash attribute.
Tags: terminal_output
--[no]proto:instantiation_stack default: "false"
Populate the instantiation call stack of each rule. Note that this requires the stack to be present
Tags: terminal_output
--[no]proto:locations default: "true"
Whether to output location information in proto output at all.
Tags: terminal_output
--proto:output_rule_attrs=<comma-separated list of options> default: "all"
Comma separated list of attributes to include in output. Defaults to all attributes. Set to empty string to not output any attribute. This option is applicable to --output=proto.
Tags: terminal_output
--[no]proto:rule_inputs_and_outputs default: "true"
Whether or not to populate the rule_input and rule_output fields.
Tags: terminal_output
--query_file=<a string> default: ""
If set, query will read the query from the file named here, rather than on the command line. It is an error to specify a file here as well as a command-line query.
Tags: changes_inputs
--[no]relative_locations default: "false"
If true, the location of BUILD files in xml and proto outputs will be relative. By default, the location output is an absolute path and will not be consistent across machines. You can set this option to true to have a consistent result across machines.
Tags: terminal_output
--show_config_fragments=<off, direct or transitive> default: "off"
Shows the configuration fragments required by a rule and its transitive dependencies. This can be useful for evaluating how much a configured target graph can be trimmed.
Tags: affects_outputs
--starlark:expr=<a string> default: ""
A Starlark expression to format each configured target in cquery's --output=starlark mode. The configured target is bound to 'target'. If neither --starlark:expr nor --starlark:file is specified, this option will default to 'str(target.label)'. It is an error to specify both --starlark:expr and --starlark:file.
Tags: terminal_output
--starlark:file=<a string> default: ""
The name of a file that defines a Starlark function called 'format', of one argument, that is applied to each configured target to format it as a string. It is an error to specify both --starlark:expr and --starlark:file. See help for --output=starlark for additional detail.
Tags: terminal_output
--[no]tool_deps default: "true"
Query: If disabled, dependencies on 'exec configuration' will not be included in the dependency graph over which the query operates. An 'exec configuration' dependency edge, such as the one from any 'proto_library' rule to the Protocol Compiler, usually points to a tool executed during the build rather than a part of the same 'target' program. Cquery: If disabled, filters out all configured targets which cross an execution transition from the top-level target that discovered this configured target. That means if the top-level target is in the target configuration, only configured targets also in the target configuration will be returned. If the top-level target is in the exec configuration, only exec configured targets will be returned. This option will NOT exclude resolved toolchains.
Tags: build_file_semantics
--transitions=<full, lite or none> default: "none"
The format in which cquery will print transition information.
Tags: affects_outputs
--universe_scope=<comma-separated list of options> default: ""
A comma-separated set of target patterns (additive and subtractive). The query may be performed in the universe defined by the transitive closure of the specified targets. This option is used for the query and cquery commands. For cquery, the input to this option is the targets all answers are built under and so this option may affect configurations and transitions. If this option is not specified, the top-level targets are assumed to be the targets parsed from the query expression. Note: For cquery, not specifying this option may cause the build to break if targets parsed from the query expression are not buildable with top-level options.
Tags: loading_and_analysis
Options relating to Bzlmod output and semantics:
--allow_yanked_versions=<a string> multiple uses are accumulated
Specified the module versions in the form of `<module1>@<version1>,<module2>@<version2>` that will be allowed in the resolved dependency graph even if they are declared yanked in the registry where they come from (if they are not coming from a NonRegistryOverride). Otherwise, yanked versions will cause the resolution to fail. You can also define allowed yanked version with the `BZLMOD_ALLOW_YANKED_VERSIONS` environment variable. You can disable this check by using the keyword 'all' (not recommended).
Tags: loading_and_analysis
--check_bazel_compatibility=<error, warning or off> default: "error"
Check bazel version compatibility of Bazel modules. Valid values are `error` to escalate it to a resolution failure, `off` to disable the check, or `warning` to print a warning when mismatch detected.
Tags: loading_and_analysis
--check_direct_dependencies=<off, warning or error> default: "warning"
Check if the direct `bazel_dep` dependencies declared in the root module are the same versions you get in the resolved dependency graph. Valid values are `off` to disable the check, `warning` to print a warning when mismatch detected or `error` to escalate it to a resolution failure.
Tags: loading_and_analysis
--[no]ignore_dev_dependency default: "false"
If true, Bazel ignores `bazel_dep` and `use_extension` declared as `dev_dependency` in the MODULE.bazel of the root module. Note that, those dev dependencies are always ignored in the MODULE.bazel if it's not the root module regardless of the value of this flag.
Tags: loading_and_analysis
--lockfile_mode=<off, update or error> default: "update"
Specifies how and whether or not to use the lockfile. Valid values are `update` to use the lockfile and update it if there are changes, `error` to use the lockfile but throw an error if it's not up-to-date, or `off` to neither read from or write to the lockfile.
Tags: loading_and_analysis
--override_module=<an equals-separated mapping of module name to path> multiple uses are accumulated
Override a module with a local path in the form of <module name>=<path>. If the given path is an absolute path, it will be used as it is. If the given path is a relative path, it is relative to the current working directory. If the given path starts with '%workspace%, it is relative to the workspace root, which is the output of `bazel info workspace`
--registry=<a string> multiple uses are accumulated
Specifies the registries to use to locate Bazel module dependencies. The order is important: modules will be looked up in earlier registries first, and only fall back to later registries when they're missing from the earlier ones.
Tags: changes_inputs
Options that trigger optimizations of the build time:
--gc_thrashing_limits=<comma separated pairs of <period>:<count>> default: "1s:2,20s:3,1m:5"
Limits which, if reached, cause GcThrashingDetector to crash Bazel with an OOM. Each limit is specified as <period>:<count> where period is a duration and count is a positive integer. If more than --gc_thrashing_threshold percent of tenured space (old gen heap) remains occupied after <count> consecutive full GCs within <period>, an OOM is triggered. Multiple limits can be specified separated by commas.
Tags: host_machine_resource_optimizations
--skyframe_high_water_mark_full_gc_drops_per_invocation=<an integer, >= 0> default: "2147483647"
Flag for advanced configuration of Bazel's internal Skyframe engine. If Bazel detects its retained heap percentage usage exceeds the threshold set by --skyframe_high_water_mark_threshold, when a full GC event occurs, it will drop unnecessary temporary Skyframe state, up to this many times per invocation. Defaults to Integer.MAX_VALUE; effectively unlimited. Zero means that full GC events will never trigger drops. If the limit is reached, Skyframe state will no longer be dropped when a full GC event occurs and that retained heap percentage threshold is exceeded.
Tags: host_machine_resource_optimizations
--skyframe_high_water_mark_minor_gc_drops_per_invocation=<an integer, >= 0> default: "2147483647"
Flag for advanced configuration of Bazel's internal Skyframe engine. If Bazel detects its retained heap percentage usage exceeds the threshold set by --skyframe_high_water_mark_threshold, when a minor GC event occurs, it will drop unnecessary temporary Skyframe state, up to this many times per invocation. Defaults to Integer.MAX_VALUE; effectively unlimited. Zero means that minor GC events will never trigger drops. If the limit is reached, Skyframe state will no longer be dropped when a minor GC event occurs and that retained heap percentage threshold is exceeded.
Tags: host_machine_resource_optimizations
--skyframe_high_water_mark_threshold=<an integer> default: "85"
Flag for advanced configuration of Bazel's internal Skyframe engine. If Bazel detects its retained heap percentage usage is at least this threshold, it will drop unnecessary temporary Skyframe state. Tweaking this may let you mitigate wall time impact of GC thrashing, when the GC thrashing is (i) caused by the memory usage of this temporary state and (ii) more costly than reconstituting the state when it is needed.
Tags: host_machine_resource_optimizations
Options that affect the verbosity, format or location of logging:
--[no]experimental_command_profile default: "false"
Records a Java Flight Recorder CPU profile into a profile.jfr file in the output base directory. The syntax and semantics of this flag might change in the future to support different profile types or output formats; use at your own risk.
--[no]experimental_record_metrics_for_all_mnemonics default: "false"
By default the number of action types is limited to the 20 mnemonics with the largest number of executed actions. Setting this option will write statistics for all mnemonics.
Options specifying or altering a generic input to a Bazel command that does not fall into other categories.:
--experimental_resolved_file_instead_of_workspace=<a string> default: ""
If non-empty read the specified resolved file instead of the WORKSPACE file
Tags: changes_inputs
Remote caching and execution options:
--experimental_downloader_config=<a string> default: see description
Specify a file to configure the remote downloader with. This file consists of lines, each of which starts with a directive (`allow`, `block` or `rewrite`) followed by either a host name (for `allow` and `block`) or two patterns, one to match against, and one to use as a substitute URL, with back-references starting from `$1`. It is possible for multiple `rewrite` directives for the same URL to be give, and in this case multiple URLs will be returned.
--experimental_worker_for_repo_fetching=<off, platform or virtual> default: "off"
The threading mode to use for repo fetching. If set to 'off', no worker thread is used, and the repo fetching is subject to restarts. Otherwise, uses a platform thread (i.e. OS thread) if set to 'platform' or a virtual thread if set to 'virtual'.
Miscellaneous options, not otherwise categorized.:
--override_repository=<an equals-separated mapping of repository name to path> multiple uses are accumulated
Override a repository with a local path in the form of <repository name>=<path>. If the given path is an absolute path, it will be used as it is. If the given path is a relative path, it is relative to the current working directory. If the given path starts with '%workspace%, it is relative to the workspace root, which is the output of `bazel info workspace`
Options that control build execution:
Whether to make direct file system calls to create symlink trees
Tags: loading_and_analysis, execution, experimental
--[no]experimental_persistent_aar_extractor default: "false"
Enable persistent aar extractor by using workers.
Tags: execution
--[no]experimental_remotable_source_manifests default: "false"
Whether to make source manifest actions remotable
Tags: loading_and_analysis, execution, experimental
--[no]experimental_split_coverage_postprocessing default: "false"
If true, then Bazel will run coverage postprocessing for test in a new spawn.
Tags: execution
--[no]experimental_strict_fileset_output default: "false"
If this option is enabled, filesets will treat all output artifacts as regular files. They will not traverse directories or be sensitive to symlinks.
Tags: execution
--modify_execution_info=<regex=[+-]key,regex=[+-]key,...> default: ""
Add or remove keys from an action's execution info based on action mnemonic. Applies only to actions which support execution info. Many common actions support execution info, e.g. Genrule, CppCompile, Javac, StarlarkAction, TestRunner. When specifying multiple values, order matters because many regexes may apply to the same mnemonic. Syntax: "regex=[+-]key,regex=[+-]key,...". Examples: '.*=+x,.*=-y,.*=+z' adds 'x' and 'z' to, and removes 'y' from, the execution info for all actions. 'Genrule=+requires-x' adds 'requires-x' to the execution info for all Genrule actions. '(?!Genrule).*=-requires-x' removes 'requires-x' from the execution info for all non-Genrule actions.
Tags: execution, affects_outputs, loading_and_analysis
--persistent_android_dex_desugar
Enable persistent Android dex and desugar actions by using workers.
Expands to:
  --internal_persistent_android_dex_desugar
  --strategy=Desugar=worker
  --strategy=DexBuilder=worker

Tags: host_machine_resource_optimizations, execution
--persistent_android_resource_processor
Enable persistent Android resource processor by using workers.
Expands to:
  --internal_persistent_busybox_tools
  --strategy=AaptPackage=worker
  --strategy=AndroidResourceParser=worker
  --strategy=AndroidResourceValidator=worker
  --strategy=AndroidResourceCompiler=worker
  --strategy=RClassGenerator=worker
  --strategy=AndroidResourceLink=worker
  --strategy=AndroidAapt2=worker
  --strategy=AndroidAssetMerger=worker
  --strategy=AndroidResourceMerger=worker
  --strategy=AndroidCompiledResourceMerger=worker
  --strategy=ManifestMerger=worker
  --strategy=AndroidManifestMerger=worker
  --strategy=Aapt2Optimize=worker
  --strategy=AARGenerator=worker
  --strategy=ProcessDatabinding=worker
  --strategy=GenerateDataBindingBaseClasses=worker

Tags: host_machine_resource_optimizations, execution
--persistent_multiplex_android_dex_desugar
Enable persistent multiplexed Android dex and desugar actions by using workers.
Expands to:
  --persistent_android_dex_desugar
  --internal_persistent_multiplex_android_dex_desugar

Tags: host_machine_resource_optimizations, execution
--persistent_multiplex_android_resource_processor
Enable persistent multiplexed Android resource processor by using workers.
Expands to:
  --persistent_android_resource_processor
  --modify_execution_info=AaptPackage=+supports-multiplex-workers
  --modify_execution_info=AndroidResourceParser=+supports-multiplex-workers
  --modify_execution_info=AndroidResourceValidator=+supports-multiplex-workers
  --modify_execution_info=AndroidResourceCompiler=+supports-multiplex-workers
  --modify_execution_info=RClassGenerator=+supports-multiplex-workers
  --modify_execution_info=AndroidResourceLink=+supports-multiplex-workers
  --modify_execution_info=AndroidAapt2=+supports-multiplex-workers
  --modify_execution_info=AndroidAssetMerger=+supports-multiplex-workers
  --modify_execution_info=AndroidResourceMerger=+supports-multiplex-workers
  --modify_execution_info=AndroidCompiledResourceMerger=+supports-multiplex-workers
  --modify_execution_info=ManifestMerger=+supports-multiplex-workers
  --modify_execution_info=AndroidManifestMerger=+supports-multiplex-workers
  --modify_execution_info=Aapt2Optimize=+supports-multiplex-workers
  --modify_execution_info=AARGenerator=+supports-multiplex-workers

Tags: host_machine_resource_optimizations, execution
--persistent_multiplex_android_tools
Enable persistent and multiplexed Android tools (dexing, desugaring, resource processing).
Expands to:
  --internal_persistent_multiplex_busybox_tools
  --persistent_multiplex_android_resource_processor
  --persistent_multiplex_android_dex_desugar

Tags: host_machine_resource_optimizations, execution
--[no]use_target_platform_for_tests default: "false"
If true, then Bazel will use the target platform for running tests rather than the test exec group.
Tags: execution
Options that configure the toolchain used for action execution:
--android_compiler=<a string> default: see description
The Android target compiler.
Tags: affects_outputs, loading_and_analysis, loses_incremental_state
--android_crosstool_top=<a build target label> default: "//external:android/crosstool"
The location of the C++ compiler used for Android builds.
Tags: affects_outputs, changes_inputs, loading_and_analysis, loses_incremental_state
--android_grte_top=<a label> default: see description
The Android target grte_top.
Tags: changes_inputs, loading_and_analysis, loses_incremental_state
--android_manifest_merger=<legacy, android or force_android> default: "android"
Selects the manifest merger to use for android_binary rules. Flag to help thetransition to the Android manifest merger from the legacy merger.
Tags: affects_outputs, loading_and_analysis, loses_incremental_state
--android_platforms=<a build target label> default: ""
Sets the platforms that android_binary targets use. If multiple platforms are specified, then the binary is a fat APKs, which contains native binaries for each specified target platform.
Tags: changes_inputs, loading_and_analysis, loses_incremental_state
--android_sdk=<a build target label> default: "@bazel_tools//tools/android:sdk"
Specifies Android SDK/platform that is used to build Android applications.
Tags: changes_inputs, loading_and_analysis, loses_incremental_state
--apple_crosstool_top=<a build target label> default: "@bazel_tools//tools/cpp:toolchain"
The label of the crosstool package to be used in Apple and Objc rules and their dependencies.
Tags: loses_incremental_state, changes_inputs
--cc_output_directory_tag=<a string> default: ""
Specifies a suffix to be added to the configuration directory.
Tags: affects_outputs
--compiler=<a string> default: see description
The C++ compiler to use for compiling the target.
Tags: loading_and_analysis, execution
--coverage_output_generator=<a build target label> default: "@bazel_tools//tools/test:lcov_merger"
Location of the binary that is used to postprocess raw coverage reports. This must currently be a filegroup that contains a single file, the binary. Defaults to '//tools/test:lcov_merger'.
Tags: changes_inputs, affects_outputs, loading_and_analysis
--coverage_report_generator=<a build target label> default: "@bazel_tools//tools/test:coverage_report_generator"
Location of the binary that is used to generate coverage reports. This must currently be a filegroup that contains a single file, the binary. Defaults to '//tools/test:coverage_report_generator'.
Tags: changes_inputs, affects_outputs, loading_and_analysis
--coverage_support=<a build target label> default: "@bazel_tools//tools/test:coverage_support"
Location of support files that are required on the inputs of every test action that collects code coverage. Defaults to '//tools/test:coverage_support'.
Tags: changes_inputs, affects_outputs, loading_and_analysis
--custom_malloc=<a build target label> default: see description
Specifies a custom malloc implementation. This setting overrides malloc attributes in build rules.
Tags: changes_inputs, affects_outputs
--experimental_add_exec_constraints_to_targets=<a '<RegexFilter>=<label1>[,<label2>,...]' assignment> multiple uses are accumulated
List of comma-separated regular expressions, each optionally prefixed by - (negative expression), assigned (=) to a list of comma-separated constraint value targets. If a target matches no negative expression and at least one positive expression its toolchain resolution will be performed as if it had declared the constraint values as execution constraints. Example: //demo,-test=@platforms//cpus:x86_64 will add 'x86_64' to any target under //demo except for those whose name contains 'test'.
Tags: loading_and_analysis
--[no]experimental_include_xcode_execution_requirements default: "false"
If set, add a "requires-xcode:{version}" execution requirement to every Xcode action. If the xcode version has a hyphenated label, also add a "requires-xcode-label:{version_label}" execution requirement.
Tags: loses_incremental_state, loading_and_analysis, execution
--[no]experimental_prefer_mutual_xcode default: "true"
If true, use the most recent Xcode that is available both locally and remotely. If false, or if there are no mutual available versions, use the local Xcode version selected via xcode-select.
Tags: loses_incremental_state
--extra_execution_platforms=<comma-separated list of options> default: ""
The platforms that are available as execution platforms to run actions. Platforms can be specified by exact target, or as a target pattern. These platforms will be considered before those declared in the WORKSPACE file by register_execution_platforms(). This option may only be set once; later instances will override earlier flag settings.
Tags: execution
--extra_toolchains=<comma-separated list of options> multiple uses are accumulated
The toolchain rules to be considered during toolchain resolution. Toolchains can be specified by exact target, or as a target pattern. These toolchains will be considered before those declared in the WORKSPACE file by register_toolchains().
Tags: affects_outputs, changes_inputs, loading_and_analysis
--grte_top=<a label> default: see description
A label to a checked-in libc library. The default value is selected by the crosstool toolchain, and you almost never need to override it.
Tags: action_command_lines, affects_outputs
--host_compiler=<a string> default: see description
No-op flag. Will be removed in a future release.
Tags: loading_and_analysis, execution
--host_grte_top=<a label> default: see description
If specified, this setting overrides the libc top-level directory (--grte_top) for the exec configuration.
Tags: action_command_lines, affects_outputs
--host_platform=<a build target label> default: "@local_config_platform//:host"
The label of a platform rule that describes the host system.
Tags: affects_outputs, changes_inputs, loading_and_analysis
--[no]incompatible_dont_enable_host_nonhost_crosstool_features default: "true"
If true, Bazel will not enable 'host' and 'nonhost' features in the c++ toolchain (see https://github.com/bazelbuild/bazel/issues/7407 for more information).
Tags: loading_and_analysis, incompatible_change
--[no]incompatible_enable_android_toolchain_resolution default: "true"
Use toolchain resolution to select the Android SDK for android rules (Starlark and native)
Tags: loading_and_analysis, incompatible_change
--[no]incompatible_enable_apple_toolchain_resolution default: "false"
Use toolchain resolution to select the Apple SDK for apple rules (Starlark and native)
Tags: loading_and_analysis, incompatible_change
--[no]incompatible_make_thinlto_command_lines_standalone default: "true"
If true, Bazel will not reuse C++ link action command lines for lto indexing command lines (see https://github.com/bazelbuild/bazel/issues/6791 for more information).
Tags: loading_and_analysis, incompatible_change
--[no]incompatible_remove_legacy_whole_archive default: "true"
If true, Bazel will not link library dependencies as whole archive by default (see https://github.com/bazelbuild/bazel/issues/7362 for migration instructions).
Tags: loading_and_analysis, incompatible_change
--[no]incompatible_require_ctx_in_configure_features default: "true"
This flag is a noop and scheduled for removal.
Tags: no_op, incompatible_change
--[no]interface_shared_objects default: "true"
Use interface shared objects if supported by the toolchain. All ELF toolchains currently support this setting.
Tags: loading_and_analysis, affects_outputs, affects_outputs
--ios_sdk_version=<a dotted version (for example '2.3' or '3.3alpha2.4')> default: see description
Specifies the version of the iOS SDK to use to build iOS applications. If unspecified, uses default iOS SDK version from 'xcode_version'.
Tags: loses_incremental_state
--macos_sdk_version=<a dotted version (for example '2.3' or '3.3alpha2.4')> default: see description
Specifies the version of the macOS SDK to use to build macOS applications. If unspecified, uses default macOS SDK version from 'xcode_version'.
Tags: loses_incremental_state
--minimum_os_version=<a string> default: see description
The minimum OS version which your compilation targets.
Tags: loading_and_analysis, affects_outputs
--platform_mappings=<a relative path> default: ""
The location of a mapping file that describes which platform to use if none is set or which flags to set when a platform already exists. Must be relative to the main workspace root. Defaults to 'platform_mappings' (a file directly under the workspace root).
Tags: affects_outputs, changes_inputs, loading_and_analysis
--platforms=<a build target label> default: ""
The labels of the platform rules describing the target platforms for the current command.
Tags: affects_outputs, changes_inputs, loading_and_analysis
--python2_path=<a string> default: see description
Deprecated, no-op. Disabled by `--incompatible_use_python_toolchains`.
Tags: no_op, deprecated
--python3_path=<a string> default: see description
Deprecated, no-op. Disabled by `--incompatible_use_python_toolchains`.
Tags: no_op, deprecated
--python_path=<a string> default: see description
The absolute path of the Python interpreter invoked to run Python targets on the target platform. Deprecated; disabled by --incompatible_use_python_toolchains.
Tags: loading_and_analysis, affects_outputs
--python_top=<a build target label> default: see description
The label of a py_runtime representing the Python interpreter invoked to run Python targets on the target platform. Deprecated; disabled by --incompatible_use_python_toolchains.
Tags: loading_and_analysis, affects_outputs
--tvos_sdk_version=<a dotted version (for example '2.3' or '3.3alpha2.4')> default: see description
Specifies the version of the tvOS SDK to use to build tvOS applications. If unspecified, uses default tvOS SDK version from 'xcode_version'.
Tags: loses_incremental_state
--watchos_sdk_version=<a dotted version (for example '2.3' or '3.3alpha2.4')> default: see description
Specifies the version of the watchOS SDK to use to build watchOS applications. If unspecified, uses default watchOS SDK version from 'xcode_version'.
Tags: loses_incremental_state
--xcode_version=<a string> default: see description
If specified, uses Xcode of the given version for relevant build actions. If unspecified, uses the executor default version of Xcode.
Tags: loses_incremental_state
--xcode_version_config=<a build target label> default: "@bazel_tools//tools/cpp:host_xcodes"
The label of the xcode_config rule to be used for selecting the Xcode version in the build configuration.
Tags: loses_incremental_state, loading_and_analysis
Options that control the output of the command:
--[no]apple_generate_dsym default: "false"
Whether to generate debug symbol(.dSYM) file(s).
Tags: affects_outputs, action_command_lines
If true, build runfiles symlink forests for all targets. If false, write them only when required by a local action, test or run command.
Tags: affects_outputs
--[no]build_runfile_manifests default: "true"
If true, write runfiles manifests for all targets. If false, omit them. Local tests will fail to run when false.
Tags: affects_outputs
--[no]build_test_dwp default: "false"
If enabled, when building C++ tests statically and with fission the .dwp file for the test binary will be automatically built as well.
Tags: loading_and_analysis, affects_outputs
--cc_proto_library_header_suffixes=<comma-separated set of options> default: ".pb.h"
Sets the suffixes of header files that a cc_proto_library creates.
Tags: affects_outputs, loading_and_analysis
--cc_proto_library_source_suffixes=<comma-separated set of options> default: ".pb.cc"
Sets the suffixes of source files that a cc_proto_library creates.
Tags: affects_outputs, loading_and_analysis
--[no]experimental_proto_descriptor_sets_include_source_info default: "false"
Run extra actions for alternative Java api versions in a proto_library.
Tags: affects_outputs, loading_and_analysis, experimental
--[no]experimental_proto_extra_actions default: "false"
Run extra actions for alternative Java api versions in a proto_library.
Tags: affects_outputs, loading_and_analysis, experimental
--[no]experimental_save_feature_state default: "false"
Save the state of enabled and requested feautres as an output of compilation.
Tags: affects_outputs, experimental
--fission=<a set of compilation modes> default: "no"
Specifies which compilation modes use fission for C++ compilations and links. May be any combination of {'fastbuild', 'dbg', 'opt'} or the special values 'yes' to enable all modes and 'no' to disable all modes.
Tags: loading_and_analysis, action_command_lines, affects_outputs
--[no]incompatible_always_include_files_in_data default: "true"
If true, native rules add <code>DefaultInfo.files</code> of data dependencies to their runfiles, which matches the recommended behavior for Starlark rules (https://bazel.build/extending/rules#runfiles_features_to_avoid).
Tags: affects_outputs, incompatible_change
--[no]legacy_external_runfiles default: "true"
If true, build runfiles symlink forests for external repositories under .runfiles/wsname/external/repo (in addition to .runfiles/repo).
Tags: affects_outputs
--[no]objc_generate_linkmap default: "false"
Specifies whether to generate a linkmap file.
Tags: affects_outputs
--[no]save_temps default: "false"
If set, temporary outputs from gcc will be saved. These include .s files (assembler code), .i files (preprocessed C) and .ii files (preprocessed C++).
Tags: affects_outputs
Options that let the user configure the intended output, affecting its value, as opposed to its existence:
--action_env=<a 'name=value' assignment with an optional value part> multiple uses are accumulated
Specifies the set of environment variables available to actions with target configuration. Variables can be either specified by name, in which case the value will be taken from the invocation environment, or by the name=value pair which sets the value independent of the invocation environment. This option can be used multiple times; for options given for the same variable, the latest wins, options for different variables accumulate.
Tags: action_command_lines
--android_cpu=<a string> default: "armeabi-v7a"
The Android target CPU.
Tags: affects_outputs, loading_and_analysis, loses_incremental_state
--[no]android_databinding_use_androidx default: "true"
Generate AndroidX-compatible data-binding files. This is only used with databinding v2. This flag is a no-op.
Tags: affects_outputs, loading_and_analysis, loses_incremental_state, experimental
--[no]android_databinding_use_v3_4_args default: "true"
Use android databinding v2 with 3.4.0 argument. This flag is a no-op.
Tags: affects_outputs, loading_and_analysis, loses_incremental_state, experimental
--android_dynamic_mode=<off, default or fully> default: "off"
Determines whether C++ deps of Android rules will be linked dynamically when a cc_binary does not explicitly create a shared library. 'default' means bazel will choose whether to link dynamically. 'fully' means all libraries will be linked dynamically. 'off' means that all libraries will be linked in mostly static mode.
Tags: affects_outputs, loading_and_analysis
--android_manifest_merger_order=<alphabetical, alphabetical_by_configuration or dependency> default: "alphabetical"
Sets the order of manifests passed to the manifest merger for Android binaries. ALPHABETICAL means manifests are sorted by path relative to the execroot. ALPHABETICAL_BY_CONFIGURATION means manifests are sorted by paths relative to the configuration directory within the output directory. DEPENDENCY means manifests are ordered with each library's manifest coming before the manifests of its dependencies.
Tags: action_command_lines, execution
--[no]android_resource_shrinking default: "false"
Enables resource shrinking for android_binary APKs that use ProGuard.
Tags: affects_outputs, loading_and_analysis
--[no]build_python_zip default: "auto"
Build python executable zip; on on Windows, off on other platforms
Tags: affects_outputs
--catalyst_cpus=<comma-separated list of options> multiple uses are accumulated
Comma-separated list of architectures for which to build Apple Catalyst binaries.
Tags: loses_incremental_state, loading_and_analysis
--[no]collect_code_coverage default: "false"
If specified, Bazel will instrument code (using offline instrumentation where possible) and will collect coverage information during tests. Only targets that match --instrumentation_filter will be affected. Usually this option should not be specified directly - 'bazel coverage' command should be used instead.
Tags: affects_outputs
--compilation_mode=<fastbuild, dbg or opt> [-c] default: "fastbuild"
Specify the mode the binary will be built in. Values: 'fastbuild', 'dbg', 'opt'.
Tags: affects_outputs, action_command_lines
--conlyopt=<a string> multiple uses are accumulated
Additional option to pass to gcc when compiling C source files.
Tags: action_command_lines, affects_outputs
--copt=<a string> multiple uses are accumulated
Additional options to pass to gcc.
Tags: action_command_lines, affects_outputs
--cpu=<a string> default: ""
The target CPU.
Tags: changes_inputs, affects_outputs
--cs_fdo_absolute_path=<a string> default: see description
Use CSFDO profile information to optimize compilation. Specify the absolute path name of the zip file containing the profile file, a raw or an indexed LLVM profile file.
Tags: affects_outputs
--cs_fdo_instrument=<a string> default: see description
Generate binaries with context sensitive FDO instrumentation. With Clang/LLVM compiler, it also accepts the directory name under which the raw profile file(s) will be dumped at runtime.
Tags: affects_outputs
--cs_fdo_profile=<a build target label> default: see description
The cs_fdo_profile representing the context sensitive profile to be used for optimization.
Tags: affects_outputs
--cxxopt=<a string> multiple uses are accumulated
Additional option to pass to gcc when compiling C++ source files.
Tags: action_command_lines, affects_outputs
--define=<a 'name=value' assignment> multiple uses are accumulated
Each --define option specifies an assignment for a build variable. In case of multiple values for a variable, the last one wins.
Tags: changes_inputs, affects_outputs
--dynamic_mode=<off, default or fully> default: "default"
Determines whether C++ binaries will be linked dynamically. 'default' means Bazel will choose whether to link dynamically. 'fully' means all libraries will be linked dynamically. 'off' means that all libraries will be linked in mostly static mode.
Tags: loading_and_analysis, affects_outputs
--[no]enable_fdo_profile_absolute_path default: "true"
If set, use of fdo_absolute_profile_path will raise an error.
Tags: affects_outputs
--[no]enable_runfiles default: "auto"
Enable runfiles symlink tree; By default, it's off on Windows, on on other platforms.
Tags: affects_outputs
--experimental_action_listener=<a build target label> multiple uses are accumulated
Deprecated in favor of aspects. Use action_listener to attach an extra_action to existing build actions.
Tags: execution, experimental
--[no]experimental_android_compress_java_resources default: "false"
Compress Java resources in APKs
Tags: affects_outputs, loading_and_analysis, experimental
--[no]experimental_android_databinding_v2 default: "true"
Use android databinding v2. This flag is a no-op.
Tags: affects_outputs, loading_and_analysis, loses_incremental_state, experimental
--[no]experimental_android_resource_shrinking default: "false"
Enables resource shrinking for android_binary APKs that use ProGuard.
Tags: affects_outputs, loading_and_analysis
--[no]experimental_android_rewrite_dexes_with_rex default: "false"
use rex tool to rewrite dex files
Tags: affects_outputs, loading_and_analysis, loses_incremental_state, experimental
--[no]experimental_collect_code_coverage_for_generated_files default: "false"
If specified, Bazel will also generate collect coverage information for generated files.
Tags: affects_outputs
--experimental_objc_fastbuild_options=<comma-separated list of options> default: "-O0,-DDEBUG=1"
Uses these strings as objc fastbuild compiler options.
Tags: action_command_lines
--[no]experimental_omitfp default: "false"
If true, use libunwind for stack unwinding, and compile with -fomit-frame-pointer and -fasynchronous-unwind-tables.
Tags: action_command_lines, affects_outputs, experimental
--experimental_output_paths=<off, content or strip> default: "off"
Which model to use for where in the output tree rules write their outputs, particularly for multi-platform / multi-configuration builds. This is highly experimental. See https://github.com/bazelbuild/bazel/issues/6526 for details. Starlark actions canopt into path mapping by adding the key 'supports-path-mapping' to the 'execution_requirements' dict.
Tags: loses_incremental_state, bazel_internal_configuration, affects_outputs, execution
--experimental_override_name_platform_in_output_dir=<a 'label=value' assignment> multiple uses are accumulated
Each entry should be of the form label=value where label refers to a platform and values is the desired shortname to use in the output path. Only used when --experimental_platform_in_output_dir is true. Has highest naming priority.
Tags: affects_outputs, experimental
--[no]experimental_platform_in_output_dir default: "false"
If true, a shortname for the target platform is used in the output directory name instead of the CPU. The exact scheme is experimental and subject to change: First, in the rare case the --platforms option does not have exactly one value, a hash of the platforms option is used. Next, if any shortname for the current platform was registered by --experimental_override_name_platform_in_output_dir, then that shortname is used. Then, if --experimental_use_platforms_in_output_dir_legacy_heuristic is set, use a shortname based off the current platform Label. Finally, a hash of the platform option is used as a last resort.
Tags: affects_outputs, experimental
--[no]experimental_use_llvm_covmap default: "false"
If specified, Bazel will generate llvm-cov coverage map information rather than gcov when collect_code_coverage is enabled.
Tags: changes_inputs, affects_outputs, loading_and_analysis, experimental
--[no]experimental_use_platforms_in_output_dir_legacy_heuristic default: "true"
Please only use this flag as part of a suggested migration or testing strategy. Note that the heuristic has known deficiencies and it is suggested to migrate to relying on just --experimental_override_name_platform_in_output_dir.
Tags: affects_outputs, experimental
--fat_apk_cpu=<comma-separated set of options> default: "armeabi-v7a"
Setting this option enables fat APKs, which contain native binaries for all specified target architectures, e.g., --fat_apk_cpu=x86,armeabi-v7a. If this flag is specified, then --android_cpu is ignored for dependencies of android_binary rules.
Tags: affects_outputs, loading_and_analysis, loses_incremental_state
--[no]fat_apk_hwasan default: "false"
Whether to create HWASAN splits.
Tags: affects_outputs, loading_and_analysis, loses_incremental_state
--fdo_instrument=<a string> default: see description
Generate binaries with FDO instrumentation. With Clang/LLVM compiler, it also accepts the directory name under which the raw profile file(s) will be dumped at runtime.
Tags: affects_outputs
--fdo_optimize=<a string> default: see description
Use FDO profile information to optimize compilation. Specify the name of a zip file containing a .gcda file tree, an afdo file containing an auto profile, or an LLVM profile file. This flag also accepts files specified as labels (e.g. `//foo/bar:file.afdo` - you may need to add an `exports_files` directive to the corresponding package) and labels pointing to `fdo_profile` targets. This flag will be superseded by the `fdo_profile` rule.
Tags: affects_outputs
--fdo_prefetch_hints=<a build target label> default: see description
Use cache prefetch hints.
Tags: affects_outputs
--fdo_profile=<a build target label> default: see description
The fdo_profile representing the profile to be used for optimization.
Tags: affects_outputs
--features=<a string> multiple uses are accumulated
The given features will be enabled or disabled by default for targets built in the target configuration. Specifying -<feature> will disable the feature. Negative features always override positive ones. See also --host_features
Tags: changes_inputs, affects_outputs
--[no]force_pic default: "false"
If enabled, all C++ compilations produce position-independent code ("-fPIC"), links prefer PIC pre-built libraries over non-PIC libraries, and links produce position-independent executables ("-pie").
Tags: loading_and_analysis, affects_outputs
--host_action_env=<a 'name=value' assignment with an optional value part> multiple uses are accumulated
Specifies the set of environment variables available to actions with execution configurations. Variables can be either specified by name, in which case the value will be taken from the invocation environment, or by the name=value pair which sets the value independent of the invocation environment. This option can be used multiple times; for options given for the same variable, the latest wins, options for different variables accumulate.
Tags: action_command_lines
--host_compilation_mode=<fastbuild, dbg or opt> default: "opt"
Specify the mode the tools used during the build will be built in. Values: 'fastbuild', 'dbg', 'opt'.
Tags: affects_outputs, action_command_lines
--host_conlyopt=<a string> multiple uses are accumulated
Additional option to pass to the C compiler when compiling C (but not C++) source files in the exec configurations.
Tags: action_command_lines, affects_outputs
--host_copt=<a string> multiple uses are accumulated
Additional options to pass to the C compiler for tools built in the exec configurations.
Tags: action_command_lines, affects_outputs
--host_cpu=<a string> default: ""
The host CPU.
Tags: changes_inputs, affects_outputs
--host_cxxopt=<a string> multiple uses are accumulated
Additional options to pass to C++ compiler for tools built in the exec configurations.
Tags: action_command_lines, affects_outputs
--host_features=<a string> multiple uses are accumulated
The given features will be enabled or disabled by default for targets built in the exec configuration. Specifying -<feature> will disable the feature. Negative features always override positive ones.
Tags: changes_inputs, affects_outputs
--host_force_python=<PY2 or PY3> default: see description
Overrides the Python version for the exec configuration. Can be "PY2" or "PY3".
Tags: loading_and_analysis, affects_outputs
--host_linkopt=<a string> multiple uses are accumulated
Additional option to pass to linker when linking tools in the exec configurations.
Tags: action_command_lines, affects_outputs
--host_macos_minimum_os=<a dotted version (for example '2.3' or '3.3alpha2.4')> default: see description
Minimum compatible macOS version for host targets. If unspecified, uses 'macos_sdk_version'.
Tags: loses_incremental_state
--host_per_file_copt=<a comma-separated list of regex expressions with prefix '-' specifying excluded paths followed by an @ and a comma separated list of options> multiple uses are accumulated
Additional options to selectively pass to the C/C++ compiler when compiling certain files in the exec configurations. This option can be passed multiple times. Syntax: regex_filter@option_1,option_2,...,option_n. Where regex_filter stands for a list of include and exclude regular expression patterns (Also see --instrumentation_filter). option_1 to option_n stand for arbitrary command line options. If an option contains a comma it has to be quoted with a backslash. Options can contain @. Only the first @ is used to split the string. Example: --host_per_file_copt=//foo/.*\.cc,-//foo/bar\.cc@-O0 adds the -O0 command line option to the gcc command line of all cc files in //foo/ except bar.cc.
Tags: action_command_lines, affects_outputs
--[no]incompatible_auto_exec_groups default: "false"
When enabled, an exec groups is automatically created for each toolchain used by a rule. For this to work rule needs to specify `toolchain` parameter on its actions. For more information, see https://github.com/bazelbuild/bazel/issues/17134.
Tags: affects_outputs, incompatible_change
--[no]incompatible_merge_genfiles_directory default: "true"
If true, the genfiles directory is folded into the bin directory.
Tags: affects_outputs, incompatible_change
--[no]incompatible_use_host_features default: "true"
If true, use --features only for the target configuration and --host_features for the exec configuration.
Tags: changes_inputs, affects_outputs, incompatible_change
--[no]instrument_test_targets default: "false"
When coverage is enabled, specifies whether to consider instrumenting test rules. When set, test rules included by --instrumentation_filter are instrumented. Otherwise, test rules are always excluded from coverage instrumentation.
Tags: affects_outputs
--instrumentation_filter=<a comma-separated list of regex expressions with prefix '-' specifying excluded paths> default: "-/javatests[/:],-/test/java[/:]"
When coverage is enabled, only rules with names included by the specified regex-based filter will be instrumented. Rules prefixed with '-' are excluded instead. Note that only non-test rules are instrumented unless --instrument_test_targets is enabled.
Tags: affects_outputs
--ios_minimum_os=<a dotted version (for example '2.3' or '3.3alpha2.4')> default: see description
Minimum compatible iOS version for target simulators and devices. If unspecified, uses 'ios_sdk_version'.
Tags: loses_incremental_state
--ios_multi_cpus=<comma-separated list of options> multiple uses are accumulated
Comma-separated list of architectures to build an ios_application with. The result is a universal binary containing all specified architectures.
Tags: loses_incremental_state, loading_and_analysis
--[no]legacy_whole_archive default: "true"
Deprecated, superseded by --incompatible_remove_legacy_whole_archive (see https://github.com/bazelbuild/bazel/issues/7362 for details). When on, use --whole-archive for cc_binary rules that have linkshared=True and either linkstatic=True or '-static' in linkopts. This is for backwards compatibility only. A better alternative is to use alwayslink=1 where required.
Tags: action_command_lines, affects_outputs, deprecated
--linkopt=<a string> multiple uses are accumulated
Additional option to pass to gcc when linking.
Tags: action_command_lines, affects_outputs
--ltobackendopt=<a string> multiple uses are accumulated
Additional option to pass to the LTO backend step (under --features=thin_lto).
Tags: action_command_lines, affects_outputs
--ltoindexopt=<a string> multiple uses are accumulated
Additional option to pass to the LTO indexing step (under --features=thin_lto).
Tags: action_command_lines, affects_outputs
--macos_cpus=<comma-separated list of options> multiple uses are accumulated
Comma-separated list of architectures for which to build Apple macOS binaries.
Tags: loses_incremental_state, loading_and_analysis
--macos_minimum_os=<a dotted version (for example '2.3' or '3.3alpha2.4')> default: see description
Minimum compatible macOS version for targets. If unspecified, uses 'macos_sdk_version'.
Tags: loses_incremental_state
--memprof_profile=<a build target label> default: see description
Use memprof profile.
Tags: affects_outputs
--[no]objc_debug_with_GLIBCXX default: "false"
If set, and compilation mode is set to 'dbg', define GLIBCXX_DEBUG, GLIBCXX_DEBUG_PEDANTIC and GLIBCPP_CONCEPT_CHECKS.
Tags: action_command_lines
--[no]objc_enable_binary_stripping default: "false"
Whether to perform symbol and dead-code strippings on linked binaries. Binary strippings will be performed if both this flag and --compilation_mode=opt are specified.
Tags: action_command_lines
--objccopt=<a string> multiple uses are accumulated
Additional options to pass to gcc when compiling Objective-C/C++ source files.
Tags: action_command_lines
--per_file_copt=<a comma-separated list of regex expressions with prefix '-' specifying excluded paths followed by an @ and a comma separated list of options> multiple uses are accumulated
Additional options to selectively pass to gcc when compiling certain files. This option can be passed multiple times. Syntax: regex_filter@option_1,option_2,...,option_n. Where regex_filter stands for a list of include and exclude regular expression patterns (Also see --instrumentation_filter). option_1 to option_n stand for arbitrary command line options. If an option contains a comma it has to be quoted with a backslash. Options can contain @. Only the first @ is used to split the string. Example: --per_file_copt=//foo/.*\.cc,-//foo/bar\.cc@-O0 adds the -O0 command line option to the gcc command line of all cc files in //foo/ except bar.cc.
Tags: action_command_lines, affects_outputs
--per_file_ltobackendopt=<a comma-separated list of regex expressions with prefix '-' specifying excluded paths followed by an @ and a comma separated list of options> multiple uses are accumulated
Additional options to selectively pass to LTO backend (under --features=thin_lto) when compiling certain backend objects. This option can be passed multiple times. Syntax: regex_filter@option_1,option_2,...,option_n. Where regex_filter stands for a list of include and exclude regular expression patterns. option_1 to option_n stand for arbitrary command line options. If an option contains a comma it has to be quoted with a backslash. Options can contain @. Only the first @ is used to split the string. Example: --per_file_ltobackendopt=//foo/.*\.o,-//foo/bar\.o@-O0 adds the -O0 command line option to the LTO backend command line of all o files in //foo/ except bar.o.
Tags: action_command_lines, affects_outputs
--platform_suffix=<a string> default: see description
Specifies a suffix to be added to the configuration directory.
Tags: loses_incremental_state, affects_outputs, loading_and_analysis
--propeller_optimize=<a build target label> default: see description
Use Propeller profile information to optimize the build target.A propeller profile must consist of at least one of two files, a cc profile and a ld profile. This flag accepts a build label which must refer to the propeller profile input files. For example, the BUILD file that defines the label, in a/b/BUILD:propeller_optimize( name = "propeller_profile", cc_profile = "propeller_cc_profile.txt", ld_profile = "propeller_ld_profile.txt",)An exports_files directive may have to be added to the corresponding package to make these files visible to Bazel. The option must be used as: --propeller_optimize=//a/b:propeller_profile
Tags: action_command_lines, affects_outputs
--propeller_optimize_absolute_cc_profile=<a string> default: see description
Absolute path name of cc_profile file for Propeller Optimized builds.
Tags: affects_outputs
--propeller_optimize_absolute_ld_profile=<a string> default: see description
Absolute path name of ld_profile file for Propeller Optimized builds.
Tags: affects_outputs
--run_under=<a prefix in front of command> default: see description
Prefix to insert before the executables for the 'test' and 'run' commands. If the value is 'foo -bar', and the execution command line is 'test_binary -baz', then the final command line is 'foo -bar test_binary -baz'.This can also be a label to an executable target. Some examples are: 'valgrind', 'strace', 'strace -c', 'valgrind --quiet --num-callers=20', '//package:target', '//package:target --options'.
Tags: action_command_lines
--[no]share_native_deps default: "true"
If true, native libraries that contain identical functionality will be shared among different targets
Tags: loading_and_analysis, affects_outputs
--[no]stamp default: "false"
Stamp binaries with the date, username, hostname, workspace information, etc.
Tags: affects_outputs
--strip=<always, sometimes or never> default: "sometimes"
Specifies whether to strip binaries and shared libraries (using "-Wl,--strip-debug"). The default value of 'sometimes' means strip iff --compilation_mode=fastbuild.
Tags: affects_outputs
--stripopt=<a string> multiple uses are accumulated
Additional options to pass to strip when generating a '<name>.stripped' binary.
Tags: action_command_lines, affects_outputs
--swiftcopt=<a string> multiple uses are accumulated
Additional options to pass to Swift compilation.
Tags: action_command_lines
--tvos_cpus=<comma-separated list of options> multiple uses are accumulated
Comma-separated list of architectures for which to build Apple tvOS binaries.
Tags: loses_incremental_state, loading_and_analysis
--tvos_minimum_os=<a dotted version (for example '2.3' or '3.3alpha2.4')> default: see description
Minimum compatible tvOS version for target simulators and devices. If unspecified, uses 'tvos_sdk_version'.
Tags: loses_incremental_state
--visionos_cpus=<comma-separated list of options> multiple uses are accumulated
Comma-separated list of architectures for which to build Apple visionOS binaries.
Tags: loses_incremental_state, loading_and_analysis
--watchos_cpus=<comma-separated list of options> multiple uses are accumulated
Comma-separated list of architectures for which to build Apple watchOS binaries.
Tags: loses_incremental_state, loading_and_analysis
--watchos_minimum_os=<a dotted version (for example '2.3' or '3.3alpha2.4')> default: see description
Minimum compatible watchOS version for target simulators and devices. If unspecified, uses 'watchos_sdk_version'.
Tags: loses_incremental_state
--xbinary_fdo=<a build target label> default: see description
Use XbinaryFDO profile information to optimize compilation. Specify the name of default cross binary profile. When the option is used together with --fdo_instrument/--fdo_optimize/--fdo_profile, those options will always prevail as if xbinary_fdo is never specified.
Tags: affects_outputs
Options that affect how strictly Bazel enforces valid build inputs (rule definitions, flag combinations, etc.):
--auto_cpu_environment_group=<a build target label> default: ""
Declare the environment_group to use for automatically mapping cpu values to target_environment values.
Tags: changes_inputs, loading_and_analysis, experimental
--[no]check_licenses default: "false"
Check that licensing constraints imposed by dependent packages do not conflict with distribution modes of the targets being built. By default, licenses are not checked.
Tags: build_file_semantics
--[no]check_visibility default: "true"
If disabled, visibility errors in target dependencies are demoted to warnings.
Tags: build_file_semantics
--[no]desugar_for_android default: "true"
Whether to desugar Java 8 bytecode before dexing.
Tags: affects_outputs, loading_and_analysis, loses_incremental_state
--[no]desugar_java8_libs default: "false"
Whether to include supported Java 8 libraries in apps for legacy devices.
Tags: affects_outputs, loading_and_analysis, loses_incremental_state, experimental
--[no]enforce_constraints default: "true"
Checks the environments each target is compatible with and reports errors if any target has dependencies that don't support the same environments
Tags: build_file_semantics
--[no]experimental_check_desugar_deps default: "true"
Whether to double-check correct desugaring at Android binary level.
Tags: eagerness_to_exit, loading_and_analysis, experimental
--experimental_import_deps_checking=<off, warning or error> default: "OFF"
When enabled, check whether the dependencies of an aar_import are complete. This enforcement can break the build, or can just result in warnings.
Tags: loading_and_analysis
--experimental_strict_java_deps=<off, warn, error, strict or default> default: "default"
If true, checks that a Java target explicitly declares all directly used targets as dependencies.
Tags: build_file_semantics, eagerness_to_exit
--[no]incompatible_check_testonly_for_output_files default: "false"
If enabled, check testonly for prerequisite targets that are output files by looking up the testonly of the generating rule. This matches visibility checking.
Tags: build_file_semantics, incompatible_change
--[no]incompatible_check_visibility_for_toolchains default: "false"
If enabled, visibility checking also applies to toolchain implementations.
Tags: build_file_semantics, incompatible_change
--[no]incompatible_disable_native_android_rules default: "false"
If enabled, direct usage of the native Android rules is disabled. Please use the Starlark Android rules from https://github.com/bazelbuild/rules_android
Tags: eagerness_to_exit, incompatible_change
--[no]incompatible_disable_native_apple_binary_rule default: "false"
No-op. Kept here for backwards compatibility.
Tags: eagerness_to_exit, incompatible_change
--[no]incompatible_python_disable_py2 default: "true"
If true, using Python 2 settings will cause an error. This includes python_version=PY2, srcs_version=PY2, and srcs_version=PY2ONLY. See https://github.com/bazelbuild/bazel/issues/15684 for more information.
Tags: loading_and_analysis, incompatible_change
--[no]incompatible_validate_top_level_header_inclusions default: "true"
If true, Bazel will also validate top level directory header inclusions (see https://github.com/bazelbuild/bazel/issues/10047 for more information).
Tags: loading_and_analysis, incompatible_change
--python_native_rules_allowlist=<a build target label> default: see description
An allowlist (package_group target) to use when enforcing --incompatible_python_disallow_native_rules.
Tags: loading_and_analysis
--[no]strict_filesets default: "false"
If this option is enabled, filesets crossing package boundaries are reported as errors.
Tags: build_file_semantics, eagerness_to_exit
--strict_proto_deps=<off, warn, error, strict or default> default: "error"
Unless OFF, checks that a proto_library target explicitly declares all directly used targets as dependencies.
Tags: build_file_semantics, eagerness_to_exit, incompatible_change
--strict_public_imports=<off, warn, error, strict or default> default: "off"
Unless OFF, checks that a proto_library target explicitly declares all targets used in 'import public' as exported.
Tags: build_file_semantics, eagerness_to_exit, incompatible_change
--[no]strict_system_includes default: "false"
If true, headers found through system include paths (-isystem) are also required to be declared.
Tags: loading_and_analysis, eagerness_to_exit
--target_environment=<a build target label> multiple uses are accumulated
Declares this build's target environment. Must be a label reference to an "environment" rule. If specified, all top-level targets must be compatible with this environment.
Tags: changes_inputs
Options that affect the signing outputs of a build:
--apk_signing_method=<v1, v2, v1_v2 or v4> default: "v1_v2"
Implementation to use to sign APKs
Tags: action_command_lines, affects_outputs, loading_and_analysis
--[no]device_debug_entitlements default: "true"
If set, and compilation mode is not 'opt', objc apps will include debug entitlements when signing.
Tags: changes_inputs
--ios_signing_cert_name=<a string> default: see description
Certificate name to use for iOS signing. If not set will fall back to provisioning profile. May be the certificate's keychain identity preference or (substring) of the certificate's common name, as per codesign's man page (SIGNING IDENTITIES).
Tags: action_command_lines
This option affects semantics of the Starlark language or the build API accessible to BUILD files, .bzl files, or WORKSPACE files.:
--[no]incompatible_disallow_legacy_py_provider default: "true"
No-op, will be removed soon.
Tags: loading_and_analysis, incompatible_change
--[no]incompatible_disallow_sdk_frameworks_attributes default: "false"
If true, disallow sdk_frameworks and weak_sdk_frameworks attributes in objc_library andobjc_import.
Tags: build_file_semantics, incompatible_change
If true, make the default value true for alwayslink attributes in objc_library and objc_import.
Tags: build_file_semantics, incompatible_change
--[no]incompatible_python_disallow_native_rules default: "false"
When true, an error occurs when using the builtin py_* rules; instead the rule_python rules should be used. See https://github.com/bazelbuild/bazel/issues/17773 for more information and migration instructions.
Tags: loading_and_analysis, incompatible_change
Options that govern the behavior of the test environment or test runner:
--[no]allow_analysis_failures default: "false"
If true, an analysis failure of a rule target results in the target's propagation of an instance of AnalysisFailureInfo containing the error description, instead of resulting in a build failure.
Tags: loading_and_analysis, experimental
--analysis_testing_deps_limit=<an integer> default: "2000"
Sets the maximum number of transitive dependencies through a rule attribute with a for_analysis_testing configuration transition. Exceeding this limit will result in a rule error.
Tags: loading_and_analysis
--[no]break_build_on_parallel_dex2oat_failure default: "false"
If true dex2oat action failures will cause the build to break instead of executing dex2oat during test runtime.
Tags: loading_and_analysis, experimental
--[no]experimental_android_use_parallel_dex2oat default: "false"
Use dex2oat in parallel to possibly speed up android_test.
Tags: loading_and_analysis, host_machine_resource_optimizations, experimental
--[no]ios_memleaks default: "false"
Enable checking for memory leaks in ios_test targets.
Tags: action_command_lines
--ios_simulator_device=<a string> default: see description
The device to simulate when running an iOS application in the simulator, e.g. 'iPhone 6'. You can get a list of devices by running 'xcrun simctl list devicetypes' on the machine the simulator will be run on.
Tags: test_runner
--ios_simulator_version=<a dotted version (for example '2.3' or '3.3alpha2.4')> default: see description
The version of iOS to run on the simulator when running or testing. This is ignored for ios_test rules if a target device is specified in the rule.
Tags: test_runner
--runs_per_test=<a positive integer or test_regex@runs. This flag may be passed more than once> multiple uses are accumulated
Specifies number of times to run each test. If any of those attempts fail for any reason, the whole test is considered failed. Normally the value specified is just an integer. Example: --runs_per_test=3 will run all tests 3 times. Alternate syntax: regex_filter@runs_per_test. Where runs_per_test stands for an integer value and regex_filter stands for a list of include and exclude regular expression patterns (Also see --instrumentation_filter). Example: --runs_per_test=//foo/.*,-//foo/bar/.*@3 runs all tests in //foo/ except those under foo/bar three times. This option can be passed multiple times. The most recently passed argument that matches takes precedence. If nothing matches, the test is only run once.
--test_env=<a 'name=value' assignment with an optional value part> multiple uses are accumulated
Specifies additional environment variables to be injected into the test runner environment. Variables can be either specified by name, in which case its value will be read from the Bazel client environment, or by the name=value pair. This option can be used multiple times to specify several variables. Used only by the 'bazel test' command.
Tags: test_runner
--test_timeout=<a single integer or comma-separated list of 4 integers> default: "-1"
Override the default test timeout values for test timeouts (in secs). If a single positive integer value is specified it will override all categories. If 4 comma-separated integers are specified, they will override the timeouts for short, moderate, long and eternal (in that order). In either form, a value of -1 tells blaze to use its default timeouts for that category.
--[no]zip_undeclared_test_outputs default: "true"
If true, undeclared test outputs will be archived in a zip file.
Tags: test_runner
Options relating to query output and semantics:
--aspect_deps=<off, conservative or precise> default: "conservative"
How to resolve aspect dependencies when the output format is one of {xml,proto,record}. 'off' means no aspect dependencies are resolved, 'conservative' (the default) means all declared aspect dependencies are added regardless of whether they are given the rule class of direct dependencies, 'precise' means that only those aspects are added that are possibly active given the rule class of the direct dependencies. Note that precise mode requires loading other packages to evaluate a single target thus making it slower than the other modes. Also note that even precise mode is not completely precise: the decision whether to compute an aspect is decided in the analysis phase, which is not run during 'bazel query'.
Tags: build_file_semantics
--[no]consistent_labels default: "false"
If enabled, every query command emits labels as if by the Starlark <code>str</code> function applied to a <code>Label</code> instance. This is useful for tools that need to match the output of different query commands and/or labels emitted by rules. If not enabled, output formatters are free to emit apparent repository names (relative to the main repository) instead to make the output more readable.
Tags: terminal_output
--[no]graph:factored default: "true"
If true, then the graph will be emitted 'factored', i.e. topologically-equivalent nodes will be merged together and their labels concatenated. This option is only applicable to --output=graph.
Tags: terminal_output
--graph:node_limit=<an integer> default: "512"
The maximum length of the label string for a graph node in the output. Longer labels will be truncated; -1 means no truncation. This option is only applicable to --output=graph.
Tags: terminal_output
--[no]implicit_deps default: "true"
If enabled, implicit dependencies will be included in the dependency graph over which the query operates. An implicit dependency is one that is not explicitly specified in the BUILD file but added by bazel. For cquery, this option controls filtering resolved toolchains.
Tags: build_file_semantics
--[no]include_aspects default: "true"
aquery, cquery: whether to include aspect-generated actions in the output. query: no-op (aspects are always followed).
Tags: terminal_output
--[no]incompatible_package_group_includes_double_slash default: "true"
If enabled, when outputting package_group's `packages` attribute, the leading `//` will not be omitted.
Tags: terminal_output, incompatible_change
--[no]infer_universe_scope default: "false"
If set and --universe_scope is unset, then a value of --universe_scope will be inferred as the list of unique target patterns in the query expression. Note that the --universe_scope value inferred for a query expression that uses universe-scoped functions (e.g.`allrdeps`) may not be what you want, so you should use this option only if you know what you are doing. See https://bazel.build/reference/query#sky-query for details and examples. If --universe_scope is set, then this option's value is ignored. Note: this option applies only to `query` (i.e. not `cquery`).
Tags: loading_and_analysis
--[no]line_terminator_null default: "false"
Whether each format is terminated with \0 instead of newline.
Tags: terminal_output
--[no]nodep_deps default: "true"
If enabled, deps from "nodep" attributes will be included in the dependency graph over which the query operates. A common example of a "nodep" attribute is "visibility". Run and parse the output of `info build-language` to learn about all the "nodep" attributes in the build language.
Tags: build_file_semantics
--output=<a string> default: "label"
The format in which the cquery results should be printed. Allowed values for cquery are: label, label_kind, textproto, transitions, proto, streamed_proto, jsonproto. If you select 'transitions', you also have to specify the --transitions=(lite|full) option.
Tags: terminal_output
--[no]proto:default_values default: "true"
If true, attributes whose value is not explicitly specified in the BUILD file are included; otherwise they are omitted. This option is applicable to --output=proto
Tags: terminal_output
--[no]proto:definition_stack default: "false"
Populate the definition_stack proto field, which records for each rule instance the Starlark call stack at the moment the rule's class was defined.
Tags: terminal_output
--[no]proto:flatten_selects default: "true"
If enabled, configurable attributes created by select() are flattened. For list types the flattened representation is a list containing each value of the select map exactly once. Scalar types are flattened to null.
Tags: build_file_semantics
--[no]proto:include_attribute_source_aspects default: "false"
Populate the source_aspect_name proto field of each Attribute with the source aspect that the attribute came from (empty string if it did not).
Tags: terminal_output
--[no]proto:include_configurations default: "true"
if enabled, proto output will include information about configurations. When disabled,cquery proto output format resembles query output format.
Tags: affects_outputs
--[no]proto:include_synthetic_attribute_hash default: "false"
Whether or not to calculate and populate the $internal_attr_hash attribute.
Tags: terminal_output
--[no]proto:instantiation_stack default: "false"
Populate the instantiation call stack of each rule. Note that this requires the stack to be present
Tags: terminal_output
--[no]proto:locations default: "true"
Whether to output location information in proto output at all.
Tags: terminal_output
--proto:output_rule_attrs=<comma-separated list of options> default: "all"
Comma separated list of attributes to include in output. Defaults to all attributes. Set to empty string to not output any attribute. This option is applicable to --output=proto.
Tags: terminal_output
--[no]proto:rule_inputs_and_outputs default: "true"
Whether or not to populate the rule_input and rule_output fields.
Tags: terminal_output
--query_file=<a string> default: ""
If set, query will read the query from the file named here, rather than on the command line. It is an error to specify a file here as well as a command-line query.
Tags: changes_inputs
--[no]relative_locations default: "false"
If true, the location of BUILD files in xml and proto outputs will be relative. By default, the location output is an absolute path and will not be consistent across machines. You can set this option to true to have a consistent result across machines.
Tags: terminal_output
--show_config_fragments=<off, direct or transitive> default: "off"
Shows the configuration fragments required by a rule and its transitive dependencies. This can be useful for evaluating how much a configured target graph can be trimmed.
Tags: affects_outputs
--starlark:expr=<a string> default: ""
A Starlark expression to format each configured target in cquery's --output=starlark mode. The configured target is bound to 'target'. If neither --starlark:expr nor --starlark:file is specified, this option will default to 'str(target.label)'. It is an error to specify both --starlark:expr and --starlark:file.
Tags: terminal_output
--starlark:file=<a string> default: ""
The name of a file that defines a Starlark function called 'format', of one argument, that is applied to each configured target to format it as a string. It is an error to specify both --starlark:expr and --starlark:file. See help for --output=starlark for additional detail.
Tags: terminal_output
--[no]tool_deps default: "true"
Query: If disabled, dependencies on 'exec configuration' will not be included in the dependency graph over which the query operates. An 'exec configuration' dependency edge, such as the one from any 'proto_library' rule to the Protocol Compiler, usually points to a tool executed during the build rather than a part of the same 'target' program. Cquery: If disabled, filters out all configured targets which cross an execution transition from the top-level target that discovered this configured target. That means if the top-level target is in the target configuration, only configured targets also in the target configuration will be returned. If the top-level target is in the exec configuration, only exec configured targets will be returned. This option will NOT exclude resolved toolchains.
Tags: build_file_semantics
--transitions=<full, lite or none> default: "none"
The format in which cquery will print transition information.
Tags: affects_outputs
--universe_scope=<comma-separated list of options> default: ""
A comma-separated set of target patterns (additive and subtractive). The query may be performed in the universe defined by the transitive closure of the specified targets. This option is used for the query and cquery commands. For cquery, the input to this option is the targets all answers are built under and so this option may affect configurations and transitions. If this option is not specified, the top-level targets are assumed to be the targets parsed from the query expression. Note: For cquery, not specifying this option may cause the build to break if targets parsed from the query expression are not buildable with top-level options.
Tags: loading_and_analysis
Options that trigger optimizations of the build time:
--[no]experimental_filter_library_jar_with_program_jar default: "false"
Filter the ProGuard ProgramJar to remove any classes also present in the LibraryJar.
Tags: action_command_lines
--[no]experimental_inmemory_dotd_files default: "true"
If enabled, C++ .d files will be passed through in memory directly from the remote build nodes instead of being written to disk.
Tags: loading_and_analysis, execution, affects_outputs, experimental
--[no]experimental_inmemory_jdeps_files default: "true"
If enabled, the dependency (.jdeps) files generated from Java compilations will be passed through in memory directly from the remote build nodes instead of being written to disk.
Tags: loading_and_analysis, execution, affects_outputs, experimental
--[no]experimental_objc_include_scanning default: "false"
Whether to perform include scanning for objective C/C++.
Tags: loading_and_analysis, execution, changes_inputs
--[no]experimental_retain_test_configuration_across_testonly default: "false"
When enabled, --trim_test_configuration will not trim the test configuration for rules marked testonly=1. This is meant to reduce action conflict issues when non-test rules depend on cc_test rules. No effect if --trim_test_configuration is false.
Tags: loading_and_analysis, loses_incremental_state
--[no]experimental_starlark_cc_import default: "false"
If enabled, the Starlark version of cc_import can be used.
Tags: loading_and_analysis, experimental
--[no]experimental_unsupported_and_brittle_include_scanning default: "false"
Whether to narrow inputs to C/C++ compilation by parsing #include lines from input files. This can improve performance and incrementality by decreasing the size of compilation input trees. However, it can also break builds because the include scanner does not fully implement C preprocessor semantics. In particular, it does not understand dynamic #include directives and ignores preprocessor conditional logic. Use at your own risk. Any issues relating to this flag that are filed will be closed.
Tags: loading_and_analysis, execution, changes_inputs
--[no]incremental_dexing default: "true"
Does most of the work for dexing separately for each Jar file.
Tags: affects_outputs, loading_and_analysis, loses_incremental_state
--[no]objc_use_dotd_pruning default: "true"
If set, .d files emitted by clang will be used to prune the set of inputs passed into objc compiles.
Tags: changes_inputs, loading_and_analysis
--[no]process_headers_in_dependencies default: "false"
When building a target //a:a, process headers in all targets that //a:a depends on (if header processing is enabled for the toolchain).
Tags: execution
--[no]trim_test_configuration default: "true"
When enabled, test-related options will be cleared below the top level of the build. When this flag is active, tests cannot be built as dependencies of non-test rules, but changes to test-related options will not cause non-test rules to be re-analyzed.
Tags: loading_and_analysis, loses_incremental_state
Options that affect the verbosity, format or location of logging:
--toolchain_resolution_debug=<a comma-separated list of regex expressions with prefix '-' specifying excluded paths> default: "-.*"
Print debug information during toolchain resolution. The flag takes a regex, which is checked against toolchain types and specific targets to see which to debug. Multiple regexes may be separated by commas, and then each regex is checked separately. Note: The output of this flag is very complex and will likely only be useful to experts in toolchain resolution.
Tags: terminal_output
Options specifying or altering a generic input to a Bazel command that does not fall into other categories.:
--flag_alias=<a 'name=value' flag alias> multiple uses are accumulated
Sets a shorthand name for a Starlark flag. It takes a single key-value pair in the form "<key>=<value>" as an argument.
Tags: changes_inputs
--[no]incompatible_default_to_explicit_init_py default: "false"
This flag changes the default behavior so that __init__.py files are no longer automatically created in the runfiles of Python targets. Precisely, when a py_binary or py_test target has legacy_create_init set to "auto" (the default), it is treated as false if and only if this flag is set. See https://github.com/bazelbuild/bazel/issues/10076.
Tags: affects_outputs, incompatible_change
--[no]incompatible_py2_outputs_are_suffixed default: "true"
If true, targets built in the Python 2 configuration will appear under an output root that includes the suffix '-py2', while targets built for Python 3 will appear in a root with no Python-related suffix. This means that the `bazel-bin` convenience symlink will point to Python 3 targets rather than Python 2. If you enable this option it is also recommended to enable `--incompatible_py3_is_default`.
Tags: affects_outputs, incompatible_change
--[no]incompatible_py3_is_default default: "true"
If true, `py_binary` and `py_test` targets that do not set their `python_version` (or `default_python_version`) attribute will default to PY3 rather than to PY2. If you set this flag it is also recommended to set `--incompatible_py2_outputs_are_suffixed`.
Tags: loading_and_analysis, affects_outputs, incompatible_change
--[no]incompatible_use_python_toolchains default: "true"
If set to true, executable native Python rules will use the Python runtime specified by the Python toolchain, rather than the runtime given by legacy flags like --python_top.
Tags: loading_and_analysis, incompatible_change
--python_version=<PY2 or PY3> default: see description
The Python major version mode, either `PY2` or `PY3`. Note that this is overridden by `py_binary` and `py_test` targets (even if they don't explicitly specify a version) so there is usually not much reason to supply this flag.
Tags: loading_and_analysis, affects_outputs
Miscellaneous options, not otherwise categorized.:
--[no]cache_test_results [-t] default: "auto"
If set to 'auto', Bazel reruns a test if and only if: (1) Bazel detects changes in the test or its dependencies, (2) the test is marked as external, (3) multiple test runs were requested with --runs_per_test, or(4) the test previously failed. If set to 'yes', Bazel caches all test results except for tests marked as external. If set to 'no', Bazel does not cache any test results.
--[no]experimental_cancel_concurrent_tests default: "false"
If true, then Blaze will cancel concurrently running tests on the first successful run. This is only useful in combination with --runs_per_test_detects_flakes.
Tags: affects_outputs, loading_and_analysis
--[no]experimental_fetch_all_coverage_outputs default: "false"
If true, then Bazel fetches the entire coverage data directory for each test during a coverage run.
Tags: affects_outputs, loading_and_analysis
--[no]experimental_generate_llvm_lcov default: "false"
If true, coverage for clang will generate an LCOV report.
Tags: affects_outputs, loading_and_analysis
--[no]experimental_j2objc_header_map default: "true"
Whether to generate J2ObjC header map in parallel of J2ObjC transpilation.
--[no]experimental_j2objc_shorter_header_path default: "false"
Whether to generate with shorter header path (uses "_ios" instead of "_j2objc").
Tags: affects_outputs
--experimental_java_classpath=<off, javabuilder or bazel> default: "javabuilder"
Enables reduced classpaths for Java compilations.
--[no]experimental_limit_android_lint_to_android_constrained_java default: "false"
Limit --experimental_run_android_lint_on_java_rules to Android-compatible libraries.
Tags: affects_outputs
--[no]experimental_run_android_lint_on_java_rules default: "false"
Whether to validate java_* sources.
Tags: affects_outputs
--[no]explicit_java_test_deps default: "false"
Explicitly specify a dependency to JUnit or Hamcrest in a java_test instead of accidentally obtaining from the TestRunner's deps. Only works for bazel right now.
--host_java_launcher=<a build target label> default: see description
The Java launcher used by tools that are executed during a build.
--host_javacopt=<a string> multiple uses are accumulated
Additional options to pass to javac when building tools that are executed during a build.
--host_jvmopt=<a string> multiple uses are accumulated
Additional options to pass to the Java VM when building tools that are executed during the build. These options will get added to the VM startup options of each java_binary target.
--[no]incompatible_check_sharding_support default: "true"
If true, Bazel will fail a sharded test if the test runner does not indicate that it supports sharding by touching the file at the path in TEST_SHARD_STATUS_FILE. If false, a test runner that does not support sharding will lead to all tests running in each shard.
Tags: incompatible_change
--[no]incompatible_exclusive_test_sandboxed default: "true"
If true, exclusive tests will run with sandboxed strategy. Add 'local' tag to force an exclusive test run locally
Tags: incompatible_change
--[no]incompatible_strict_action_env default: "false"
If true, Bazel uses an environment with a static value for PATH and does not inherit LD_LIBRARY_PATH. Use --action_env=ENV_VARIABLE if you want to inherit specific environment variables from the client, but note that doing so can prevent cross-user caching if a shared cache is used.
Tags: loading_and_analysis, incompatible_change
--j2objc_translation_flags=<comma-separated list of options> multiple uses are accumulated
Additional options to pass to the J2ObjC tool.
--java_debug
Causes the Java virtual machine of a java test to wait for a connection from a JDWP-compliant debugger (such as jdb) before starting the test. Implies -test_output=streamed.
Expands to:
  --test_arg=--wrapper_script_flag=--debug
  --test_output=streamed
  --test_strategy=exclusive
  --test_timeout=9999
  --nocache_test_results
--[no]java_deps default: "true"
Generate dependency information (for now, compile-time classpath) per Java target.
--[no]java_header_compilation default: "true"
Compile ijars directly from source.
--java_language_version=<a string> default: ""
The Java language version
--java_launcher=<a build target label> default: see description
The Java launcher to use when building Java binaries. If this flag is set to the empty string, the JDK launcher is used. The "launcher" attribute overrides this flag.
--java_runtime_version=<a string> default: "local_jdk"
The Java runtime version
--javacopt=<a string> multiple uses are accumulated
Additional options to pass to javac.
--jvmopt=<a string> multiple uses are accumulated
Additional options to pass to the Java VM. These options will get added to the VM startup options of each java_binary target.
--legacy_main_dex_list_generator=<a build target label> default: see description
Specifies a binary to use to generate the list of classes that must be in the main dex when compiling legacy multidex.
--optimizing_dexer=<a build target label> default: see description
Specifies a binary to use to do dexing without sharding.
--plugin=<a build target label> multiple uses are accumulated
Plugins to use in the build. Currently works with java_plugin.
--proguard_top=<a build target label> default: see description
Specifies which version of ProGuard to use for code removal when building a Java binary.
--proto_compiler=<a build target label> default: "@bazel_tools//tools/proto:protoc"
The label of the proto-compiler.
Tags: affects_outputs, loading_and_analysis
--proto_toolchain_for_cc=<a build target label> default: "@bazel_tools//tools/proto:cc_toolchain"
Label of proto_lang_toolchain() which describes how to compile C++ protos
Tags: affects_outputs, loading_and_analysis
--proto_toolchain_for_j2objc=<a build target label> default: "@bazel_tools//tools/j2objc:j2objc_proto_toolchain"
Label of proto_lang_toolchain() which describes how to compile j2objc protos
Tags: affects_outputs, loading_and_analysis
--proto_toolchain_for_java=<a build target label> default: "@bazel_tools//tools/proto:java_toolchain"
Label of proto_lang_toolchain() which describes how to compile Java protos
Tags: affects_outputs, loading_and_analysis
--proto_toolchain_for_javalite=<a build target label> default: "@bazel_tools//tools/proto:javalite_toolchain"
Label of proto_lang_toolchain() which describes how to compile JavaLite protos
Tags: affects_outputs, loading_and_analysis
--protocopt=<a string> multiple uses are accumulated
Additional options to pass to the protobuf compiler.
Tags: affects_outputs
--[no]runs_per_test_detects_flakes default: "false"
If true, any shard in which at least one run/attempt passes and at least one run/attempt fails gets a FLAKY status.
--shell_executable=<a path> default: see description
Absolute path to the shell executable for Bazel to use. If this is unset, but the BAZEL_SH environment variable is set on the first Bazel invocation (that starts up a Bazel server), Bazel uses that. If neither is set, Bazel uses a hard-coded default path depending on the operating system it runs on (Windows: c:/tools/msys64/usr/bin/bash.exe, FreeBSD: /usr/local/bin/bash, all others: /bin/bash). Note that using a shell that is not compatible with bash may lead to build failures or runtime failures of the generated binaries.
Tags: loading_and_analysis
--test_arg=<a string> multiple uses are accumulated
Specifies additional options and arguments that should be passed to the test executable. Can be used multiple times to specify several arguments. If multiple tests are executed, each of them will receive identical arguments. Used only by the 'bazel test' command.
--test_filter=<a string> default: see description
Specifies a filter to forward to the test framework. Used to limit the tests run. Note that this does not affect which targets are built.
--test_result_expiration=<an integer> default: "-1"
This option is deprecated and has no effect.
--[no]test_runner_fail_fast default: "false"
Forwards fail fast option to the test runner. The test runner should stop execution upon first failure.
--test_sharding_strategy=<explicit, disabled or forced=k where k is the number of shards to enforce> default: "explicit"
Specify strategy for test sharding: 'explicit' to only use sharding if the 'shard_count' BUILD attribute is present. 'disabled' to never use test sharding. 'forced=k' to enforce 'k' shards for testing regardless of the 'shard_count' BUILD attribute.
--tool_java_language_version=<a string> default: ""
The Java language version used to execute the tools that are needed during a build
--tool_java_runtime_version=<a string> default: "remotejdk_11"
The Java runtime version used to execute tools during the build
--[no]use_ijars default: "true"
If enabled, this option causes Java compilation to use interface jars. This will result in faster incremental compilation, but error messages can be different.

Dump Options

Options that appear before the command and are parsed by the client:
--distdir=<a path> multiple uses are accumulated
Additional places to search for archives before accessing the network to download them.
Tags: bazel_internal_configuration
If set, the repository cache will hardlink the file in case of a cache hit, rather than copying. This is intended to save disk space.
Tags: bazel_internal_configuration
--experimental_repository_downloader_retries=<an integer> default: "0"
The maximum number of attempts to retry a download error. If set to 0, retries are disabled.
Tags: experimental
--experimental_scale_timeouts=<a double> default: "1.0"
Scale all timeouts in Starlark repository rules by this factor. In this way, external repositories can be made working on machines that are slower than the rule author expected, without changing the source code
Tags: bazel_internal_configuration, experimental
--http_connector_attempts=<an integer> default: "8"
The maximum number of attempts for http downloads.
Tags: bazel_internal_configuration
--http_connector_retry_max_timeout=<An immutable length of time.> default: "0s"
The maximum timeout for http download retries. With a value of 0, no timeout maximum is defined.
Tags: bazel_internal_configuration
--http_timeout_scaling=<a double> default: "1.0"
Scale all timeouts related to http downloads by the given factor
Tags: bazel_internal_configuration
--repository_cache=<a path> default: see description
Specifies the cache location of the downloaded values obtained during the fetching of external repositories. An empty string as argument requests the cache to be disabled, otherwise the default of '<output_user_root>/cache/repos/v1' is used
Tags: bazel_internal_configuration
--[no]repository_disable_download default: "false"
If set, downloading using ctx.download{,_and_extract} is not allowed during repository fetching. Note that network access is not completely disabled; ctx.execute could still run an arbitrary executable that accesses the Internet.
Tags: bazel_internal_configuration
Options that control build execution:
--gc_thrashing_threshold=<an integer in 0-100 range> default: "100"
The percent of tenured space occupied (0-100) above which GcThrashingDetector considers memory pressure events against its limits (--gc_thrashing_limits). If set to 100, GcThrashingDetector is disabled.
Tags: host_machine_resource_optimizations
Options that control the output of the command:
--[no]action_cache default: "false"
Dump action cache content.
Tags: bazel_monitoring
--[no]packages default: "false"
Dump package cache content.
Tags: bazel_monitoring
--[no]rule_classes default: "false"
Dump rule classes.
Tags: bazel_monitoring
--[no]rules default: "false"
Dump rules, including counts and memory usage (if memory is tracked).
Tags: bazel_monitoring
--skyframe=<off, summary, count, deps or rdeps> default: "off"
Dump Skyframe graph: 'off', 'summary', 'count', 'deps', or 'rdeps'.
Tags: bazel_monitoring
--skykey_filter=<a comma-separated list of regex expressions with prefix '-' specifying excluded paths> default: ".*"
Regex filter of SkyKey names to output. Only used with --skyframe=deps, rdeps.
Tags: bazel_monitoring
--skylark_memory=<a string> default: see description
Dumps a pprof-compatible memory profile to the specified path. To learn more please see https://github.com/google/pprof.
Tags: bazel_monitoring
This option affects semantics of the Starlark language or the build API accessible to BUILD files, .bzl files, or WORKSPACE files.:
--[no]incompatible_depset_for_java_output_source_jars default: "true"
No-op.
Tags: loading_and_analysis, incompatible_change
--[no]incompatible_new_actions_api default: "true"
No-op
Tags: no_op, incompatible_change
Options relating to Bzlmod output and semantics:
--allow_yanked_versions=<a string> multiple uses are accumulated
Specified the module versions in the form of `<module1>@<version1>,<module2>@<version2>` that will be allowed in the resolved dependency graph even if they are declared yanked in the registry where they come from (if they are not coming from a NonRegistryOverride). Otherwise, yanked versions will cause the resolution to fail. You can also define allowed yanked version with the `BZLMOD_ALLOW_YANKED_VERSIONS` environment variable. You can disable this check by using the keyword 'all' (not recommended).
Tags: loading_and_analysis
--check_bazel_compatibility=<error, warning or off> default: "error"
Check bazel version compatibility of Bazel modules. Valid values are `error` to escalate it to a resolution failure, `off` to disable the check, or `warning` to print a warning when mismatch detected.
Tags: loading_and_analysis
--check_direct_dependencies=<off, warning or error> default: "warning"
Check if the direct `bazel_dep` dependencies declared in the root module are the same versions you get in the resolved dependency graph. Valid values are `off` to disable the check, `warning` to print a warning when mismatch detected or `error` to escalate it to a resolution failure.
Tags: loading_and_analysis
--[no]ignore_dev_dependency default: "false"
If true, Bazel ignores `bazel_dep` and `use_extension` declared as `dev_dependency` in the MODULE.bazel of the root module. Note that, those dev dependencies are always ignored in the MODULE.bazel if it's not the root module regardless of the value of this flag.
Tags: loading_and_analysis
--lockfile_mode=<off, update or error> default: "update"
Specifies how and whether or not to use the lockfile. Valid values are `update` to use the lockfile and update it if there are changes, `error` to use the lockfile but throw an error if it's not up-to-date, or `off` to neither read from or write to the lockfile.
Tags: loading_and_analysis
--override_module=<an equals-separated mapping of module name to path> multiple uses are accumulated
Override a module with a local path in the form of <module name>=<path>. If the given path is an absolute path, it will be used as it is. If the given path is a relative path, it is relative to the current working directory. If the given path starts with '%workspace%, it is relative to the workspace root, which is the output of `bazel info workspace`
--registry=<a string> multiple uses are accumulated
Specifies the registries to use to locate Bazel module dependencies. The order is important: modules will be looked up in earlier registries first, and only fall back to later registries when they're missing from the earlier ones.
Tags: changes_inputs
Options that trigger optimizations of the build time:
--gc_thrashing_limits=<comma separated pairs of <period>:<count>> default: "1s:2,20s:3,1m:5"
Limits which, if reached, cause GcThrashingDetector to crash Bazel with an OOM. Each limit is specified as <period>:<count> where period is a duration and count is a positive integer. If more than --gc_thrashing_threshold percent of tenured space (old gen heap) remains occupied after <count> consecutive full GCs within <period>, an OOM is triggered. Multiple limits can be specified separated by commas.
Tags: host_machine_resource_optimizations
--skyframe_high_water_mark_full_gc_drops_per_invocation=<an integer, >= 0> default: "2147483647"
Flag for advanced configuration of Bazel's internal Skyframe engine. If Bazel detects its retained heap percentage usage exceeds the threshold set by --skyframe_high_water_mark_threshold, when a full GC event occurs, it will drop unnecessary temporary Skyframe state, up to this many times per invocation. Defaults to Integer.MAX_VALUE; effectively unlimited. Zero means that full GC events will never trigger drops. If the limit is reached, Skyframe state will no longer be dropped when a full GC event occurs and that retained heap percentage threshold is exceeded.
Tags: host_machine_resource_optimizations
--skyframe_high_water_mark_minor_gc_drops_per_invocation=<an integer, >= 0> default: "2147483647"
Flag for advanced configuration of Bazel's internal Skyframe engine. If Bazel detects its retained heap percentage usage exceeds the threshold set by --skyframe_high_water_mark_threshold, when a minor GC event occurs, it will drop unnecessary temporary Skyframe state, up to this many times per invocation. Defaults to Integer.MAX_VALUE; effectively unlimited. Zero means that minor GC events will never trigger drops. If the limit is reached, Skyframe state will no longer be dropped when a minor GC event occurs and that retained heap percentage threshold is exceeded.
Tags: host_machine_resource_optimizations
--skyframe_high_water_mark_threshold=<an integer> default: "85"
Flag for advanced configuration of Bazel's internal Skyframe engine. If Bazel detects its retained heap percentage usage is at least this threshold, it will drop unnecessary temporary Skyframe state. Tweaking this may let you mitigate wall time impact of GC thrashing, when the GC thrashing is (i) caused by the memory usage of this temporary state and (ii) more costly than reconstituting the state when it is needed.
Tags: host_machine_resource_optimizations
Options that affect the verbosity, format or location of logging:
--[no]experimental_command_profile default: "false"
Records a Java Flight Recorder CPU profile into a profile.jfr file in the output base directory. The syntax and semantics of this flag might change in the future to support different profile types or output formats; use at your own risk.
--[no]experimental_record_metrics_for_all_mnemonics default: "false"
By default the number of action types is limited to the 20 mnemonics with the largest number of executed actions. Setting this option will write statistics for all mnemonics.
Options specifying or altering a generic input to a Bazel command that does not fall into other categories.:
--experimental_resolved_file_instead_of_workspace=<a string> default: ""
If non-empty read the specified resolved file instead of the WORKSPACE file
Tags: changes_inputs
Remote caching and execution options:
--experimental_downloader_config=<a string> default: see description
Specify a file to configure the remote downloader with. This file consists of lines, each of which starts with a directive (`allow`, `block` or `rewrite`) followed by either a host name (for `allow` and `block`) or two patterns, one to match against, and one to use as a substitute URL, with back-references starting from `$1`. It is possible for multiple `rewrite` directives for the same URL to be give, and in this case multiple URLs will be returned.
--experimental_worker_for_repo_fetching=<off, platform or virtual> default: "off"
The threading mode to use for repo fetching. If set to 'off', no worker thread is used, and the repo fetching is subject to restarts. Otherwise, uses a platform thread (i.e. OS thread) if set to 'platform' or a virtual thread if set to 'virtual'.
Miscellaneous options, not otherwise categorized.:
--override_repository=<an equals-separated mapping of repository name to path> multiple uses are accumulated
Override a repository with a local path in the form of <repository name>=<path>. If the given path is an absolute path, it will be used as it is. If the given path is a relative path, it is relative to the current working directory. If the given path starts with '%workspace%, it is relative to the workspace root, which is the output of `bazel info workspace`

Fetch Options

Options that appear before the command and are parsed by the client:
--distdir=<a path> multiple uses are accumulated
Additional places to search for archives before accessing the network to download them.
Tags: bazel_internal_configuration
If set, the repository cache will hardlink the file in case of a cache hit, rather than copying. This is intended to save disk space.
Tags: bazel_internal_configuration
--experimental_repository_downloader_retries=<an integer> default: "0"
The maximum number of attempts to retry a download error. If set to 0, retries are disabled.
Tags: experimental
--experimental_scale_timeouts=<a double> default: "1.0"
Scale all timeouts in Starlark repository rules by this factor. In this way, external repositories can be made working on machines that are slower than the rule author expected, without changing the source code
Tags: bazel_internal_configuration, experimental
--http_connector_attempts=<an integer> default: "8"
The maximum number of attempts for http downloads.
Tags: bazel_internal_configuration
--http_connector_retry_max_timeout=<An immutable length of time.> default: "0s"
The maximum timeout for http download retries. With a value of 0, no timeout maximum is defined.
Tags: bazel_internal_configuration
--http_timeout_scaling=<a double> default: "1.0"
Scale all timeouts related to http downloads by the given factor
Tags: bazel_internal_configuration
--repository_cache=<a path> default: see description
Specifies the cache location of the downloaded values obtained during the fetching of external repositories. An empty string as argument requests the cache to be disabled, otherwise the default of '<output_user_root>/cache/repos/v1' is used
Tags: bazel_internal_configuration
--[no]repository_disable_download default: "false"
If set, downloading using ctx.download{,_and_extract} is not allowed during repository fetching. Note that network access is not completely disabled; ctx.execute could still run an arbitrary executable that accesses the Internet.
Tags: bazel_internal_configuration
Options that control build execution:
--[no]all default: "false"
Fetches all external repositories necessary for building any target or repository. Only works when --enable_bzlmod is on.
Tags: changes_inputs
--[no]configure default: "false"
Only fetches repositories marked as 'configure' for system-configuration purpose. Only works when --enable_bzlmod is on.
Tags: changes_inputs
--[no]force default: "false"
Ignore existing repository if any and force fetch the repository again. Only works when --enable_bzlmod is on.
Tags: changes_inputs
--gc_thrashing_threshold=<an integer in 0-100 range> default: "100"
The percent of tenured space occupied (0-100) above which GcThrashingDetector considers memory pressure events against its limits (--gc_thrashing_limits). If set to 100, GcThrashingDetector is disabled.
Tags: host_machine_resource_optimizations
--[no]keep_going [-k] default: "false"
Continue as much as possible after an error. While the target that failed and those that depend on it cannot be analyzed, other prerequisites of these targets can be.
Tags: eagerness_to_exit
--loading_phase_threads=<an integer, or a keyword ("auto", "HOST_CPUS", "HOST_RAM"), optionally followed by an operation ([-|*]<float>) eg. "auto", "HOST_CPUS*.5"> default: "auto"
Number of parallel threads to use for the loading/analysis phase.Takes an integer, or a keyword ("auto", "HOST_CPUS", "HOST_RAM"), optionally followed by an operation ([-|*]<float>) eg. "auto", "HOST_CPUS*.5". "auto" sets a reasonable default based on host resources. Must be at least 1.
Tags: bazel_internal_configuration
--repo=<a string> multiple uses are accumulated
Only fetches the specified repository, which can be either {@apparent_repo_name} or {@@canonical_repo_name}. Only works when --enable_bzlmod is on.
Tags: changes_inputs
This option affects semantics of the Starlark language or the build API accessible to BUILD files, .bzl files, or WORKSPACE files.:
--[no]incompatible_config_setting_private_default_visibility default: "false"
If incompatible_enforce_config_setting_visibility=false, this is a noop. Else, if this flag is false, any config_setting without an explicit visibility attribute is //visibility:public. If this flag is true, config_setting follows the same visibility logic as all other rules. See https://github.com/bazelbuild/bazel/issues/12933.
Tags: loading_and_analysis, incompatible_change
--[no]incompatible_depset_for_java_output_source_jars default: "true"
No-op.
Tags: loading_and_analysis, incompatible_change
--[no]incompatible_enforce_config_setting_visibility default: "true"
If true, enforce config_setting visibility restrictions. If false, every config_setting is visible to every target. See https://github.com/bazelbuild/bazel/issues/12932.
Tags: loading_and_analysis, incompatible_change
--[no]incompatible_new_actions_api default: "true"
No-op
Tags: no_op, incompatible_change
Options relating to Bzlmod output and semantics:
--allow_yanked_versions=<a string> multiple uses are accumulated
Specified the module versions in the form of `<module1>@<version1>,<module2>@<version2>` that will be allowed in the resolved dependency graph even if they are declared yanked in the registry where they come from (if they are not coming from a NonRegistryOverride). Otherwise, yanked versions will cause the resolution to fail. You can also define allowed yanked version with the `BZLMOD_ALLOW_YANKED_VERSIONS` environment variable. You can disable this check by using the keyword 'all' (not recommended).
Tags: loading_and_analysis
--check_bazel_compatibility=<error, warning or off> default: "error"
Check bazel version compatibility of Bazel modules. Valid values are `error` to escalate it to a resolution failure, `off` to disable the check, or `warning` to print a warning when mismatch detected.
Tags: loading_and_analysis
--check_direct_dependencies=<off, warning or error> default: "warning"
Check if the direct `bazel_dep` dependencies declared in the root module are the same versions you get in the resolved dependency graph. Valid values are `off` to disable the check, `warning` to print a warning when mismatch detected or `error` to escalate it to a resolution failure.
Tags: loading_and_analysis
--[no]ignore_dev_dependency default: "false"
If true, Bazel ignores `bazel_dep` and `use_extension` declared as `dev_dependency` in the MODULE.bazel of the root module. Note that, those dev dependencies are always ignored in the MODULE.bazel if it's not the root module regardless of the value of this flag.
Tags: loading_and_analysis
--lockfile_mode=<off, update or error> default: "update"
Specifies how and whether or not to use the lockfile. Valid values are `update` to use the lockfile and update it if there are changes, `error` to use the lockfile but throw an error if it's not up-to-date, or `off` to neither read from or write to the lockfile.
Tags: loading_and_analysis
--override_module=<an equals-separated mapping of module name to path> multiple uses are accumulated
Override a module with a local path in the form of <module name>=<path>. If the given path is an absolute path, it will be used as it is. If the given path is a relative path, it is relative to the current working directory. If the given path starts with '%workspace%, it is relative to the workspace root, which is the output of `bazel info workspace`
--registry=<a string> multiple uses are accumulated
Specifies the registries to use to locate Bazel module dependencies. The order is important: modules will be looked up in earlier registries first, and only fall back to later registries when they're missing from the earlier ones.
Tags: changes_inputs
Options that trigger optimizations of the build time:
--gc_thrashing_limits=<comma separated pairs of <period>:<count>> default: "1s:2,20s:3,1m:5"
Limits which, if reached, cause GcThrashingDetector to crash Bazel with an OOM. Each limit is specified as <period>:<count> where period is a duration and count is a positive integer. If more than --gc_thrashing_threshold percent of tenured space (old gen heap) remains occupied after <count> consecutive full GCs within <period>, an OOM is triggered. Multiple limits can be specified separated by commas.
Tags: host_machine_resource_optimizations
--skyframe_high_water_mark_full_gc_drops_per_invocation=<an integer, >= 0> default: "2147483647"
Flag for advanced configuration of Bazel's internal Skyframe engine. If Bazel detects its retained heap percentage usage exceeds the threshold set by --skyframe_high_water_mark_threshold, when a full GC event occurs, it will drop unnecessary temporary Skyframe state, up to this many times per invocation. Defaults to Integer.MAX_VALUE; effectively unlimited. Zero means that full GC events will never trigger drops. If the limit is reached, Skyframe state will no longer be dropped when a full GC event occurs and that retained heap percentage threshold is exceeded.
Tags: host_machine_resource_optimizations
--skyframe_high_water_mark_minor_gc_drops_per_invocation=<an integer, >= 0> default: "2147483647"
Flag for advanced configuration of Bazel's internal Skyframe engine. If Bazel detects its retained heap percentage usage exceeds the threshold set by --skyframe_high_water_mark_threshold, when a minor GC event occurs, it will drop unnecessary temporary Skyframe state, up to this many times per invocation. Defaults to Integer.MAX_VALUE; effectively unlimited. Zero means that minor GC events will never trigger drops. If the limit is reached, Skyframe state will no longer be dropped when a minor GC event occurs and that retained heap percentage threshold is exceeded.
Tags: host_machine_resource_optimizations
--skyframe_high_water_mark_threshold=<an integer> default: "85"
Flag for advanced configuration of Bazel's internal Skyframe engine. If Bazel detects its retained heap percentage usage is at least this threshold, it will drop unnecessary temporary Skyframe state. Tweaking this may let you mitigate wall time impact of GC thrashing, when the GC thrashing is (i) caused by the memory usage of this temporary state and (ii) more costly than reconstituting the state when it is needed.
Tags: host_machine_resource_optimizations
Options that affect the verbosity, format or location of logging:
--[no]experimental_command_profile default: "false"
Records a Java Flight Recorder CPU profile into a profile.jfr file in the output base directory. The syntax and semantics of this flag might change in the future to support different profile types or output formats; use at your own risk.
--[no]experimental_record_metrics_for_all_mnemonics default: "false"
By default the number of action types is limited to the 20 mnemonics with the largest number of executed actions. Setting this option will write statistics for all mnemonics.
--experimental_repository_resolved_file=<a string> default: ""
If non-empty, write a Starlark value with the resolved information of all Starlark repository rules that were executed.
Tags: affects_outputs
Options specifying or altering a generic input to a Bazel command that does not fall into other categories.:
--experimental_resolved_file_instead_of_workspace=<a string> default: ""
If non-empty read the specified resolved file instead of the WORKSPACE file
Tags: changes_inputs
Remote caching and execution options:
--experimental_downloader_config=<a string> default: see description
Specify a file to configure the remote downloader with. This file consists of lines, each of which starts with a directive (`allow`, `block` or `rewrite`) followed by either a host name (for `allow` and `block`) or two patterns, one to match against, and one to use as a substitute URL, with back-references starting from `$1`. It is possible for multiple `rewrite` directives for the same URL to be give, and in this case multiple URLs will be returned.
--experimental_worker_for_repo_fetching=<off, platform or virtual> default: "off"
The threading mode to use for repo fetching. If set to 'off', no worker thread is used, and the repo fetching is subject to restarts. Otherwise, uses a platform thread (i.e. OS thread) if set to 'platform' or a virtual thread if set to 'virtual'.
Miscellaneous options, not otherwise categorized.:
--deleted_packages=<comma-separated list of package names> multiple uses are accumulated
A comma-separated list of names of packages which the build system will consider non-existent, even if they are visible somewhere on the package path. Use this option when deleting a subpackage 'x/y' of an existing package 'x'. For example, after deleting x/y/BUILD in your client, the build system may complain if it encounters a label '//x:y/z' if that is still provided by another package_path entry. Specifying --deleted_packages x/y avoids this problem.
--override_repository=<an equals-separated mapping of repository name to path> multiple uses are accumulated
Override a repository with a local path in the form of <repository name>=<path>. If the given path is an absolute path, it will be used as it is. If the given path is a relative path, it is relative to the current working directory. If the given path starts with '%workspace%, it is relative to the workspace root, which is the output of `bazel info workspace`
--package_path=<colon-separated list of options> default: "%workspace%"
A colon-separated list of where to look for packages. Elements beginning with '%workspace%' are relative to the enclosing workspace. If omitted or empty, the default is the output of 'bazel info default-package-path'.
--[no]show_loading_progress default: "true"
If enabled, causes Bazel to print "Loading package:" messages.

Help Options

Options that appear before the command and are parsed by the client:
--distdir=<a path> multiple uses are accumulated
Additional places to search for archives before accessing the network to download them.
Tags: bazel_internal_configuration
If set, the repository cache will hardlink the file in case of a cache hit, rather than copying. This is intended to save disk space.
Tags: bazel_internal_configuration
--experimental_repository_downloader_retries=<an integer> default: "0"
The maximum number of attempts to retry a download error. If set to 0, retries are disabled.
Tags: experimental
--experimental_scale_timeouts=<a double> default: "1.0"
Scale all timeouts in Starlark repository rules by this factor. In this way, external repositories can be made working on machines that are slower than the rule author expected, without changing the source code
Tags: bazel_internal_configuration, experimental
--http_connector_attempts=<an integer> default: "8"
The maximum number of attempts for http downloads.
Tags: bazel_internal_configuration
--http_connector_retry_max_timeout=<An immutable length of time.> default: "0s"
The maximum timeout for http download retries. With a value of 0, no timeout maximum is defined.
Tags: bazel_internal_configuration
--http_timeout_scaling=<a double> default: "1.0"
Scale all timeouts related to http downloads by the given factor
Tags: bazel_internal_configuration
--repository_cache=<a path> default: see description
Specifies the cache location of the downloaded values obtained during the fetching of external repositories. An empty string as argument requests the cache to be disabled, otherwise the default of '<output_user_root>/cache/repos/v1' is used
Tags: bazel_internal_configuration
--[no]repository_disable_download default: "false"
If set, downloading using ctx.download{,_and_extract} is not allowed during repository fetching. Note that network access is not completely disabled; ctx.execute could still run an arbitrary executable that accesses the Internet.
Tags: bazel_internal_configuration
Options that control build execution:
--gc_thrashing_threshold=<an integer in 0-100 range> default: "100"
The percent of tenured space occupied (0-100) above which GcThrashingDetector considers memory pressure events against its limits (--gc_thrashing_limits). If set to 100, GcThrashingDetector is disabled.
Tags: host_machine_resource_optimizations
This option affects semantics of the Starlark language or the build API accessible to BUILD files, .bzl files, or WORKSPACE files.:
--[no]incompatible_depset_for_java_output_source_jars default: "true"
No-op.
Tags: loading_and_analysis, incompatible_change
--[no]incompatible_new_actions_api default: "true"
No-op
Tags: no_op, incompatible_change
Options relating to Bzlmod output and semantics:
--allow_yanked_versions=<a string> multiple uses are accumulated
Specified the module versions in the form of `<module1>@<version1>,<module2>@<version2>` that will be allowed in the resolved dependency graph even if they are declared yanked in the registry where they come from (if they are not coming from a NonRegistryOverride). Otherwise, yanked versions will cause the resolution to fail. You can also define allowed yanked version with the `BZLMOD_ALLOW_YANKED_VERSIONS` environment variable. You can disable this check by using the keyword 'all' (not recommended).
Tags: loading_and_analysis
--check_bazel_compatibility=<error, warning or off> default: "error"
Check bazel version compatibility of Bazel modules. Valid values are `error` to escalate it to a resolution failure, `off` to disable the check, or `warning` to print a warning when mismatch detected.
Tags: loading_and_analysis
--check_direct_dependencies=<off, warning or error> default: "warning"
Check if the direct `bazel_dep` dependencies declared in the root module are the same versions you get in the resolved dependency graph. Valid values are `off` to disable the check, `warning` to print a warning when mismatch detected or `error` to escalate it to a resolution failure.
Tags: loading_and_analysis
--[no]ignore_dev_dependency default: "false"
If true, Bazel ignores `bazel_dep` and `use_extension` declared as `dev_dependency` in the MODULE.bazel of the root module. Note that, those dev dependencies are always ignored in the MODULE.bazel if it's not the root module regardless of the value of this flag.
Tags: loading_and_analysis
--lockfile_mode=<off, update or error> default: "update"
Specifies how and whether or not to use the lockfile. Valid values are `update` to use the lockfile and update it if there are changes, `error` to use the lockfile but throw an error if it's not up-to-date, or `off` to neither read from or write to the lockfile.
Tags: loading_and_analysis
--override_module=<an equals-separated mapping of module name to path> multiple uses are accumulated
Override a module with a local path in the form of <module name>=<path>. If the given path is an absolute path, it will be used as it is. If the given path is a relative path, it is relative to the current working directory. If the given path starts with '%workspace%, it is relative to the workspace root, which is the output of `bazel info workspace`
--registry=<a string> multiple uses are accumulated
Specifies the registries to use to locate Bazel module dependencies. The order is important: modules will be looked up in earlier registries first, and only fall back to later registries when they're missing from the earlier ones.
Tags: changes_inputs
Options that trigger optimizations of the build time:
--gc_thrashing_limits=<comma separated pairs of <period>:<count>> default: "1s:2,20s:3,1m:5"
Limits which, if reached, cause GcThrashingDetector to crash Bazel with an OOM. Each limit is specified as <period>:<count> where period is a duration and count is a positive integer. If more than --gc_thrashing_threshold percent of tenured space (old gen heap) remains occupied after <count> consecutive full GCs within <period>, an OOM is triggered. Multiple limits can be specified separated by commas.
Tags: host_machine_resource_optimizations
--skyframe_high_water_mark_full_gc_drops_per_invocation=<an integer, >= 0> default: "2147483647"
Flag for advanced configuration of Bazel's internal Skyframe engine. If Bazel detects its retained heap percentage usage exceeds the threshold set by --skyframe_high_water_mark_threshold, when a full GC event occurs, it will drop unnecessary temporary Skyframe state, up to this many times per invocation. Defaults to Integer.MAX_VALUE; effectively unlimited. Zero means that full GC events will never trigger drops. If the limit is reached, Skyframe state will no longer be dropped when a full GC event occurs and that retained heap percentage threshold is exceeded.
Tags: host_machine_resource_optimizations
--skyframe_high_water_mark_minor_gc_drops_per_invocation=<an integer, >= 0> default: "2147483647"
Flag for advanced configuration of Bazel's internal Skyframe engine. If Bazel detects its retained heap percentage usage exceeds the threshold set by --skyframe_high_water_mark_threshold, when a minor GC event occurs, it will drop unnecessary temporary Skyframe state, up to this many times per invocation. Defaults to Integer.MAX_VALUE; effectively unlimited. Zero means that minor GC events will never trigger drops. If the limit is reached, Skyframe state will no longer be dropped when a minor GC event occurs and that retained heap percentage threshold is exceeded.
Tags: host_machine_resource_optimizations
--skyframe_high_water_mark_threshold=<an integer> default: "85"
Flag for advanced configuration of Bazel's internal Skyframe engine. If Bazel detects its retained heap percentage usage is at least this threshold, it will drop unnecessary temporary Skyframe state. Tweaking this may let you mitigate wall time impact of GC thrashing, when the GC thrashing is (i) caused by the memory usage of this temporary state and (ii) more costly than reconstituting the state when it is needed.
Tags: host_machine_resource_optimizations
Options that affect the verbosity, format or location of logging:
--[no]experimental_command_profile default: "false"
Records a Java Flight Recorder CPU profile into a profile.jfr file in the output base directory. The syntax and semantics of this flag might change in the future to support different profile types or output formats; use at your own risk.
--[no]experimental_record_metrics_for_all_mnemonics default: "false"
By default the number of action types is limited to the 20 mnemonics with the largest number of executed actions. Setting this option will write statistics for all mnemonics.
--help_verbosity=<long, medium or short> default: "medium"
Select the verbosity of the help command.
Tags: affects_outputs, terminal_output
--long [-l]
Show full description of each option, instead of just its name.
Expands to:
  --help_verbosity=long

Tags: affects_outputs, terminal_output
--short
Show only the names of the options, not their types or meanings.
Expands to:
  --help_verbosity=short

Tags: affects_outputs, terminal_output
Options specifying or altering a generic input to a Bazel command that does not fall into other categories.:
--experimental_resolved_file_instead_of_workspace=<a string> default: ""
If non-empty read the specified resolved file instead of the WORKSPACE file
Tags: changes_inputs
Remote caching and execution options:
--experimental_downloader_config=<a string> default: see description
Specify a file to configure the remote downloader with. This file consists of lines, each of which starts with a directive (`allow`, `block` or `rewrite`) followed by either a host name (for `allow` and `block`) or two patterns, one to match against, and one to use as a substitute URL, with back-references starting from `$1`. It is possible for multiple `rewrite` directives for the same URL to be give, and in this case multiple URLs will be returned.
--experimental_worker_for_repo_fetching=<off, platform or virtual> default: "off"
The threading mode to use for repo fetching. If set to 'off', no worker thread is used, and the repo fetching is subject to restarts. Otherwise, uses a platform thread (i.e. OS thread) if set to 'platform' or a virtual thread if set to 'virtual'.
Miscellaneous options, not otherwise categorized.:
--override_repository=<an equals-separated mapping of repository name to path> multiple uses are accumulated
Override a repository with a local path in the form of <repository name>=<path>. If the given path is an absolute path, it will be used as it is. If the given path is a relative path, it is relative to the current working directory. If the given path starts with '%workspace%, it is relative to the workspace root, which is the output of `bazel info workspace`

Info Options

Inherits all options from build.

Options that appear before the command and are parsed by the client:
--distdir=<a path> multiple uses are accumulated
Additional places to search for archives before accessing the network to download them.
Tags: bazel_internal_configuration
If set, the repository cache will hardlink the file in case of a cache hit, rather than copying. This is intended to save disk space.
Tags: bazel_internal_configuration
--experimental_repository_downloader_retries=<an integer> default: "0"
The maximum number of attempts to retry a download error. If set to 0, retries are disabled.
Tags: experimental
--experimental_scale_timeouts=<a double> default: "1.0"
Scale all timeouts in Starlark repository rules by this factor. In this way, external repositories can be made working on machines that are slower than the rule author expected, without changing the source code
Tags: bazel_internal_configuration, experimental
--http_connector_attempts=<an integer> default: "8"
The maximum number of attempts for http downloads.
Tags: bazel_internal_configuration
--http_connector_retry_max_timeout=<An immutable length of time.> default: "0s"
The maximum timeout for http download retries. With a value of 0, no timeout maximum is defined.
Tags: bazel_internal_configuration
--http_timeout_scaling=<a double> default: "1.0"
Scale all timeouts related to http downloads by the given factor
Tags: bazel_internal_configuration
--repository_cache=<a path> default: see description
Specifies the cache location of the downloaded values obtained during the fetching of external repositories. An empty string as argument requests the cache to be disabled, otherwise the default of '<output_user_root>/cache/repos/v1' is used
Tags: bazel_internal_configuration
--[no]repository_disable_download default: "false"
If set, downloading using ctx.download{,_and_extract} is not allowed during repository fetching. Note that network access is not completely disabled; ctx.execute could still run an arbitrary executable that accesses the Internet.
Tags: bazel_internal_configuration
Options that control build execution:
--gc_thrashing_threshold=<an integer in 0-100 range> default: "100"
The percent of tenured space occupied (0-100) above which GcThrashingDetector considers memory pressure events against its limits (--gc_thrashing_limits). If set to 100, GcThrashingDetector is disabled.
Tags: host_machine_resource_optimizations
This option affects semantics of the Starlark language or the build API accessible to BUILD files, .bzl files, or WORKSPACE files.:
--[no]incompatible_depset_for_java_output_source_jars default: "true"
No-op.
Tags: loading_and_analysis, incompatible_change
--[no]incompatible_new_actions_api default: "true"
No-op
Tags: no_op, incompatible_change
Options relating to Bzlmod output and semantics:
--allow_yanked_versions=<a string> multiple uses are accumulated
Specified the module versions in the form of `<module1>@<version1>,<module2>@<version2>` that will be allowed in the resolved dependency graph even if they are declared yanked in the registry where they come from (if they are not coming from a NonRegistryOverride). Otherwise, yanked versions will cause the resolution to fail. You can also define allowed yanked version with the `BZLMOD_ALLOW_YANKED_VERSIONS` environment variable. You can disable this check by using the keyword 'all' (not recommended).
Tags: loading_and_analysis
--check_bazel_compatibility=<error, warning or off> default: "error"
Check bazel version compatibility of Bazel modules. Valid values are `error` to escalate it to a resolution failure, `off` to disable the check, or `warning` to print a warning when mismatch detected.
Tags: loading_and_analysis
--check_direct_dependencies=<off, warning or error> default: "warning"
Check if the direct `bazel_dep` dependencies declared in the root module are the same versions you get in the resolved dependency graph. Valid values are `off` to disable the check, `warning` to print a warning when mismatch detected or `error` to escalate it to a resolution failure.
Tags: loading_and_analysis
--[no]ignore_dev_dependency default: "false"
If true, Bazel ignores `bazel_dep` and `use_extension` declared as `dev_dependency` in the MODULE.bazel of the root module. Note that, those dev dependencies are always ignored in the MODULE.bazel if it's not the root module regardless of the value of this flag.
Tags: loading_and_analysis
--lockfile_mode=<off, update or error> default: "update"
Specifies how and whether or not to use the lockfile. Valid values are `update` to use the lockfile and update it if there are changes, `error` to use the lockfile but throw an error if it's not up-to-date, or `off` to neither read from or write to the lockfile.
Tags: loading_and_analysis
--override_module=<an equals-separated mapping of module name to path> multiple uses are accumulated
Override a module with a local path in the form of <module name>=<path>. If the given path is an absolute path, it will be used as it is. If the given path is a relative path, it is relative to the current working directory. If the given path starts with '%workspace%, it is relative to the workspace root, which is the output of `bazel info workspace`
--registry=<a string> multiple uses are accumulated
Specifies the registries to use to locate Bazel module dependencies. The order is important: modules will be looked up in earlier registries first, and only fall back to later registries when they're missing from the earlier ones.
Tags: changes_inputs
Options that trigger optimizations of the build time:
--gc_thrashing_limits=<comma separated pairs of <period>:<count>> default: "1s:2,20s:3,1m:5"
Limits which, if reached, cause GcThrashingDetector to crash Bazel with an OOM. Each limit is specified as <period>:<count> where period is a duration and count is a positive integer. If more than --gc_thrashing_threshold percent of tenured space (old gen heap) remains occupied after <count> consecutive full GCs within <period>, an OOM is triggered. Multiple limits can be specified separated by commas.
Tags: host_machine_resource_optimizations
--skyframe_high_water_mark_full_gc_drops_per_invocation=<an integer, >= 0> default: "2147483647"
Flag for advanced configuration of Bazel's internal Skyframe engine. If Bazel detects its retained heap percentage usage exceeds the threshold set by --skyframe_high_water_mark_threshold, when a full GC event occurs, it will drop unnecessary temporary Skyframe state, up to this many times per invocation. Defaults to Integer.MAX_VALUE; effectively unlimited. Zero means that full GC events will never trigger drops. If the limit is reached, Skyframe state will no longer be dropped when a full GC event occurs and that retained heap percentage threshold is exceeded.
Tags: host_machine_resource_optimizations
--skyframe_high_water_mark_minor_gc_drops_per_invocation=<an integer, >= 0> default: "2147483647"
Flag for advanced configuration of Bazel's internal Skyframe engine. If Bazel detects its retained heap percentage usage exceeds the threshold set by --skyframe_high_water_mark_threshold, when a minor GC event occurs, it will drop unnecessary temporary Skyframe state, up to this many times per invocation. Defaults to Integer.MAX_VALUE; effectively unlimited. Zero means that minor GC events will never trigger drops. If the limit is reached, Skyframe state will no longer be dropped when a minor GC event occurs and that retained heap percentage threshold is exceeded.
Tags: host_machine_resource_optimizations
--skyframe_high_water_mark_threshold=<an integer> default: "85"
Flag for advanced configuration of Bazel's internal Skyframe engine. If Bazel detects its retained heap percentage usage is at least this threshold, it will drop unnecessary temporary Skyframe state. Tweaking this may let you mitigate wall time impact of GC thrashing, when the GC thrashing is (i) caused by the memory usage of this temporary state and (ii) more costly than reconstituting the state when it is needed.
Tags: host_machine_resource_optimizations
Options that affect the verbosity, format or location of logging:
--[no]experimental_command_profile default: "false"
Records a Java Flight Recorder CPU profile into a profile.jfr file in the output base directory. The syntax and semantics of this flag might change in the future to support different profile types or output formats; use at your own risk.
--[no]experimental_record_metrics_for_all_mnemonics default: "false"
By default the number of action types is limited to the 20 mnemonics with the largest number of executed actions. Setting this option will write statistics for all mnemonics.
--[no]show_make_env default: "false"
Include the "Make" environment in the output.
Tags: affects_outputs, terminal_output
Options specifying or altering a generic input to a Bazel command that does not fall into other categories.:
--experimental_resolved_file_instead_of_workspace=<a string> default: ""
If non-empty read the specified resolved file instead of the WORKSPACE file
Tags: changes_inputs
Remote caching and execution options:
--experimental_downloader_config=<a string> default: see description
Specify a file to configure the remote downloader with. This file consists of lines, each of which starts with a directive (`allow`, `block` or `rewrite`) followed by either a host name (for `allow` and `block`) or two patterns, one to match against, and one to use as a substitute URL, with back-references starting from `$1`. It is possible for multiple `rewrite` directives for the same URL to be give, and in this case multiple URLs will be returned.
--experimental_worker_for_repo_fetching=<off, platform or virtual> default: "off"
The threading mode to use for repo fetching. If set to 'off', no worker thread is used, and the repo fetching is subject to restarts. Otherwise, uses a platform thread (i.e. OS thread) if set to 'platform' or a virtual thread if set to 'virtual'.
Miscellaneous options, not otherwise categorized.:
--override_repository=<an equals-separated mapping of repository name to path> multiple uses are accumulated
Override a repository with a local path in the form of <repository name>=<path>. If the given path is an absolute path, it will be used as it is. If the given path is a relative path, it is relative to the current working directory. If the given path starts with '%workspace%, it is relative to the workspace root, which is the output of `bazel info workspace`

License Options

Options that appear before the command and are parsed by the client:
--distdir=<a path> multiple uses are accumulated
Additional places to search for archives before accessing the network to download them.
Tags: bazel_internal_configuration
If set, the repository cache will hardlink the file in case of a cache hit, rather than copying. This is intended to save disk space.
Tags: bazel_internal_configuration
--experimental_repository_downloader_retries=<an integer> default: "0"
The maximum number of attempts to retry a download error. If set to 0, retries are disabled.
Tags: experimental
--experimental_scale_timeouts=<a double> default: "1.0"
Scale all timeouts in Starlark repository rules by this factor. In this way, external repositories can be made working on machines that are slower than the rule author expected, without changing the source code
Tags: bazel_internal_configuration, experimental
--http_connector_attempts=<an integer> default: "8"
The maximum number of attempts for http downloads.
Tags: bazel_internal_configuration
--http_connector_retry_max_timeout=<An immutable length of time.> default: "0s"
The maximum timeout for http download retries. With a value of 0, no timeout maximum is defined.
Tags: bazel_internal_configuration
--http_timeout_scaling=<a double> default: "1.0"
Scale all timeouts related to http downloads by the given factor
Tags: bazel_internal_configuration
--repository_cache=<a path> default: see description
Specifies the cache location of the downloaded values obtained during the fetching of external repositories. An empty string as argument requests the cache to be disabled, otherwise the default of '<output_user_root>/cache/repos/v1' is used
Tags: bazel_internal_configuration
--[no]repository_disable_download default: "false"
If set, downloading using ctx.download{,_and_extract} is not allowed during repository fetching. Note that network access is not completely disabled; ctx.execute could still run an arbitrary executable that accesses the Internet.
Tags: bazel_internal_configuration
Options that control build execution:
--gc_thrashing_threshold=<an integer in 0-100 range> default: "100"
The percent of tenured space occupied (0-100) above which GcThrashingDetector considers memory pressure events against its limits (--gc_thrashing_limits). If set to 100, GcThrashingDetector is disabled.
Tags: host_machine_resource_optimizations
This option affects semantics of the Starlark language or the build API accessible to BUILD files, .bzl files, or WORKSPACE files.:
--[no]incompatible_depset_for_java_output_source_jars default: "true"
No-op.
Tags: loading_and_analysis, incompatible_change
--[no]incompatible_new_actions_api default: "true"
No-op
Tags: no_op, incompatible_change
Options relating to Bzlmod output and semantics:
--allow_yanked_versions=<a string> multiple uses are accumulated
Specified the module versions in the form of `<module1>@<version1>,<module2>@<version2>` that will be allowed in the resolved dependency graph even if they are declared yanked in the registry where they come from (if they are not coming from a NonRegistryOverride). Otherwise, yanked versions will cause the resolution to fail. You can also define allowed yanked version with the `BZLMOD_ALLOW_YANKED_VERSIONS` environment variable. You can disable this check by using the keyword 'all' (not recommended).
Tags: loading_and_analysis
--check_bazel_compatibility=<error, warning or off> default: "error"
Check bazel version compatibility of Bazel modules. Valid values are `error` to escalate it to a resolution failure, `off` to disable the check, or `warning` to print a warning when mismatch detected.
Tags: loading_and_analysis
--check_direct_dependencies=<off, warning or error> default: "warning"
Check if the direct `bazel_dep` dependencies declared in the root module are the same versions you get in the resolved dependency graph. Valid values are `off` to disable the check, `warning` to print a warning when mismatch detected or `error` to escalate it to a resolution failure.
Tags: loading_and_analysis
--[no]ignore_dev_dependency default: "false"
If true, Bazel ignores `bazel_dep` and `use_extension` declared as `dev_dependency` in the MODULE.bazel of the root module. Note that, those dev dependencies are always ignored in the MODULE.bazel if it's not the root module regardless of the value of this flag.
Tags: loading_and_analysis
--lockfile_mode=<off, update or error> default: "update"
Specifies how and whether or not to use the lockfile. Valid values are `update` to use the lockfile and update it if there are changes, `error` to use the lockfile but throw an error if it's not up-to-date, or `off` to neither read from or write to the lockfile.
Tags: loading_and_analysis
--override_module=<an equals-separated mapping of module name to path> multiple uses are accumulated
Override a module with a local path in the form of <module name>=<path>. If the given path is an absolute path, it will be used as it is. If the given path is a relative path, it is relative to the current working directory. If the given path starts with '%workspace%, it is relative to the workspace root, which is the output of `bazel info workspace`
--registry=<a string> multiple uses are accumulated
Specifies the registries to use to locate Bazel module dependencies. The order is important: modules will be looked up in earlier registries first, and only fall back to later registries when they're missing from the earlier ones.
Tags: changes_inputs
Options that trigger optimizations of the build time:
--gc_thrashing_limits=<comma separated pairs of <period>:<count>> default: "1s:2,20s:3,1m:5"
Limits which, if reached, cause GcThrashingDetector to crash Bazel with an OOM. Each limit is specified as <period>:<count> where period is a duration and count is a positive integer. If more than --gc_thrashing_threshold percent of tenured space (old gen heap) remains occupied after <count> consecutive full GCs within <period>, an OOM is triggered. Multiple limits can be specified separated by commas.
Tags: host_machine_resource_optimizations
--skyframe_high_water_mark_full_gc_drops_per_invocation=<an integer, >= 0> default: "2147483647"
Flag for advanced configuration of Bazel's internal Skyframe engine. If Bazel detects its retained heap percentage usage exceeds the threshold set by --skyframe_high_water_mark_threshold, when a full GC event occurs, it will drop unnecessary temporary Skyframe state, up to this many times per invocation. Defaults to Integer.MAX_VALUE; effectively unlimited. Zero means that full GC events will never trigger drops. If the limit is reached, Skyframe state will no longe