diff --git a/8.0.1/flags.mdx b/8.0.1/flags.mdx new file mode 100644 index 00000000..5bbdb22b --- /dev/null +++ b/8.0.1/flags.mdx @@ -0,0 +1,9302 @@ +--- +title: Bazel flags +--- + +## --experimental_repository_resolved_file + +History: +- Introduced in Bazel x.x.x + +If non-empty, write a Starlark value with the resolved information of all Starlark repository rules that were executed. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, query, run, sync, test, vendor_ + +## --incompatible_no_implicit_watch_label + +History: +- Introduced in Bazel x.x.x + +If true, then methods on repository_ctx that are passed a Label will no longer automatically watch the file under that label for changes even if watch = "no", and repository_ctx.path no longer causes the returned path to be watched. Use repository_ctx.watch instead. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --internal_persistent_multiplex_busybox_tools + +History: +- Introduced in Bazel x.x.x + +Tracking flag for when multiplexed busybox workers are enabled. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --autodetect_server_javabase + +History: +- Introduced in Bazel x.x.x + +When --noautodetect_server_javabase is passed, Bazel does not fall back to the local JDK for running the bazel server and instead exits. + +_May apply to commands: startup_ + +## --host_conlyopt + +History: +- Introduced in Bazel x.x.x + +Additional option to pass to the C compiler when compiling C (but not C++) source files in the exec configurations. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --instrumentation_filter + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --action_cache_store_output_metadata + +History: +- Introduced in Bazel x.x.x + +no-op + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --remote_build_event_upload + +History: +- Introduced in Bazel x.x.x + +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'. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --experimental_incremental_dexing_after_proguard + +History: +- Introduced in Bazel x.x.x + +Whether to use incremental dexing tools when building proguarded Android binaries. Values > 0 turn the feature on, values > 1 run that many dexbuilder shards. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_enable_critical_path_profiling + +History: +- Introduced in Bazel x.x.x + +If set (the default), critical path profiling is enabled for the execution phase. This has a slight overhead in RAM and CPU, and may prevent Bazel from making certain aggressive RAM optimizations in some cases. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --allowed_local_actions_regex + +History: +- Introduced in Bazel x.x.x + +A regex whitelist for action types which may be run locally. If unset, all actions are allowed to execute locally + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --device_debug_entitlements + +History: +- Introduced in Bazel x.x.x + +If set, and compilation mode is not 'opt', objc apps will include debug entitlements when signing. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --aspect_deps + +History: +- Introduced in Bazel x.x.x + +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'. + +_May apply to commands: aquery, cquery, query_ + +## --experimental_worker_sandbox_inmemory_tracking + +History: +- Introduced in Bazel x.x.x + +A worker key mnemonic for which the contents of the sandbox directory are tracked in memory. This may improve build performance at the cost of additional memory usage. Only affects sandboxed workers. May be specified multiple times for different mnemonics. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --incompatible_depset_for_libraries_to_link_getter + +History: +- Introduced in Bazel x.x.x + +When true, Bazel no longer returns a list from linking_context.libraries_to_link but returns a depset instead. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --experimental_announce_profile_path + +History: +- Introduced in Bazel x.x.x + +No-op. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --experimental_worker_use_cgroups_on_linux + +History: +- Introduced in Bazel x.x.x + +On linux, run all workers in its own cgroup (without any limits set) and use the cgroup's own resource accounting for memory measurements. This is overridden by --experimental_worker_sandbox_hardening for sandboxed workers. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --worker_multiplex + +History: +- Introduced in Bazel x.x.x + +If enabled, workers will use multiplexing if they support it. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --dynamic_remote_strategy + +History: +- Introduced in Bazel x.x.x + +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,...] + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --base_module + +History: +- Introduced in Bazel x.x.x + +Specify a module relative to which the specified target repos will be interpreted. + +_May apply to commands: mod_ + +## --host_crosstool_top + +History: +- Introduced in Bazel x.x.x + +No-op flag. Will be removed in a future release. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --packages + +History: +- Introduced in Bazel x.x.x + +Dump package cache content. + +_May apply to commands: dump_ + +## --version_window_for_dirty_node_gc + +History: +- Introduced in Bazel x.x.x + +Nodes that have been dirty for more than this many versions will be deleted from the graph upon the next update. Values must be non-negative long integers, or -1 indicating the maximum possible window. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --fat_apk_hwasan + +History: +- Introduced in Bazel x.x.x + +No-op flag. Will be removed in a future release. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_materialize_param_files_directly + +History: +- Introduced in Bazel x.x.x + +If materializing param files, do so with direct writes to disk. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --run_under + +History: +- Introduced in Bazel x.x.x + +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'. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --show_make_env + +History: +- Introduced in Bazel x.x.x + +Include the "Make" environment in the output. + +_May apply to commands: info_ + +## --experimental_docker_image + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --android_dynamic_mode + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --android_cpu + +History: +- Introduced in Bazel x.x.x + +No-op + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --lockfile_mode + +History: +- Introduced in Bazel x.x.x + +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, `refresh` to additionally refresh mutable information (yanked versions and previously missing modules) from remote registries from time to time, `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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --experimental_guard_against_concurrent_changes + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --experimental_docker_verbose + +History: +- Introduced in Bazel x.x.x + +If enabled, Bazel will print more verbose messages about the Docker sandbox strategy. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --enable_workspace + +History: +- Introduced in Bazel x.x.x + +If true, enables the legacy WORKSPACE system for external dependencies. See https://bazel.build/external/overview for more information. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --legacy_bazel_java_test + +History: +- Introduced in Bazel x.x.x + +No-op, kept only for backwards compatibility + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --show_timestamps + +History: +- Introduced in Bazel x.x.x + +Include timestamps in messages + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --experimental_worker_metrics_poll_interval + +History: +- Introduced in Bazel x.x.x + +The interval between collecting worker metrics and possibly attempting evictions. Cannot effectively be less than 1s for performance reasons. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --quiet + +History: +- Introduced in Bazel x.x.x + +If true, no informational messages are emitted on the console, only errors. Changing this option will not cause the server to restart. + +_May apply to commands: startup_ + +## --share_native_deps + +History: +- Introduced in Bazel x.x.x + +If true, native libraries that contain identical functionality will be shared among different targets + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_filter_r_jars_from_android_test + +History: +- Introduced in Bazel x.x.x + +If enabled, R Jars will be filtered from the test apk built by android_test. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --gc_thrashing_limits + +History: +- Introduced in Bazel x.x.x + +Limits which, if reached, cause GcThrashingDetector to crash Bazel with an OOM. Each limit is specified as : 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 consecutive full GCs within , an OOM is triggered. Multiple limits can be specified separated by commas. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --ios_multi_cpus + +History: +- Introduced in Bazel x.x.x + +Comma-separated list of architectures to build an ios_application with. The result is a universal binary containing all specified architectures. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --test_env + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --dexopts_supported_in_dexsharder + +History: +- Introduced in Bazel x.x.x + +dx flags supported in tool that groups classes for inclusion in final .dex files. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --sandbox_debug + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_use_hermetic_linux_sandbox + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --build_tests_only + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --check_bzl_visibility + +History: +- Introduced in Bazel x.x.x + +If disabled, .bzl load visibility errors are demoted to warnings. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --incompatible_disallow_empty_glob + +History: +- Introduced in Bazel x.x.x + +If set to true, the default value of the `allow_empty` argument of glob() is False. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --proto_toolchain_for_java + +History: +- Introduced in Bazel x.x.x + +Label of proto_lang_toolchain() which describes how to compile Java protos + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --remote_local_fallback + +History: +- Introduced in Bazel x.x.x + +Whether to fall back to standalone local execution strategy if remote execution fails. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --crosstool_top + +History: +- Introduced in Bazel x.x.x + +No-op flag. Will be removed in a future release. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --incompatible_modify_execution_info_additive + +History: +- Introduced in Bazel x.x.x + +When enabled, passing multiple --modify_execution_info flags is additive. When disabled, only the last flag is taken into account. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --remote_header + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --strict_system_includes + +History: +- Introduced in Bazel x.x.x + +If true, headers found through system include paths (-isystem) are also required to be declared. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --remote_max_connections + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --ignore_unsupported_sandboxing + +History: +- Introduced in Bazel x.x.x + +Do not print a warning when sandboxed execution is not supported on this system. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --android_manifest_merger + +History: +- Introduced in Bazel x.x.x + +Selects the manifest merger to use for android_binary rules. Flag to help thetransition to the Android manifest merger from the legacy merger. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --repository_cache + +History: +- Introduced in Bazel x.x.x + +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 '/cache/repos/v1' is used + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --unlimit_coredumps + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: startup_ + +## --use_target_platform_for_tests + +History: +- Introduced in Bazel x.x.x + +If true, then Bazel will use the target platform for running tests rather than the test exec group. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --local_cpu_resources + +History: +- Introduced in Bazel x.x.x + +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 [-|*] (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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --remote_proxy + +History: +- Introduced in Bazel x.x.x + +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). + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --server_javabase + +History: +- Introduced in Bazel x.x.x + +Path to the JVM used to execute Bazel itself. + +_May apply to commands: startup_ + +## --memprof_profile + +History: +- Introduced in Bazel x.x.x + +Use memprof profile. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --tool_java_runtime_version + +History: +- Introduced in Bazel x.x.x + +The Java runtime version used to execute tools during the build + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --expand_test_suites + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --adb + +History: +- Introduced in Bazel x.x.x + +adb binary to use for the 'mobile-install' command. If unspecified, the one in the Android SDK specified by the --android_sdk_channel command line option (or the default SDK if --android_sdk_channel is not specified) is used. + +_May apply to commands: mobile-install_ + +## --experimental_skyframe_target_pattern_evaluator + +History: +- Introduced in Bazel x.x.x + +Use the Skyframe-based target pattern evaluator; implies --experimental_interleave_loading_and_analysis. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --build_event_publish_all_actions + +History: +- Introduced in Bazel x.x.x + +Whether all actions should be published. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --experimental_generate_llvm_lcov + +History: +- Introduced in Bazel x.x.x + +If true, coverage for clang will generate an LCOV report. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_android_resource_shrinking + +History: +- Introduced in Bazel x.x.x + +Enables resource shrinking for android_binary APKs that use ProGuard. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_use_new_worker_pool + +History: +- Introduced in Bazel x.x.x + +Uses a new worker pool implementation (no change in behavior, reimplementation of the worker pool in order to deprecate the use of a third party tool). + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --use_ijars + +History: +- Introduced in Bazel x.x.x + +If enabled, this option causes Java compilation to use interface jars. This will result in faster incremental compilation, but error messages can be different. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_extra_action_top_level_only + +History: +- Introduced in Bazel x.x.x + +Deprecated in favor of aspects. Only schedules extra_actions for top level targets. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --ios_simulator_device + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_skyfocus_handling_strategy + +History: +- Introduced in Bazel x.x.x + +Strategies for Skyfocus to handle changes outside of the working set. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --incompatible_package_group_includes_double_slash + +History: +- Introduced in Bazel x.x.x + +If enabled, when outputting package_group's `packages` attribute, the leading `//` will not be omitted. + +_May apply to commands: aquery, cquery, query_ + +## --incompatible_validate_top_level_header_inclusions + +History: +- Introduced in Bazel x.x.x + +This flag is a noop and scheduled for removal. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --heap_dump_on_oom + +History: +- Introduced in Bazel x.x.x + +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 /.heapdump.hprof. This option effectively replaces -XX:+HeapDumpOnOutOfMemoryError, which has no effect for manual OOMs. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --inject_repository + +History: +- Introduced in Bazel x.x.x + +Adds a new repository with a local path in the form of =. This only takes effect with --enable_bzlmod and is equivalent to adding a corresponding `local_repository` to the root module's MODULE.bazel file via `use_repo_rule`. 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`. If the given path is empty, then remove any previous injections. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --incompatible_use_toolchain_resolution_for_java_rules + +History: +- Introduced in Bazel x.x.x + +No-op. Kept here for backwards compatibility. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --skyframe_high_water_mark_threshold + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --rewind_lost_inputs + +History: +- Introduced in Bazel x.x.x + +Whether to use action rewinding to recover from lost inputs. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --jvm_heap_histogram_internal_object_pattern + +History: +- Introduced in Bazel x.x.x + +Regex for overriding the matching logic for JDK21+ JVM heap memory collection. We are relying on volatile internal G1 GC implemenation details to get a clean memory metric, this option allows us to adapt to changes in that internal implementation without having to wait for a binary release. Passed to JDK Matcher.find() + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --java_header_compilation + +History: +- Introduced in Bazel x.x.x + +Compile ijars directly from source. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_enable_scl_dialect + +History: +- Introduced in Bazel x.x.x + +If set to true, .scl files may be used in load() statements. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --output_tree_tracking + +History: +- Introduced in Bazel x.x.x + +If set, tell the output service (if any) to track when files in the output tree have been modified externally (not by the build system). This should improve incremental build speed when an appropriate output service is enabled. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --remote_cache_header + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --experimental_dormant_deps + +History: +- Introduced in Bazel x.x.x + + If set to true, attr.label(materializer=), attr(for_dependency_resolution=), attr.dormant_label(), attr.dormant_label_list() and rule(for_dependency_resolution=) are allowed. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --compiler + +History: +- Introduced in Bazel x.x.x + +The C++ compiler to use for compiling the target. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --java_debug + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --remote_retries + +History: +- Introduced in Bazel x.x.x + +The maximum number of attempts to retry a transient error. If set to 0, retries are disabled. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --experimental_run_bep_event_include_residue + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --experimental_remote_analysis_cache_concurrency + +History: +- Introduced in Bazel x.x.x + +Target concurrency for remote analysis caching RPCs. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_worker_multiplex_sandboxing + +History: +- Introduced in Bazel x.x.x + +If enabled, multiplex workers with a 'supports-multiplex-sandboxing' execution requirement will run in a sandboxed environment, using a separate sandbox directory per work request. Multiplex workers with the execution requirement are always sandboxed when running under the dynamic execution strategy, irrespective of this flag. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --dexopts_supported_in_incremental_dexing + +History: +- Introduced in Bazel x.x.x + +dx flags supported when converting Jars to dex archives incrementally. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --tvos_minimum_os + +History: +- Introduced in Bazel x.x.x + +Minimum compatible tvOS version for target simulators and devices. If unspecified, uses 'tvos_sdk_version'. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --proguard_top + +History: +- Introduced in Bazel x.x.x + +Specifies which version of ProGuard to use for code removal when building a Java binary. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --consistent_labels + +History: +- Introduced in Bazel x.x.x + +If enabled, every query command emits labels as if by the Starlark str function applied to a Label 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. + +_May apply to commands: aquery, cquery, query_ + +## --graph:node_limit + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, cquery, query_ + +## --incompatible_disallow_java_import_exports + +History: +- Introduced in Bazel x.x.x + +When enabled, java_import.exports is not supported. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --incompatible_enable_cc_toolchain_resolution + +History: +- Introduced in Bazel x.x.x + +No-op flag. Will be removed in a future release. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --sandbox_default_allow_network + +History: +- Introduced in Bazel x.x.x + +Allow network access by default for actions; this may not work with all sandboxing implementations. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_get_android_java_resources_from_optimized_jar + +History: +- Introduced in Bazel x.x.x + +Get Java resources from _proguard.jar instead of _deploy.jar in android_binary when bundling the final APK. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --unconditional_warning + +History: +- Introduced in Bazel x.x.x + +A warning that will unconditionally get printed with build warnings and errors. This is useful to deprecate bazelrc files or --config definitions. If the intent is to effectively deprecate some flag or combination of flags, this is NOT sufficient. The flag or flags should use the deprecationWarning field in the option definition, or the bad combination should be checked for programmatically. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --remote_execution_priority + +History: +- Introduced in Bazel x.x.x + +The relative priority of actions to be executed remotely. The semantics of the particular priority values are server-dependent. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --experimental_exec_configuration_distinguisher + +History: +- Introduced in Bazel x.x.x + +Please only use this flag as part of a suggested migration or testing strategy due to potential for action conflicts. Controls how the execution transition changes the platform_suffix flag. In legacy mode, sets it to a hash of the execution platform. In fullhash mode, sets it to a hash of the entire configuration. In off mode, does not touch it. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_remote_downloader_local_fallback + +History: +- Introduced in Bazel x.x.x + +Whether to fall back to the local downloader if remote downloader fails. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --proto_profile + +History: +- Introduced in Bazel x.x.x + +Whether to pass profile_path to the proto compiler. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --execution_log_json_file + +History: +- Introduced in Bazel x.x.x + +Log the executed spawns into this file as newline-delimited JSON representations of SpawnExec protos, according to src/main/protobuf/spawn.proto. Prefer --execution_log_compact_file, which is significantly smaller and cheaper to produce. Related flags: --execution_log_compact_file (compact format; mutually exclusive), --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). + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --build_manual_tests + +History: +- Introduced in Bazel x.x.x + +Forces test targets tagged 'manual' to be built. 'manual' tests are excluded from processing. This option forces them to be built (but not executed). + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_skip_ttvs_for_genquery + +History: +- Introduced in Bazel x.x.x + +If true, genquery loads its scope's transitive closure directly instead of by using 'TransitiveTargetValue' Skyframe work. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --write_command_log + +History: +- Introduced in Bazel x.x.x + +Whether or not to write the command.log file + +_May apply to commands: startup_ + +## --skyframe_state + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery_ + +## --flag_alias + +History: +- Introduced in Bazel x.x.x + +Sets a shorthand name for a Starlark flag. It takes a single key-value pair in the form "=" as an argument. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --worker_quit_after_build + +History: +- Introduced in Bazel x.x.x + +If enabled, all workers quit after a build is done. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --runs_per_test + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_collect_pressure_stall_indicators + +History: +- Introduced in Bazel x.x.x + +If enabled, the profiler collects the Linux PSI data. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --incompatible_load_python_rules_from_bzl + +History: +- Introduced in Bazel x.x.x + +Deprecated no-op. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --incompatible_java_common_parameters + +History: +- Introduced in Bazel x.x.x + +If set to true, the output_jar, and host_javabase parameters in pack_sources and host_javabase in compile will all be removed. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --incompatible_enable_deprecated_label_apis + +History: +- Introduced in Bazel x.x.x + +If enabled, certain deprecated APIs (native.repository_name, Label.workspace_name, Label.relative) can be used. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --android_databinding_use_v3_4_args + +History: +- Introduced in Bazel x.x.x + +Use android databinding v2 with 3.4.0 argument. This flag is a no-op. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --announce_rc + +History: +- Introduced in Bazel x.x.x + +Whether to announce rc options. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --line_terminator_null + +History: +- Introduced in Bazel x.x.x + +Whether each format is terminated with \0 instead of newline. + +_May apply to commands: aquery, cquery, query_ + +## --tool_tag + +History: +- Introduced in Bazel x.x.x + +A tool name to attribute this Bazel invocation to. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --shutdown_on_low_sys_mem + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: startup_ + +## --incompatible_avoid_hardcoded_objc_compilation_flags + +History: +- Introduced in Bazel x.x.x + +Prevents Bazel from adding compiler options to Objective-C compilation actions. Options set in the crosstool are still applied. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --analysis_testing_deps_limit + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --test_filter + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --host_cxxopt + +History: +- Introduced in Bazel x.x.x + +Additional options to pass to C++ compiler for tools built in the exec configurations. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --incompatible_merge_fixed_and_default_shell_env + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --protocopt + +History: +- Introduced in Bazel x.x.x + +Additional options to pass to the protobuf compiler. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --build_test_dwp + +History: +- Introduced in Bazel x.x.x + +If enabled, when building C++ tests statically and with fission the .dwp file for the test binary will be automatically built as well. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --show_progress + +History: +- Introduced in Bazel x.x.x + +Display progress messages during a build. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --check_direct_dependencies + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --incompatible_check_sharding_support + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --sandbox_fake_hostname + +History: +- Introduced in Bazel x.x.x + +Change the current hostname to 'localhost' for sandboxed actions. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --ltobackendopt + +History: +- Introduced in Bazel x.x.x + +Additional option to pass to the LTO backend step (under --features=thin_lto). + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --keep_backend_build_event_connections_alive + +History: +- Introduced in Bazel x.x.x + +If enabled, keep connections to build event backend connections alive across builds. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --incompatible_skip_genfiles_symlink + +History: +- Introduced in Bazel x.x.x + +If set to true, the genfiles symlink will not be created. For more information, see https://github.com/bazelbuild/bazel/issues/8651 + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --command_wait_time + +History: +- Introduced in Bazel x.x.x + +The time in ms a command had to wait on a busy Bazel server process. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --build_event_binary_file_upload_mode + +History: +- Introduced in Bazel x.x.x + +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'. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --xml:line_numbers + +History: +- Introduced in Bazel x.x.x + +If true, XML output contains line numbers. Disabling this option may make diffs easier to read. This option is only applicable to --output=xml. + +_May apply to commands: query_ + +## --bes_timeout + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --experimental_graphless_query + +History: +- Introduced in Bazel x.x.x + +If true, uses a Query implementation that does not make a copy of the graph. The new implementation only supports --order_output=no, as well as only a subset of output formatters. + +_May apply to commands: query_ + +## --remote_exec_header + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --analyze + +History: +- Introduced in Bazel x.x.x + +Execute the loading/analysis phase; this is the usual behaviour. Specifying --noanalyzecauses the build to stop before starting the loading/analysis phase, just doing target pattern parsing and returning zero iff that completed successfully; this mode is useful for testing. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --record_metrics_for_all_packages + +History: +- Introduced in Bazel x.x.x + +Configures PackageMetrics to record all metrics for all packages. Disables Top-n INFO logging. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --bes_oom_finish_upload_timeout + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --fdo_profile + +History: +- Introduced in Bazel x.x.x + +The fdo_profile representing the profile to be used for optimization. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --skylark_memory + +History: +- Introduced in Bazel x.x.x + +Dumps a pprof-compatible memory profile to the specified path. To learn more please see https://github.com/google/pprof. + +_May apply to commands: dump_ + +## --experimental_skylark_debug + +History: +- Introduced in Bazel x.x.x + +If true, Blaze will open the Starlark debug server at the start of the build invocation, and wait for a debugger to attach before running the build. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_enable_docker_sandbox + +History: +- Introduced in Bazel x.x.x + +Enable Docker-based sandboxing. This option has no effect if Docker is not installed. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --worker_extra_flag + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --force_ignore_dash_static + +History: +- Introduced in Bazel x.x.x + +noop + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --apple_platform_type + +History: +- Introduced in Bazel x.x.x + +Don't set this value from the command line - it is derived from other flags and configuration transitions derived from rule attributes + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_link_static_libraries_once + +History: +- Introduced in Bazel x.x.x + +If enabled, cc_shared_library will link all libraries statically linked into it, that should only be linked once. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --fdo_optimize + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --run_env + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: run_ + +## --persistent_android_resource_processor + +History: +- Introduced in Bazel x.x.x + +Enable persistent Android resource processor by using workers. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --bes_best_effort + +History: +- Introduced in Bazel x.x.x + +No-op + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --dump_all + +History: +- Introduced in Bazel x.x.x + +If set, dump all known configurations instead of just the ids. + +_May apply to commands: config_ + +## --strategy_regexp + +History: +- Introduced in Bazel x.x.x + +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'. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --python_version + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --incompatible_dont_collect_native_libraries_in_data + +History: +- Introduced in Bazel x.x.x + +This flag is a noop and scheduled for removal. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_extra_action_filter + +History: +- Introduced in Bazel x.x.x + +Deprecated in favor of aspects. Filters set of targets to schedule extra_actions for. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_skylark_debug_verbose_logging + +History: +- Introduced in Bazel x.x.x + +Show verbose logs for the debugger. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --allow_unresolved_symlinks + +History: +- Introduced in Bazel x.x.x + +If enabled, Bazel allows the use of ctx.action.declare_symlink() and the use of ctx.actions.symlink() without a target file, thus allowing the creation of unresolved symlinks. Unresolved symlinks inside tree artifacts are not currently supported. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --proto:include_configurations + +History: +- Introduced in Bazel x.x.x + +if enabled, proto output will include information about configurations. When disabled,cquery proto output format resembles query output format. + +_May apply to commands: cquery_ + +## --apple_platforms + +History: +- Introduced in Bazel x.x.x + +Comma-separated list of platforms to use when building Apple binaries. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --ios_simulator_version + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_scale_timeouts + +History: +- Introduced in Bazel x.x.x + +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 + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --experimental_turbine_annotation_processing + +History: +- Introduced in Bazel x.x.x + +If enabled, turbine is used for all annotation processing + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_stream_log_file_uploads + +History: +- Introduced in Bazel x.x.x + +Stream log file uploads directly to the remote storage rather than writing them to disk. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --output_groups + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --legacy_whole_archive + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --internal_spawn_scheduler + +History: +- Introduced in Bazel x.x.x + +Placeholder option so that we can tell in Blaze whether the spawn scheduler was enabled. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --default_override + +History: +- Introduced in Bazel x.x.x + + + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --build_metadata + +History: +- Introduced in Bazel x.x.x + +Custom key-value string pairs to supply in a build event. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --worker_max_multiplex_instances + +History: +- Introduced in Bazel x.x.x + +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 ([-|*]) eg. "auto", "HOST_CPUS*.5". 'auto' calculates a reasonable default based on machine capacity. "=value" sets a default for unspecified mnemonics. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --incompatible_remove_binary_profile + +History: +- Introduced in Bazel x.x.x + +No-op. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_split_xml_generation + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --http_max_parallel_downloads + +History: +- Introduced in Bazel x.x.x + +The maximum number parallel http downloads. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --experimental_collect_skyframe_counts_in_profiler + +History: +- Introduced in Bazel x.x.x + +If enabled, the profiler collects SkyFunction counts in the Skyframe graph over time for key function types, like configured targets and action executions. May have a performance hit as this visits the ENTIRE Skyframe graph at every profiling time unit. Do not use this flag with performance-critical measurements. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --experimental_one_version_enforcement_use_transitive_jars_for_binary_under_test + +History: +- Introduced in Bazel x.x.x + +If enabled, one version enforcement for android_test uses the binary_under_test's transitive classpath, otherwise it uses the deploy jar + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --incompatible_enable_proto_toolchain_resolution + +History: +- Introduced in Bazel x.x.x + +If true, proto lang rules define toolchains from protobuf repository. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --platforms + +History: +- Introduced in Bazel x.x.x + +The labels of the platform rules describing the target platforms for the current command. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --mode + +History: +- Introduced in Bazel x.x.x + +Deprecated no-effect flag. Only skylark mode is still supported. + +_May apply to commands: mobile-install_ + +## --aspects_parameters + +History: +- Introduced in Bazel x.x.x + +Specifies the values of the command-line aspects parameters. Each parameter value is specified via =, 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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_remote_analysis_cache_mode + +History: +- Introduced in Bazel x.x.x + +The transport direction for the remote analysis cache. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --zip_undeclared_test_outputs + +History: +- Introduced in Bazel x.x.x + +If true, undeclared test outputs will be archived in a zip file. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --coverage_output_generator + +History: +- Introduced in Bazel x.x.x + +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'. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --tls_client_certificate + +History: +- Introduced in Bazel x.x.x + +Specify the TLS client certificate to use; you also need to provide a client key to enable client authentication. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --output_base + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: startup_ + +## --print_relative_test_log_paths + +History: +- Introduced in Bazel x.x.x + +If true, when printing the path to a test log, use relative path that makes use of the 'testlogs' convenience symlink. N.B. - A subsequent 'build'/'test'/etc invocation with a different configuration can cause the target of this symlink to change, making the path printed previously no longer useful. + +_May apply to commands: coverage, cquery, fetch, test, vendor_ + +## --incompatible_no_rule_outputs_param + +History: +- Introduced in Bazel x.x.x + +If set to true, disables the `outputs` parameter of the `rule()` Starlark function. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --all + +History: +- Introduced in Bazel x.x.x + +Fetches all external repositories necessary for building any target or repository. This is the default if no other flags and arguments are provided. Only works when --enable_bzlmod is on. + +_May apply to commands: fetch_ + +## --experimental_cgroup_parent + +History: +- Introduced in Bazel x.x.x + +The cgroup where to start the bazel server as an absolute path. The server process will be started in the specified cgroup for each supported controller. For example, if the value of this flag is /build/bazel and the cpu and memory controllers are mounted respectively on /sys/fs/cgroup/cpu and /sys/fs/cgroup/memory, the server will be started in the cgroups /sys/fs/cgroup/cpu/build/bazel and /sys/fs/cgroup/memory/build/bazel.It is not an error if the specified cgroup is not writable for one or more of the controllers. This options does not have any effect on platforms that do not support cgroups. + +_May apply to commands: startup_ + +## --incompatible_auto_configure_host_platform + +History: +- Introduced in Bazel x.x.x + +This option is deprecated and has no effect. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --cpu + +History: +- Introduced in Bazel x.x.x + +The target CPU. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_enable_starlark_doc_extract + +History: +- Introduced in Bazel x.x.x + +Deprecated no-op. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --cs_fdo_profile + +History: +- Introduced in Bazel x.x.x + +The cs_fdo_profile representing the context sensitive profile to be used for optimization. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_cpu_load_scheduling + +History: +- Introduced in Bazel x.x.x + +Enables the experimental local execution scheduling based on CPU load, not estimation of actions one by one. Experimental scheduling have showed the large benefit on a large local builds on a powerful machines with the large number of cores. Reccommended to use with --local_resources=cpu=HOST_CPUS + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_collect_local_sandbox_action_metrics + +History: +- Introduced in Bazel x.x.x + +Deprecated no-op. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --emit_script_path_in_exec_request + +History: +- Introduced in Bazel x.x.x + +If true, emits the ExecRequest with --script_path file value and script contents instead of writing the script. + +_May apply to commands: run_ + +## --experimental_local_retries_on_crash + +History: +- Introduced in Bazel x.x.x + +Number of times to retry a local action when we detect that it crashed. This exists to workaround a bug in OSXFUSE which is tickled by the use of the dynamic scheduler and --experimental_local_lockfree_output due to constant process churn. The bug can be triggered by a cancelled process that ran *before* the process we are trying to run, introducing corruption in its file reads. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --workspace_status_command + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --coverage_support + +History: +- Introduced in Bazel x.x.x + +Location of support files that are required on the inputs of every test action that collects code coverage. Defaults to '//tools/test:coverage_support'. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_profile_action_counts + +History: +- Introduced in Bazel x.x.x + +No-op. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --android_resource_shrinking + +History: +- Introduced in Bazel x.x.x + +Enables resource shrinking for android_binary APKs that use ProGuard. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --nested_set_depth_limit + +History: +- Introduced in Bazel x.x.x + +The maximum depth of the graph internal to a depset (also known as NestedSet), above which the depset() constructor will fail. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --experimental_throttle_action_cache_check + +History: +- Introduced in Bazel x.x.x + +Whether to throttle the check whether an action is cached. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --high_priority_workers + +History: +- Introduced in Bazel x.x.x + +No-op, will be removed soon. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --nodep_deps + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, cquery, query_ + +## --experimental_android_compress_java_resources + +History: +- Introduced in Bazel x.x.x + +Compress Java resources in APKs + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --mobile_install_run_deployer + +History: +- Introduced in Bazel x.x.x + +Whether to run the mobile-install deployer after building all artifacts. + +_May apply to commands: mobile-install_ + +## --persistent_android_dex_desugar + +History: +- Introduced in Bazel x.x.x + +Enable persistent Android dex and desugar actions by using workers. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --remote_upload_local_results + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --startup_time + +History: +- Introduced in Bazel x.x.x + +The time in ms the launcher spends before sending the request to the bazel server. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --adb_arg + +History: +- Introduced in Bazel x.x.x + +Extra arguments to pass to adb. Usually used to designate a device to install to. + +_May apply to commands: mobile-install_ + +## --process_headers_in_dependencies + +History: +- Introduced in Bazel x.x.x + +When building a target //a:a, process headers in all targets that //a:a depends on (if header processing is enabled for the toolchain). + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_profile_include_target_label + +History: +- Introduced in Bazel x.x.x + +Includes target label in action events' JSON profile data. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --tool_java_language_version + +History: +- Introduced in Bazel x.x.x + +The Java language version used to execute the tools that are needed during a build + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_java_test_auto_create_deploy_jar + +History: +- Introduced in Bazel x.x.x + +DO NOT USE + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --oom_message + +History: +- Introduced in Bazel x.x.x + +Custom message to be emitted on an out of memory failure. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --grpc_keepalive_timeout + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --enable_propeller_optimize_absolute_paths + +History: +- Introduced in Bazel x.x.x + +If set, any use of absolute paths for propeller optimize will raise an error. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --define + +History: +- Introduced in Bazel x.x.x + +Each --define option specifies an assignment for a build variable. In case of multiple values for a variable, the last one wins. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --dump (-d) + +History: +- Introduced in Bazel x.x.x + +output full profile data dump either in human-readable 'text' format or script-friendly 'raw' format. + +_May apply to commands: analyze-profile_ + +## --allow_yanked_versions + +History: +- Introduced in Bazel x.x.x + +Specified the module versions in the form of `@,@` 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). + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --incompatible_disallow_legacy_py_provider + +History: +- Introduced in Bazel x.x.x + +No-op, will be removed soon. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --jvmopt + +History: +- Introduced in Bazel x.x.x + +Additional options to pass to the Java VM. These options will get added to the VM startup options of each java_binary target. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --profiles_to_retain + +History: +- Introduced in Bazel x.x.x + +Number of profiles to retain in the output base. If there are more than this number of profiles in the output base, the oldest are deleted until the total is under the limit. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --android_databinding_use_androidx + +History: +- Introduced in Bazel x.x.x + +Generate AndroidX-compatible data-binding files. This is only used with databinding v2. This flag is a no-op. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --merge_android_manifest_permissions + +History: +- Introduced in Bazel x.x.x + +If enabled, the manifest merger will merge uses-permission and uses-permission-sdk-23 attributes. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --local_termination_grace_seconds + +History: +- Introduced in Bazel x.x.x + +Time to wait between terminating a local process due to timeout and forcefully shutting it down. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --collect_code_coverage + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --preemptible + +History: +- Introduced in Bazel x.x.x + +If true, the command can be preempted if another command is started. + +_May apply to commands: startup_ + +## --sandbox_explicit_pseudoterminal + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --infer_universe_scope + +History: +- Introduced in Bazel x.x.x + +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`). + +_May apply to commands: aquery, cquery, query_ + +## --option_sources + +History: +- Introduced in Bazel x.x.x + + + +_May apply to commands: startup_ + +## --strategy + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --include_builtin + +History: +- Introduced in Bazel x.x.x + +Include built-in modules in the dependency graph. Disabled by default because it is quite noisy. + +_May apply to commands: mod_ + +## --experimental_android_resource_cycle_shrinking + +History: +- Introduced in Bazel x.x.x + +Enables more shrinking of code and resources by instructing AAPT2 to emit conditional Proguard keep rules. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --incompatible_strict_action_env + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_disk_cache_gc_max_size + +History: +- Introduced in Bazel x.x.x + +If set to a positive value, the disk cache will be periodically garbage collected to stay under this size. If set in conjunction with --experimental_disk_cache_gc_max_age, both criteria are applied. Garbage collection occurrs in the background once the server has become idle, as determined by the --experimental_disk_cache_gc_idle_delay flag. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --repository_disable_download + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --target_environment + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --debug_app + +History: +- Introduced in Bazel x.x.x + +Whether to wait for the debugger before starting the app. + +_May apply to commands: mobile-install_ + +## --incompatible_allow_python_version_transitions + +History: +- Introduced in Bazel x.x.x + +No-op, will be removed soon. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --symlink_prefix + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_record_skyframe_metrics + +History: +- Introduced in Bazel x.x.x + +Controls the output of BEP BuildGraphMetrics, including expensiveto compute skyframe metrics about Skykeys, RuleClasses and Aspects.With this flag set to false BuildGraphMetrics.rule_count and aspectfields will not be populated in the BEP. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --experimental_tool_command_line + +History: +- Introduced in Bazel x.x.x + +An extra command line to report with this invocation's command line. Useful for tools that invoke Bazel and want the original information that the tool received to be logged with the rest of the Bazel invocation. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --j2objc_dead_code_removal + +History: +- Introduced in Bazel x.x.x + +Whether to perform J2ObjC dead code removal to strip unused code from the final app bundle. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_disable_instrumentation_manifest_merge + +History: +- Introduced in Bazel x.x.x + +Disables manifest merging when an android_binary has instruments set (i.e. is used for instrumentation testing). + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --auto_output_filter + +History: +- Introduced in Bazel x.x.x + +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)'. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --graph:factored + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, cquery, query_ + +## --experimental_use_platforms_in_output_dir_legacy_heuristic + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_remote_merkle_tree_cache + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --test_size_filters + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_collect_local_action_metrics + +History: +- Introduced in Bazel x.x.x + +Deprecated no-op. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_repository_downloader_retries + +History: +- Introduced in Bazel x.x.x + +The maximum number of attempts to retry a download error. If set to 0, retries are disabled. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --minimum_os_version + +History: +- Introduced in Bazel x.x.x + +The minimum OS version which your compilation targets. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_remote_discard_merkle_trees + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --hide_aspect_results + +History: +- Introduced in Bazel x.x.x + +Comma-separated list of aspect names to not display in results (see --show_result). Useful for keeping aspects added by wrappers which are typically not interesting to end users out of console output. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --make_variables_source + +History: +- Introduced in Bazel x.x.x + + + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_repository_cache_hardlinks + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --experimental_action_resource_set + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --incompatible_always_check_depset_elements + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --incompatible_enable_apple_toolchain_resolution + +History: +- Introduced in Bazel x.x.x + +Use toolchain resolution to select the Apple SDK for apple rules (Starlark and native) + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --android_grte_top + +History: +- Introduced in Bazel x.x.x + +No-op + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --skyframe + +History: +- Introduced in Bazel x.x.x + +Dump the Skyframe graph. + +_May apply to commands: dump_ + +## --experimental_j2objc_shorter_header_path + +History: +- Introduced in Bazel x.x.x + +Whether to generate with shorter header path (uses "_ios" instead of "_j2objc"). + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --remote_print_execution_messages + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --sandbox_fake_username + +History: +- Introduced in Bazel x.x.x + +Change the current username to 'nobody' for sandboxed actions. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --gnu_format + +History: +- Introduced in Bazel x.x.x + +If set, write the version to stdout using the conventions described in the GNU standards. + +_May apply to commands: version_ + +## --objc_generate_linkmap + +History: +- Introduced in Bazel x.x.x + +Specifies whether to generate a linkmap file. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_run_android_lint_on_java_rules + +History: +- Introduced in Bazel x.x.x + +Whether to validate java_* sources. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --test_timeout + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --relative_locations + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, cquery, query_ + +## --build_event_binary_file + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --java_launcher + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --execution_log_sort + +History: +- Introduced in Bazel x.x.x + +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. Only applies to the binary and JSON formats; the compact format is never sorted. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --credential_helper_timeout + +History: +- Introduced in Bazel x.x.x + +Configures the timeout for a credential helper. + +Credential helpers failing to respond within this timeout will fail the invocation. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --experimental_sandbox_enforce_resources_regexp + +History: +- Introduced in Bazel x.x.x + +If true, actions whose mnemonic matches the input regex will have their resources request enforced as limits, overriding the value of --experimental_sandbox_limits, if the resource type supports it. For example a test that declares cpu:3 and resources:memory:10, will run with at most 3 cpus and 10 megabytes of memory. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_circuit_breaker_strategy + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --experimental_j2objc_header_map + +History: +- Introduced in Bazel x.x.x + +Whether to generate J2ObjC header map in parallel of J2ObjC transpilation. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --build_event_text_file + +History: +- Introduced in Bazel x.x.x + +If non-empty, write a textual representation of the build event protocol to that file + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --workspace_directory + +History: +- Introduced in Bazel x.x.x + +The root of the workspace, that is, the directory that Bazel uses as the root of the build. This flag is only to be set by the bazel client. + +_May apply to commands: startup_ + +## --flaky_test_attempts + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_worker_sandbox_hardening + +History: +- Introduced in Bazel x.x.x + +If enabled, workers are run in a hardened sandbox, if the implementation allows it. If hardening is enabled then tmp directories are distinct for different workers. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_oom_sensitive_skyfunctions_semaphore_size + +History: +- Introduced in Bazel x.x.x + +Sets the size of the semaphore used to prevent SkyFunctions with large peak memory requirement from OOM-ing blaze. A value of 0 indicates that no semaphore should be used. Example value: "HOST_CPUS*0.5". + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --apple_crosstool_top + +History: +- Introduced in Bazel x.x.x + +The label of the crosstool package to be used in Apple and Objc rules and their dependencies. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_cc_static_library + +History: +- Introduced in Bazel x.x.x + +If set to true, rule attributes and Starlark API methods needed for the rule cc_static_library will be available + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --worker_sandboxing + +History: +- Introduced in Bazel x.x.x + +If enabled, singleplex workers will run in a sandboxed environment. Singleplex workers are always sandboxed when running under the dynamic execution strategy, irrespective of this flag. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_strict_java_deps + +History: +- Introduced in Bazel x.x.x + +If true, checks that a Java target explicitly declares all directly used targets as dependencies. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_objc_provider_from_linked + +History: +- Introduced in Bazel x.x.x + +No-op. Kept here for backwards compatibility. This field will be removed in a future release. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --remote_download_all + +History: +- Introduced in Bazel x.x.x + +Downloads all remote outputs to the local machine. This flag is an alias for --remote_download_outputs=all. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --experimental_max_directories_to_eagerly_visit_in_globbing + +History: +- Introduced in Bazel x.x.x + +If non-negative, the first time a glob is evaluated in a package, the subdirectories of the package will be traversed in order to warm filesystem caches and compensate for lack of parallelism in globbing. At most this many directories will be visited. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, mod, print_action, query, run, sync, test, vendor_ + +## --plugin + +History: +- Introduced in Bazel x.x.x + +Plugins to use in the build. Currently works with java_plugin. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --remote_download_outputs + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --java_language_version + +History: +- Introduced in Bazel x.x.x + +The Java language version + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --incompatible_allow_tags_propagation + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --legacy_external_runfiles + +History: +- Introduced in Bazel x.x.x + +If true, build runfiles symlink forests for external repositories under .runfiles/wsname/external/repo (in addition to .runfiles/repo). + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --tls_client_key + +History: +- Introduced in Bazel x.x.x + +Specify the TLS client key to use; you also need to provide a client certificate to enable client authentication. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --remote_default_platform_properties + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --objc_use_dotd_pruning + +History: +- Introduced in Bazel x.x.x + +If set, .d files emitted by clang will be used to prune the set of inputs passed into objc compiles. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --genrule_strategy + +History: +- Introduced in Bazel x.x.x + +Specify how to execute genrules. This flag will be phased out. Instead, use --spawn_strategy= to control all actions or --strategy=Genrule= to control genrules only. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_workspace_rules_log_file + +History: +- Introduced in Bazel x.x.x + +Log certain Workspace Rules events into this file as delimited WorkspaceEvent protos. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --worker_max_instances + +History: +- Introduced in Bazel x.x.x + +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 ([-|*]) eg. "auto", "HOST_CPUS*.5". 'auto' calculates a reasonable default based on machine capacity. "=value" sets a default for unspecified mnemonics. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --run + +History: +- Introduced in Bazel x.x.x + +If false, skip running the command line constructed for the built target. Note that this flag is ignored for all --script_path builds. + +_May apply to commands: run_ + +## --incremental_install_verbosity + +History: +- Introduced in Bazel x.x.x + +The verbosity for incremental install. Set to 1 for debug logging. + +_May apply to commands: mobile-install_ + +## --experimental_build_event_upload_strategy + +History: +- Introduced in Bazel x.x.x + +Selects how to upload artifacts referenced in the build event protocol. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --bes_instance_name + +History: +- Introduced in Bazel x.x.x + +Specifies the instance name under which the BES will persist uploaded BEP. Defaults to null. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --incompatible_lexicographical_output + +History: +- Introduced in Bazel x.x.x + +If this option is set, sorts --order_output=auto output in lexicographical order. + +_May apply to commands: query_ + +## --host_linkopt + +History: +- Introduced in Bazel x.x.x + +Additional option to pass to linker when linking tools in the exec configurations. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_output_directory_naming_scheme + +History: +- Introduced in Bazel x.x.x + +Please only use this flag as part of a suggested migration or testing strategy. In legacy mode, transitions (generally only Starlark) set and use `affected by Starlark transition` to determine the ST hash. In diff_against_baseline mode, `affected by Starlark transition` is ignored and instead ST hash is determined, for all configuration, by diffing against the top-level configuration. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_remote_mark_tool_inputs + +History: +- Introduced in Bazel x.x.x + +If set to true, Bazel will mark inputs as tool inputs for the remote executor. This can be used to implement remote persistent workers. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --features + +History: +- Introduced in Bazel x.x.x + +The given features will be enabled or disabled by default for targets built in the target configuration. Specifying - will disable the feature. Negative features always override positive ones. See also --host_features + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_platform_in_output_dir + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --test_tmpdir + +History: +- Introduced in Bazel x.x.x + +Specifies the base temporary directory for 'bazel test' to use. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --incompatible_use_new_cgroup_implementation + +History: +- Introduced in Bazel x.x.x + +If true, use the new implementation for cgroups. The old implementation only supports the memory controller and ignores the value of --experimental_sandbox_limits. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --incompatible_depset_for_java_output_source_jars + +History: +- Introduced in Bazel x.x.x + +No-op. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --execution_log_binary_file + +History: +- Introduced in Bazel x.x.x + +Log the executed spawns into this file as length-delimited SpawnExec protos, according to src/main/protobuf/spawn.proto. Prefer --execution_log_compact_file, which is significantly smaller and cheaper to produce. Related flags: --execution_log_compact_file (compact format; mutually exclusive), --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). + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_remote_cache_compression_threshold + +History: +- Introduced in Bazel x.x.x + +The minimum blob size required to compress/decompress with zstd. Ineffectual unless --remote_cache_compression is set. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --per_file_ltobackendopt + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_working_set + +History: +- Introduced in Bazel x.x.x + +The working set for Skyfocus. Specify as comma-separated workspace root-relative paths. This is a stateful flag. Defining a working set persists it for subsequent invocations, until it is redefined with a new set. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_aquery_dump_after_build_format + +History: +- Introduced in Bazel x.x.x + +Writes the state of Skyframe (which includes previous invocations on this blaze instance as well) after a build. Output is streamed remotely unless local output is requested with --experimental_aquery_dump_after_build_output_file. Does not honor aquery flags for --include_*, but uses the same defaults, except for --include_commandline=false. Possible output formats: proto|streamed_proto|textproto|jsonproto. Using this will disable Skymeld. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --credential_helper + +History: +- Introduced in Bazel x.x.x + +Configures a credential helper conforming to the Credential Helper Specification 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://blog.engflow.com/2023/10/09/configuring-bazels-credential-helper/ for instructions. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --batch + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: startup_ + +## --host_javabase + +History: +- Introduced in Bazel x.x.x + +No-op. Kept here for backwards compatibility. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --order_results + +History: +- Introduced in Bazel x.x.x + +Output the results in dependency-ordered (default) or unordered fashion. The unordered output is faster but only supported when --output is not minrank, maxrank, or graph. + +_May apply to commands: query_ + +## --javabase + +History: +- Introduced in Bazel x.x.x + +No-op. Kept here for backwards compatibility. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_execution_graph_log_middleman + +History: +- Introduced in Bazel x.x.x + +Subscribe to ActionMiddlemanEvent in ExecutionGraphModule. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_cc_shared_library + +History: +- Introduced in Bazel x.x.x + +If set to true, rule attributes and Starlark API methods needed for the rule cc_shared_library will be available + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --strict_deps_java_protos + +History: +- Introduced in Bazel x.x.x + +No-op, kept only for backwards compatibility + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --build_event_json_file + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --override_repository + +History: +- Introduced in Bazel x.x.x + +Override a repository with a local path in the form of =. 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`. If the given path is empty, then remove any previous overrides. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --generate_json_trace_profile + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --per_file_copt + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --idle_server_tasks + +History: +- Introduced in Bazel x.x.x + +Run System.gc() when the server is idle + +_May apply to commands: startup_ + +## --host_action_env + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --attempt_to_print_relative_paths + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --experimental_require_availability_info + +History: +- Introduced in Bazel x.x.x + +Deprecated no-op. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_collect_worker_data_in_profiler + +History: +- Introduced in Bazel x.x.x + +If enabled, the profiler collects worker's aggregated resource data. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --enable_bzlmod + +History: +- Introduced in Bazel x.x.x + +If true, enables the Bzlmod dependency management system, taking precedence over WORKSPACE. See https://bazel.build/docs/bzlmod for more information. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --sandbox_base + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_split_coverage_postprocessing + +History: +- Introduced in Bazel x.x.x + +If true, then Bazel will run coverage postprocessing for test in a new spawn. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --watchfs + +History: +- Introduced in Bazel x.x.x + +If true, %{product} tries to use the operating system's file watch service for local changes instead of scanning every file for a change. + +_May apply to commands: startup, analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --digest_function + +History: +- Introduced in Bazel x.x.x + +The hash function to use when computing file digests. + +_May apply to commands: startup_ + +## --memory + +History: +- Introduced in Bazel x.x.x + +Dump the memory use of the given Skyframe node. + +_May apply to commands: dump_ + +## --tvos_cpus + +History: +- Introduced in Bazel x.x.x + +Comma-separated list of architectures for which to build Apple tvOS binaries. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --incompatible_disable_starlark_host_transitions + +History: +- Introduced in Bazel x.x.x + +If set to true, rule attributes cannot set 'cfg = "host"'. Rules should set 'cfg = "exec"' instead. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --color + +History: +- Introduced in Bazel x.x.x + +Use terminal controls to colorize output. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --bes_backend + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --aspects + +History: +- Introduced in Bazel x.x.x + +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. %, for example '//tools:my_def.bzl%my_aspect', where 'my_aspect' is a top-level value from a file tools/my_def.bzl + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_async_execution + +History: +- Introduced in Bazel x.x.x + +If set to true, Bazel is allowed to run action in a virtual thread. The number of actions in flight is still capped with --jobs. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --incompatible_existing_rules_immutable_view + +History: +- Introduced in Bazel x.x.x + +No-op. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --test_verbose_timeout_warnings + +History: +- Introduced in Bazel x.x.x + +If true, print additional warnings when the actual test execution time does not match the timeout defined by the test (whether implied or explicit). + +_May apply to commands: coverage, cquery, fetch, test, vendor_ + +## --universe_scope + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, cquery, query_ + +## --experimental_ui_max_stdouterr_bytes + +History: +- Introduced in Bazel x.x.x + +The maximum size of the stdout / stderr files that will be printed to the console. -1 implies no limit. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --experimental_remote_cache_ttl + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --experimental_propagate_custom_flag + +History: +- Introduced in Bazel x.x.x + +Which custom flags (starlark flags or defines) to propagate to the exec transition, by key. e.g. if '--define=a=b' should be propagated, set `--experimental_propagate_custom_flag=a` + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_always_filter_duplicate_classes_from_android_test + +History: +- Introduced in Bazel x.x.x + +If enabled and the android_test defines a binary_under_test, the class filterering applied to the test's deploy jar will always filter duplicate classes based solely on matching class and package name, ignoring hash values. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --incompatible_remote_use_new_exit_code_for_lost_inputs + +History: +- Introduced in Bazel x.x.x + +If set to true, Bazel will use new exit code 39 instead of 34 if remote cacheerrors, including cache evictions, cause the build to fail. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --remote_download_minimal + +History: +- Introduced in Bazel x.x.x + +Does not download any remote build outputs to the local machine. This flag is an alias for --remote_download_outputs=minimal. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --start + +History: +- Introduced in Bazel x.x.x + +How the app should be started after installing it. Set to WARM to preserve and restore application state on incremental installs. + +_May apply to commands: mobile-install_ + +## --test_keep_going + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --tls_authority_override + +History: +- Introduced in Bazel x.x.x + +TESTING ONLY! Can be used with a self-signed certificate to consider the specified value a valid TLS authority. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --configure + +History: +- Introduced in Bazel x.x.x + +Only fetches repositories marked as 'configure' for system-configuration purpose. Only works when --enable_bzlmod is on. + +_May apply to commands: fetch, sync_ + +## --proto_toolchain_for_cc + +History: +- Introduced in Bazel x.x.x + +Label of proto_lang_toolchain() which describes how to compile C++ protos + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --incompatible_python_disallow_native_rules + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_remote_failure_window_interval + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --experimental_dynamic_ignore_local_signals + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --cxxopt + +History: +- Introduced in Bazel x.x.x + +Additional option to pass to gcc when compiling C++ source files. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --incompatible_enable_profile_by_default + +History: +- Introduced in Bazel x.x.x + +No-op. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --short + +History: +- Introduced in Bazel x.x.x + +Show only the names of the options, not their types or meanings. + +_May apply to commands: help_ + +## --keep_going (-k) + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, query, run, sync, test, vendor_ + +## --grte_top + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --collapse_duplicate_defines + +History: +- Introduced in Bazel x.x.x + +no-op + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --batch_cpu_scheduling + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: startup_ + +## --android_migration_tag_check + +History: +- Introduced in Bazel x.x.x + +If enabled, strict usage of the Starlark migration tag is enabled for android rules. Prefer using --incompatible_disable_native_android_rules. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_publish_package_metrics_in_bep + +History: +- Introduced in Bazel x.x.x + +Whether to publish package metrics in the BEP. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --dynamic_mode + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --starlark:expr + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: cquery_ + +## --incompatible_run_shell_command_string + +History: +- Introduced in Bazel x.x.x + +If set to true, the command parameter of actions.run_shell will only accept string + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --experimental_limit_android_lint_to_android_constrained_java + +History: +- Introduced in Bazel x.x.x + +No-op, kept only for backwards compatibility + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_android_resource_name_obfuscation + +History: +- Introduced in Bazel x.x.x + +Enables obfuscation of resource names within android_binary APKs. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --install_md5 + +History: +- Introduced in Bazel x.x.x + +This launcher option is intended for use only by tests. + +_May apply to commands: startup_ + +## --experimental_retain_test_configuration_across_testonly + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_exclude_starlark_flags_from_exec_config + +History: +- Introduced in Bazel x.x.x + +If true, don't propagate starlark flags to the exec transition at default; only propagate starlark flags specified in `--experimental_propagate_custom_flag`. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --host_jvm_args + +History: +- Introduced in Bazel x.x.x + +Flags to pass to the JVM executing Blaze. + +_May apply to commands: startup_ + +## --ignore_all_rc_files + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: startup_ + +## --bes_results_url + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --interface_shared_objects + +History: +- Introduced in Bazel x.x.x + +Use interface shared objects if supported by the toolchain. All ELF toolchains currently support this setting. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --incompatible_disable_nocopts + +History: +- Introduced in Bazel x.x.x + +When enabled, it removes nocopts attribute from C++ rules. See https://github.com/bazelbuild/bazel/issues/8706 for details. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --android_manifest_merger_order + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --fat_apk_cpu + +History: +- Introduced in Bazel x.x.x + +No-op + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --cc_proto_library_header_suffixes + +History: +- Introduced in Bazel x.x.x + +Sets the suffixes of header files that a cc_proto_library creates. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --print_action_mnemonics + +History: +- Introduced in Bazel x.x.x + +Lists which mnemonics to filter print_action data by, no filtering takes place when left empty. + +_May apply to commands: print_action_ + +## --experimental_throttle_remote_action_building + +History: +- Introduced in Bazel x.x.x + +Whether to throttle the building of remote action to avoid OOM. Defaults to true. + +This is a temporary flag to allow users switch off the behaviour. Once Bazel is smart enough about the RAM/CPU usages, this flag will be removed. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --incompatible_check_visibility_for_toolchains + +History: +- Introduced in Bazel x.x.x + +If enabled, visibility checking also applies to toolchain implementations. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_collect_load_average_in_profiler + +History: +- Introduced in Bazel x.x.x + +If enabled, the profiler collects the system's overall load average. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --proto:rule_classes + +History: +- Introduced in Bazel x.x.x + +Populate the rule_class_key field of each rule; and for the first rule with a given rule_class_key, also populate its rule_class_info proto field. The rule_class_key field uniquely identifies a rule class, and the rule_class_info field is a Stardoc-format rule class API definition. + +_May apply to commands: aquery, cquery, query_ + +## --experimental_prefer_mutual_xcode + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --repo + +History: +- Introduced in Bazel x.x.x + +Only fetches the specified repository, which can be either {@apparent_repo_name} or {@@canonical_repo_name}. Only works when --enable_bzlmod is on. + +_May apply to commands: fetch, vendor_ + +## --build_event_max_named_set_of_file_entries + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --host_javacopt + +History: +- Introduced in Bazel x.x.x + +Additional options to pass to javac when building tools that are executed during a build. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_total_worker_memory_limit_mb + +History: +- Introduced in Bazel x.x.x + +If this limit is greater than zero idle workers might be killed if the total memory usage of all workers exceed the limit. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --incompatible_dont_use_javasourceinfoprovider + +History: +- Introduced in Bazel x.x.x + +No-op + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_override_name_platform_in_output_dir + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --remote_result_cache_priority + +History: +- Introduced in Bazel x.x.x + +The relative priority of remote actions to be stored in remote cache. The semantics of the particular priority values are server-dependent. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --override_module + +History: +- Introduced in Bazel x.x.x + +Override a module with a local path in the form of =. 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`. If the given path is empty, then remove any previous overrides. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --repositories_without_autoloads + +History: +- Introduced in Bazel x.x.x + +A list of additional repositories (beyond the hardcoded ones Bazel knows about) where autoloads are not to be added. This should typically contain repositories that are transitively depended on by a repository that may be loaded automatically (and which can therefore potentially create a cycle). + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --mobile_install_aspect + +History: +- Introduced in Bazel x.x.x + +The aspect to use for mobile-install. + +_May apply to commands: mobile-install_ + +## --platform_mappings + +History: +- Introduced in Bazel x.x.x + +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). + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_dynamic_local_load_factor + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --remote_executor + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --always_profile_slow_operations + +History: +- Introduced in Bazel x.x.x + +Whether profiling slow operations is always turned on + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --cs_fdo_instrument + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --rc_source + +History: +- Introduced in Bazel x.x.x + + + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --break_build_on_parallel_dex2oat_failure + +History: +- Introduced in Bazel x.x.x + +If true dex2oat action failures will cause the build to break instead of executing dex2oat during test runtime. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_isolated_extension_usages + +History: +- Introduced in Bazel x.x.x + +If true, enables the isolate parameter in the use_extension function. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --non_incremental_per_target_dexopts + +History: +- Introduced in Bazel x.x.x + +dx flags that that prevent incremental dexing for binary targets that list any of the flags listed here in their 'dexopts' attribute, which are ignored with incremental dexing (superseding --dexopts_supported_in_incremental_dexing). Defaults to --positions for safety but can in general be used to make sure the listed dx flags are honored, with additional build latency. Please notify us if you find yourself needing this flag. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --ui_actions_shown + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --test_result_expiration + +History: +- Introduced in Bazel x.x.x + +This option is deprecated and has no effect. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --objc_enable_binary_stripping + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --for_command + +History: +- Introduced in Bazel x.x.x + +The command for which the options should be canonicalized. + +_May apply to commands: canonicalize-flags_ + +## --combined_report + +History: +- Introduced in Bazel x.x.x + +Specifies desired cumulative coverage report type. At this point only LCOV is supported. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --verbose_explanations + +History: +- Introduced in Bazel x.x.x + +Increases the verbosity of the explanations issued if --explain is enabled. Has no effect if --explain is not enabled. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --fetch + +History: +- Introduced in Bazel x.x.x + +Allows the command to fetch external dependencies. If set to false, the command will utilize any cached version of the dependency, and if none exists, the command will result in failure. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, mod, print_action, query, run, sync, test, vendor_ + +## --watchos_cpus + +History: +- Introduced in Bazel x.x.x + +Comma-separated list of architectures for which to build Apple watchOS binaries. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --gc_thrashing_threshold + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --max_test_output_bytes + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --check_bazel_compatibility + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --incompatible_simplify_unconditional_selects_in_rule_attrs + +History: +- Introduced in Bazel x.x.x + +If true, simplify configurable rule attributes which contain only unconditional selects; for example, if ["a"] + select("//conditions:default", ["b"]) is assigned to a rule attribute, it is stored as ["a", "b"]. This option does not affect attributes of symbolic macros or attribute default values. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --xcode_version + +History: +- Introduced in Bazel x.x.x + +If specified, uses Xcode of the given version for relevant build actions. If unspecified, uses the executor default version of Xcode. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --allow_analysis_failures + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_execution_graph_enable_edges_from_filewrite_actions + +History: +- Introduced in Bazel x.x.x + +Handle edges from filewrite actions to their inputs correctly. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --record_full_profiler_data + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --cycles + +History: +- Introduced in Bazel x.x.x + +Points out dependency cycles inside the displayed tree, which are normally ignored by default. + +_May apply to commands: mod_ + +## --incompatible_config_setting_private_default_visibility + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, mod, print_action, query, run, sync, test, vendor_ + +## --incompatible_python_disable_py2 + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --transitions + +History: +- Introduced in Bazel x.x.x + +The format in which cquery will print transition information. + +_May apply to commands: cquery_ + +## --experimental_android_assume_minsdkversion + +History: +- Introduced in Bazel x.x.x + +When enabled, the minSdkVersion is parsed from the merged AndroidManifest and used to instruct Proguard on valid Android build versions. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --isatty + +History: +- Introduced in Bazel x.x.x + +A system-generated parameter which is used to notify the server whether this client is running in a terminal. If this is set to false, then '--color=auto' will be treated as '--color=no'. If this is set to true, then '--color=auto' will be treated as '--color=yes'. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --python_path + +History: +- Introduced in Bazel x.x.x + +The absolute path of the Python interpreter invoked to run Python targets on the target platform. Deprecated; disabled by --incompatible_use_python_toolchains. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --incompatible_require_javaplugininfo_in_javacommon + +History: +- Introduced in Bazel x.x.x + +When enabled java_common.compile only accepts JavaPluginInfo for plugins. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --internal_persistent_busybox_tools + +History: +- Introduced in Bazel x.x.x + +Tracking flag for when busybox workers are enabled. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --extra_execution_platforms + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --host_compilation_mode + +History: +- Introduced in Bazel x.x.x + +Specify the mode the tools used during the build will be built in. Values: 'fastbuild', 'dbg', 'opt'. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --proto_compiler + +History: +- Introduced in Bazel x.x.x + +The label of the proto-compiler. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --spawn_strategy + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_remote_downloader + +History: +- Introduced in Bazel x.x.x + +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 + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --build_event_upload_max_retries + +History: +- Introduced in Bazel x.x.x + +The maximum number of times Bazel should retry uploading a build event. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --build_runfile_links + +History: +- Introduced in Bazel x.x.x + +If true, build runfiles symlink forests for all targets. If false, write them only when required by a local action, test or run command. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --tool_deps + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, cquery, query_ + +## --experimental_remote_merkle_tree_cache_size + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --reuse_sandbox_directories + +History: +- Introduced in Bazel x.x.x + +If set to true, directories used by sandboxed non-worker execution may be reused to avoid unnecessary setup costs. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --run_validations + +History: +- Introduced in Bazel x.x.x + +Whether to run validation actions as part of the build. See https://bazel.build/extending/rules#validation_actions + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --ltoindexopt + +History: +- Introduced in Bazel x.x.x + +Additional option to pass to the LTO indexing step (under --features=thin_lto). + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --incompatible_require_linker_input_cc_api + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --test_output + +History: +- Introduced in Bazel x.x.x + +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). + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_sibling_repository_layout + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --remote_downloader_header + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --incompatible_enforce_config_setting_visibility + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, mod, print_action, query, run, sync, test, vendor_ + +## --incompatible_sandbox_hermetic_tmp + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --incompatible_exclusive_test_sandboxed + +History: +- Introduced in Bazel x.x.x + +If true, exclusive tests will run with sandboxed strategy. Add 'local' tag to force an exclusive test run locally + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --embed_label + +History: +- Introduced in Bazel x.x.x + +Embed source control revision or release label in binary + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --install_base + +History: +- Introduced in Bazel x.x.x + +This launcher option is intended for use only by tests. + +_May apply to commands: startup_ + +## --output_user_root + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: startup_ + +## --incompatible_use_specific_tool_files + +History: +- Introduced in Bazel x.x.x + +Use cc toolchain's compiler_files, as_files, and ar_files as inputs to appropriate actions. See https://github.com/bazelbuild/bazel/issues/8531 + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_skymeld_analysis_overlap_percentage + +History: +- Introduced in Bazel x.x.x + +The value represents the % of the analysis phase which will be overlapped with the execution phase. A value of x means Skyframe will queue up execution tasks and wait until there's x% of the top level target left to be analyzed before allowing them to launch. When the value is 0%, we'd wait for all analysis to finish before executing (no overlap). When it's 100%, the phases are free to overlap as much as they can. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --proto_toolchain_for_j2objc + +History: +- Introduced in Bazel x.x.x + +Label of proto_lang_toolchain() which describes how to compile j2objc protos + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --dynamic_local_execution_delay + +History: +- Introduced in Bazel x.x.x + +How many milliseconds should local execution be delayed, if remote execution was faster during a build at least once? + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_builtins_injection_override + +History: +- Introduced in Bazel x.x.x + +A comma-separated list of symbol names prefixed by a + or - character, indicating which symbols from `@_builtins//:exports.bzl` to inject, overriding their default injection status. Precisely, this works as follows. Each dict key of `exported_toplevels` or `exported_rules` has the form `foo`, `+foo`, or `-foo`. The first two forms mean it gets injected by default, while the last form means it does not get injected by default. In the first case (unprefixed), the default is absolute and cannot be overridden. Otherwise, we then consult this options list, and if we see foo occur here, we take the prefix of its last occurrence and use that to decide whether or not to inject. It is a no-op to specify an unknown symbol, or to attempt to not inject a symbol that occurs unprefixed in a dict key. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --experimental_merged_skyframe_analysis_execution + +History: +- Introduced in Bazel x.x.x + +If this flag is set, the analysis and execution phases of Skyframe are merged. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --incompatible_visibility_private_attributes_at_definition + +History: +- Introduced in Bazel x.x.x + +No-op + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --allowed_cpu_values + +History: +- Introduced in Bazel x.x.x + +Allowed values for the --cpu flag. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --host_jvm_debug + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: startup_ + +## --experimental_add_test_support_to_compile_time_deps + +History: +- Introduced in Bazel x.x.x + +Flag to help transition away from adding test support libraries to the compile-time deps of Java test rules. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --extension_filter + +History: +- Introduced in Bazel x.x.x + +Only display the usages of these module extensions and the repos generated by them if their respective flags are set. If set, the result graph will only include paths that contain modules using the specified extensions. An empty list disables the filter, effectively specifying all possible extensions. + +_May apply to commands: mod_ + +## --proto:output_rule_attrs + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, cquery, query_ + +## --build_event_text_file_upload_mode + +History: +- Introduced in Bazel x.x.x + +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'. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --ios_sdk_version + +History: +- Introduced in Bazel x.x.x + +Specifies the version of the iOS SDK to use to build iOS applications. If unspecified, uses the default iOS SDK version from 'xcode_version'. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --discard_analysis_cache + +History: +- Introduced in Bazel x.x.x + +Discard the analysis cache immediately after the analysis phase completes. Reduces memory usage by ~10%, but makes further incremental builds slower. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --sandbox_block_path + +History: +- Introduced in Bazel x.x.x + +For sandboxed actions, disallow access to this path. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --max_computation_steps + +History: +- Introduced in Bazel x.x.x + +The maximum number of Starlark computation steps that may be executed by a BUILD file (zero means no limit). + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --track_incremental_state + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --scl_config + +History: +- Introduced in Bazel x.x.x + +Name of the scl config defined in PROJECT.scl. Note that this feature is still under development b/324119879. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --instrument_test_targets + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --unix_digest_hash_attribute_name + +History: +- Introduced in Bazel x.x.x + +The name of an extended attribute that can be placed on files to store a precomputed copy of the file's hash, corresponding with --digest_function. This option can be used to reduce disk I/O and CPU load caused by hash computation. This extended attribute is checked on all source files and output files, meaning that it causes a significant number of invocations of the getxattr() system call. + +_May apply to commands: startup_ + +## --bes_lifecycle_events + +History: +- Introduced in Bazel x.x.x + +Specifies whether to publish BES lifecycle events. (defaults to 'true'). + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --experimental_inprocess_symlink_creation + +History: +- Introduced in Bazel x.x.x + +Whether to make direct filesystem calls to create symlink trees instead of delegating to a helper process. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --incompatible_disable_native_repo_rules + +History: +- Introduced in Bazel x.x.x + +If false, native repo rules can be used in WORKSPACE; otherwise, Starlark repo rules must be used instead. Native repo rules include local_repository, new_local_repository, local_config_platform, and android_sdk_repository. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --extension_info + +History: +- Introduced in Bazel x.x.x + +Specify how much detail about extension usages to include in the query result. "Usages" will only show the extensions names, "repos" will also include repos imported with use_repo, and "all" will also show the other repositories generated by extensions. + + +_May apply to commands: mod_ + +## --incompatible_do_not_split_linking_cmdline + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --optimizing_dexer + +History: +- Introduced in Bazel x.x.x + +Specifies a binary to use to do dexing without sharding. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_disable_external_package + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --output_library_merged_assets + +History: +- Introduced in Bazel x.x.x + +If disabled, does not produce merged asset.zip outputs for library targets + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --incompatible_use_cpp_compile_header_mnemonic + +History: +- Introduced in Bazel x.x.x + +If enabled, give distinguishing mnemonic to header processing actions + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --build + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --xcode_version_config + +History: +- Introduced in Bazel x.x.x + +The label of the xcode_config rule to be used for selecting the Xcode version in the build configuration. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --macos_sdk_version + +History: +- Introduced in Bazel x.x.x + +Specifies the version of the macOS SDK to use to build macOS applications. If unspecified, uses the default macOS SDK version from 'xcode_version'. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --persistent_multiplex_android_resource_processor + +History: +- Introduced in Bazel x.x.x + +Enable persistent multiplexed Android resource processor by using workers. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_exclude_defines_from_exec_config + +History: +- Introduced in Bazel x.x.x + +If true, don't propagate '--define's to the exec transition at default; only propagate defines specified by `--experimental_propagate_custom_flag`. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_filter_library_jar_with_program_jar + +History: +- Introduced in Bazel x.x.x + +Filter the ProGuard ProgramJar to remove any classes also present in the LibraryJar. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_remove_r_classes_from_instrumentation_test_jar + +History: +- Introduced in Bazel x.x.x + +If enabled and the test instruments an application, all the R classes from the test's deploy jar will be removed. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --build_tag_filters + +History: +- Introduced in Bazel x.x.x + +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' + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_build_event_expand_filesets + +History: +- Introduced in Bazel x.x.x + +If true, expand Filesets in the BEP when presenting output files. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --experimental_disk_cache_gc_idle_delay + +History: +- Introduced in Bazel x.x.x + +How long the server must remain idle before a garbage collection of the disk cache occurs. To specify the garbage collection policy, set --experimental_disk_cache_gc_max_size and/or --experimental_disk_cache_gc_max_age. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --extra_toolchains + +History: +- Introduced in Bazel x.x.x + +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(). + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --conlyopt + +History: +- Introduced in Bazel x.x.x + +Additional option to pass to gcc when compiling C source files. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --include_config_fragments_provider + +History: +- Introduced in Bazel x.x.x + +INTERNAL BLAZE DEVELOPER FEATURE: If "direct", all configured targets expose RequiredConfigFragmentsProvider with the configuration fragments they directly require. If "transitive", they do the same but also include the fragments their transitive dependencies require. If "off", the provider is omitted. If not "off", this also populates config_setting's ConfigMatchingProvider.requiredFragmentOptions with the fragment options the config_setting requires.Be careful using this feature: it adds memory to every configured target in the build. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --http_timeout_scaling + +History: +- Introduced in Bazel x.x.x + +Scale all timeouts related to http downloads by the given factor + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --include_aspects + +History: +- Introduced in Bazel x.x.x + +aquery, cquery: whether to include aspect-generated actions in the output. query: no-op (aspects are always followed). + +_May apply to commands: aquery, cquery, query_ + +## --progress_in_terminal_title + +History: +- Introduced in Bazel x.x.x + +Show the command progress in the terminal title. Useful to see what bazel is doing when having multiple terminal tabs. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --google_auth_scopes + +History: +- Introduced in Bazel x.x.x + +A comma-separated list of Google Cloud authentication scopes. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --experimental_use_scheduling_middlemen + +History: +- Introduced in Bazel x.x.x + +Deprecated. No-op. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_skylark_debug_reset_analysis + +History: +- Introduced in Bazel x.x.x + +If true, resets analysis before executing the build. Has no effect without --experimental_skylark_debug + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --android_crosstool_top + +History: +- Introduced in Bazel x.x.x + +No-op + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --server_jvm_out + +History: +- Introduced in Bazel x.x.x + +The location to write the server's JVM's output. If unset then defaults to a location in output_base. + +_May apply to commands: startup_ + +## --bes_proxy + +History: +- Introduced in Bazel x.x.x + +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). + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --workspace_rc + +History: +- Introduced in Bazel x.x.x + +Whether or not to look for the workspace bazelrc file at $workspace/.bazelrc + +_May apply to commands: startup_ + +## --include_artifacts + +History: +- Introduced in Bazel x.x.x + +Includes names of the action inputs and outputs in the output (potentially large). + +_May apply to commands: aquery_ + +## --incompatible_override_toolchain_transition + +History: +- Introduced in Bazel x.x.x + +Deprecated, this is no longer in use and should be removed. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --run_in_client + +History: +- Introduced in Bazel x.x.x + +If true, the mobile-install deployer command will be sent to the bazel client for execution. Useful for configurations where the bazel client is on a different machine than the bazel server. + +_May apply to commands: mobile-install_ + +## --build_event_json_file_path_conversion + +History: +- Introduced in Bazel x.x.x + +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 + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --experimental_local_java_optimization_configuration + +History: +- Introduced in Bazel x.x.x + +Do not use. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_sandbox_async_tree_delete_idle_threads + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --local_test_jobs + +History: +- Introduced in Bazel x.x.x + +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 ([-|*]) 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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_worker_for_repo_fetching + +History: +- Introduced in Bazel x.x.x + +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 virtual worker thread. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --experimental_local_lockfree_output + +History: +- Introduced in Bazel x.x.x + +When true, the local spawn runner doesn't lock the output tree during dynamic execution. Instead, spawns are allowed to execute until they are explicitly interrupted by a faster remote action. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_java_proto_add_allowed_public_imports + +History: +- Introduced in Bazel x.x.x + +This flag is a noop and scheduled for removal. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --bes_check_preceding_lifecycle_events + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --experimental_parallel_aquery_output + +History: +- Introduced in Bazel x.x.x + +No-op. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --target_pattern_file + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --java_optimization_mode + +History: +- Introduced in Bazel x.x.x + +Do not use. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --experimental_spawn_scheduler + +History: +- Introduced in Bazel x.x.x + +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==dynamic` flags instead. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --repo_env + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --xml:default_values + +History: +- Introduced in Bazel x.x.x + +If true, rule attributes whose value is not explicitly specified in the BUILD file are printed; otherwise they are omitted. + +_May apply to commands: query_ + +## --max_config_changes_to_show + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --profile + +History: +- Introduced in Bazel x.x.x + +If set, profile Bazel and write data to the specified file. Use bazel analyze-profile to analyze the profile. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --internal_persistent_multiplex_android_dex_desugar + +History: +- Introduced in Bazel x.x.x + +Tracking flag for when multiplexed dexing and desugaring workers are enabled. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_bytecode_optimizers + +History: +- Introduced in Bazel x.x.x + +Do not use. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --allow_local_tests + +History: +- Introduced in Bazel x.x.x + +If true, Bazel will allow local tests to run. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_build_transitive_python_runfiles + +History: +- Introduced in Bazel x.x.x + +No-op + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --discard_actions_after_execution + +History: +- Introduced in Bazel x.x.x + +This option is deprecated and has no effect. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --host_java_toolchain + +History: +- Introduced in Bazel x.x.x + +No-op. Kept here for backwards compatibility. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --extension_usages + +History: +- Introduced in Bazel x.x.x + +Specify modules whose extension usages will be displayed in the show_extension query. + +_May apply to commands: mod_ + +## --remote_retry_max_delay + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --experimental_include_xcode_execution_requirements + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --order_output + +History: +- Introduced in Bazel x.x.x + +Output the results unordered (no), dependency-ordered (deps), or fully ordered (full). The default is 'auto', meaning that results are output either dependency-ordered or fully ordered, depending on the output formatter (dependency-ordered for proto, minrank, maxrank, and graph, fully ordered for all others). When output is fully ordered, nodes are printed in a fully deterministic (total) order. First, all nodes are sorted alphabetically. Then, each node in the list is used as the start of a post-order depth-first search in which outgoing edges to unvisited nodes are traversed in alphabetical order of the successor nodes. Finally, nodes are printed in the reverse of the order in which they were visited. + +_May apply to commands: query_ + +## --memory_profile_stable_heap_parameters + +History: +- Introduced in Bazel x.x.x + +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 + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --experimental_java_library_export + +History: +- Introduced in Bazel x.x.x + +If enabled, experimental_java_library_export_do_not_use module is available. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --experimental_check_output_files + +History: +- Introduced in Bazel x.x.x + +Check for modifications made to the output files of a build. Consider setting this flag to false if you don't expect these files to change outside of bazel since it will speed up subsequent runs as they won't have to check a previous run's cache. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, mod, print_action, query, run, sync, test, vendor_ + +## --experimental_cpp_modules + +History: +- Introduced in Bazel x.x.x + +Enables experimental C++20 modules support. Use it with `module_interfaces` attribute on `cc_binary` and `cc_library`. While the support is behind the experimental flag, there are no guarantees about incompatible changes to it or even keeping the support in the future. Consider those risks when using it. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --incompatible_disable_legacy_cc_provider + +History: +- Introduced in Bazel x.x.x + +No-op flag. Will be removed in a future release. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --incompatible_auto_exec_groups + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_use_llvm_covmap + +History: +- Introduced in Bazel x.x.x + +If specified, Bazel will generate llvm-cov coverage map information rather than gcov when collect_code_coverage is enabled. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --mobile_install_supported_rules + +History: +- Introduced in Bazel x.x.x + +The supported rules for mobile-install. + +_May apply to commands: mobile-install_ + +## --directory_creation_cache + +History: +- Introduced in Bazel x.x.x + +Describes the cache used to store known regular directories as they're created. Parent directories of output files are created on-demand during action execution. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_platforms_api + +History: +- Introduced in Bazel x.x.x + +If set to true, enables a number of platform-related Starlark APIs useful for debugging. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --incompatible_no_attr_license + +History: +- Introduced in Bazel x.x.x + +If set to true, disables the function `attr.license`. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --incompatible_disable_non_executable_java_binary + +History: +- Introduced in Bazel x.x.x + +If true, java_binary is always executable. create_executable attribute is removed. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --build_event_text_file_path_conversion + +History: +- Introduced in Bazel x.x.x + +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 + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --package_path + +History: +- Introduced in Bazel x.x.x + +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'. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, mod, print_action, query, run, sync, test, vendor_ + +## --experimental_google_legacy_api + +History: +- Introduced in Bazel x.x.x + +If set to true, exposes a number of experimental pieces of Starlark build API pertaining to Google legacy code. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --experimental_collect_system_network_usage + +History: +- Introduced in Bazel x.x.x + +If enabled, the profiler collects the system's network usage. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --jobs (-j) + +History: +- Introduced in Bazel x.x.x + +The number of concurrent jobs to run. Takes an integer, or a keyword ("auto", "HOST_CPUS", "HOST_RAM"), optionally followed by an operation ([-|*]) 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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --enable_runfiles + +History: +- Introduced in Bazel x.x.x + +Enable runfiles symlink tree; By default, it's off on Windows, on on other platforms. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --split_apks + +History: +- Introduced in Bazel x.x.x + +Whether to use split apks to install and update the application on the device. Works only with devices with Marshmallow or later + +_May apply to commands: mobile-install_ + +## --command_port + +History: +- Introduced in Bazel x.x.x + +Port to start up the gRPC command server on. If 0, let the kernel choose. + +_May apply to commands: startup_ + +## --incompatible_use_cc_configure_from_rules_cc + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --legacy_globbing_threads + +History: +- Introduced in Bazel x.x.x + +Number of threads to use for glob evaluation. Takes an integer, or a keyword ("auto", "HOST_CPUS", "HOST_RAM"), optionally followed by an operation ([-|*]) eg. "auto", "HOST_CPUS*.5". "auto" means to use a reasonable value derived from the machine's hardware profile (e.g. the number of processors). + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, mod, print_action, query, run, sync, test, vendor_ + +## --vendor_dir + +History: +- Introduced in Bazel x.x.x + +Specifies the directory that should hold the external repositories in vendor mode, whether for the purpose of fetching them into it or using them while building. The path can be specified as either an absolute path or a path relative to the workspace directory. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --experimental_convenience_symlinks + +History: +- Introduced in Bazel x.x.x + +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 not be created or cleaned up. + 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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --test_summary + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --binary_path + +History: +- Introduced in Bazel x.x.x + +The absolute path of the bazel binary. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --enforce_project_configs + +History: +- Introduced in Bazel x.x.x + +If true, interactive builds may only pass the --scl_config build flag; they may not use any other build flags. --scl_config must be set to an officially suported project configuration. Supported configurations are defined in the target's PROJECT.scl, which can be found by walking up the target's packagge path. See b/324126745. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --runs_per_test_detects_flakes + +History: +- Introduced in Bazel x.x.x + +If true, any shard in which at least one run/attempt passes and at least one run/attempt fails gets a FLAKY status. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --config + +History: +- Introduced in Bazel x.x.x + +Selects additional config sections from the rc files; for every , it also pulls in the options from : 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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --disk_cache + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --host_cpu + +History: +- Introduced in Bazel x.x.x + +The host CPU. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_cpp_compile_resource_estimation + +History: +- Introduced in Bazel x.x.x + +If enabled, will estimate precise resource usage for local execution of CppCompileAction. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_collect_resource_estimation + +History: +- Introduced in Bazel x.x.x + +If enabled, the profiler collects CPU and memory usage estimation for local actions. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --proto:include_attribute_source_aspects + +History: +- Introduced in Bazel x.x.x + +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). + +_May apply to commands: aquery, cquery, query_ + +## --incompatible_disable_legacy_flags_cc_toolchain_api + +History: +- Introduced in Bazel x.x.x + +Flag for disabling the legacy cc_toolchain Starlark API for accessing legacy CROSSTOOL fields. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --remote_download_regex + +History: +- Introduced in Bazel x.x.x + +Force remote build outputs whose path matches this pattern to be downloaded, irrespective of --remote_download_outputs. Multiple patterns may be specified by repeating this flag. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --java_runtime_version + +History: +- Introduced in Bazel x.x.x + +The Java runtime version + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --cc_output_directory_tag + +History: +- Introduced in Bazel x.x.x + +Specifies a suffix to be added to the configuration directory. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --min_param_file_size + +History: +- Introduced in Bazel x.x.x + +Minimum command line length before creating a parameter file. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --execution_log_compact_file + +History: +- Introduced in Bazel x.x.x + +Log the executed spawns into this file as length-delimited ExecLogEntry protos, according to src/main/protobuf/spawn.proto. The entire file is zstd compressed. Related flags: --execution_log_binary_file (binary protobuf format; mutually exclusive), --execution_log_json_file (text JSON format; mutually exclusive), --subcommands (for displaying subcommands in terminal output). + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --strict_public_imports + +History: +- Introduced in Bazel x.x.x + +Unless OFF, checks that a proto_library target explicitly declares all targets used in 'import public' as exported. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_android_rewrite_dexes_with_rex + +History: +- Introduced in Bazel x.x.x + +use rex tool to rewrite dex files + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --legacy_important_outputs + +History: +- Introduced in Bazel x.x.x + +Use this to suppress generation of the legacy important_outputs field in the TargetComplete event. important_outputs are required for Bazel to ResultStore/BTX integration. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --remote_timeout + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --experimental_single_package_toolchain_binding + +History: +- Introduced in Bazel x.x.x + +If enabled, the register_toolchain function may not include target patterns which may refer to more than one package. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --experimental_unsupported_and_brittle_include_scanning + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_remote_scrubbing_config + +History: +- Introduced in Bazel x.x.x + +Enables remote cache key scrubbing with the supplied configuration file, which must be a protocol buffer in text format (see src/main/protobuf/remote_scrubbing.proto). + +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. Scrubbed actions are incompatible with remote execution, and will always be executed locally instead. + +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). + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --experimental_fix_deps_tool + +History: +- Introduced in Bazel x.x.x + +Specifies which tool should be used to resolve missing dependencies. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --check_tests_up_to_date + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --home_rc + +History: +- Introduced in Bazel x.x.x + +Whether or not to look for the home bazelrc file at $HOME/.bazelrc + +_May apply to commands: startup_ + +## --incompatible_require_ctx_in_configure_features + +History: +- Introduced in Bazel x.x.x + +This flag is a noop and scheduled for removal. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_remote_capture_corrupted_outputs + +History: +- Introduced in Bazel x.x.x + +A path to a directory where the corrupted outputs will be captured to. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --experimental_disallow_legacy_java_toolchain_flags + +History: +- Introduced in Bazel x.x.x + +If enabled, disallow legacy Java toolchain flags (--javabase, --host_javabase, --java_toolchain, --host_java_toolchain) and require the use of --platforms instead; see #7849 + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --debug_spawn_scheduler + +History: +- Introduced in Bazel x.x.x + + + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --incompatible_always_include_files_in_data + +History: +- Introduced in Bazel x.x.x + +If true, native rules add DefaultInfo.files of data dependencies to their runfiles, which matches the recommended behavior for Starlark rules (https://bazel.build/extending/rules#runfiles_features_to_avoid). + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_convenience_symlinks_bep_event + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --google_default_credentials + +History: +- Introduced in Bazel x.x.x + +Whether to use 'Google Application Default Credentials' for authentication. See https://cloud.google.com/docs/authentication for details. Disabled by default. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --include_unused + +History: +- Introduced in Bazel x.x.x + +The queries will also take into account and display the unused modules, which are not present in the module resolution graph after selection (due to the Minimal-Version Selection or override rules). This can have different effects for each of the query types i.e. include new paths in the all_paths command, or extra dependants in the explain command. + +_May apply to commands: mod_ + +## --google_credentials + +History: +- Introduced in Bazel x.x.x + +Specifies the file to get authentication credentials from. See https://cloud.google.com/docs/authentication for details. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --experimental_parse_headers_skipped_if_corresponding_srcs_found + +History: +- Introduced in Bazel x.x.x + +No-op. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --j2objc_dead_code_report + +History: +- Introduced in Bazel x.x.x + +Allows J2ObjC to strip dead code reported by ProGuard. Takes a label that can generate a dead code report as argument. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_remotable_source_manifests + +History: +- Introduced in Bazel x.x.x + +Whether to make source manifest actions remotable + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_omitfp + +History: +- Introduced in Bazel x.x.x + +If true, use libunwind for stack unwinding, and compile with -fomit-frame-pointer and -fasynchronous-unwind-tables. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --incompatible_j2objc_library_migration + +History: +- Introduced in Bazel x.x.x + +If enabled, direct usage of the native j2objc_library rules is disabled. Please use the Starlark rule instead. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --invocation_id + +History: +- Introduced in Bazel x.x.x + +Unique identifier, in UUID format, for the command being run. If explicitly specified uniqueness must be ensured by the caller. The UUID is printed to stderr, the BEP and remote execution protocol. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --enforce_proguard_file_extension + +History: +- Introduced in Bazel x.x.x + +If enabled, requires that ProGuard configuration files outside of third_party/ use the *.pgcfg file extension. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_debug_selects_always_succeed + +History: +- Introduced in Bazel x.x.x + +When set, select functions with no matching clause will return an empty value, instead of failing. This is to help use cquery diagnose failures in select. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --remote_bytestream_uri_prefix + +History: +- Introduced in Bazel x.x.x + +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}". + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --proto:locations + +History: +- Introduced in Bazel x.x.x + +Whether to output location information in proto output at all. + +_May apply to commands: aquery, cquery, query_ + +## --experimental_remote_include_extraction_size_threshold + +History: +- Introduced in Bazel x.x.x + +Run remotable C++ include extraction remotely if the file size in bytes exceeds this. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_android_library_exports_manifest_default + +History: +- Introduced in Bazel x.x.x + +The default value of the exports_manifest attribute on android_library. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --incompatible_dont_enable_host_nonhost_crosstool_features + +History: +- Introduced in Bazel x.x.x + +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). + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_persistent_aar_extractor + +History: +- Introduced in Bazel x.x.x + +Enable persistent aar extractor by using workers. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --check_fileset_dependencies_recursively + +History: +- Introduced in Bazel x.x.x + + + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --enable_remaining_fdo_absolute_paths + +History: +- Introduced in Bazel x.x.x + +If set, any use of absolute paths for FDO will raise an error. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --shell_executable + +History: +- Introduced in Bazel x.x.x + +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:/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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --python_top + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --j2objc_translation_flags + +History: +- Introduced in Bazel x.x.x + +Additional options to pass to the J2ObjC tool. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_use_dex_splitter_for_incremental_dexing + +History: +- Introduced in Bazel x.x.x + +Do not use. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --persistent_multiplex_android_tools + +History: +- Introduced in Bazel x.x.x + +Enable persistent and multiplexed Android tools (dexing, desugaring, resource processing). + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --java_toolchain + +History: +- Introduced in Bazel x.x.x + +No-op. Kept here for backwards compatibility. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_sandbox_limits + +History: +- Introduced in Bazel x.x.x + +If > 0, each Linux sandbox will be limited to the given amount for the specified resource. Requires --incompatible_use_new_cgroup_implementation and overrides --experimental_sandbox_memory_limit_mb. Requires cgroups v1 or v2 and permissions for the users to the cgroups dir. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_execution_graph_log_path + +History: +- Introduced in Bazel x.x.x + +Local path at which the execution path will be written. If this is set, the log will only be written locally, and not to BEP. If this is set when experimental_enable_execution_graph_log is disabled, there will be an error. If this is unset while BEP uploads are disabled and experimental_enable_execution_graph_log is enabled, the log will be written to a local default. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_inmemory_dotd_files + +History: +- Introduced in Bazel x.x.x + +If enabled, C++ .d files will be passed through in memory directly from the remote build nodes instead of being written to disk. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --cache_computed_file_digests + +History: +- Introduced in Bazel x.x.x + +If greater than 0, configures Bazel to cache file digests in memory based on their metadata instead of recomputing the digests from disk every time they are needed. Setting this to 0 ensures correctness because not all file changes can be noted from file metadata. When not 0, the number indicates the size of the cache as the number of file digests to be cached. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_docker_use_customized_images + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --default_system_javabase + +History: +- Introduced in Bazel x.x.x + +The root of the user's local JDK install, to be used as the default target javabase and as a fall-back host_javabase. This is not the embedded JDK. + +_May apply to commands: startup_ + +## --test_strategy + +History: +- Introduced in Bazel x.x.x + +Specifies which strategy to use when running tests. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --proto:rule_inputs_and_outputs + +History: +- Introduced in Bazel x.x.x + +Whether or not to populate the rule_input and rule_output fields. + +_May apply to commands: aquery, cquery, query_ + +## --use_top_level_targets_for_symlinks + +History: +- Introduced in Bazel x.x.x + +Deprecated. No-op. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_extended_sanity_checks + +History: +- Introduced in Bazel x.x.x + +Enables internal validation checks to make sure that configured target implementations only access things they should. Causes a performance hit. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_worker_cancellation + +History: +- Introduced in Bazel x.x.x + +If enabled, Bazel may send cancellation requests to workers that support them. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_use_windows_sandbox + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --bes_header + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --incompatible_disable_native_apple_binary_rule + +History: +- Introduced in Bazel x.x.x + +No-op. Kept here for backwards compatibility. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --proto:definition_stack + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, cquery, query_ + +## --failure_detail_out + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: startup_ + +## --experimental_profile_additional_tasks + +History: +- Introduced in Bazel x.x.x + +Specifies additional profile tasks to be included in the profile. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --include_pruned_inputs + +History: +- Introduced in Bazel x.x.x + +Includes action inputs that were pruned during action execution. Only affects actions that discover inputs and have been executed in a previous invocation. Only takes effect if --include_artifacts is also set. + +_May apply to commands: aquery_ + +## --propeller_optimize_absolute_cc_profile + +History: +- Introduced in Bazel x.x.x + +Absolute path name of cc_profile file for Propeller Optimized builds. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_rule_extension_api + +History: +- Introduced in Bazel x.x.x + +Enable experimental rule extension API and subrule APIs + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --explain + +History: +- Introduced in Bazel x.x.x + +Causes the build system to explain each executed step of the build. The explanation is written to the specified log file. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --propeller_optimize_absolute_ld_profile + +History: +- Introduced in Bazel x.x.x + +Absolute path name of ld_profile file for Propeller Optimized builds. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --jplPropagateCcLinkParamsStore + +History: +- Introduced in Bazel x.x.x + +No-op, kept only for backwards compatibility + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --action_env + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --incompatible_stop_exporting_build_file_path + +History: +- Introduced in Bazel x.x.x + +If set to true, deprecated ctx.build_file_path will not be available. ctx.label.package + '/BUILD' can be used instead. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --loading_phase_threads + +History: +- Introduced in Bazel x.x.x + +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 ([-|*]) eg. "auto", "HOST_CPUS*.5". "auto" sets a reasonable default based on host resources. Must be at least 1. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, mod, print_action, query, run, sync, test, vendor_ + +## --experimental_build_event_fully_resolve_fileset_symlinks + +History: +- Introduced in Bazel x.x.x + +If true, fully resolve relative Fileset symlinks in the BEP when presenting output files. Requires --experimental_build_event_expand_filesets. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --system_rc + +History: +- Introduced in Bazel x.x.x + +Whether or not to look for the system-wide bazelrc. + +_May apply to commands: startup_ + +## --experimental_record_metrics_for_all_mnemonics + +History: +- Introduced in Bazel x.x.x + +Controls the output of BEP ActionSummary and BuildGraphMetrics, limiting the number of mnemonics in ActionData and number of entries reported in BuildGraphMetrics.AspectCount/RuleClassCount. By default the number of types is limited to the top 20, by number of executed actions for ActionData, and instances for RuleClass and Asepcts. Setting this option will write statistics for all mnemonics, rule classes and aspects. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --output + +History: +- Introduced in Bazel x.x.x + +The format in which the aquery results should be printed. Allowed values for aquery are: text, textproto, proto, streamed_proto, jsonproto. + +_May apply to commands: aquery, config, cquery, mod, query_ + +## --experimental_py_binaries_include_label + +History: +- Introduced in Bazel x.x.x + +py_binary targets include their label even when stamping is disabled. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --custom_malloc + +History: +- Introduced in Bazel x.x.x + +Specifies a custom malloc implementation. This setting overrides malloc attributes in build rules. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --auto_cpu_environment_group + +History: +- Introduced in Bazel x.x.x + +No-op + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --incompatible_enable_cc_test_feature + +History: +- Introduced in Bazel x.x.x + +When enabled, it switches Crosstool to use feature 'is_cc_test' rather than the link-time build variable of the same name. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_sandboxfs_map_symlink_targets + +History: +- Introduced in Bazel x.x.x + +No-op + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_local_java_optimizations + +History: +- Introduced in Bazel x.x.x + +Do not use. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --remote_instance_name + +History: +- Introduced in Bazel x.x.x + +Value to pass as instance_name in the remote execution API. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --redirect_local_instrumentation_output_writes + +History: +- Introduced in Bazel x.x.x + +If true and supported, instrumentation output is redirected to be written locally on a different machine than where bazel is running on. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --experimental_worker_memory_limit_mb + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_proto_extra_actions + +History: +- Introduced in Bazel x.x.x + +Deprecated. No-op. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --sandbox_writable_path + +History: +- Introduced in Bazel x.x.x + +For sandboxed actions, make an existing directory writable in the sandbox (if supported by the sandboxing implementation, ignored otherwise). + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_remote_output_service + +History: +- Introduced in Bazel x.x.x + +HOST or HOST:PORT of a remote output service 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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --expunge + +History: +- Introduced in Bazel x.x.x + +If true, clean removes the entire working tree for this %{product} instance, which includes all %{product}-created temporary and build output files, and stops the %{product} server if it is running. + +_May apply to commands: clean_ + +## --experimental_remote_require_cached + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --macos_qos_class + +History: +- Introduced in Bazel x.x.x + +Sets the QoS service class of the %{product} 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. + +_May apply to commands: startup_ + +## --default_visibility + +History: +- Introduced in Bazel x.x.x + +Default visibility for packages that don't set it explicitly ('public' or 'private'). + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, mod, print_action, query, run, sync, test, vendor_ + +## --dynamic_local_strategy + +History: +- Introduced in Bazel x.x.x + +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,...] + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --bytecode_optimization_pass_actions + +History: +- Introduced in Bazel x.x.x + +Do not use. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --terminal_columns + +History: +- Introduced in Bazel x.x.x + +A system-generated parameter which specifies the terminal width in columns. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --force_pic + +History: +- Introduced in Bazel x.x.x + +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"). + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --announce + +History: +- Introduced in Bazel x.x.x + +Deprecated. No-op. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --enable_platform_specific_config + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --experimental_builtins_bzl_path + +History: +- Introduced in Bazel x.x.x + +This flag tells Bazel how to find the "@_builtins" .bzl files that govern how predeclared symbols for BUILD and .bzl files are defined. This flag is only intended for Bazel developers, to help when writing @_builtins .bzl code. Ordinarily this value is set to "%bundled%", which means to use the builtins_bzl/ directory packaged in the Bazel binary. However, it can be set to the path (relative to the root of the current workspace) of an alternate builtins_bzl/ directory, such as one in a Bazel source tree workspace. A literal value of "%workspace%" is equivalent to the relative package path of builtins_bzl/ within a Bazel source tree; this should only be used when running Bazel within its own source tree. Finally, a value of the empty string disables the builtins injection mechanism entirely. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --bes_outerr_buffer_size + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --incompatible_bazel_test_exec_run_under + +History: +- Introduced in Bazel x.x.x + +If enabled, "bazel test --run_under=//:runner" builds "//:runner" in the exec configuration. If disabled, it builds "//:runner" in the target configuration. Bazel executes tests on exec machines, so the former is more correct. This doesn't affect "bazel run", which always builds "`--run_under=//foo" in the target configuration. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_enable_jspecify + +History: +- Introduced in Bazel x.x.x + +Enable experimental jspecify integration. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --charset + +History: +- Introduced in Bazel x.x.x + +Chooses the character set to use for the tree. Only affects text output. Valid values are "utf8" or "ascii". Default is "utf8" + +_May apply to commands: mod_ + +## --proto:instantiation_stack + +History: +- Introduced in Bazel x.x.x + +Populate the instantiation call stack of each rule. Note that this requires the stack to be present + +_May apply to commands: aquery, cquery, query_ + +## --expunge_async + +History: +- Introduced in Bazel x.x.x + +If specified, clean asynchronously removes the entire working tree for this %{product} instance, which includes all %{product}-created temporary and build output files, and stops the %{product} 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. + +_May apply to commands: clean_ + +## --remote_download_symlink_template + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --experimental_process_wrapper_graceful_sigterm + +History: +- Introduced in Bazel x.x.x + +When true, make the process-wrapper propagate SIGTERMs (used by the dynamic scheduler to stop process trees) to the subprocesses themselves, giving them the grace period in --local_termination_grace_seconds before forcibly sending a SIGKILL. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --incompatible_no_implicit_file_export + +History: +- Introduced in Bazel x.x.x + +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 + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --stamp + +History: +- Introduced in Bazel x.x.x + +Stamp binaries with the date, username, hostname, workspace information, etc. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --enforce_transitive_configs_for_config_feature_flag + +History: +- Introduced in Bazel x.x.x + + + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_ui_debug_all_events + +History: +- Introduced in Bazel x.x.x + +Report all events known to the Bazel UI. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --host_platform + +History: +- Introduced in Bazel x.x.x + +The label of a platform rule that describes the host system. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --fdo_prefetch_hints + +History: +- Introduced in Bazel x.x.x + +Use cache prefetch hints. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --graph:conditional_edges_limit + +History: +- Introduced in Bazel x.x.x + +The maximum number of condition labels to show. -1 means no truncation and 0 means no annotation. This option is only applicable to --output=graph. + +_May apply to commands: query_ + +## --incompatible_strip_executable_safely + +History: +- Introduced in Bazel x.x.x + +If true, strip action for executables will use flag -x, which does not break dynamic symbol resolution. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_bzl_visibility + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --allow_analysis_cache_discard + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_include_scanning_parallelism + +History: +- Introduced in Bazel x.x.x + +Configures the size of the thread pool used for include scanning. Takes an integer, or a keyword ("auto", "HOST_CPUS", "HOST_RAM"), optionally followed by an operation ([-|*]) eg. "auto", "HOST_CPUS*.5". 0 means to disable parallelism and to just rely on the build graph parallelism for concurrency. "auto" means to use a reasonable value derived from the machine's hardware profile (e.g. the number of processors). + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_exec_config + +History: +- Introduced in Bazel x.x.x + +If set to '//some:label:my.bzl%my_transition', uses my_transition for 'cfg = "exec"' semantics instead of Bazel's internal exec transition logic. Else uses Bazel's internal logic. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_stats_summary + +History: +- Introduced in Bazel x.x.x + +Enable a modernized summary of the build stats. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --incompatible_autoload_externally + +History: +- Introduced in Bazel x.x.x + +A comma-separated list of rules (or other symbols) that were previously part of Bazel and which are now to be retrieved from their respective external repositories. This flag is intended to be used to facilitate migration of rules out of Bazel. See also https://github.com/bazelbuild/bazel/issues/23043. +A symbol that is autoloaded within a file behaves as if its built-into-Bazel definition were replaced by its canonical new definition in an external repository. For a BUILD file, this essentially means implicitly adding a load() statement. For a .bzl file, it's either a load() statement or a change to a field of the `native` object, depending on whether the autoloaded symbol is a rule. +Bazel maintains a hardcoded list of all symbols that may be autoloaded; only those symbols may appear in this flag. For each symbol, Bazel knows the new definition location in an external repository, as well as a set of special-cased repositories that must not autoload it to avoid creating cycles. +A list item of "+foo" in this flag causes symbol foo to be autoloaded, except in foo's exempt repositories, within which the Bazel-defined version of foo is still available. +A list item of "foo" triggers autoloading as above, but the Bazel-defined version of foo is not made available to the excluded repositories. This ensures that foo's external repository does not depend on the old Bazel implementation of foo +A list item of "-foo" does not trigger any autoloading, but makes the Bazel-defined version of foo inaccessible throughout the workspace. This is used to validate that the workspace is ready for foo's definition to be deleted from Bazel. +If a symbol is not named in this flag then it continues to work as normal -- no autoloading is done, nor is the Bazel-defined version suppressed. For configuration see https://github.com/bazelbuild/bazel/blob/master/src/main/java/com/google/devtools/build/lib/packages/AutoloadSymbols.java As a shortcut also whole repository may be used, for example +@rules_python will autoload all Python rules. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --desugar_for_android + +History: +- Introduced in Bazel x.x.x + +Whether to desugar Java 8 bytecode before dexing. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --watchos_minimum_os + +History: +- Introduced in Bazel x.x.x + +Minimum compatible watchOS version for target simulators and devices. If unspecified, uses 'watchos_sdk_version'. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --default_test_resources + +History: +- Introduced in Bazel x.x.x + +Override the default resources amount for tests. The expected format is =. If a single positive number is specified as it will override the default resources for all test sizes. If 4 comma-separated numbers are specified, they will override the resource amount for respectively the small, medium, large, enormous test sizes. Values can also be HOST_RAM/HOST_CPU, optionally followed by [-|*] (eg. memory=HOST_RAM*.1,HOST_RAM*.2,HOST_RAM*.3,HOST_RAM*.4). The default test resources specified by this flag are overridden by explicit resources specified in tags. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --action_cache + +History: +- Introduced in Bazel x.x.x + +Dump action cache content. + +_May apply to commands: dump_ + +## --target_platform_fallback + +History: +- Introduced in Bazel x.x.x + +This option is deprecated and has no effect. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_skylark_debug_server_port + +History: +- Introduced in Bazel x.x.x + +The port on which the Starlark debug server will listen for connections. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --verbose_failures + +History: +- Introduced in Bazel x.x.x + +If a command fails, print out the full command line. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --bep_maximum_open_remote_upload_files + +History: +- Introduced in Bazel x.x.x + +Maximum number of open files allowed during BEP artifact upload. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --experimental_remote_failure_rate_threshold + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --remote_cache_compression + +History: +- Introduced in Bazel x.x.x + +If enabled, compress/decompress cache blobs with zstd when their size is at least --experimental_remote_cache_compression_threshold. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --incompatible_disable_target_default_provider_fields + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --experimental_worker_as_resource + +History: +- Introduced in Bazel x.x.x + +No-op, will be removed soon. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --http_connector_attempts + +History: +- Introduced in Bazel x.x.x + +The maximum number of attempts for http downloads. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --verbose + +History: +- Introduced in Bazel x.x.x + +The queries will also display the reason why modules were resolved to their current version (if changed). Defaults to true only for the explain query. + +_May apply to commands: mod_ + +## --tls_certificate + +History: +- Introduced in Bazel x.x.x + +Specify a path to a TLS certificate that is trusted to sign server certificates. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --experimental_skyframe_memory_dump + +History: +- Introduced in Bazel x.x.x + +Dump the memory use of individual nodes in the Skyframe graph after the build. This option takes a number of flags separated by commas: 'json' (no-op, that's the only format), 'notransient' (don't traverse transient fields), 'noconfig' (ignore objects related to configurations), 'noprecomputed' (ignore precomputed values) and 'noworkspacestatus' (ignore objects related to the workspace status machinery) + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_enable_aspect_hints + +History: +- Introduced in Bazel x.x.x + + + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --incompatible_py3_is_default + +History: +- Introduced in Bazel x.x.x + +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`. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_action_listener + +History: +- Introduced in Bazel x.x.x + +Deprecated in favor of aspects. Use action_listener to attach an extra_action to existing build actions. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_reuse_include_scanning_threads + +History: +- Introduced in Bazel x.x.x + +If enabled core threads of include scanner pool will not die during execution. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --heuristically_drop_nodes + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --android_fixed_resource_neverlinking + +History: +- Introduced in Bazel x.x.x + +If true, resources will properly not get propagated through neverlinked libraries. Otherwise, the old behavior of propagating those resources if no resource-related attributes are specified in the neverlink library will be preserved. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_windows_sandbox_path + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --android_sdk + +History: +- Introduced in Bazel x.x.x + +No-op + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_bep_target_summary + +History: +- Introduced in Bazel x.x.x + +Whether to publish TargetSummary events. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --build_runfile_manifests + +History: +- Introduced in Bazel x.x.x + +If true, write runfiles manifests for all targets. If false, omit them. Local tests will fail to run when false. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --strip + +History: +- Introduced in Bazel x.x.x + +Specifies whether to strip binaries and shared libraries (using "-Wl,--strip-debug"). The default value of 'sometimes' means strip iff --compilation_mode=fastbuild. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --incompatible_legacy_local_fallback + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --split_bytecode_optimization_pass + +History: +- Introduced in Bazel x.x.x + +Do not use. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --host_grte_top + +History: +- Introduced in Bazel x.x.x + +If specified, this setting overrides the libc top-level directory (--grte_top) for the exec configuration. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --test_timeout_filters + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_starlark_cc_import + +History: +- Introduced in Bazel x.x.x + +If enabled, the Starlark version of cc_import can be used. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --toolchain_resolution_debug + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --macos_minimum_os + +History: +- Introduced in Bazel x.x.x + +Minimum compatible macOS version for targets. If unspecified, uses 'macos_sdk_version'. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_allow_project_files + +History: +- Introduced in Bazel x.x.x + +Enable processing of + parameters. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --show_loading_progress + +History: +- Introduced in Bazel x.x.x + +If enabled, causes Bazel to print "Loading package:" messages. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, mod, print_action, query, run, sync, test, vendor_ + +## --experimental_skyframe_native_filesets + +History: +- Introduced in Bazel x.x.x + + + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --io_nice_level + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: startup_ + +## --null + +History: +- Introduced in Bazel x.x.x + +Whether each format is terminated with \0 instead of newline. + +_May apply to commands: query_ + +## --archived_tree_artifact_mnemonics_filter + +History: +- Introduced in Bazel x.x.x + +Regex filter for mnemonics of actions for which we should create archived tree artifacts. This option is a no-op for actions which do not generate tree artifacts. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --curses + +History: +- Introduced in Bazel x.x.x + +Use terminal cursor controls to minimize scrolling output. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --host_compiler + +History: +- Introduced in Bazel x.x.x + +No-op flag. Will be removed in a future release. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --legacy_main_dex_list_generator + +History: +- Introduced in Bazel x.x.x + +Specifies a binary to use to generate the list of classes that must be in the main dex when compiling legacy multidex. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_profile_include_primary_output + +History: +- Introduced in Bazel x.x.x + +Includes the extra "out" attribute in action events that contains the exec path to the action's primary output. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --experimental_shrink_worker_pool + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_inmemory_jdeps_files + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --enable_fdo_profile_absolute_path + +History: +- Introduced in Bazel x.x.x + +Deprecated. No-op. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_check_external_repository_files + +History: +- Introduced in Bazel x.x.x + +Check for modifications to files in external repositories. Consider setting this flag to false if you don't expect these files to change outside of bazel since it will speed up subsequent runs as they won't have to check a previous run's cache. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --noorder_results + +History: +- Introduced in Bazel x.x.x + +Output the results in dependency-ordered (default) or unordered fashion. The unordered output is faster but only supported when --output is not minrank, maxrank, or graph. + +_May apply to commands: query_ + +## --javacopt + +History: +- Introduced in Bazel x.x.x + +Additional options to pass to javac. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --log_top_n_packages + +History: +- Introduced in Bazel x.x.x + +Configures number of packages included in top-package INFO logging, <= 0 disables. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --remote_local_fallback_strategy + +History: +- Introduced in Bazel x.x.x + +Deprecated. See https://github.com/bazelbuild/bazel/issues/7480 for details. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --incremental_dexing + +History: +- Introduced in Bazel x.x.x + +Does most of the work for dexing separately for each Jar file. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --skip_incompatible_explicit_targets + +History: +- Introduced in Bazel x.x.x + +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 + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --start_app + +History: +- Introduced in Bazel x.x.x + +Whether to start the app after installing it. + +_May apply to commands: mobile-install_ + +## --incompatible_disable_target_provider_fields + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --remote_verify_downloads + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --cc_proto_library_source_suffixes + +History: +- Introduced in Bazel x.x.x + +Sets the suffixes of source files that a cc_proto_library creates. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --save_temps + +History: +- Introduced in Bazel x.x.x + +If set, temporary outputs from gcc will be saved. These include .s files (assembler code), .i files (preprocessed C) and .ii files (preprocessed C++). + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --check_up_to_date + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --portable_paths + +History: +- Introduced in Bazel x.x.x + +If true, includes paths to replace in ExecRequest to make the resulting paths portable. + +_May apply to commands: run_ + +## --build_request_id + +History: +- Introduced in Bazel x.x.x + +Unique string identifier for the build being run. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --cs_fdo_absolute_path + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_sandbox_memory_limit_mb + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_explicit_aspects + +History: +- Introduced in Bazel x.x.x + +aquery, cquery: whether to include aspect-generated actions in the output. query: no-op (aspects are always followed). + +_May apply to commands: aquery, cquery, query_ + +## --strict_proto_deps + +History: +- Introduced in Bazel x.x.x + +Unless OFF, checks that a proto_library target explicitly declares all directly used targets as dependencies. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_repo_remote_exec + +History: +- Introduced in Bazel x.x.x + +If set to true, repository_rule gains some remote execution capabilities. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --skykey_filter + +History: +- Introduced in Bazel x.x.x + +Regex filter of SkyKey names to output. Only used with --skyframe=deps, rdeps, function_graph. + +_May apply to commands: dump_ + +## --one_version_enforcement_on_java_tests + +History: +- Introduced in Bazel x.x.x + +When enabled, and with experimental_one_version_enforcement set to a non-NONE value, enforce one version on java_test targets. This flag can be disabled to improve incremental test performance at the expense of missing potential one version violations. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --incompatible_objc_alwayslink_by_default + +History: +- Introduced in Bazel x.x.x + +If true, make the default value true for alwayslink attributes in objc_library and objc_import. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --incompatible_load_proto_rules_from_bzl + +History: +- Introduced in Bazel x.x.x + +Deprecated no-op. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --starlark_cpu_profile + +History: +- Introduced in Bazel x.x.x + +Writes into the specified file a pprof profile of CPU usage by all Starlark threads. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --watchos_sdk_version + +History: +- Introduced in Bazel x.x.x + +Specifies the version of the watchOS SDK to use to build watchOS applications. If unspecified, uses the default watchOS SDK version from 'xcode_version'. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --output_filter + +History: +- Introduced in Bazel x.x.x + +Only shows warnings and action outputs for rules with a name matching the provided regular expression. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --build_event_json_file_upload_mode + +History: +- Introduced in Bazel x.x.x + +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'. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --desugar_java8_libs + +History: +- Introduced in Bazel x.x.x + +Whether to include supported Java 8 libraries in apps for legacy devices. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --sandbox_add_mount_pair + +History: +- Introduced in Bazel x.x.x + +Add additional path pair to mount in sandbox. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --script_path + +History: +- Introduced in Bazel x.x.x + +If set, write a shell script to the given file which invokes the target. If this option is set, the target is not run from %{product}. Use '%{product} run --script_path=foo //foo && ./foo' to invoke target '//foo' This differs from '%{product} run //foo' in that the %{product} lock is released and the executable is connected to the terminal's stdin. + +_May apply to commands: run_ + +## --remote_cache_async + +History: +- Introduced in Bazel x.x.x + +If true, uploading of action results to a disk or remote cache will happen in the background instead of blocking the completion of an action. Some actions are incompatible with background uploads, and may still block even when this flag is set. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --incompatible_enable_android_toolchain_resolution + +History: +- Introduced in Bazel x.x.x + +No-op + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_use_cpp_compile_action_args_params_file + +History: +- Introduced in Bazel x.x.x + +If enabled, write CppCompileAction exposed action.args to parameters file. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --skyframe_high_water_mark_minor_gc_drops_per_invocation + +History: +- Introduced in Bazel x.x.x + +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 10. 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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --test_runner_fail_fast + +History: +- Introduced in Bazel x.x.x + +Forwards fail fast option to the test runner. The test runner should stop execution upon first failure. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --slim_profile + +History: +- Introduced in Bazel x.x.x + +Slims down the size of the JSON profile by merging events if the profile gets too large. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --experimental_java_classpath + +History: +- Introduced in Bazel x.x.x + +Enables reduced classpaths for Java compilations. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --xbinary_fdo + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --serialized_frontier_profile + +History: +- Introduced in Bazel x.x.x + +Dump a profile of serialized frontier bytes. Specifies the output path. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --check_licenses + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --host_macos_minimum_os + +History: +- Introduced in Bazel x.x.x + +Minimum compatible macOS version for host targets. If unspecified, uses 'macos_sdk_version'. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --extract_data_time + +History: +- Introduced in Bazel x.x.x + +The time in ms spent on extracting the new bazel version. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --incompatible_multi_release_deploy_jars + +History: +- Introduced in Bazel x.x.x + +When enabled, java_binary creates Multi-Release deploy jars. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --incompatible_locations_prefers_executable + +History: +- Introduced in Bazel x.x.x + +Whether a target that provides an executable expands to the executable rather than the files in DefaultInfo.files under $(locations ...) expansion if the number of files is not 1. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --android_platforms + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_enable_first_class_macros + +History: +- Introduced in Bazel x.x.x + +If set to true, enables the `macro()` construct for defining symbolic macros. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --experimental_writable_outputs + +History: +- Introduced in Bazel x.x.x + +If true, the file permissions of action outputs are set to 0755 instead of 0555 + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_skyframe_prepare_analysis + +History: +- Introduced in Bazel x.x.x + +Deprecated. No-op. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --incompatible_macos_set_install_name + +History: +- Introduced in Bazel x.x.x + +Whether to explicitly set `-install_name` when creating dynamic libraries. See https://github.com/bazelbuild/bazel/issues/12370 + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_remote_cache_lease_extension + +History: +- Introduced in Bazel x.x.x + +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`. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --proto_profile_path + +History: +- Introduced in Bazel x.x.x + +The profile to pass to the proto compiler as profile_path. If unset, but --proto_profile is true (the default), infers the path from --fdo_optimize. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --persistent_multiplex_android_dex_desugar + +History: +- Introduced in Bazel x.x.x + +Enable persistent multiplexed Android dex and desugar actions by using workers. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --remote_download_toplevel + +History: +- Introduced in Bazel x.x.x + +Only downloads remote outputs of top level targets to the local machine. This flag is an alias for --remote_download_outputs=toplevel. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --use_action_cache + +History: +- Introduced in Bazel x.x.x + +Whether to use the action cache + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --incompatible_no_package_distribs + +History: +- Introduced in Bazel x.x.x + +If set to true, disables the `package(distribs=...)`. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --show_result + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_remote_output_service_output_path_prefix + +History: +- Introduced in Bazel x.x.x + +The path under which the contents of output directories managed by the --experimental_remote_output_service are placed. The actual output directory used by a build will be a descendant of this path and determined by the output service. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --device + +History: +- Introduced in Bazel x.x.x + +The adb device serial number. If not specified, the first device will be used. + +_May apply to commands: mobile-install_ + +## --iff_heap_size_greater_than + +History: +- Introduced in Bazel x.x.x + +Iff non-zero, then shutdown will only shut down the server if the total memory (in MB) consumed by the JVM exceeds this value. + +_May apply to commands: shutdown_ + +## --defer_param_files + +History: +- Introduced in Bazel x.x.x + +This option is deprecated and has no effect and will be removed in the future. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --apple_generate_dsym + +History: +- Introduced in Bazel x.x.x + +Whether to generate debug symbol(.dSYM) file(s). + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --client_cwd + +History: +- Introduced in Bazel x.x.x + +A system-generated parameter which specifies the client's working directory + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --bes_upload_mode + +History: +- Introduced in Bazel x.x.x + +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'. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --long (-l) + +History: +- Introduced in Bazel x.x.x + +Show full description of each option, instead of just its name. + +_May apply to commands: help_ + +## --experimental_show_artifacts + +History: +- Introduced in Bazel x.x.x + +Deprecated no-op. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --catalyst_cpus + +History: +- Introduced in Bazel x.x.x + +Comma-separated list of architectures for which to build Apple Catalyst binaries. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_build_event_upload_retry_minimum_delay + +History: +- Introduced in Bazel x.x.x + +Initial, minimum delay for exponential backoff retries when BEP upload fails. (exponent: 1.6) + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --experimental_aquery_dump_after_build_output_file + +History: +- Introduced in Bazel x.x.x + +Specify the output file for the aquery dump after a build. Use in conjunction with --experimental_aquery_dump_after_build_format. The path provided is relative to Bazel's output base, unless it's an absolute path. Using this will disable Skymeld. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_remote_analysis_cache_deadline + +History: +- Introduced in Bazel x.x.x + +Deadline to use for remote analysis cache operations. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_worker_strict_flagfiles + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_inmemory_sandbox_stashes + +History: +- Introduced in Bazel x.x.x + +If set to true, the contents of stashed sandboxes for reuse_sandbox_directories will be tracked in memory. This reduces the amount of I/O needed during reuse. Depending on the build this flag may improve wall time. Depending on the build as well this flag may use a significant amount of additional memory. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --credential_helper_cache_duration + +History: +- Introduced in Bazel x.x.x + +The default duration for which credentials supplied by a credential helper are cached if the helper does not provide when the credentials expire. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --subcommands (-s) + +History: +- Introduced in Bazel x.x.x + +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). + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_correct_runfiles_middleman_paths + +History: +- Introduced in Bazel x.x.x + +If set, the path of runfiles middlemen represents the real path of the runfiles tree. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --host_jvmopt + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_inmemory_dotincludes_files + +History: +- Introduced in Bazel x.x.x + +If enabled, searching for '#include' lines in generated header files will not touch local disk. This makes include scanning of C++ files less disk-intensive. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --stripopt + +History: +- Introduced in Bazel x.x.x + +Additional options to pass to strip when generating a '.stripped' binary. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --incompatible_disallow_sdk_frameworks_attributes + +History: +- Introduced in Bazel x.x.x + +If true, disallow sdk_frameworks and weak_sdk_frameworks attributes in objc_library andobjc_import. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_remote_cache_eviction_retries + +History: +- Introduced in Bazel x.x.x + +The maximum number of attempts to retry if the build encountered a transient remote cache error that would otherwise fail the build. Applies for example when artifacts are evicted from the remote cache, or in certain cache failure conditions. 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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --host_per_file_copt + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --proto:flatten_selects + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, cquery, query_ + +## --build_event_binary_file_path_conversion + +History: +- Introduced in Bazel x.x.x + +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 + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --block_for_lock + +History: +- Introduced in Bazel x.x.x + +When --noblock_for_lock is passed, Bazel does not wait for a running command to complete, but instead exits immediately. + +_May apply to commands: startup, analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --local_resources + +History: +- Introduced in Bazel x.x.x + +Set the number of resources available to Bazel. Takes in an assignment to a float or HOST_RAM/HOST_CPUS, optionally followed by [-|*] (eg. memory=HOST_RAM*.5 to use half the available RAM). Can be used multiple times to specify multiple types of resources. Bazel will limit concurrently running actions based on the available resources and the resources required. Tests can declare the amount of resources they need by using a tag of the "resources::" format. Overrides resources specified by --local_{cpu|ram|extra}_resources. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_execution_graph_log_dep_type + +History: +- Introduced in Bazel x.x.x + +Selects what kind of dependency information is reported in the action dump. If 'all', every inter-action edge will be reported. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_dynamic_slow_remote_time + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --memory_profile + +History: +- Introduced in Bazel x.x.x + +If set, write memory usage data to the specified file at phase ends and stable heap to master log at end of build. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --incompatible_new_actions_api + +History: +- Introduced in Bazel x.x.x + +No-op + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --incompatible_package_group_has_public_syntax + +History: +- Introduced in Bazel x.x.x + +In package_group's `packages` attribute, allows writing "public" or "private" to refer to all packages or no packages respectively. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --incompatible_disable_native_android_rules + +History: +- Introduced in Bazel x.x.x + +If enabled, direct usage of the native Android rules is disabled. Please use the Starlark Android rules from https://github.com/bazelbuild/rules_android + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_fsvc_threads + +History: +- Introduced in Bazel x.x.x + +The number of threads that are used by the FileSystemValueChecker. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_cc_implementation_deps + +History: +- Introduced in Bazel x.x.x + +If enabled, cc_library targets can use attribute `implementation_deps`. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --distdir + +History: +- Introduced in Bazel x.x.x + +Additional places to search for archives before accessing the network to download them. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --incompatible_default_to_explicit_init_py + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --test_arg + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --propeller_optimize + +History: +- Introduced in Bazel x.x.x + +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 + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --explicit_java_test_deps + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --modify_execution_info + +History: +- Introduced in Bazel x.x.x + +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. + + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --rules + +History: +- Introduced in Bazel x.x.x + +Dump rules, including counts and memory usage (if memory is tracked). + +_May apply to commands: dump_ + +## --help_verbosity + +History: +- Introduced in Bazel x.x.x + +Select the verbosity of the help command. + +_May apply to commands: help_ + +## --separate_aspect_deps + +History: +- Introduced in Bazel x.x.x + +No-op + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --starlark:file + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: cquery_ + +## --host_copt + +History: +- Introduced in Bazel x.x.x + +Additional options to pass to the C compiler for tools built in the exec configurations. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --incompatible_disallow_ctx_resolve_tools + +History: +- Introduced in Bazel x.x.x + +If set to true, calling the deprecated ctx.resolve_tools API always fails. Uses of this API should be replaced by an executable or tools argument to ctx.actions.run or ctx.actions.run_shell. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --experimental_skyframe_cpu_heavy_skykeys_thread_pool_size + +History: +- Introduced in Bazel x.x.x + +If set to a positive value (e.g. "HOST_CPUS*1.5"), Skyframe will run the loading/analysis phase with 2 separate thread pools: 1 with threads (ideally close to HOST_CPUS) reserved for CPU-heavy SkyKeys, and 1 "standard" thread pool (whose size is controlled by --loading_phase_threads) for the rest. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_output_paths + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_worker_allowlist + +History: +- Introduced in Bazel x.x.x + +If non-empty, only allow using persistent workers with the given worker key mnemonic. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --include_file_write_contents + +History: +- Introduced in Bazel x.x.x + +Include the file contents for the FileWrite, SourceSymlinkManifest, and RepoMappingManifest actions (potentially large). + +_May apply to commands: aquery_ + +## --restart_reason + +History: +- Introduced in Bazel x.x.x + +The reason for the server restart. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --experimental_downloader_config + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --experimental_docker_privileged + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --compile_one_dependency + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --http_connector_retry_max_timeout + +History: +- Introduced in Bazel x.x.x + +The maximum timeout for http download retries. With a value of 0, no timeout maximum is defined. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --incompatible_remove_old_python_version_api + +History: +- Introduced in Bazel x.x.x + +No-op, will be removed soon. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_android_databinding_v2 + +History: +- Introduced in Bazel x.x.x + +Use android databinding v2. This flag is a no-op. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --remote_cache + +History: +- Introduced in Bazel x.x.x + +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 + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --proto_toolchain_for_javalite + +History: +- Introduced in Bazel x.x.x + +Label of proto_lang_toolchain() which describes how to compile JavaLite protos + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --materialize_param_files + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --ignore_dev_dependency + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --apk_signing_method + +History: +- Introduced in Bazel x.x.x + +Implementation to use to sign APKs + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --ios_minimum_os + +History: +- Introduced in Bazel x.x.x + +Minimum compatible iOS version for target simulators and devices. If unspecified, uses 'ios_sdk_version'. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_python_import_all_repositories + +History: +- Introduced in Bazel x.x.x + +If true, the roots of repositories in the runfiles tree are added to PYTHONPATH, so that imports like `import mytoplevelpackage.package.module` are valid. Regardless of whether this flag is true, the runfiles root itself is also added to the PYTHONPATH, so `import myreponame.mytoplevelpackage.package.module` is valid. The latter form is less likely to experience import name collisions. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_fetch_all_coverage_outputs + +History: +- Introduced in Bazel x.x.x + +If true, then Bazel fetches the entire coverage data directory for each test during a coverage run. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_dynamic_exclude_tools + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --start_end_lib + +History: +- Introduced in Bazel x.x.x + +Use the --start-lib/--end-lib ld options if supported by the toolchain. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_enable_android_migration_apis + +History: +- Introduced in Bazel x.x.x + +If set to true, enables the APIs required to support the Android Starlark migration. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --python_native_rules_allowlist + +History: +- Introduced in Bazel x.x.x + +An allowlist (package_group target) to use when enforcing --incompatible_python_disallow_native_rules. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --platform_suffix + +History: +- Introduced in Bazel x.x.x + +Specifies a suffix to be added to the configuration directory. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --force_python + +History: +- Introduced in Bazel x.x.x + +No-op, will be removed soon. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_windows_watchfs + +History: +- Introduced in Bazel x.x.x + +If true, experimental Windows support for --watchfs is enabled. Otherwise --watchfsis a non-op on Windows. Make sure to also enable --watchfs. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --incompatible_load_java_rules_from_bzl + +History: +- Introduced in Bazel x.x.x + +Deprecated no-op. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --verbose_test_summary + +History: +- Introduced in Bazel x.x.x + +If true, print additional information (timing, number of failed runs, etc) in the test summary. + +_May apply to commands: coverage, cquery, fetch, test, vendor_ + +## --incompatible_top_level_aspects_require_providers + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --include_param_files + +History: +- Introduced in Bazel x.x.x + +Include the content of the param files used in the command (potentially large). Note: Enabling this flag will automatically enable the --include_commandline flag. + +_May apply to commands: aquery_ + +## --experimental_add_exec_constraints_to_targets + +History: +- Introduced in Bazel x.x.x + +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'. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --registry + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --connect_timeout_secs + +History: +- Introduced in Bazel x.x.x + +The amount of time the client waits for each attempt to connect to the server + +_May apply to commands: startup_ + +## --test_sharding_strategy + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --internal_persistent_android_dex_desugar + +History: +- Introduced in Bazel x.x.x + +Tracking flag for when dexing and desugaring workers are enabled. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --fdo_instrument + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_use_validation_aspect + +History: +- Introduced in Bazel x.x.x + +Whether to run validation actions using aspect (for parallelism with tests). + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --local_startup_timeout_secs + +History: +- Introduced in Bazel x.x.x + +The maximum amount of time the client waits to connect to the server + +_May apply to commands: startup_ + +## --include_commandline + +History: +- Introduced in Bazel x.x.x + +Includes the content of the action command lines in the output (potentially large). + +_May apply to commands: aquery_ + +## --rule_classes + +History: +- Introduced in Bazel x.x.x + +Dump rule classes. + +_May apply to commands: dump_ + +## --incompatible_fix_package_group_reporoot_syntax + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --client_debug + +History: +- Introduced in Bazel x.x.x + +If true, log debug information from the client to stderr. Changing this option will not cause the server to restart. + +_May apply to commands: startup_ + +## --objccopt + +History: +- Introduced in Bazel x.x.x + +Additional options to pass to gcc when compiling Objective-C/C++ source files. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --linkopt + +History: +- Introduced in Bazel x.x.x + +Additional option to pass to gcc when linking. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --show_progress_rate_limit + +History: +- Introduced in Bazel x.x.x + +Minimum number of seconds between progress messages in the output. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --internal_starlark_flag_test_canary + +History: +- Introduced in Bazel x.x.x + + + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --canonicalize_policy + +History: +- Introduced in Bazel x.x.x + +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'. + +_May apply to commands: canonicalize-flags_ + +## --experimental_one_version_enforcement + +History: +- Introduced in Bazel x.x.x + +When enabled, enforce that a java_binary rule can't contain more than one version of the same class file on the classpath. This enforcement can break the build, or can just result in warnings. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_android_resource_path_shortening + +History: +- Introduced in Bazel x.x.x + +Enables shortening of resource file paths within android_binary APKs. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --progress_report_interval + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --bes_system_keywords + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --incompatible_make_thinlto_command_lines_standalone + +History: +- Introduced in Bazel x.x.x + +This flag is a noop and scheduled for removal. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_execution_graph_log_queue_size + +History: +- Introduced in Bazel x.x.x + +The size of the action dump queue, where actions are kept before writing. Larger sizes will increase peak memory usage, but should decrease queue blocking. -1 means unbounded + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --implicit_deps + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, cquery, query_ + +## --experimental_cancel_concurrent_tests + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --dexopts_supported_in_dexmerger + +History: +- Introduced in Bazel x.x.x + +dx flags supported in tool that merges dex archives into final classes.dex files. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_allow_android_library_deps_without_srcs + +History: +- Introduced in Bazel x.x.x + +No-op. Kept here for backwards compatibility. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --incompatible_use_plus_in_repo_names + +History: +- Introduced in Bazel x.x.x + +No-op. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --keep_state_after_build + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --deleted_packages + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, mod, print_action, query, run, sync, test, vendor_ + +## --skyframe_high_water_mark_full_gc_drops_per_invocation + +History: +- Introduced in Bazel x.x.x + +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 10. 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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --strict_filesets + +History: +- Introduced in Bazel x.x.x + +If this option is enabled, filesets crossing package boundaries are reported as errors. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_remote_analysis_cache + +History: +- Introduced in Bazel x.x.x + +The URL for the remote analysis caching backend. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --test_tag_filters + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --ui_event_filters + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --experimental_resolved_file_instead_of_workspace + +History: +- Introduced in Bazel x.x.x + +If non-empty read the specified resolved file instead of the WORKSPACE file + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --check_visibility + +History: +- Introduced in Bazel x.x.x + +If disabled, visibility errors in target dependencies are demoted to warnings. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --emacs + +History: +- Introduced in Bazel x.x.x + +A system-generated parameter which is true iff EMACS=t or INSIDE_EMACS is set in the environment of the client. This option controls certain display features. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --disallow_strict_deps_for_jpl + +History: +- Introduced in Bazel x.x.x + +No-op, kept only for backwards compatibility. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_skyfocus_dump_keys + +History: +- Introduced in Bazel x.x.x + +For debugging Skyfocus. Dump the focused SkyKeys (roots, leafs, focused deps, focused rdeps). + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --max_idle_secs + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: startup_ + +## --experimental_builtins_dummy + +History: +- Introduced in Bazel x.x.x + +Enables an internal dummy symbol used to test builtins injection. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --logging + +History: +- Introduced in Bazel x.x.x + +The logging level. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --force + +History: +- Introduced in Bazel x.x.x + +Ignore existing repository if any and force fetch the repository again. Only works when --enable_bzlmod is on. + +_May apply to commands: fetch_ + +## --bes_outerr_chunk_size + +History: +- Introduced in Bazel x.x.x + +Specifies the maximal size of stdout or stderr to be sent to BEP in a single message. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --experimental_proto_descriptor_sets_include_source_info + +History: +- Introduced in Bazel x.x.x + +Run extra actions for alternative Java api versions in a proto_library. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --bazelrc + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: startup_ + +## --trim_test_configuration + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_save_feature_state + +History: +- Introduced in Bazel x.x.x + +Save the state of enabled and requested feautres as an output of compilation. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_cc_skylark_api_enabled_packages + +History: +- Introduced in Bazel x.x.x + +Passes list of packages that can use the C++ Starlark API. Don't enable this flag yet, we will be making breaking changes. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --tvos_sdk_version + +History: +- Introduced in Bazel x.x.x + +Specifies the version of the tvOS SDK to use to build tvOS applications. If unspecified, uses the default tvOS SDK version from 'xcode_version'. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --worker_verbose + +History: +- Introduced in Bazel x.x.x + +If enabled, prints verbose messages when workers are started, shutdown, ... + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --incompatible_disallow_java_import_empty_jars + +History: +- Introduced in Bazel x.x.x + +When enabled, empty java_import.jars is not supported. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_import_deps_checking + +History: +- Introduced in Bazel x.x.x + +No-op, kept only for backwards compatibility + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --objc_debug_with_GLIBCXX + +History: +- Introduced in Bazel x.x.x + +If set, and compilation mode is set to 'dbg', define GLIBCXX_DEBUG, GLIBCXX_DEBUG_PEDANTIC and GLIBCPP_CONCEPT_CHECKS. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_skyfocus_dump_post_gc_stats + +History: +- Introduced in Bazel x.x.x + +For debugging Skyfocus. If enabled, trigger manual GC before/after focusing to report heap sizes reductions. This will increase the Skyfocus latency. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --compilation_mode (-c) + +History: +- Introduced in Bazel x.x.x + +Specify the mode the binary will be built in. Values: 'fastbuild', 'dbg', 'opt'. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --incompatible_merge_genfiles_directory + +History: +- Introduced in Bazel x.x.x + +If true, the genfiles directory is folded into the bin directory. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_allow_runtime_deps_on_neverlink + +History: +- Introduced in Bazel x.x.x + +No-op, kept only for backwards compatibility + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --apple_split_cpu + +History: +- Introduced in Bazel x.x.x + +Don't set this value from the command line - it is derived from other flags and configuration transitions derived from rule attributes + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --visionos_cpus + +History: +- Introduced in Bazel x.x.x + +Comma-separated list of architectures for which to build Apple visionOS binaries. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --copt + +History: +- Introduced in Bazel x.x.x + +Additional options to pass to gcc. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --query_file + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, cquery, query_ + +## --experimental_command_profile + +History: +- Introduced in Bazel x.x.x + +Records a Java Flight Recorder profile for the duration of the command. One of the supported profiling event types (cpu, wall, alloc or lock) must be given as an argument. The profile is written to a file named after the event type under the output base directory. The syntax and semantics of this flag might change in the future to support additional profile types or output formats; use at your own risk. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --experimental_post_profile_started_event + +History: +- Introduced in Bazel x.x.x + +No-op. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --incompatible_use_python_toolchains + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --incremental + +History: +- Introduced in Bazel x.x.x + +Whether to do an incremental install. If true, try to avoid unnecessary additional work by reading the state of the device the code is to be installed on and using that information to avoid unnecessary work. If false (the default), always do a full install. + +_May apply to commands: mobile-install_ + +## --invocation_policy + +History: +- Introduced in Bazel x.x.x + +A base64-encoded-binary-serialized or text-formated invocation_policy.InvocationPolicy proto. Unlike other options, it is an error to specify --invocation_policy multiple times. + +_May apply to commands: startup, canonicalize-flags_ + +## --incompatible_check_testonly_for_output_files + +History: +- Introduced in Bazel x.x.x + +If enabled, check testonly for prerequisite targets that are output files by looking up the testonly of the generating rule. This matches visibility checking. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --enforce_constraints + +History: +- Introduced in Bazel x.x.x + +Checks the environments each target is compatible with and reports errors if any target has dependencies that don't support the same environments + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --depth + +History: +- Introduced in Bazel x.x.x + +Maximum display depth of the dependency tree. A depth of 1 displays the direct dependencies, for example. For tree, path and all_paths it defaults to Integer.MAX_VALUE, while for deps and explain it defaults to 1 (only displays direct deps of the root besides the target leaves and their parents). + + +_May apply to commands: mod_ + +## --incompatible_disallow_resource_jars + +History: +- Introduced in Bazel x.x.x + +No-op, kept only for backwards compatibility + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_strict_fileset_output + +History: +- Introduced in Bazel x.x.x + +If this option is enabled, filesets will treat all output artifacts as regular files. They will not traverse directories or be sensitive to symlinks. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_cpu_load_scheduling_window_size + +History: +- Introduced in Bazel x.x.x + +The size of window during experimental scheduling of action based on CPU load. Make sense to define only when flag --experimental_cpu_load_scheduling is enabled. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --local_ram_resources + +History: +- Introduced in Bazel x.x.x + +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 [-|*] (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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --incompatible_unambiguous_label_stringification + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --show_config_fragments + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: cquery_ + +## --local_extra_resources + +History: +- Introduced in Bazel x.x.x + +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::" format. Available CPU, RAM and resources cannot be set with this flag. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --ios_signing_cert_name + +History: +- Introduced in Bazel x.x.x + +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). + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --remote_default_exec_properties + +History: +- Introduced in Bazel x.x.x + +Set the default exec properties to be used as the remote execution platform if an execution platform does not already set exec_properties. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --experimental_genquery_use_graphless_query + +History: +- Introduced in Bazel x.x.x + +Deprecated. No-op. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --incompatible_disable_objc_library_transition + +History: +- Introduced in Bazel x.x.x + +Disable objc_library's custom transition and inherit from the top level target instead (No-op in Bazel) + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --experimental_collect_code_coverage_for_generated_files + +History: +- Introduced in Bazel x.x.x + +If specified, Bazel will also generate collect coverage information for generated files. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_incremental_dexing_after_proguard_by_default + +History: +- Introduced in Bazel x.x.x + +Whether to use incremental dexing for proguarded Android binaries by default. Use incremental_dexing attribute to override default for a particular android_binary. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_use_rtxt_from_merged_resources + +History: +- Introduced in Bazel x.x.x + +Use R.txt from the merging action, instead of from the validation action. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --only + +History: +- Introduced in Bazel x.x.x + +If this option is given, only sync the repositories specified with this option. Still consider all (or all configure-like, of --configure is given) outdated. + +_May apply to commands: sync_ + +## --remote_grpc_log + +History: +- Introduced in Bazel x.x.x + +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). + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --from + +History: +- Introduced in Bazel x.x.x + +The module(s) starting from which the dependency graph query will be displayed. Check each query’s description for the exact semantics. Defaults to . + + +_May apply to commands: mod_ + +## --experimental_include_default_values + +History: +- Introduced in Bazel x.x.x + +Whether Starlark options set to their default values are included in the output. + +_May apply to commands: canonicalize-flags_ + +## --experimental_remote_downloader_propagate_credentials + +History: +- Introduced in Bazel x.x.x + +Whether to propagate credentials from netrc and credential helper to the remote downloader server. The server implementation needs to support the new `http_header_url::` qualifier where the `` is a 0-based position of the URL inside the FetchBlobRequest's `uris` field. The URL-specific headers should take precedence over the global headers. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --sandbox_tmpfs_path + +History: +- Introduced in Bazel x.x.x + +For sandboxed actions, mount an empty, writable directory at this absolute path (if supported by the sandboxing implementation, ignored otherwise). + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --host_features + +History: +- Introduced in Bazel x.x.x + +The given features will be enabled or disabled by default for targets built in the exec configuration. Specifying - will disable the feature. Negative features always override positive ones. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_enable_execution_graph_log + +History: +- Introduced in Bazel x.x.x + +Enabling this flag makes Blaze write a file of all actions executed during a build. Note that this dump may use a different granularity of actions than other APIs, and may also contain additional information as necessary to reconstruct the full dependency graph in combination with other sources of data. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --windows_enable_symlinks + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: startup_ + +## --remote_accept_cached + +History: +- Introduced in Bazel x.x.x + +Whether to accept remotely cached action results. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --incompatible_disallow_struct_provider_syntax + +History: +- Introduced in Bazel x.x.x + +If set to true, rule implementation functions may not return a struct. They must instead return a list of provider instances. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --product_name + +History: +- Introduced in Bazel x.x.x + +The name of the build system. It is used as part of the name of the generated directories (e.g. productName-bin for binaries) as well as for printing error messages and logging + +_May apply to commands: startup_ + +## --grpc_keepalive_time + +History: +- Introduced in Bazel x.x.x + +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 + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --experimental_check_desugar_deps + +History: +- Introduced in Bazel x.x.x + +Whether to double-check correct desugaring at Android binary level. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --test_lang_filters + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --bes_keywords + +History: +- Introduced in Bazel x.x.x + +Specifies a list of notification keywords to be added the default set of keywords published to BES ("command_name= ", "protocol_name=BEP"). Defaults to none. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --host_force_python + +History: +- Introduced in Bazel x.x.x + +Overrides the Python version for the exec configuration. Can be "PY2" or "PY3". + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_force_gc_after_build + +History: +- Introduced in Bazel x.x.x + +If true calls System.gc() after a build to try and get a post-gc peak heap measurement. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --fission + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --host_java_launcher + +History: +- Introduced in Bazel x.x.x + +The Java launcher used by tools that are executed during a build. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_java_header_input_pruning + +History: +- Introduced in Bazel x.x.x + +No-op, kept only for backwards compatibility + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_use_semaphore_for_jobs + +History: +- Introduced in Bazel x.x.x + +If set to true, additionally use semaphore to limit number of concurrent jobs. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --cache_test_results (-t) + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_profile_include_target_configuration + +History: +- Introduced in Bazel x.x.x + +Includes target configuration hash in action events' JSON profile data. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --client_env + +History: +- Introduced in Bazel x.x.x + +A system-generated parameter which specifies the client's environment + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --strict_test_suite + +History: +- Introduced in Bazel x.x.x + +If true, the tests() expression gives an error if it encounters a test_suite containing non-test targets. + +_May apply to commands: query_ + +## --experimental_platform_cc_test + +History: +- Introduced in Bazel x.x.x + +If enabled, a Starlark version of cc_test can be used which will use platform-based toolchain() resolution to choose a test runner. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --proto:include_synthetic_attribute_hash + +History: +- Introduced in Bazel x.x.x + +Whether or not to calculate and populate the $internal_attr_hash attribute. + +_May apply to commands: aquery, cquery, query_ + +## --macos_cpus + +History: +- Introduced in Bazel x.x.x + +Comma-separated list of architectures for which to build Apple macOS binaries. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_disk_cache_gc_max_age + +History: +- Introduced in Bazel x.x.x + +If set to a positive value, the disk cache will be periodically garbage collected to remove entries older than this age. If set in conjunction with --experimental_disk_cache_gc_max_size, both criteria are applied. Garbage collection occurrs in the background once the server has become idle, as determined by the --experimental_disk_cache_gc_idle_delay flag. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --android_compiler + +History: +- Introduced in Bazel x.x.x + +The Android target compiler. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --proto:default_values + +History: +- Introduced in Bazel x.x.x + +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 + +_May apply to commands: aquery, cquery, query_ + +## --build_python_zip + +History: +- Introduced in Bazel x.x.x + +Build python executable zip; on on Windows, off on other platforms + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --incompatible_java_info_merge_runtime_module_flags + +History: +- Introduced in Bazel x.x.x + +If set to true, the JavaInfo constructor will merge add_exports and add_opens of runtime_deps in addition to deps and exports. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --incompatible_stop_exporting_language_modules + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --experimental_use_event_based_build_completion_status + +History: +- Introduced in Bazel x.x.x + +No-op + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --fatal_event_bus_exceptions + +History: +- Introduced in Bazel x.x.x + +Whether or not to exit if an exception is thrown by an internal EventBus handler. No-op if --fatal_async_exceptions_exclusions is available; that flag's behavior is preferentially used. + +_May apply to commands: startup_ + +## --incompatible_fail_on_unknown_attributes + +History: +- Introduced in Bazel x.x.x + +If enabled, targets that have unknown attributes set to None fail. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --ios_memleaks + +History: +- Introduced in Bazel x.x.x + +Enable checking for memory leaks in ios_test targets. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_omit_resources_info_provider_from_android_binary + +History: +- Introduced in Bazel x.x.x + +Omit AndroidResourcesInfo provider from android_binary rules. Propagating resources out to other binaries is usually unintentional. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --async + +History: +- Introduced in Bazel x.x.x + +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. + +_May apply to commands: clean_ + +## --experimental_build_event_output_group_mode + +History: +- Introduced in Bazel x.x.x + +Specify how an output group's files will be represented in TargetComplete/AspectComplete BEP events. Values are an assignment of an output group name to one of 'NAMED_SET_OF_FILES_ONLY', 'INLINE_ONLY', or 'BOTH'. The default value is 'NAMED_SET_OF_FILES_ONLY'. If an output group is repeated, the final value to appear is used. The default value sets the mode for coverage artifacts to BOTH: --experimental_build_event_output_group_mode=baseline.lcov=both + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## --incompatible_remove_legacy_whole_archive + +History: +- Introduced in Bazel x.x.x + +If true, Bazel will not link library dependencies as whole archive by default (see https://github.com/bazelbuild/bazel/issues/7362 for migration instructions). + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_objc_fastbuild_options + +History: +- Introduced in Bazel x.x.x + +Uses these strings as objc fastbuild compiler options. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_enable_skyfocus + +History: +- Introduced in Bazel x.x.x + +If true, enable the use of --experimental_working_set to reduce Bazel's memory footprint for incremental builds. This feature is known as Skyfocus. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --java_deps + +History: +- Introduced in Bazel x.x.x + +Generate dependency information (for now, compile-time classpath) per Java target. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_android_use_parallel_dex2oat + +History: +- Introduced in Bazel x.x.x + +Use dex2oat in parallel to possibly speed up android_test. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --coverage_report_generator + +History: +- Introduced in Bazel x.x.x + +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'. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --incompatible_py2_outputs_are_suffixed + +History: +- Introduced in Bazel x.x.x + +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`. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## --experimental_remote_execution_keepalive + +History: +- Introduced in Bazel x.x.x + +Whether to use keepalive for remote execution calls. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ diff --git a/8.4.2/flags.mdx b/8.4.2/flags.mdx new file mode 100644 index 00000000..e83f2dc8 --- /dev/null +++ b/8.4.2/flags.mdx @@ -0,0 +1,7403 @@ +--- +title: Bazel flags +--- +## logging + +### experimental + +#### --experimental_repository_resolved_file +effect: AFFECTS_OUTPUTS +allowsMultiple: false +requiresValue: true +defaultValue: +If non-empty, write a Starlark value with the resolved information of all Starlark repository rules that were executed. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, query, run, sync, test, vendor_ + +#### --experimental_materialize_param_files_directly +effect: EXECUTION +allowsMultiple: false +requiresValue: false +defaultValue: false +If materializing param files, do so with direct writes to disk. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --experimental_docker_verbose +effect: EXECUTION +allowsMultiple: false +requiresValue: false +defaultValue: false +If enabled, Bazel will print more verbose messages about the Docker sandbox strategy. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --experimental_skyfocus_handling_strategy +enum values: STRICT,WARN +effect: EAGERNESS_TO_EXIT +allowsMultiple: false +requiresValue: true +defaultValue: strict +Strategies for Skyfocus to handle changes outside of the working set. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --experimental_run_bep_event_include_residue +effect: AFFECTS_OUTPUTS +allowsMultiple: false +requiresValue: false +defaultValue: 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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --experimental_collect_pressure_stall_indicators +effect: BAZEL_MONITORING +allowsMultiple: false +requiresValue: false +defaultValue: false +If enabled, the profiler collects the Linux PSI data. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --experimental_stream_log_file_uploads +effect: AFFECTS_OUTPUTS +allowsMultiple: false +requiresValue: false +defaultValue: false +Stream log file uploads directly to the remote storage rather than writing them to disk. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --experimental_collect_skyframe_counts_in_profiler +effect: BAZEL_MONITORING +allowsMultiple: false +requiresValue: false +defaultValue: false +If enabled, the profiler collects SkyFunction counts in the Skyframe graph over time for key function types, like configured targets and action executions. May have a performance hit as this visits the ENTIRE Skyframe graph at every profiling time unit. Do not use this flag with performance-critical measurements. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --experimental_collect_local_sandbox_action_metrics +effect: NO_OP +allowsMultiple: false +requiresValue: false +defaultValue: true +Deprecated no-op. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --experimental_profile_include_target_label +effect: BAZEL_MONITORING +allowsMultiple: false +requiresValue: false +defaultValue: false +Includes target label in action events' JSON profile data. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --experimental_record_skyframe_metrics +effect: UNKNOWN +allowsMultiple: false +requiresValue: false +defaultValue: false +Controls the output of BEP BuildGraphMetrics, including expensiveto compute skyframe metrics about Skykeys, RuleClasses and Aspects.With this flag set to false BuildGraphMetrics.rule_count and aspectfields will not be populated in the BEP. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --experimental_workspace_rules_log_file +effect: UNKNOWN +allowsMultiple: false +requiresValue: true +defaultValue: +Log certain Workspace Rules events into this file as delimited WorkspaceEvent protos. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --experimental_build_event_upload_strategy +effect: AFFECTS_OUTPUTS +allowsMultiple: false +requiresValue: true +defaultValue: +Selects how to upload artifacts referenced in the build event protocol. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --experimental_collect_worker_data_in_profiler +effect: BAZEL_MONITORING +allowsMultiple: false +requiresValue: false +defaultValue: false +If enabled, the profiler collects worker's aggregated resource data. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --experimental_collect_load_average_in_profiler +effect: BAZEL_MONITORING +allowsMultiple: false +requiresValue: false +defaultValue: true +If enabled, the profiler collects the system's overall load average. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --experimental_build_event_expand_filesets +effect: AFFECTS_OUTPUTS +allowsMultiple: false +requiresValue: false +defaultValue: false +If true, expand Filesets in the BEP when presenting output files. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --experimental_collect_system_network_usage +effect: BAZEL_MONITORING +allowsMultiple: false +requiresValue: false +defaultValue: true +If enabled, the profiler collects the system's network usage. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --experimental_collect_resource_estimation +effect: BAZEL_MONITORING +allowsMultiple: false +requiresValue: false +defaultValue: false +If enabled, the profiler collects CPU and memory usage estimation for local actions. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --experimental_profile_additional_tasks +enum values: PHASE,ACTION,DISCOVER_INPUTS,ACTION_CHECK,ACTION_LOCK,ACTION_UPDATE,ACTION_COMPLETE,ACTION_REWINDING,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,LOCAL_ACTION_COUNTS,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,CONFLICT_CHECK,DYNAMIC_LOCK,REPOSITORY_FETCH,REPOSITORY_VENDOR,REPO_CACHE_GC_WAIT,SPAWN_LOG,WASM_LOAD,WASM_EXEC,UNKNOWN +effect: BAZEL_MONITORING +allowsMultiple: true +requiresValue: true +defaultValue: +Specifies additional profile tasks to be included in the profile. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --experimental_build_event_fully_resolve_fileset_symlinks +effect: AFFECTS_OUTPUTS +allowsMultiple: false +requiresValue: false +defaultValue: false +If true, fully resolve relative Fileset symlinks in the BEP when presenting output files. Requires --experimental_build_event_expand_filesets. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --experimental_record_metrics_for_all_mnemonics +effect: UNKNOWN +allowsMultiple: false +requiresValue: false +defaultValue: false +Controls the output of BEP ActionSummary and BuildGraphMetrics, limiting the number of mnemonics in ActionData and number of entries reported in BuildGraphMetrics.AspectCount/RuleClassCount. By default the number of types is limited to the top 20, by number of executed actions for ActionData, and instances for RuleClass and Asepcts. Setting this option will write statistics for all mnemonics, rule classes and aspects. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --experimental_bep_target_summary +effect: UNKNOWN +allowsMultiple: false +requiresValue: false +defaultValue: false +Whether to publish TargetSummary events. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --experimental_profile_include_primary_output +effect: BAZEL_MONITORING +allowsMultiple: false +requiresValue: false +defaultValue: false +Includes the extra "out" attribute in action events that contains the exec path to the action's primary output. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --experimental_build_event_upload_retry_minimum_delay +effect: BAZEL_INTERNAL_CONFIGURATION +allowsMultiple: false +requiresValue: true +defaultValue: 1s +Initial, minimum delay for exponential backoff retries when BEP upload fails. (exponent: 1.6) + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --experimental_skyfocus_dump_keys +enum values: NONE,COUNT,VERBOSE +effect: TERMINAL_OUTPUT +allowsMultiple: false +requiresValue: true +defaultValue: none +For debugging Skyfocus. Dump the focused SkyKeys (roots, leafs, focused deps, focused rdeps). + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --experimental_skyfocus_dump_post_gc_stats +effect: TERMINAL_OUTPUT +allowsMultiple: false +requiresValue: false +defaultValue: false +For debugging Skyfocus. If enabled, trigger manual GC before/after focusing to report heap sizes reductions. This will increase the Skyfocus latency. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --experimental_command_profile +enum values: cpu,wall,alloc,lock +effect: UNKNOWN +allowsMultiple: false +requiresValue: true +defaultValue: +Records a Java Flight Recorder profile for the duration of the command. One of the supported profiling event types (cpu, wall, alloc or lock) must be given as an argument. The profile is written to a file named after the event type under the output base directory. The syntax and semantics of this flag might change in the future to support additional profile types or output formats; use at your own risk. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --experimental_profile_include_target_configuration +effect: BAZEL_MONITORING +allowsMultiple: false +requiresValue: false +defaultValue: false +Includes target configuration hash in action events' JSON profile data. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --experimental_build_event_output_group_mode +effect: AFFECTS_OUTPUTS +allowsMultiple: true +requiresValue: true +defaultValue: +Specify how an output group's files will be represented in TargetComplete/AspectComplete BEP events. Values are an assignment of an output group name to one of 'NAMED_SET_OF_FILES_ONLY', 'INLINE_ONLY', or 'BOTH'. The default value is 'NAMED_SET_OF_FILES_ONLY'. If an output group is repeated, the final value to appear is used. The default value sets the mode for coverage artifacts to BOTH: --experimental_build_event_output_group_mode=baseline.lcov=both + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +### stable + +#### --show_make_env +effect: AFFECTS_OUTPUTS,TERMINAL_OUTPUT +allowsMultiple: false +requiresValue: false +defaultValue: false +Include the "Make" environment in the output. + +_May apply to commands: info_ + +#### --sandbox_debug +effect: TERMINAL_OUTPUT +allowsMultiple: false +requiresValue: false +defaultValue: 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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --ignore_unsupported_sandboxing +effect: TERMINAL_OUTPUT +allowsMultiple: false +requiresValue: false +defaultValue: false +Do not print a warning when sandboxed execution is not supported on this system. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --build_event_publish_all_actions +effect: AFFECTS_OUTPUTS +allowsMultiple: false +requiresValue: false +defaultValue: false +Whether all actions should be published. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --heap_dump_on_oom +effect: BAZEL_MONITORING +allowsMultiple: false +requiresValue: false +defaultValue: 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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --jvm_heap_histogram_internal_object_pattern +effect: UNKNOWN +allowsMultiple: false +requiresValue: true +defaultValue: jdk\.internal\.vm\.Filler.+ +Regex for overriding the matching logic for JDK21+ JVM heap memory collection. We are relying on volatile internal G1 GC implemenation details to get a clean memory metric, this option allows us to adapt to changes in that internal implementation without having to wait for a binary release. Passed to JDK Matcher.find() + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --announce_rc +effect: AFFECTS_OUTPUTS +allowsMultiple: false +requiresValue: false +defaultValue: false +Whether to announce rc options. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --tool_tag +effect: AFFECTS_OUTPUTS,BAZEL_MONITORING +allowsMultiple: false +requiresValue: true +defaultValue: +A tool name to attribute this Bazel invocation to. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --build_event_binary_file_upload_mode +enum values: WAIT_FOR_UPLOAD_COMPLETE,NOWAIT_FOR_UPLOAD_COMPLETE,FULLY_ASYNC +effect: EAGERNESS_TO_EXIT +allowsMultiple: false +requiresValue: true +defaultValue: 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'. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --bes_timeout +effect: AFFECTS_OUTPUTS +allowsMultiple: false +requiresValue: true +defaultValue: 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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --bes_oom_finish_upload_timeout +effect: BAZEL_MONITORING +allowsMultiple: false +requiresValue: true +defaultValue: 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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --print_relative_test_log_paths +effect: AFFECTS_OUTPUTS +allowsMultiple: false +requiresValue: false +defaultValue: false +If true, when printing the path to a test log, use relative path that makes use of the 'testlogs' convenience symlink. N.B. - A subsequent 'build'/'test'/etc invocation with a different configuration can cause the target of this symlink to change, making the path printed previously no longer useful. + +_May apply to commands: coverage, cquery, fetch, test, vendor_ + +#### --dump +effect: BAZEL_MONITORING +allowsMultiple: false +requiresValue: true +defaultValue: +output full profile data dump either in human-readable 'text' format or script-friendly 'raw' format. + +_May apply to commands: analyze-profile_ + +#### --profiles_to_retain +effect: BAZEL_MONITORING +allowsMultiple: false +requiresValue: true +defaultValue: 5 +Number of profiles to retain in the output base. If there are more than this number of profiles in the output base, the oldest are deleted until the total is under the limit. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --remote_print_execution_messages +enum values: FAILURE,SUCCESS,ALL +effect: TERMINAL_OUTPUT +allowsMultiple: false +requiresValue: true +defaultValue: 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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --build_event_binary_file +effect: AFFECTS_OUTPUTS +allowsMultiple: false +requiresValue: true +defaultValue: +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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --build_event_text_file +effect: AFFECTS_OUTPUTS +allowsMultiple: false +requiresValue: true +defaultValue: +If non-empty, write a textual representation of the build event protocol to that file + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --incremental_install_verbosity +effect: BAZEL_MONITORING +allowsMultiple: false +requiresValue: true +defaultValue: +The verbosity for incremental install. Set to 1 for debug logging. + +_May apply to commands: mobile-install_ + +#### --bes_instance_name +effect: AFFECTS_OUTPUTS +allowsMultiple: false +requiresValue: true +defaultValue: +Specifies the instance name under which the BES will persist uploaded BEP. Defaults to null. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --build_event_json_file +effect: AFFECTS_OUTPUTS +allowsMultiple: false +requiresValue: true +defaultValue: +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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --generate_json_trace_profile +effect: BAZEL_MONITORING +allowsMultiple: false +requiresValue: false +defaultValue: 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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --attempt_to_print_relative_paths +effect: TERMINAL_OUTPUT +allowsMultiple: false +requiresValue: false +defaultValue: 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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --bes_backend +effect: AFFECTS_OUTPUTS +allowsMultiple: false +requiresValue: true +defaultValue: +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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --test_verbose_timeout_warnings +effect: AFFECTS_OUTPUTS +allowsMultiple: false +requiresValue: false +defaultValue: false +If true, print additional warnings when the actual test execution time does not match the timeout defined by the test (whether implied or explicit). + +_May apply to commands: coverage, cquery, fetch, test, vendor_ + +#### --short +expands to --help_verbosity=short +effect: TERMINAL_OUTPUT +allowsMultiple: false +requiresValue: false +defaultValue: +Show only the names of the options, not their types or meanings. + +_May apply to commands: help_ + +#### --bes_results_url +effect: TERMINAL_OUTPUT +allowsMultiple: false +requiresValue: true +defaultValue: +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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --build_event_max_named_set_of_file_entries +effect: AFFECTS_OUTPUTS +allowsMultiple: false +requiresValue: true +defaultValue: 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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --verbose_explanations +effect: AFFECTS_OUTPUTS +allowsMultiple: false +requiresValue: false +defaultValue: false +Increases the verbosity of the explanations issued if --explain is enabled. Has no effect if --explain is not enabled. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --max_test_output_bytes +effect: TEST_RUNNER,TERMINAL_OUTPUT,EXECUTION +allowsMultiple: false +requiresValue: true +defaultValue: -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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --record_full_profiler_data +effect: BAZEL_MONITORING +allowsMultiple: false +requiresValue: false +defaultValue: 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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --build_event_upload_max_retries +effect: BAZEL_INTERNAL_CONFIGURATION +allowsMultiple: false +requiresValue: true +defaultValue: 4 +The maximum number of times Bazel should retry uploading a build event. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --test_output +enum values: SUMMARY,ERRORS,ALL,STREAMED +effect: TEST_RUNNER,TERMINAL_OUTPUT,EXECUTION +allowsMultiple: false +requiresValue: true +defaultValue: 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). + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --build_event_text_file_upload_mode +enum values: WAIT_FOR_UPLOAD_COMPLETE,NOWAIT_FOR_UPLOAD_COMPLETE,FULLY_ASYNC +effect: EAGERNESS_TO_EXIT +allowsMultiple: false +requiresValue: true +defaultValue: 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'. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --bes_lifecycle_events +effect: AFFECTS_OUTPUTS +allowsMultiple: false +requiresValue: false +defaultValue: true +Specifies whether to publish BES lifecycle events. (defaults to 'true'). + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --bes_proxy +effect: UNKNOWN +allowsMultiple: false +requiresValue: true +defaultValue: +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). + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --build_event_json_file_path_conversion +effect: AFFECTS_OUTPUTS +allowsMultiple: false +requiresValue: false +defaultValue: 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 + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --bes_check_preceding_lifecycle_events +effect: AFFECTS_OUTPUTS +allowsMultiple: false +requiresValue: false +defaultValue: 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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --max_config_changes_to_show +effect: TERMINAL_OUTPUT +allowsMultiple: false +requiresValue: true +defaultValue: 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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --profile +effect: BAZEL_MONITORING +allowsMultiple: false +requiresValue: true +defaultValue: +If set, profile Bazel and write data to the specified file. Use bazel analyze-profile to analyze the profile. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --memory_profile_stable_heap_parameters +effect: BAZEL_MONITORING +allowsMultiple: false +requiresValue: true +defaultValue: 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 + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --build_event_text_file_path_conversion +effect: AFFECTS_OUTPUTS +allowsMultiple: false +requiresValue: false +defaultValue: 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 + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --test_summary +enum values: SHORT,TERSE,DETAILED,NONE,TESTCASE +effect: TERMINAL_OUTPUT +allowsMultiple: false +requiresValue: true +defaultValue: 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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --legacy_important_outputs +effect: AFFECTS_OUTPUTS +allowsMultiple: false +requiresValue: false +defaultValue: false +Use this to suppress generation of the legacy important_outputs field in the TargetComplete event. important_outputs are required for Bazel to ResultStore/BTX integration. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --debug_spawn_scheduler +effect: UNKNOWN +allowsMultiple: false +requiresValue: false +defaultValue: false + + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --bes_header +effect: AFFECTS_OUTPUTS +allowsMultiple: true +requiresValue: true +defaultValue: +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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --explain +effect: AFFECTS_OUTPUTS +allowsMultiple: false +requiresValue: true +defaultValue: +Causes the build system to explain each executed step of the build. The explanation is written to the specified log file. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --redirect_local_instrumentation_output_writes +effect: BAZEL_MONITORING +allowsMultiple: false +requiresValue: false +defaultValue: false +If true and supported, instrumentation output is redirected to be written locally on a different machine than where bazel is running on. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --bes_outerr_buffer_size +effect: AFFECTS_OUTPUTS +allowsMultiple: false +requiresValue: true +defaultValue: 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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --verbose_failures +effect: TERMINAL_OUTPUT +allowsMultiple: false +requiresValue: false +defaultValue: false +If a command fails, print out the full command line. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --toolchain_resolution_debug +effect: TERMINAL_OUTPUT +allowsMultiple: false +requiresValue: true +defaultValue: -.* +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --starlark_cpu_profile +effect: BAZEL_MONITORING +allowsMultiple: false +requiresValue: true +defaultValue: +Writes into the specified file a pprof profile of CPU usage by all Starlark threads. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --output_filter +effect: AFFECTS_OUTPUTS +allowsMultiple: false +requiresValue: true +defaultValue: +Only shows warnings and action outputs for rules with a name matching the provided regular expression. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --build_event_json_file_upload_mode +enum values: WAIT_FOR_UPLOAD_COMPLETE,NOWAIT_FOR_UPLOAD_COMPLETE,FULLY_ASYNC +effect: EAGERNESS_TO_EXIT +allowsMultiple: false +requiresValue: true +defaultValue: 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'. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --slim_profile +effect: BAZEL_MONITORING +allowsMultiple: false +requiresValue: false +defaultValue: true +Slims down the size of the JSON profile by merging events if the profile gets too large. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --show_result +effect: AFFECTS_OUTPUTS +allowsMultiple: false +requiresValue: true +defaultValue: 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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --bes_upload_mode +enum values: WAIT_FOR_UPLOAD_COMPLETE,NOWAIT_FOR_UPLOAD_COMPLETE,FULLY_ASYNC +effect: EAGERNESS_TO_EXIT +allowsMultiple: false +requiresValue: true +defaultValue: 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'. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --long +expands to --help_verbosity=long +effect: TERMINAL_OUTPUT +allowsMultiple: false +requiresValue: false +defaultValue: +Show full description of each option, instead of just its name. + +_May apply to commands: help_ + +#### --subcommands +enum values: TRUE,PRETTY_PRINT,FALSE +effect: TERMINAL_OUTPUT +allowsMultiple: false +requiresValue: false +defaultValue: 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). + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --build_event_binary_file_path_conversion +effect: AFFECTS_OUTPUTS +allowsMultiple: false +requiresValue: false +defaultValue: 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 + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --memory_profile +effect: BAZEL_MONITORING +allowsMultiple: false +requiresValue: true +defaultValue: +If set, write memory usage data to the specified file at phase ends and stable heap to master log at end of build. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --help_verbosity +enum values: LONG,MEDIUM,SHORT +effect: TERMINAL_OUTPUT +allowsMultiple: false +requiresValue: true +defaultValue: medium +Select the verbosity of the help command. + +_May apply to commands: help_ + +#### --materialize_param_files +effect: EXECUTION +allowsMultiple: false +requiresValue: false +defaultValue: false +Writes intermediate parameter files to output tree even when using remote action execution or caching. Useful when debugging actions. This is implied by --subcommands and --verbose_failures. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --verbose_test_summary +effect: AFFECTS_OUTPUTS +allowsMultiple: false +requiresValue: false +defaultValue: true +If true, print additional information (timing, number of failed runs, etc) in the test summary. + +_May apply to commands: coverage, cquery, fetch, test, vendor_ + +#### --progress_report_interval +effect: AFFECTS_OUTPUTS +allowsMultiple: false +requiresValue: true +defaultValue: 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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --bes_system_keywords +effect: AFFECTS_OUTPUTS +allowsMultiple: true +requiresValue: true +defaultValue: +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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --ui_event_filters +effect: TERMINAL_OUTPUT +allowsMultiple: true +requiresValue: true +defaultValue: +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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --logging +effect: AFFECTS_OUTPUTS +allowsMultiple: false +requiresValue: true +defaultValue: 3 +The logging level. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --bes_outerr_chunk_size +effect: AFFECTS_OUTPUTS +allowsMultiple: false +requiresValue: true +defaultValue: 1048576 +Specifies the maximal size of stdout or stderr to be sent to BEP in a single message. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --bes_keywords +effect: AFFECTS_OUTPUTS +allowsMultiple: true +requiresValue: true +defaultValue: +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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## starlark_semantics + +### incompatible_change + +#### --incompatible_no_implicit_watch_label +effect: LOADING_AND_ANALYSIS +allowsMultiple: false +requiresValue: false +defaultValue: true +If true, then methods on <code>repository_ctx</code> that are passed a Label will no longer automatically watch the file under that label for changes even if <code>watch = "no"</code>, and <code>repository_ctx.path</code> no longer causes the returned path to be watched. Use <code>repository_ctx.watch</code> instead. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --incompatible_depset_for_libraries_to_link_getter +effect: LOADING_AND_ANALYSIS +allowsMultiple: false +requiresValue: false +defaultValue: true +When true, Bazel no longer returns a list from linking_context.libraries_to_link but returns a depset instead. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --incompatible_disallow_empty_glob +effect: BUILD_FILE_SEMANTICS +allowsMultiple: false +requiresValue: false +defaultValue: true +If set to true, the default value of the `allow_empty` argument of glob() is False. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --incompatible_java_common_parameters +effect: BUILD_FILE_SEMANTICS +allowsMultiple: false +requiresValue: false +defaultValue: true +If set to true, the output_jar, and host_javabase parameters in pack_sources and host_javabase in compile will all be removed. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --incompatible_merge_fixed_and_default_shell_env +effect: LOADING_AND_ANALYSIS +allowsMultiple: false +requiresValue: false +defaultValue: 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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --incompatible_no_rule_outputs_param +effect: BUILD_FILE_SEMANTICS +allowsMultiple: false +requiresValue: false +defaultValue: false +If set to true, disables the `outputs` parameter of the `rule()` Starlark function. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --incompatible_disallow_legacy_py_provider +effect: LOADING_AND_ANALYSIS +allowsMultiple: false +requiresValue: false +defaultValue: true +No-op, will be removed soon. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --incompatible_disable_autoloads_in_main_repo +effect: LOADING_AND_ANALYSIS +allowsMultiple: false +requiresValue: false +defaultValue: false +Controls if the autoloads (set by --incompatible_autoload_externally) are enabled in themain repository. When enabled the rules (or other symbols) that were previously part of Bazel need to have load statements. Use buildifier to add them. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --incompatible_always_check_depset_elements +effect: BUILD_FILE_SEMANTICS +allowsMultiple: false +requiresValue: false +defaultValue: 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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --incompatible_depset_for_java_output_source_jars +effect: NO_OP +allowsMultiple: false +requiresValue: false +defaultValue: true +No-op. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --incompatible_disable_starlark_host_transitions +effect: LOADING_AND_ANALYSIS +allowsMultiple: false +requiresValue: false +defaultValue: false +If set to true, rule attributes cannot set 'cfg = "host"'. Rules should set 'cfg = "exec"' instead. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --incompatible_python_disallow_native_rules +effect: LOADING_AND_ANALYSIS +allowsMultiple: false +requiresValue: false +defaultValue: 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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --incompatible_run_shell_command_string +effect: BUILD_FILE_SEMANTICS +allowsMultiple: false +requiresValue: false +defaultValue: true +If set to true, the command parameter of actions.run_shell will only accept string + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --repositories_without_autoloads +effect: LOSES_INCREMENTAL_STATE,BUILD_FILE_SEMANTICS +allowsMultiple: false +requiresValue: true +defaultValue: +A list of additional repositories (beyond the hardcoded ones Bazel knows about) where autoloads are not to be added. This should typically contain repositories that are transitively depended on by a repository that may be loaded automatically (and which can therefore potentially create a cycle). + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --incompatible_simplify_unconditional_selects_in_rule_attrs +effect: BUILD_FILE_SEMANTICS +allowsMultiple: false +requiresValue: false +defaultValue: true +If true, simplify configurable rule attributes which contain only unconditional selects; for example, if ["a"] + select("//conditions:default", ["b"]) is assigned to a rule attribute, it is stored as ["a", "b"]. This option does not affect attributes of symbolic macros or attribute default values. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --incompatible_config_setting_private_default_visibility +effect: LOADING_AND_ANALYSIS +allowsMultiple: false +requiresValue: false +defaultValue: 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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, mod, print_action, query, run, sync, test, vendor_ + +#### --incompatible_require_linker_input_cc_api +effect: BUILD_FILE_SEMANTICS,LOADING_AND_ANALYSIS +allowsMultiple: false +requiresValue: false +defaultValue: 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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --incompatible_enforce_config_setting_visibility +effect: LOADING_AND_ANALYSIS +allowsMultiple: false +requiresValue: false +defaultValue: 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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, mod, print_action, query, run, sync, test, vendor_ + +#### --incompatible_visibility_private_attributes_at_definition +effect: NO_OP +allowsMultiple: false +requiresValue: false +defaultValue: true +No-op + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --incompatible_no_attr_license +effect: BUILD_FILE_SEMANTICS +allowsMultiple: false +requiresValue: false +defaultValue: true +If set to true, disables the function `attr.license`. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --incompatible_use_cc_configure_from_rules_cc +effect: LOADING_AND_ANALYSIS +allowsMultiple: false +requiresValue: false +defaultValue: 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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --incompatible_stop_exporting_build_file_path +effect: LOADING_AND_ANALYSIS +allowsMultiple: false +requiresValue: false +defaultValue: false +If set to true, deprecated ctx.build_file_path will not be available. ctx.label.package + '/BUILD' can be used instead. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --incompatible_no_implicit_file_export +effect: BUILD_FILE_SEMANTICS +allowsMultiple: false +requiresValue: false +defaultValue: 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 + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --incompatible_autoload_externally +effect: LOSES_INCREMENTAL_STATE,BUILD_FILE_SEMANTICS +allowsMultiple: false +requiresValue: true +defaultValue: +@rules_python,+java_common,+JavaInfo,+JavaPluginInfo,ProguardSpecProvider,java_binary,java_import,java_library,java_plugin,java_test,java_runtime,java_toolchain,java_package_configuration,@com_google_protobuf,@rules_shell,+@rules_android +A comma-separated list of rules (or other symbols) that were previously part of Bazel and which are now to be retrieved from their respective external repositories. This flag is intended to be used to facilitate migration of rules out of Bazel. See also https://github.com/bazelbuild/bazel/issues/23043. +A symbol that is autoloaded within a file behaves as if its built-into-Bazel definition were replaced by its canonical new definition in an external repository. For a BUILD file, this essentially means implicitly adding a load() statement. For a .bzl file, it's either a load() statement or a change to a field of the `native` object, depending on whether the autoloaded symbol is a rule. +Bazel maintains a hardcoded list of all symbols that may be autoloaded; only those symbols may appear in this flag. For each symbol, Bazel knows the new definition location in an external repository, as well as a set of special-cased repositories that must not autoload it to avoid creating cycles. +A list item of "+foo" in this flag causes symbol foo to be autoloaded, except in foo's exempt repositories, within which the Bazel-defined version of foo is still available. +A list item of "foo" triggers autoloading as above, but the Bazel-defined version of foo is not made available to the excluded repositories. This ensures that foo's external repository does not depend on the old Bazel implementation of foo +A list item of "-foo" does not trigger any autoloading, but makes the Bazel-defined version of foo inaccessible throughout the workspace. This is used to validate that the workspace is ready for foo's definition to be deleted from Bazel. +If a symbol is not named in this flag then it continues to work as normal -- no autoloading is done, nor is the Bazel-defined version suppressed. For configuration see https://github.com/bazelbuild/bazel/blob/master/src/main/java/com/google/devtools/build/lib/packages/AutoloadSymbols.java As a shortcut also whole repository may be used, for example +@rules_python will autoload all Python rules. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --incompatible_disable_target_default_provider_fields +effect: BUILD_FILE_SEMANTICS +allowsMultiple: false +requiresValue: false +defaultValue: 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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --incompatible_disable_target_provider_fields +effect: BUILD_FILE_SEMANTICS +allowsMultiple: false +requiresValue: false +defaultValue: 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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --incompatible_objc_alwayslink_by_default +effect: BUILD_FILE_SEMANTICS +allowsMultiple: false +requiresValue: false +defaultValue: false +If true, make the default value true for alwayslink attributes in objc_library and objc_import. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --incompatible_locations_prefers_executable +effect: LOADING_AND_ANALYSIS +allowsMultiple: false +requiresValue: false +defaultValue: true +Whether a target that provides an executable expands to the executable rather than the files in <code>DefaultInfo.files</code> under $(locations ...) expansion if the number of files is not 1. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --incompatible_disallow_sdk_frameworks_attributes +effect: BUILD_FILE_SEMANTICS +allowsMultiple: false +requiresValue: false +defaultValue: false +If true, disallow sdk_frameworks and weak_sdk_frameworks attributes in objc_library andobjc_import. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --incompatible_new_actions_api +effect: NO_OP +allowsMultiple: false +requiresValue: false +defaultValue: true +No-op + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --incompatible_package_group_has_public_syntax +effect: BUILD_FILE_SEMANTICS +allowsMultiple: false +requiresValue: false +defaultValue: true +In package_group's `packages` attribute, allows writing "public" or "private" to refer to all packages or no packages respectively. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --incompatible_disallow_ctx_resolve_tools +effect: LOADING_AND_ANALYSIS +allowsMultiple: false +requiresValue: false +defaultValue: true +If set to true, calling the deprecated ctx.resolve_tools API always fails. Uses of this API should be replaced by an executable or tools argument to ctx.actions.run or ctx.actions.run_shell. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --incompatible_top_level_aspects_require_providers +effect: LOADING_AND_ANALYSIS +allowsMultiple: false +requiresValue: false +defaultValue: true +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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --incompatible_fix_package_group_reporoot_syntax +effect: BUILD_FILE_SEMANTICS +allowsMultiple: false +requiresValue: false +defaultValue: 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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --incompatible_unambiguous_label_stringification +effect: LOADING_AND_ANALYSIS +allowsMultiple: false +requiresValue: false +defaultValue: 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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --incompatible_disable_objc_library_transition +effect: BUILD_FILE_SEMANTICS +allowsMultiple: false +requiresValue: false +defaultValue: true +Disable objc_library's custom transition and inherit from the top level target instead (No-op in Bazel) + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --incompatible_disallow_struct_provider_syntax +effect: BUILD_FILE_SEMANTICS +allowsMultiple: false +requiresValue: false +defaultValue: true +If set to true, rule implementation functions may not return a struct. They must instead return a list of provider instances. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --incompatible_stop_exporting_language_modules +effect: LOADING_AND_ANALYSIS +allowsMultiple: false +requiresValue: false +defaultValue: 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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --incompatible_fail_on_unknown_attributes +effect: LOADING_AND_ANALYSIS +allowsMultiple: false +requiresValue: false +defaultValue: true +If enabled, targets that have unknown attributes set to None fail. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +### stable + +#### --enable_workspace +effect: LOADING_AND_ANALYSIS +allowsMultiple: false +requiresValue: false +defaultValue: false +If true, enables the legacy WORKSPACE system for external dependencies. See https://bazel.build/external/overview for more information. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --incompatible_enable_deprecated_label_apis +effect: LOADING_AND_ANALYSIS +allowsMultiple: false +requiresValue: false +defaultValue: true +If enabled, certain deprecated APIs (native.repository_name, Label.workspace_name, Label.relative) can be used. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --nested_set_depth_limit +effect: LOADING_AND_ANALYSIS +allowsMultiple: false +requiresValue: true +defaultValue: 3500 +The maximum depth of the graph internal to a depset (also known as NestedSet), above which the depset() constructor will fail. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --enable_bzlmod +effect: LOADING_AND_ANALYSIS +allowsMultiple: false +requiresValue: false +defaultValue: true +If true, enables the Bzlmod dependency management system, taking precedence over WORKSPACE. See https://bazel.build/docs/bzlmod for more information. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --max_computation_steps +effect: BUILD_FILE_SEMANTICS +allowsMultiple: false +requiresValue: true +defaultValue: 0 +The maximum number of Starlark computation steps that may be executed by a BUILD file (zero means no limit). + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --separate_aspect_deps +effect: NO_OP +allowsMultiple: false +requiresValue: false +defaultValue: true +No-op + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --incompatible_use_plus_in_repo_names +effect: LOADING_AND_ANALYSIS +allowsMultiple: false +requiresValue: false +defaultValue: true +No-op. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +### experimental + +#### --experimental_enable_scl_dialect +effect: BUILD_FILE_SEMANTICS +allowsMultiple: false +requiresValue: false +defaultValue: true +If set to true, .scl files may be used in load() statements. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --experimental_dormant_deps +effect: BUILD_FILE_SEMANTICS +allowsMultiple: false +requiresValue: false +defaultValue: false + If set to true, attr.label(materializer=), attr(for_dependency_resolution=), attr.dormant_label(), attr.dormant_label_list() and rule(for_dependency_resolution=) are allowed. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --experimental_enable_starlark_set +effect: BUILD_FILE_SEMANTICS +allowsMultiple: false +requiresValue: false +defaultValue: true +If true, enable the set data type and set() constructor in Starlark. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --experimental_action_resource_set +effect: NO_OP +allowsMultiple: false +requiresValue: false +defaultValue: true +No-op. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --incompatible_allow_tags_propagation +effect: BUILD_FILE_SEMANTICS +allowsMultiple: false +requiresValue: false +defaultValue: 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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --experimental_cc_shared_library +effect: BUILD_FILE_SEMANTICS,LOADING_AND_ANALYSIS +allowsMultiple: false +requiresValue: false +defaultValue: false +If set to true, rule attributes and Starlark API methods needed for the rule cc_shared_library will be available + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --experimental_isolated_extension_usages +effect: LOADING_AND_ANALYSIS +allowsMultiple: false +requiresValue: false +defaultValue: 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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --experimental_sibling_repository_layout +effect: ACTION_COMMAND_LINES,BAZEL_INTERNAL_CONFIGURATION,LOADING_AND_ANALYSIS,LOSES_INCREMENTAL_STATE +allowsMultiple: false +requiresValue: false +defaultValue: 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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --experimental_disable_external_package +effect: LOADING_AND_ANALYSIS,LOSES_INCREMENTAL_STATE +allowsMultiple: false +requiresValue: false +defaultValue: 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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --experimental_java_library_export +effect: LOADING_AND_ANALYSIS +allowsMultiple: false +requiresValue: false +defaultValue: false +If enabled, experimental_java_library_export_do_not_use module is available. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --experimental_platforms_api +effect: LOADING_AND_ANALYSIS +allowsMultiple: false +requiresValue: false +defaultValue: false +If set to true, enables a number of platform-related Starlark APIs useful for debugging. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --experimental_google_legacy_api +effect: LOADING_AND_ANALYSIS +allowsMultiple: false +requiresValue: false +defaultValue: false +If set to true, exposes a number of experimental pieces of Starlark build API pertaining to Google legacy code. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --experimental_single_package_toolchain_binding +effect: LOADING_AND_ANALYSIS +allowsMultiple: false +requiresValue: false +defaultValue: false +If enabled, the register_toolchain function may not include target patterns which may refer to more than one package. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --experimental_bzl_visibility +effect: LOADING_AND_ANALYSIS +allowsMultiple: false +requiresValue: false +defaultValue: 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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --experimental_repo_remote_exec +effect: BUILD_FILE_SEMANTICS,LOADING_AND_ANALYSIS +allowsMultiple: false +requiresValue: false +defaultValue: false +If set to true, repository_rule gains some remote execution capabilities. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --experimental_enable_first_class_macros +effect: BUILD_FILE_SEMANTICS +allowsMultiple: false +requiresValue: false +defaultValue: true +If set to true, enables the `macro()` construct for defining symbolic macros. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --experimental_enable_android_migration_apis +effect: BUILD_FILE_SEMANTICS +allowsMultiple: false +requiresValue: false +defaultValue: false +If set to true, enables the APIs required to support the Android Starlark migration. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --experimental_repository_ctx_execute_wasm +effect: LOADING_AND_ANALYSIS +allowsMultiple: false +requiresValue: false +defaultValue: false +If true enables the repository_ctx `load_wasm` and `execute_wasm` methods. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## bazel_client_options + +### stable + +#### --autodetect_server_javabase +effect: AFFECTS_OUTPUTS,LOSES_INCREMENTAL_STATE +allowsMultiple: false +requiresValue: false +defaultValue: true +When --noautodetect_server_javabase is passed, Bazel does not fall back to the local JDK for running the bazel server and instead exits. + +_May apply to commands: startup_ + +#### --quiet +effect: AFFECTS_OUTPUTS,BAZEL_MONITORING +allowsMultiple: false +requiresValue: false +defaultValue: false +If true, no informational messages are emitted on the console, only errors. Changing this option will not cause the server to restart. + +_May apply to commands: startup_ + +#### --repository_cache +effect: BAZEL_INTERNAL_CONFIGURATION +allowsMultiple: false +requiresValue: true +defaultValue: +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 + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --unlimit_coredumps +effect: BAZEL_INTERNAL_CONFIGURATION +allowsMultiple: false +requiresValue: false +defaultValue: 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. + +_May apply to commands: startup_ + +#### --shutdown_on_low_sys_mem +effect: EAGERNESS_TO_EXIT,LOSES_INCREMENTAL_STATE +allowsMultiple: false +requiresValue: false +defaultValue: 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. + +_May apply to commands: startup_ + +#### --run_env +effect: AFFECTS_OUTPUTS +allowsMultiple: true +requiresValue: true +defaultValue: +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. + +_May apply to commands: run_ + +#### --http_max_parallel_downloads +effect: BAZEL_INTERNAL_CONFIGURATION +allowsMultiple: false +requiresValue: true +defaultValue: 8 +The maximum number parallel http downloads. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --output_base +effect: AFFECTS_OUTPUTS,LOSES_INCREMENTAL_STATE +allowsMultiple: false +requiresValue: true +defaultValue: +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. + +_May apply to commands: startup_ + +#### --preemptible +effect: EAGERNESS_TO_EXIT +allowsMultiple: false +requiresValue: false +defaultValue: false +If true, the command can be preempted if another command is started. + +_May apply to commands: startup_ + +#### --repository_disable_download +effect: BAZEL_INTERNAL_CONFIGURATION +allowsMultiple: false +requiresValue: false +defaultValue: 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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --run +effect: AFFECTS_OUTPUTS +allowsMultiple: false +requiresValue: false +defaultValue: true +If false, skip running the command line constructed for the built target. Note that this flag is ignored for all --script_path builds. + +_May apply to commands: run_ + +#### --idle_server_tasks +effect: LOSES_INCREMENTAL_STATE,HOST_MACHINE_RESOURCE_OPTIMIZATIONS +allowsMultiple: false +requiresValue: false +defaultValue: true +Run System.gc() when the server is idle + +_May apply to commands: startup_ + +#### --digest_function +effect: LOSES_INCREMENTAL_STATE,BAZEL_INTERNAL_CONFIGURATION +allowsMultiple: false +requiresValue: true +defaultValue: +The hash function to use when computing file digests. + +_May apply to commands: startup_ + +#### --batch_cpu_scheduling +effect: HOST_MACHINE_RESOURCE_OPTIMIZATIONS +allowsMultiple: false +requiresValue: false +defaultValue: 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. + +_May apply to commands: startup_ + +#### --repo_contents_cache +effect: BAZEL_INTERNAL_CONFIGURATION +allowsMultiple: false +requiresValue: true +defaultValue: +Specifies the location of the repo contents cache, which contains fetched repo directories shareable across workspaces. An empty string as argument requests the repo contents cache to be disabled. + + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --ignore_all_rc_files +effect: CHANGES_INPUTS +allowsMultiple: false +requiresValue: false +defaultValue: 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. + +_May apply to commands: startup_ + +#### --repo_contents_cache_gc_idle_delay +effect: BAZEL_INTERNAL_CONFIGURATION +allowsMultiple: false +requiresValue: true +defaultValue: 5m +Specifies the amount of time the server must remain idle before garbage collection happens +to the repo contents cache. + + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --output_user_root +effect: AFFECTS_OUTPUTS,LOSES_INCREMENTAL_STATE +allowsMultiple: false +requiresValue: true +defaultValue: +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. + +_May apply to commands: startup_ + +#### --incompatible_disable_native_repo_rules +effect: BAZEL_INTERNAL_CONFIGURATION +allowsMultiple: false +requiresValue: false +defaultValue: false +If false, native repo rules can be used in WORKSPACE; otherwise, Starlark repo rules must be used instead. Native repo rules include local_repository, new_local_repository, and local_config_platform. When this flag is set, the local_config_platform built-in module is also unavailable in Bzlmod; use `@platforms//host` instead. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --http_timeout_scaling +effect: BAZEL_INTERNAL_CONFIGURATION +allowsMultiple: false +requiresValue: true +defaultValue: 1.0 +Scale all timeouts related to http downloads by the given factor + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --server_jvm_out +effect: AFFECTS_OUTPUTS,LOSES_INCREMENTAL_STATE +allowsMultiple: false +requiresValue: true +defaultValue: +The location to write the server's JVM's output. If unset then defaults to a location in output_base. + +_May apply to commands: startup_ + +#### --workspace_rc +effect: CHANGES_INPUTS +allowsMultiple: false +requiresValue: false +defaultValue: true +Whether or not to look for the workspace bazelrc file at $workspace/.bazelrc + +_May apply to commands: startup_ + +#### --home_rc +effect: CHANGES_INPUTS +allowsMultiple: false +requiresValue: false +defaultValue: true +Whether or not to look for the home bazelrc file at $HOME/.bazelrc + +_May apply to commands: startup_ + +#### --failure_detail_out +effect: AFFECTS_OUTPUTS,LOSES_INCREMENTAL_STATE +allowsMultiple: false +requiresValue: true +defaultValue: +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. + +_May apply to commands: startup_ + +#### --system_rc +effect: CHANGES_INPUTS +allowsMultiple: false +requiresValue: false +defaultValue: true +Whether or not to look for the system-wide bazelrc. + +_May apply to commands: startup_ + +#### --macos_qos_class +effect: HOST_MACHINE_RESOURCE_OPTIMIZATIONS +allowsMultiple: false +requiresValue: true +defaultValue: 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. + +_May apply to commands: startup_ + +#### --http_connector_attempts +effect: BAZEL_INTERNAL_CONFIGURATION +allowsMultiple: false +requiresValue: true +defaultValue: 8 +The maximum number of attempts for http downloads. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --io_nice_level +effect: HOST_MACHINE_RESOURCE_OPTIMIZATIONS +allowsMultiple: false +requiresValue: true +defaultValue: -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. + +_May apply to commands: startup_ + +#### --portable_paths +effect: AFFECTS_OUTPUTS +allowsMultiple: false +requiresValue: false +defaultValue: false +If true, includes paths to replace in ExecRequest to make the resulting paths portable. + +_May apply to commands: run_ + +#### --block_for_lock +effect: EAGERNESS_TO_EXIT +allowsMultiple: false +requiresValue: false +defaultValue: true +When --noblock_for_lock is passed, Bazel does not wait for a running command to complete, but instead exits immediately. + +_May apply to commands: startup_ + +#### --distdir +effect: BAZEL_INTERNAL_CONFIGURATION +allowsMultiple: true +requiresValue: true +defaultValue: +Additional places to search for archives before accessing the network to download them. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --http_connector_retry_max_timeout +effect: BAZEL_INTERNAL_CONFIGURATION +allowsMultiple: false +requiresValue: true +defaultValue: 0s +The maximum timeout for http download retries. With a value of 0, no timeout maximum is defined. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --connect_timeout_secs +effect: BAZEL_INTERNAL_CONFIGURATION +allowsMultiple: false +requiresValue: true +defaultValue: 30 +The amount of time the client waits for each attempt to connect to the server + +_May apply to commands: startup_ + +#### --local_startup_timeout_secs +effect: BAZEL_INTERNAL_CONFIGURATION +allowsMultiple: false +requiresValue: true +defaultValue: 120 +The maximum amount of time the client waits to connect to the server + +_May apply to commands: startup_ + +#### --client_debug +effect: AFFECTS_OUTPUTS,BAZEL_MONITORING +allowsMultiple: false +requiresValue: false +defaultValue: false +If true, log debug information from the client to stderr. Changing this option will not cause the server to restart. + +_May apply to commands: startup_ + +#### --max_idle_secs +effect: EAGERNESS_TO_EXIT,LOSES_INCREMENTAL_STATE +allowsMultiple: false +requiresValue: true +defaultValue: 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. + +_May apply to commands: startup_ + +#### --bazelrc +effect: CHANGES_INPUTS +allowsMultiple: true +requiresValue: true +defaultValue: +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. + +_May apply to commands: startup_ + +#### --windows_enable_symlinks +effect: BAZEL_INTERNAL_CONFIGURATION +allowsMultiple: false +requiresValue: false +defaultValue: false +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. + +_May apply to commands: startup_ + +#### --repo_contents_cache_gc_max_age +effect: BAZEL_INTERNAL_CONFIGURATION +allowsMultiple: false +requiresValue: true +defaultValue: 14d +Specifies the amount of time an entry in the repo contents cache can stay unused before it's garbage collected. If set to zero, garbage collection is disabled. + + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +### experimental + +#### --experimental_run_in_user_cgroup +effect: BAZEL_MONITORING,EXECUTION +allowsMultiple: false +requiresValue: false +defaultValue: false +If true, the Bazel server will be run with systemd-run, and the user will own the cgroup. This flag only takes effect on Linux. + +_May apply to commands: startup_ + +#### --experimental_scale_timeouts +effect: BAZEL_INTERNAL_CONFIGURATION +allowsMultiple: false +requiresValue: true +defaultValue: 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 + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --experimental_cgroup_parent +effect: BAZEL_MONITORING,EXECUTION +allowsMultiple: false +requiresValue: true +defaultValue: +The cgroup where to start the bazel server as an absolute path. The server process will be started in the specified cgroup for each supported controller. For example, if the value of this flag is /build/bazel and the cpu and memory controllers are mounted respectively on /sys/fs/cgroup/cpu and /sys/fs/cgroup/memory, the server will be started in the cgroups /sys/fs/cgroup/cpu/build/bazel and /sys/fs/cgroup/memory/build/bazel.It is not an error if the specified cgroup is not writable for one or more of the controllers. This options does not have any effect on platforms that do not support cgroups. + +_May apply to commands: startup_ + +#### --experimental_repository_downloader_retries +effect: UNKNOWN +allowsMultiple: false +requiresValue: true +defaultValue: 5 +The maximum number of attempts to retry a download error. If set to 0, retries are disabled. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --experimental_repository_cache_hardlinks +effect: BAZEL_INTERNAL_CONFIGURATION +allowsMultiple: false +requiresValue: false +defaultValue: false +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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +### deprecated + +#### --batch +effect: LOSES_INCREMENTAL_STATE,BAZEL_INTERNAL_CONFIGURATION +allowsMultiple: false +requiresValue: false +defaultValue: 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. + +_May apply to commands: startup_ + +#### --watchfs +effect: UNKNOWN +allowsMultiple: false +requiresValue: false +defaultValue: 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. + +_May apply to commands: startup, analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## output_parameters + +### stable + +#### --host_conlyopt +effect: ACTION_COMMAND_LINES,AFFECTS_OUTPUTS +allowsMultiple: true +requiresValue: true +defaultValue: +Additional option to pass to the C compiler when compiling C (but not C++) source files in the exec configurations. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --instrumentation_filter +effect: AFFECTS_OUTPUTS +allowsMultiple: false +requiresValue: true +defaultValue: -/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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, mod, print_action, query, run, sync, test, vendor_ + +#### --fat_apk_hwasan +effect: NO_OP +allowsMultiple: false +requiresValue: false +defaultValue: false +No-op flag. Will be removed in a future release. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --run_under +effect: ACTION_COMMAND_LINES +allowsMultiple: false +requiresValue: true +defaultValue: +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'. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, mod, print_action, query, run, sync, test, vendor_ + +#### --android_dynamic_mode +enum values: OFF,DEFAULT,FULLY +effect: AFFECTS_OUTPUTS,LOADING_AND_ANALYSIS +allowsMultiple: false +requiresValue: true +defaultValue: 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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --share_native_deps +effect: LOADING_AND_ANALYSIS,AFFECTS_OUTPUTS +allowsMultiple: false +requiresValue: false +defaultValue: true +If true, native libraries that contain identical functionality will be shared among different targets + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --ios_multi_cpus +effect: LOSES_INCREMENTAL_STATE,LOADING_AND_ANALYSIS +allowsMultiple: true +requiresValue: true +defaultValue: +Comma-separated list of architectures to build an ios_application with. The result is a universal binary containing all specified architectures. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --memprof_profile +effect: AFFECTS_OUTPUTS +allowsMultiple: false +requiresValue: true +defaultValue: +Use memprof profile. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --tvos_minimum_os +effect: LOSES_INCREMENTAL_STATE +allowsMultiple: false +requiresValue: true +defaultValue: +Minimum compatible tvOS version for target simulators and devices. If unspecified, uses 'tvos_sdk_version'. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --host_cxxopt +effect: ACTION_COMMAND_LINES,AFFECTS_OUTPUTS +allowsMultiple: true +requiresValue: true +defaultValue: +Additional options to pass to C++ compiler for tools built in the exec configurations. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --ltobackendopt +effect: ACTION_COMMAND_LINES,AFFECTS_OUTPUTS +allowsMultiple: true +requiresValue: true +defaultValue: +Additional option to pass to the LTO backend step (under --features=thin_lto). + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --fdo_profile +effect: AFFECTS_OUTPUTS +allowsMultiple: false +requiresValue: true +defaultValue: +The fdo_profile representing the profile to be used for optimization. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --fdo_optimize +effect: AFFECTS_OUTPUTS +allowsMultiple: false +requiresValue: true +defaultValue: +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --dump_all +effect: AFFECTS_OUTPUTS +allowsMultiple: false +requiresValue: false +defaultValue: false +If set, dump all known configurations instead of just the ids. + +_May apply to commands: config_ + +#### --cpu +effect: CHANGES_INPUTS,AFFECTS_OUTPUTS +allowsMultiple: false +requiresValue: true +defaultValue: +The target CPU. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, mod, print_action, query, run, sync, test, vendor_ + +#### --cs_fdo_profile +effect: AFFECTS_OUTPUTS +allowsMultiple: false +requiresValue: true +defaultValue: +The cs_fdo_profile representing the context sensitive profile to be used for optimization. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --android_resource_shrinking +effect: AFFECTS_OUTPUTS,LOADING_AND_ANALYSIS +allowsMultiple: false +requiresValue: false +defaultValue: false +Enables resource shrinking for android_binary APKs that use ProGuard. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --adb_arg +effect: ACTION_COMMAND_LINES +allowsMultiple: true +requiresValue: true +defaultValue: +Extra arguments to pass to adb. Usually used to designate a device to install to. + +_May apply to commands: mobile-install_ + +#### --enable_propeller_optimize_absolute_paths +effect: AFFECTS_OUTPUTS +allowsMultiple: false +requiresValue: false +defaultValue: true +If set, any use of absolute paths for propeller optimize will raise an error. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --define +effect: CHANGES_INPUTS,AFFECTS_OUTPUTS +allowsMultiple: true +requiresValue: true +defaultValue: +Each --define option specifies an assignment for a build variable. In case of multiple values for a variable, the last one wins. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, mod, print_action, query, run, sync, test, vendor_ + +#### --collect_code_coverage +effect: AFFECTS_OUTPUTS +allowsMultiple: false +requiresValue: false +defaultValue: 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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, mod, print_action, query, run, sync, test, vendor_ + +#### --debug_app +expands to --start=DEBUG +effect: EXECUTION +allowsMultiple: false +requiresValue: false +defaultValue: +Whether to wait for the debugger before starting the app. + +_May apply to commands: mobile-install_ + +#### --symlink_prefix +effect: AFFECTS_OUTPUTS +allowsMultiple: false +requiresValue: true +defaultValue: +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --gnu_format +effect: AFFECTS_OUTPUTS,EXECUTION +allowsMultiple: false +requiresValue: false +defaultValue: false +If set, write the version to stdout using the conventions described in the GNU standards. + +_May apply to commands: version_ + +#### --remote_download_all +expands to --remote_download_outputs=all +effect: AFFECTS_OUTPUTS +allowsMultiple: false +requiresValue: false +defaultValue: +Downloads all remote outputs to the local machine. This flag is an alias for --remote_download_outputs=all. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --remote_download_outputs +enum values: ALL,MINIMAL,TOPLEVEL +effect: AFFECTS_OUTPUTS +allowsMultiple: false +requiresValue: true +defaultValue: 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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --host_linkopt +effect: ACTION_COMMAND_LINES,AFFECTS_OUTPUTS +allowsMultiple: true +requiresValue: true +defaultValue: +Additional option to pass to linker when linking tools in the exec configurations. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --features +effect: CHANGES_INPUTS,AFFECTS_OUTPUTS +allowsMultiple: true +requiresValue: true +defaultValue: +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 + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, mod, print_action, query, run, sync, test, vendor_ + +#### --per_file_ltobackendopt +effect: ACTION_COMMAND_LINES,AFFECTS_OUTPUTS +allowsMultiple: true +requiresValue: true +defaultValue: +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --per_file_copt +effect: ACTION_COMMAND_LINES,AFFECTS_OUTPUTS +allowsMultiple: true +requiresValue: true +defaultValue: +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --host_action_env +effect: ACTION_COMMAND_LINES +allowsMultiple: true +requiresValue: true +defaultValue: +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, mod, print_action, query, run, sync, test, vendor_ + +#### --tvos_cpus +effect: LOSES_INCREMENTAL_STATE,LOADING_AND_ANALYSIS +allowsMultiple: true +requiresValue: true +defaultValue: +Comma-separated list of architectures for which to build Apple tvOS binaries. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --aspects +effect: UNKNOWN +allowsMultiple: true +requiresValue: true +defaultValue: +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 + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --remote_download_minimal +expands to --remote_download_outputs=minimal +effect: AFFECTS_OUTPUTS +allowsMultiple: false +requiresValue: false +defaultValue: +Does not download any remote build outputs to the local machine. This flag is an alias for --remote_download_outputs=minimal. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --start +enum values: NO,COLD,WARM,DEBUG +effect: EXECUTION +allowsMultiple: false +requiresValue: true +defaultValue: NO +How the app should be started after installing it. Set to WARM to preserve and restore application state on incremental installs. + +_May apply to commands: mobile-install_ + +#### --cxxopt +effect: ACTION_COMMAND_LINES,AFFECTS_OUTPUTS +allowsMultiple: true +requiresValue: true +defaultValue: +Additional option to pass to gcc when compiling C++ source files. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --dynamic_mode +enum values: OFF,DEFAULT,FULLY +effect: LOADING_AND_ANALYSIS,AFFECTS_OUTPUTS +allowsMultiple: false +requiresValue: true +defaultValue: 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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --android_manifest_merger_order +enum values: ALPHABETICAL,ALPHABETICAL_BY_CONFIGURATION,DEPENDENCY +effect: ACTION_COMMAND_LINES,EXECUTION +allowsMultiple: false +requiresValue: true +defaultValue: 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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --cs_fdo_instrument +effect: AFFECTS_OUTPUTS +allowsMultiple: false +requiresValue: true +defaultValue: +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --objc_enable_binary_stripping +effect: ACTION_COMMAND_LINES +allowsMultiple: false +requiresValue: false +defaultValue: 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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --watchos_cpus +effect: LOSES_INCREMENTAL_STATE,LOADING_AND_ANALYSIS +allowsMultiple: true +requiresValue: true +defaultValue: +Comma-separated list of architectures for which to build Apple watchOS binaries. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --host_compilation_mode +enum values: fastbuild,dbg,opt +effect: AFFECTS_OUTPUTS,ACTION_COMMAND_LINES +allowsMultiple: false +requiresValue: true +defaultValue: opt +Specify the mode the tools used during the build will be built in. Values: 'fastbuild', 'dbg', 'opt'. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, mod, print_action, query, run, sync, test, vendor_ + +#### --ltoindexopt +effect: ACTION_COMMAND_LINES,AFFECTS_OUTPUTS +allowsMultiple: true +requiresValue: true +defaultValue: +Additional option to pass to the LTO indexing step (under --features=thin_lto). + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --allowed_cpu_values +effect: CHANGES_INPUTS,AFFECTS_OUTPUTS +allowsMultiple: false +requiresValue: true +defaultValue: +Allowed values for the --cpu flag. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, mod, print_action, query, run, sync, test, vendor_ + +#### --instrument_test_targets +effect: AFFECTS_OUTPUTS +allowsMultiple: false +requiresValue: false +defaultValue: 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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, mod, print_action, query, run, sync, test, vendor_ + +#### --conlyopt +effect: ACTION_COMMAND_LINES,AFFECTS_OUTPUTS +allowsMultiple: true +requiresValue: true +defaultValue: +Additional option to pass to gcc when compiling C source files. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --repo_env +effect: ACTION_COMMAND_LINES +allowsMultiple: true +requiresValue: true +defaultValue: +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. + + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --enable_runfiles +effect: AFFECTS_OUTPUTS +allowsMultiple: false +requiresValue: false +defaultValue: auto +Enable runfiles symlink tree; By default, it's off on Windows, on on other platforms. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, mod, print_action, query, run, sync, test, vendor_ + +#### --host_cpu +effect: CHANGES_INPUTS,AFFECTS_OUTPUTS +allowsMultiple: false +requiresValue: true +defaultValue: +The host CPU. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, mod, print_action, query, run, sync, test, vendor_ + +#### --enable_remaining_fdo_absolute_paths +effect: AFFECTS_OUTPUTS +allowsMultiple: false +requiresValue: false +defaultValue: true +If set, any use of absolute paths for FDO will raise an error. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --propeller_optimize_absolute_cc_profile +[WARN] deprecated: Deprecated. Use --propeller_optimize instead. +effect: AFFECTS_OUTPUTS +allowsMultiple: false +requiresValue: true +defaultValue: +Absolute path name of cc_profile file for Propeller Optimized builds. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --propeller_optimize_absolute_ld_profile +[WARN] deprecated: Deprecated. Use --propeller_optimize instead. +effect: AFFECTS_OUTPUTS +allowsMultiple: false +requiresValue: true +defaultValue: +Absolute path name of ld_profile file for Propeller Optimized builds. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --action_env +effect: ACTION_COMMAND_LINES +allowsMultiple: true +requiresValue: true +defaultValue: +Specifies the set of environment variables available to actions with target configuration. Variables can be either specified by <code>name</code>, in which case +the value will be taken from the invocation environment, or by the <code>name=value</code> 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. +<br> +Note that unless <code>--incompatible_repo_env_ignores_action_env</code> is true, all <code>name=value</code> pairs will be available to repository rules. + + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, mod, print_action, query, run, sync, test, vendor_ + +#### --force_pic +effect: LOADING_AND_ANALYSIS,AFFECTS_OUTPUTS +allowsMultiple: false +requiresValue: false +defaultValue: 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"). + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --remote_download_symlink_template +effect: AFFECTS_OUTPUTS +allowsMultiple: false +requiresValue: true +defaultValue: +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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --stamp +effect: AFFECTS_OUTPUTS +allowsMultiple: false +requiresValue: false +defaultValue: false +Stamp binaries with the date, username, hostname, workspace information, etc. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, mod, print_action, query, run, sync, test, vendor_ + +#### --fdo_prefetch_hints +effect: AFFECTS_OUTPUTS +allowsMultiple: false +requiresValue: true +defaultValue: +Use cache prefetch hints. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --watchos_minimum_os +effect: LOSES_INCREMENTAL_STATE +allowsMultiple: false +requiresValue: true +defaultValue: +Minimum compatible watchOS version for target simulators and devices. If unspecified, uses 'watchos_sdk_version'. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --bep_maximum_open_remote_upload_files +effect: AFFECTS_OUTPUTS +allowsMultiple: false +requiresValue: true +defaultValue: -1 +Maximum number of open files allowed during BEP artifact upload. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --strip +enum values: always,sometimes,never +effect: AFFECTS_OUTPUTS +allowsMultiple: false +requiresValue: true +defaultValue: sometimes +Specifies whether to strip binaries and shared libraries (using "-Wl,--strip-debug"). The default value of 'sometimes' means strip iff --compilation_mode=fastbuild. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --macos_minimum_os +effect: LOSES_INCREMENTAL_STATE +allowsMultiple: false +requiresValue: true +defaultValue: +Minimum compatible macOS version for targets. If unspecified, uses 'macos_sdk_version'. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --start_app +expands to --start=COLD +effect: EXECUTION +allowsMultiple: false +requiresValue: false +defaultValue: +Whether to start the app after installing it. + +_May apply to commands: mobile-install_ + +#### --cs_fdo_absolute_path +effect: AFFECTS_OUTPUTS +allowsMultiple: false +requiresValue: true +defaultValue: +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --script_path +effect: AFFECTS_OUTPUTS,EXECUTION +allowsMultiple: false +requiresValue: true +defaultValue: +If set, write a shell script to the given file which invokes the target. If this option is set, the target is not run from Bazel. Use '%{product} run --script_path=foo //foo && ./foo' to invoke target '//foo' This differs from '%{product} run //foo' in that the %{product} lock is released and the executable is connected to the terminal's stdin. + +_May apply to commands: run_ + +#### --xbinary_fdo +effect: AFFECTS_OUTPUTS +allowsMultiple: false +requiresValue: true +defaultValue: +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --host_macos_minimum_os +effect: LOSES_INCREMENTAL_STATE +allowsMultiple: false +requiresValue: true +defaultValue: +Minimum compatible macOS version for host targets. If unspecified, uses 'macos_sdk_version'. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --remote_download_toplevel +expands to --remote_download_outputs=toplevel +effect: AFFECTS_OUTPUTS +allowsMultiple: false +requiresValue: false +defaultValue: +Only downloads remote outputs of top level targets to the local machine. This flag is an alias for --remote_download_outputs=toplevel. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --device +effect: ACTION_COMMAND_LINES +allowsMultiple: false +requiresValue: true +defaultValue: +The adb device serial number. If not specified, the first device will be used. + +_May apply to commands: mobile-install_ + +#### --catalyst_cpus +effect: LOSES_INCREMENTAL_STATE,LOADING_AND_ANALYSIS +allowsMultiple: true +requiresValue: true +defaultValue: +Comma-separated list of architectures for which to build Apple Catalyst binaries. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --stripopt +effect: ACTION_COMMAND_LINES,AFFECTS_OUTPUTS +allowsMultiple: true +requiresValue: true +defaultValue: +Additional options to pass to strip when generating a '<name>.stripped' binary. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --host_per_file_copt +effect: ACTION_COMMAND_LINES,AFFECTS_OUTPUTS +allowsMultiple: true +requiresValue: true +defaultValue: +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --propeller_optimize +effect: ACTION_COMMAND_LINES,AFFECTS_OUTPUTS +allowsMultiple: false +requiresValue: true +defaultValue: +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 + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --host_copt +effect: ACTION_COMMAND_LINES,AFFECTS_OUTPUTS +allowsMultiple: true +requiresValue: true +defaultValue: +Additional options to pass to the C compiler for tools built in the exec configurations. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --ios_minimum_os +effect: LOSES_INCREMENTAL_STATE +allowsMultiple: false +requiresValue: true +defaultValue: +Minimum compatible iOS version for target simulators and devices. If unspecified, uses 'ios_sdk_version'. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --platform_suffix +effect: LOSES_INCREMENTAL_STATE,AFFECTS_OUTPUTS,LOADING_AND_ANALYSIS +allowsMultiple: false +requiresValue: true +defaultValue: +Specifies a suffix to be added to the configuration directory. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, mod, print_action, query, run, sync, test, vendor_ + +#### --fdo_instrument +effect: AFFECTS_OUTPUTS +allowsMultiple: false +requiresValue: true +defaultValue: +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --objccopt +effect: ACTION_COMMAND_LINES +allowsMultiple: true +requiresValue: true +defaultValue: +Additional options to pass to gcc when compiling Objective-C/C++ source files. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --linkopt +effect: ACTION_COMMAND_LINES,AFFECTS_OUTPUTS +allowsMultiple: true +requiresValue: true +defaultValue: +Additional option to pass to gcc when linking. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --objc_debug_with_GLIBCXX +effect: ACTION_COMMAND_LINES +allowsMultiple: false +requiresValue: false +defaultValue: false +If set, and compilation mode is set to 'dbg', define GLIBCXX_DEBUG, GLIBCXX_DEBUG_PEDANTIC and GLIBCPP_CONCEPT_CHECKS. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --compilation_mode +enum values: fastbuild,dbg,opt +effect: AFFECTS_OUTPUTS,ACTION_COMMAND_LINES +allowsMultiple: false +requiresValue: true +defaultValue: fastbuild +Specify the mode the binary will be built in. Values: 'fastbuild', 'dbg', 'opt'. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, mod, print_action, query, run, sync, test, vendor_ + +#### --visionos_cpus +effect: LOSES_INCREMENTAL_STATE,LOADING_AND_ANALYSIS +allowsMultiple: true +requiresValue: true +defaultValue: +Comma-separated list of architectures for which to build Apple visionOS binaries. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --copt +effect: ACTION_COMMAND_LINES,AFFECTS_OUTPUTS +allowsMultiple: true +requiresValue: true +defaultValue: +Additional options to pass to gcc. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --host_features +effect: CHANGES_INPUTS,AFFECTS_OUTPUTS +allowsMultiple: true +requiresValue: true +defaultValue: +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, mod, print_action, query, run, sync, test, vendor_ + +#### --host_force_python +effect: LOADING_AND_ANALYSIS,AFFECTS_OUTPUTS +allowsMultiple: false +requiresValue: true +defaultValue: +Overrides the Python version for the exec configuration. Can be "PY2" or "PY3". + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --macos_cpus +effect: LOSES_INCREMENTAL_STATE,LOADING_AND_ANALYSIS +allowsMultiple: true +requiresValue: true +defaultValue: +Comma-separated list of architectures for which to build Apple macOS binaries. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --build_python_zip +effect: AFFECTS_OUTPUTS +allowsMultiple: false +requiresValue: false +defaultValue: auto +Build python executable zip; on on Windows, off on other platforms + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +### experimental + +#### --experimental_android_resource_shrinking +effect: AFFECTS_OUTPUTS,LOADING_AND_ANALYSIS +allowsMultiple: false +requiresValue: false +defaultValue: false +Enables resource shrinking for android_binary APKs that use ProGuard. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --android_databinding_use_v3_4_args +effect: AFFECTS_OUTPUTS,LOADING_AND_ANALYSIS,LOSES_INCREMENTAL_STATE +allowsMultiple: false +requiresValue: false +defaultValue: true +Use android databinding v2 with 3.4.0 argument. This flag is a no-op. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --experimental_android_compress_java_resources +effect: AFFECTS_OUTPUTS,LOADING_AND_ANALYSIS +allowsMultiple: false +requiresValue: false +defaultValue: false +Compress Java resources in APKs + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --android_databinding_use_androidx +effect: AFFECTS_OUTPUTS,LOADING_AND_ANALYSIS,LOSES_INCREMENTAL_STATE +allowsMultiple: false +requiresValue: false +defaultValue: true +Generate AndroidX-compatible data-binding files. This is only used with databinding v2. This flag is a no-op. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --experimental_use_platforms_in_output_dir_legacy_heuristic +effect: AFFECTS_OUTPUTS +allowsMultiple: false +requiresValue: false +defaultValue: 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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, mod, print_action, query, run, sync, test, vendor_ + +#### --experimental_platform_in_output_dir +effect: AFFECTS_OUTPUTS +allowsMultiple: false +requiresValue: false +defaultValue: 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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, mod, print_action, query, run, sync, test, vendor_ + +#### --experimental_override_name_platform_in_output_dir +effect: AFFECTS_OUTPUTS +allowsMultiple: true +requiresValue: true +defaultValue: +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, mod, print_action, query, run, sync, test, vendor_ + +#### --experimental_use_llvm_covmap +effect: CHANGES_INPUTS,AFFECTS_OUTPUTS,LOADING_AND_ANALYSIS +allowsMultiple: false +requiresValue: false +defaultValue: false +If specified, Bazel will generate llvm-cov coverage map information rather than gcov when collect_code_coverage is enabled. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --experimental_convenience_symlinks +enum values: NORMAL,CLEAN,IGNORE,LOG_ONLY +effect: AFFECTS_OUTPUTS +allowsMultiple: false +requiresValue: false +defaultValue: normal +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 not be created or cleaned up. + 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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --experimental_android_rewrite_dexes_with_rex +effect: AFFECTS_OUTPUTS,LOADING_AND_ANALYSIS,LOSES_INCREMENTAL_STATE +allowsMultiple: false +requiresValue: false +defaultValue: false +use rex tool to rewrite dex files + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --experimental_convenience_symlinks_bep_event +effect: AFFECTS_OUTPUTS +allowsMultiple: false +requiresValue: false +defaultValue: true +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --experimental_omitfp +effect: ACTION_COMMAND_LINES,AFFECTS_OUTPUTS +allowsMultiple: false +requiresValue: false +defaultValue: false +If true, use libunwind for stack unwinding, and compile with -fomit-frame-pointer and -fasynchronous-unwind-tables. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --experimental_py_binaries_include_label +effect: AFFECTS_OUTPUTS +allowsMultiple: false +requiresValue: false +defaultValue: false +py_binary targets include their label even when stamping is disabled. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --experimental_action_listener +effect: EXECUTION +allowsMultiple: true +requiresValue: true +defaultValue: +Deprecated in favor of aspects. Use action_listener to attach an extra_action to existing build actions. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, mod, print_action, query, run, sync, test, vendor_ + +#### --experimental_output_paths +enum values: OFF,CONTENT,STRIP +effect: LOSES_INCREMENTAL_STATE,BAZEL_INTERNAL_CONFIGURATION,AFFECTS_OUTPUTS,EXECUTION +allowsMultiple: false +requiresValue: true +defaultValue: 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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, mod, print_action, query, run, sync, test, vendor_ + +#### --experimental_android_databinding_v2 +effect: AFFECTS_OUTPUTS,LOADING_AND_ANALYSIS,LOSES_INCREMENTAL_STATE +allowsMultiple: false +requiresValue: false +defaultValue: true +Use android databinding v2. This flag is a no-op. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --experimental_collect_code_coverage_for_generated_files +effect: AFFECTS_OUTPUTS +allowsMultiple: false +requiresValue: false +defaultValue: false +If specified, Bazel will also generate collect coverage information for generated files. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, mod, print_action, query, run, sync, test, vendor_ + +#### --experimental_objc_fastbuild_options +effect: ACTION_COMMAND_LINES +allowsMultiple: false +requiresValue: true +defaultValue: -O0,-DDEBUG=1 +Uses these strings as objc fastbuild compiler options. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +### deprecated + +#### --legacy_whole_archive +effect: ACTION_COMMAND_LINES,AFFECTS_OUTPUTS +allowsMultiple: false +requiresValue: false +defaultValue: 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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +### incompatible_change + +#### --incompatible_auto_exec_groups +effect: AFFECTS_OUTPUTS +allowsMultiple: false +requiresValue: false +defaultValue: 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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, mod, print_action, query, run, sync, test, vendor_ + +#### --incompatible_merge_genfiles_directory +effect: AFFECTS_OUTPUTS +allowsMultiple: false +requiresValue: false +defaultValue: true +If true, the genfiles directory is folded into the bin directory. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, mod, print_action, query, run, sync, test, vendor_ + +## remote + +### stable + +#### --remote_build_event_upload +enum values: ALL,MINIMAL +effect: UNKNOWN +allowsMultiple: false +requiresValue: true +defaultValue: 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'. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --remote_local_fallback +effect: UNKNOWN +allowsMultiple: false +requiresValue: false +defaultValue: false +Whether to fall back to standalone local execution strategy if remote execution fails. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --remote_header +effect: UNKNOWN +allowsMultiple: true +requiresValue: true +defaultValue: +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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --remote_max_connections +effect: HOST_MACHINE_RESOURCE_OPTIMIZATIONS +allowsMultiple: false +requiresValue: true +defaultValue: 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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --remote_proxy +effect: UNKNOWN +allowsMultiple: false +requiresValue: true +defaultValue: +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). + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --remote_cache_header +effect: UNKNOWN +allowsMultiple: true +requiresValue: true +defaultValue: +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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --remote_retries +effect: UNKNOWN +allowsMultiple: false +requiresValue: true +defaultValue: 5 +The maximum number of attempts to retry a transient error. If set to 0, retries are disabled. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --remote_execution_priority +effect: UNKNOWN +allowsMultiple: false +requiresValue: true +defaultValue: 0 +The relative priority of actions to be executed remotely. The semantics of the particular priority values are server-dependent. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --remote_exec_header +effect: UNKNOWN +allowsMultiple: true +requiresValue: true +defaultValue: +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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --remote_upload_local_results +effect: UNKNOWN +allowsMultiple: false +requiresValue: false +defaultValue: 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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --remote_default_platform_properties +[WARN] deprecated: --remote_default_platform_properties has been deprecated in favor of --remote_default_exec_properties. +effect: UNKNOWN +allowsMultiple: false +requiresValue: true +defaultValue: +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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --remote_result_cache_priority +effect: UNKNOWN +allowsMultiple: false +requiresValue: true +defaultValue: 0 +The relative priority of remote actions to be stored in remote cache. The semantics of the particular priority values are server-dependent. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --remote_executor +effect: UNKNOWN +allowsMultiple: false +requiresValue: true +defaultValue: +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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --remote_downloader_header +effect: UNKNOWN +allowsMultiple: true +requiresValue: true +defaultValue: +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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --remote_retry_max_delay +effect: UNKNOWN +allowsMultiple: false +requiresValue: true +defaultValue: 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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --remote_download_regex +effect: AFFECTS_OUTPUTS +allowsMultiple: true +requiresValue: true +defaultValue: +Force remote build outputs whose path matches this pattern to be downloaded, irrespective of --remote_download_outputs. Multiple patterns may be specified by repeating this flag. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --remote_timeout +effect: UNKNOWN +allowsMultiple: false +requiresValue: true +defaultValue: 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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --remote_bytestream_uri_prefix +effect: UNKNOWN +allowsMultiple: false +requiresValue: true +defaultValue: +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}". + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --remote_instance_name +effect: UNKNOWN +allowsMultiple: false +requiresValue: true +defaultValue: +Value to pass as instance_name in the remote execution API. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --remote_cache_compression +effect: UNKNOWN +allowsMultiple: false +requiresValue: false +defaultValue: false +If enabled, compress/decompress cache blobs with zstd when their size is at least --experimental_remote_cache_compression_threshold. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --guard_against_concurrent_changes +enum values: OFF,LITE,FULL +effect: EXECUTION +allowsMultiple: false +requiresValue: false +defaultValue: lite +Set this to 'full' to enable checking the ctime of all 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. The default is 'lite', which only checks source files in the main repository. Setting this to 'off' disables all checks. This is not recommended, as the cache may be polluted when a source file is changed while an action that takes it as an input is executing. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --remote_local_fallback_strategy +effect: UNKNOWN +allowsMultiple: false +requiresValue: true +defaultValue: local +Deprecated. See https://github.com/bazelbuild/bazel/issues/7480 for details. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --remote_verify_downloads +effect: UNKNOWN +allowsMultiple: false +requiresValue: false +defaultValue: 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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --remote_cache_async +effect: UNKNOWN +allowsMultiple: false +requiresValue: false +defaultValue: true +If true, uploading of action results to a disk or remote cache will happen in the background instead of blocking the completion of an action. Some actions are incompatible with background uploads, and may still block even when this flag is set. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --remote_cache +effect: UNKNOWN +allowsMultiple: false +requiresValue: true +defaultValue: +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 + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --downloader_config +effect: UNKNOWN +allowsMultiple: false +requiresValue: true +defaultValue: +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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --remote_default_exec_properties +effect: AFFECTS_OUTPUTS +allowsMultiple: true +requiresValue: true +defaultValue: +Set the default exec properties to be used as the remote execution platform if an execution platform does not already set exec_properties. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --remote_grpc_log +effect: UNKNOWN +allowsMultiple: false +requiresValue: true +defaultValue: +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). + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --remote_accept_cached +effect: UNKNOWN +allowsMultiple: false +requiresValue: false +defaultValue: true +Whether to accept remotely cached action results. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +### experimental + +#### --experimental_remote_downloader_local_fallback +effect: UNKNOWN +allowsMultiple: false +requiresValue: false +defaultValue: false +Whether to fall back to the local downloader if remote downloader fails. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --experimental_remote_merkle_tree_cache +effect: UNKNOWN +allowsMultiple: false +requiresValue: false +defaultValue: 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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --experimental_remote_discard_merkle_trees +effect: UNKNOWN +allowsMultiple: false +requiresValue: false +defaultValue: 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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --experimental_circuit_breaker_strategy +enum values: FAILURE +effect: EXECUTION +allowsMultiple: false +requiresValue: true +defaultValue: +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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --experimental_remote_mark_tool_inputs +effect: UNKNOWN +allowsMultiple: false +requiresValue: false +defaultValue: 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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --experimental_remote_cache_compression_threshold +effect: UNKNOWN +allowsMultiple: false +requiresValue: true +defaultValue: 100 +The minimum blob size required to compress/decompress with zstd. Ineffectual unless --remote_cache_compression is set. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --experimental_remote_cache_ttl +effect: EXECUTION +allowsMultiple: false +requiresValue: true +defaultValue: 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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --experimental_remote_failure_window_interval +effect: EXECUTION +allowsMultiple: false +requiresValue: true +defaultValue: 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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --experimental_remote_downloader +effect: UNKNOWN +allowsMultiple: false +requiresValue: true +defaultValue: +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 + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --experimental_remote_merkle_tree_cache_size +effect: UNKNOWN +allowsMultiple: false +requiresValue: true +defaultValue: 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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --experimental_worker_for_repo_fetching +enum values: OFF,PLATFORM,VIRTUAL,AUTO +effect: UNKNOWN +allowsMultiple: false +requiresValue: true +defaultValue: auto +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 virtual worker thread. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --experimental_remote_scrubbing_config +effect: UNKNOWN +allowsMultiple: false +requiresValue: true +defaultValue: +Enables remote cache key scrubbing with the supplied configuration file, which must be a protocol buffer in text format (see src/main/protobuf/remote_scrubbing.proto). + +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. Scrubbed actions are incompatible with remote execution, and will always be executed locally instead. + +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). + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --experimental_remote_capture_corrupted_outputs +effect: UNKNOWN +allowsMultiple: false +requiresValue: true +defaultValue: +A path to a directory where the corrupted outputs will be captured to. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --experimental_remote_output_service +effect: UNKNOWN +allowsMultiple: false +requiresValue: true +defaultValue: +HOST or HOST:PORT of a remote output service 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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --experimental_remote_require_cached +effect: UNKNOWN +allowsMultiple: false +requiresValue: false +defaultValue: 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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --experimental_remote_failure_rate_threshold +effect: EXECUTION +allowsMultiple: false +requiresValue: true +defaultValue: 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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --experimental_remote_cache_lease_extension +effect: UNKNOWN +allowsMultiple: false +requiresValue: false +defaultValue: 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`. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --experimental_remote_output_service_output_path_prefix +effect: UNKNOWN +allowsMultiple: false +requiresValue: true +defaultValue: +The path under which the contents of output directories managed by the --experimental_remote_output_service are placed. The actual output directory used by a build will be a descendant of this path and determined by the output service. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --experimental_remote_cache_eviction_retries +effect: EXECUTION +allowsMultiple: false +requiresValue: true +defaultValue: 5 +The maximum number of attempts to retry if the build encountered a transient remote cache error that would otherwise fail the build. Applies for example when artifacts are evicted from the remote cache, or in certain cache failure conditions. 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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --experimental_remote_downloader_propagate_credentials +effect: UNKNOWN +allowsMultiple: false +requiresValue: false +defaultValue: false +Whether to propagate credentials from netrc and credential helper to the remote downloader server. The server implementation needs to support the new `http_header_url:<url-index>:<header-key>` qualifier where the `<url-index>` is a 0-based position of the URL inside the FetchBlobRequest's `uris` field. The URL-specific headers should take precedence over the global headers. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --experimental_remote_execution_keepalive +effect: UNKNOWN +allowsMultiple: false +requiresValue: false +defaultValue: false +Whether to use keepalive for remote execution calls. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +### incompatible_change + +#### --incompatible_remote_use_new_exit_code_for_lost_inputs +effect: UNKNOWN +allowsMultiple: false +requiresValue: false +defaultValue: true +If set to true, Bazel will use new exit code 39 instead of 34 if remote cacheerrors, including cache evictions, cause the build to fail. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## signing + +### stable + +#### --device_debug_entitlements +effect: CHANGES_INPUTS +allowsMultiple: false +requiresValue: false +defaultValue: true +If set, and compilation mode is not 'opt', objc apps will include debug entitlements when signing. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --apk_signing_method +enum values: V1,V2,V1_V2,V4 +effect: ACTION_COMMAND_LINES,AFFECTS_OUTPUTS,LOADING_AND_ANALYSIS +allowsMultiple: false +requiresValue: true +defaultValue: v1_v2 +Implementation to use to sign APKs + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --ios_signing_cert_name +effect: ACTION_COMMAND_LINES +allowsMultiple: false +requiresValue: true +defaultValue: +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). + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## query + +### stable + +#### --aspect_deps +enum values: OFF,CONSERVATIVE,PRECISE +effect: BUILD_FILE_SEMANTICS +allowsMultiple: false +requiresValue: true +defaultValue: 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'. + +_May apply to commands: aquery, cquery, query_ + +#### --consistent_labels +effect: TERMINAL_OUTPUT +allowsMultiple: false +requiresValue: false +defaultValue: 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. + +_May apply to commands: aquery, cquery, query_ + +#### --graph:node_limit +effect: TERMINAL_OUTPUT +allowsMultiple: false +requiresValue: true +defaultValue: 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. + +_May apply to commands: aquery, cquery, query_ + +#### --skyframe_state +effect: TERMINAL_OUTPUT +allowsMultiple: false +requiresValue: false +defaultValue: 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. + +_May apply to commands: aquery_ + +#### --line_terminator_null +effect: TERMINAL_OUTPUT +allowsMultiple: false +requiresValue: false +defaultValue: false +Whether each format is terminated with \0 instead of newline. + +_May apply to commands: aquery, cquery, query_ + +#### --xml:line_numbers +effect: TERMINAL_OUTPUT +allowsMultiple: false +requiresValue: false +defaultValue: true +If true, XML output contains line numbers. Disabling this option may make diffs easier to read. This option is only applicable to --output=xml. + +_May apply to commands: query_ + +#### --proto:include_configurations +effect: AFFECTS_OUTPUTS +allowsMultiple: false +requiresValue: false +defaultValue: true +if enabled, proto output will include information about configurations. When disabled,cquery proto output format resembles query output format. + +_May apply to commands: cquery_ + +#### --nodep_deps +effect: BUILD_FILE_SEMANTICS +allowsMultiple: false +requiresValue: false +defaultValue: 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. + +_May apply to commands: aquery, cquery, query_ + +#### --infer_universe_scope +effect: LOADING_AND_ANALYSIS +allowsMultiple: false +requiresValue: false +defaultValue: 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`). + +_May apply to commands: aquery, cquery, query_ + +#### --graph:factored +effect: TERMINAL_OUTPUT +allowsMultiple: false +requiresValue: false +defaultValue: 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. + +_May apply to commands: aquery, cquery, query_ + +#### --relative_locations +effect: TERMINAL_OUTPUT +allowsMultiple: false +requiresValue: false +defaultValue: 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. + +_May apply to commands: aquery, cquery, query_ + +#### --order_results +[WARN] deprecated: Please use --order_output=auto or --order_output=no instead of this flag +expands to --order_output=auto +effect: TERMINAL_OUTPUT +allowsMultiple: false +requiresValue: false +defaultValue: +Output the results in dependency-ordered (default) or unordered fashion. The unordered output is faster but only supported when --output is not minrank, maxrank, or graph. + +_May apply to commands: query_ + +#### --universe_scope +effect: LOADING_AND_ANALYSIS +allowsMultiple: false +requiresValue: true +defaultValue: +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. + +_May apply to commands: aquery, cquery, query_ + +#### --starlark:expr +effect: TERMINAL_OUTPUT +allowsMultiple: false +requiresValue: true +defaultValue: +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. + +_May apply to commands: cquery_ + +#### --output_file +effect: TERMINAL_OUTPUT +allowsMultiple: false +requiresValue: true +defaultValue: +When specified, query results will be written directly to this file, and nothing will be printed to Bazel's standard output stream (stdout). In benchmarks, this is generally faster than <code>bazel query &gt; file</code>. + +_May apply to commands: aquery, cquery, query_ + +#### --proto:rule_classes +effect: TERMINAL_OUTPUT +allowsMultiple: false +requiresValue: false +defaultValue: false +Populate the rule_class_key field of each rule; and for the first rule with a given rule_class_key, also populate its rule_class_info proto field. The rule_class_key field uniquely identifies a rule class, and the rule_class_info field is a Stardoc-format rule class API definition. + +_May apply to commands: aquery, cquery, query_ + +#### --transitions +enum values: FULL,LITE,NONE +effect: AFFECTS_OUTPUTS +allowsMultiple: false +requiresValue: true +defaultValue: none +The format in which cquery will print transition information. + +_May apply to commands: cquery_ + +#### --tool_deps +effect: BUILD_FILE_SEMANTICS +allowsMultiple: false +requiresValue: false +defaultValue: 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. + +_May apply to commands: aquery, cquery, query_ + +#### --proto:output_rule_attrs +effect: TERMINAL_OUTPUT +allowsMultiple: false +requiresValue: true +defaultValue: 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. + +_May apply to commands: aquery, cquery, query_ + +#### --include_aspects +effect: TERMINAL_OUTPUT +allowsMultiple: false +requiresValue: false +defaultValue: true +aquery, cquery: whether to include aspect-generated actions in the output. query: no-op (aspects are always followed). + +_May apply to commands: aquery, cquery, query_ + +#### --include_artifacts +effect: TERMINAL_OUTPUT +allowsMultiple: false +requiresValue: false +defaultValue: true +Includes names of the action inputs and outputs in the output (potentially large). + +_May apply to commands: aquery_ + +#### --xml:default_values +effect: TERMINAL_OUTPUT +allowsMultiple: false +requiresValue: false +defaultValue: false +If true, rule attributes whose value is not explicitly specified in the BUILD file are printed; otherwise they are omitted. + +_May apply to commands: query_ + +#### --order_output +enum values: NO,DEPS,AUTO,FULL +effect: TERMINAL_OUTPUT +allowsMultiple: false +requiresValue: true +defaultValue: auto +Output the results unordered (no), dependency-ordered (deps), or fully ordered (full). The default is 'auto', meaning that results are output either dependency-ordered or fully ordered, depending on the output formatter (dependency-ordered for proto, minrank, maxrank, and graph, fully ordered for all others). When output is fully ordered, nodes are printed in a fully deterministic (total) order. First, all nodes are sorted alphabetically. Then, each node in the list is used as the start of a post-order depth-first search in which outgoing edges to unvisited nodes are traversed in alphabetical order of the successor nodes. Finally, nodes are printed in the reverse of the order in which they were visited. + +_May apply to commands: query_ + +#### --proto:include_attribute_source_aspects +effect: TERMINAL_OUTPUT +allowsMultiple: false +requiresValue: false +defaultValue: 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). + +_May apply to commands: aquery, cquery, query_ + +#### --proto:locations +effect: TERMINAL_OUTPUT +allowsMultiple: false +requiresValue: false +defaultValue: true +Whether to output location information in proto output at all. + +_May apply to commands: aquery, cquery, query_ + +#### --proto:rule_inputs_and_outputs +effect: TERMINAL_OUTPUT +allowsMultiple: false +requiresValue: false +defaultValue: true +Whether or not to populate the rule_input and rule_output fields. + +_May apply to commands: aquery, cquery, query_ + +#### --proto:definition_stack +effect: TERMINAL_OUTPUT +allowsMultiple: false +requiresValue: false +defaultValue: 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. + +_May apply to commands: aquery, cquery, query_ + +#### --include_pruned_inputs +effect: TERMINAL_OUTPUT +allowsMultiple: false +requiresValue: false +defaultValue: true +Includes action inputs that were pruned during action execution. Only affects actions that discover inputs and have been executed in a previous invocation. Only takes effect if --include_artifacts is also set. + +_May apply to commands: aquery_ + +#### --output +effect: TERMINAL_OUTPUT +allowsMultiple: false +requiresValue: true +defaultValue: text +The format in which the aquery results should be printed. Allowed values for aquery are: text, textproto, proto, streamed_proto, jsonproto. + +_May apply to commands: aquery, config, cquery, mod, query_ + +#### --proto:instantiation_stack +effect: TERMINAL_OUTPUT +allowsMultiple: false +requiresValue: false +defaultValue: false +Populate the instantiation call stack of each rule. Note that this requires the stack to be present + +_May apply to commands: aquery, cquery, query_ + +#### --graph:conditional_edges_limit +effect: TERMINAL_OUTPUT +allowsMultiple: false +requiresValue: true +defaultValue: 4 +The maximum number of condition labels to show. -1 means no truncation and 0 means no annotation. This option is only applicable to --output=graph. + +_May apply to commands: query_ + +#### --null +expands to --line_terminator_null=true +effect: TERMINAL_OUTPUT +allowsMultiple: false +requiresValue: false +defaultValue: +Whether each format is terminated with \0 instead of newline. + +_May apply to commands: query_ + +#### --noorder_results +[WARN] deprecated: Please use --order_output=no or --order_output=auto instead of this flag +expands to --order_output=no +effect: TERMINAL_OUTPUT +allowsMultiple: false +requiresValue: false +defaultValue: +Output the results in dependency-ordered (default) or unordered fashion. The unordered output is faster but only supported when --output is not minrank, maxrank, or graph. + +_May apply to commands: query_ + +#### --proto:flatten_selects +effect: BUILD_FILE_SEMANTICS +allowsMultiple: false +requiresValue: false +defaultValue: 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. + +_May apply to commands: aquery, cquery, query_ + +#### --starlark:file +effect: TERMINAL_OUTPUT +allowsMultiple: false +requiresValue: true +defaultValue: +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. + +_May apply to commands: cquery_ + +#### --include_file_write_contents +effect: TERMINAL_OUTPUT +allowsMultiple: false +requiresValue: false +defaultValue: false +Include the file contents for the FileWrite, SourceSymlinkManifest, and RepoMappingManifest actions (potentially large). + +_May apply to commands: aquery_ + +#### --include_param_files +effect: TERMINAL_OUTPUT +allowsMultiple: false +requiresValue: false +defaultValue: 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. + +_May apply to commands: aquery_ + +#### --include_commandline +effect: TERMINAL_OUTPUT +allowsMultiple: false +requiresValue: false +defaultValue: true +Includes the content of the action command lines in the output (potentially large). + +_May apply to commands: aquery_ + +#### --implicit_deps +effect: BUILD_FILE_SEMANTICS +allowsMultiple: false +requiresValue: false +defaultValue: 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. + +_May apply to commands: aquery, cquery, query_ + +#### --query_file +effect: CHANGES_INPUTS +allowsMultiple: false +requiresValue: true +defaultValue: +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. + +_May apply to commands: aquery, cquery, query_ + +#### --show_config_fragments +enum values: OFF,DIRECT,TRANSITIVE +effect: AFFECTS_OUTPUTS +allowsMultiple: false +requiresValue: true +defaultValue: 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. + +_May apply to commands: cquery_ + +#### --strict_test_suite +effect: BUILD_FILE_SEMANTICS,EAGERNESS_TO_EXIT +allowsMultiple: false +requiresValue: false +defaultValue: false +If true, the tests() expression gives an error if it encounters a test_suite containing non-test targets. + +_May apply to commands: query_ + +#### --proto:include_synthetic_attribute_hash +effect: TERMINAL_OUTPUT +allowsMultiple: false +requiresValue: false +defaultValue: false +Whether or not to calculate and populate the $internal_attr_hash attribute. + +_May apply to commands: aquery, cquery, query_ + +#### --proto:default_values +effect: TERMINAL_OUTPUT +allowsMultiple: false +requiresValue: false +defaultValue: 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 + +_May apply to commands: aquery, cquery, query_ + +### incompatible_change + +#### --incompatible_package_group_includes_double_slash +effect: TERMINAL_OUTPUT +allowsMultiple: false +requiresValue: false +defaultValue: true +If enabled, when outputting package_group's `packages` attribute, the leading `//` will not be omitted. + +_May apply to commands: aquery, cquery, query_ + +#### --incompatible_lexicographical_output +effect: TERMINAL_OUTPUT +allowsMultiple: false +requiresValue: false +defaultValue: true +If this option is set, sorts --order_output=auto output in lexicographical order. + +_May apply to commands: query_ + +### experimental + +#### --experimental_graphless_query +effect: BUILD_FILE_SEMANTICS,EAGERNESS_TO_EXIT +allowsMultiple: false +requiresValue: false +defaultValue: auto +If true, uses a Query implementation that does not make a copy of the graph. The new implementation only supports --order_output=no, as well as only a subset of output formatters. + +_May apply to commands: query_ + +#### --experimental_parallel_aquery_output +effect: NO_OP +allowsMultiple: false +requiresValue: false +defaultValue: true +No-op. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --experimental_explicit_aspects +effect: TERMINAL_OUTPUT +allowsMultiple: false +requiresValue: false +defaultValue: false +aquery, cquery: whether to include aspect-generated actions in the output. query: no-op (aspects are always followed). + +_May apply to commands: aquery, cquery, query_ + +## execution_strategy + +### experimental + +#### --experimental_worker_sandbox_inmemory_tracking +effect: EXECUTION +allowsMultiple: true +requiresValue: true +defaultValue: +A worker key mnemonic for which the contents of the sandbox directory are tracked in memory. This may improve build performance at the cost of additional memory usage. Only affects sandboxed workers. May be specified multiple times for different mnemonics. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --experimental_docker_image +effect: EXECUTION +allowsMultiple: false +requiresValue: true +defaultValue: +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --experimental_worker_metrics_poll_interval +effect: EXECUTION,HOST_MACHINE_RESOURCE_OPTIMIZATIONS +allowsMultiple: false +requiresValue: true +defaultValue: 5s +The interval between collecting worker metrics and possibly attempting evictions. Cannot effectively be less than 1s for performance reasons. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --experimental_use_hermetic_linux_sandbox +effect: EXECUTION +allowsMultiple: false +requiresValue: false +defaultValue: 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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --experimental_worker_multiplex_sandboxing +effect: EXECUTION +allowsMultiple: false +requiresValue: false +defaultValue: false +If enabled, multiplex workers with a 'supports-multiplex-sandboxing' execution requirement will run in a sandboxed environment, using a separate sandbox directory per work request. Multiplex workers with the execution requirement are always sandboxed when running under the dynamic execution strategy, irrespective of this flag. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --experimental_enable_docker_sandbox +effect: EXECUTION +allowsMultiple: false +requiresValue: false +defaultValue: false +Enable Docker-based sandboxing. This option has no effect if Docker is not installed. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --experimental_split_xml_generation +effect: EXECUTION +allowsMultiple: false +requiresValue: false +defaultValue: 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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --experimental_sandbox_enforce_resources_regexp +effect: EXECUTION +allowsMultiple: false +requiresValue: true +defaultValue: +If true, actions whose mnemonic matches the input regex will have their resources request enforced as limits, overriding the value of --experimental_sandbox_limits, if the resource type supports it. For example a test that declares cpu:3 and resources:memory:10, will run with at most 3 cpus and 10 megabytes of memory. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --experimental_worker_sandbox_hardening +effect: EXECUTION +allowsMultiple: false +requiresValue: false +defaultValue: false +If enabled, workers are run in a hardened sandbox, if the implementation allows it. If hardening is enabled then tmp directories are distinct for different workers. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --experimental_split_coverage_postprocessing +effect: EXECUTION +allowsMultiple: false +requiresValue: false +defaultValue: false +If true, then Bazel will run coverage postprocessing for test in a new spawn. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --experimental_ui_max_stdouterr_bytes +effect: EXECUTION +allowsMultiple: false +requiresValue: true +defaultValue: 1048576 +The maximum size of the stdout / stderr files that will be printed to the console. -1 implies no limit. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --experimental_total_worker_memory_limit_mb +effect: EXECUTION,HOST_MACHINE_RESOURCE_OPTIMIZATIONS +allowsMultiple: false +requiresValue: true +defaultValue: 0 +If this limit is greater than zero idle workers might be killed if the total memory usage of all workers exceed the limit. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --experimental_dynamic_local_load_factor +effect: EXECUTION,HOST_MACHINE_RESOURCE_OPTIMIZATIONS +allowsMultiple: false +requiresValue: true +defaultValue: 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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --experimental_inprocess_symlink_creation +effect: LOADING_AND_ANALYSIS,EXECUTION +allowsMultiple: false +requiresValue: false +defaultValue: true +Whether to make direct filesystem calls to create symlink trees instead of delegating to a helper process. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, mod, print_action, query, run, sync, test, vendor_ + +#### --experimental_sandbox_async_tree_delete_idle_threads +effect: HOST_MACHINE_RESOURCE_OPTIMIZATIONS,EXECUTION +allowsMultiple: false +requiresValue: true +defaultValue: 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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --experimental_remotable_source_manifests +effect: LOADING_AND_ANALYSIS,EXECUTION +allowsMultiple: false +requiresValue: false +defaultValue: false +Whether to make source manifest actions remotable + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, mod, print_action, query, run, sync, test, vendor_ + +#### --experimental_persistent_aar_extractor +effect: EXECUTION +allowsMultiple: false +requiresValue: false +defaultValue: false +Enable persistent aar extractor by using workers. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --experimental_sandbox_limits +effect: EXECUTION +allowsMultiple: true +requiresValue: true +defaultValue: +If > 0, each Linux sandbox will be limited to the given amount for the specified resource. Requires --incompatible_use_new_cgroup_implementation and overrides --experimental_sandbox_memory_limit_mb. Requires cgroups v1 or v2 and permissions for the users to the cgroups dir. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --experimental_docker_use_customized_images +effect: EXECUTION +allowsMultiple: false +requiresValue: false +defaultValue: 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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --experimental_worker_cancellation +effect: EXECUTION +allowsMultiple: false +requiresValue: false +defaultValue: false +If enabled, Bazel may send cancellation requests to workers that support them. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --experimental_use_windows_sandbox +effect: EXECUTION +allowsMultiple: false +requiresValue: false +defaultValue: 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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --experimental_worker_memory_limit_mb +effect: EXECUTION,HOST_MACHINE_RESOURCE_OPTIMIZATIONS +allowsMultiple: false +requiresValue: true +defaultValue: 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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --experimental_worker_as_resource +effect: NO_OP +allowsMultiple: false +requiresValue: false +defaultValue: true +No-op, will be removed soon. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --experimental_windows_sandbox_path +effect: EXECUTION +allowsMultiple: false +requiresValue: true +defaultValue: 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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --experimental_shrink_worker_pool +effect: EXECUTION,HOST_MACHINE_RESOURCE_OPTIMIZATIONS +allowsMultiple: false +requiresValue: false +defaultValue: 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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --experimental_sandbox_memory_limit_mb +effect: EXECUTION +allowsMultiple: false +requiresValue: true +defaultValue: 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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --experimental_worker_strict_flagfiles +effect: EXECUTION +allowsMultiple: false +requiresValue: false +defaultValue: 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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --experimental_inmemory_sandbox_stashes +effect: HOST_MACHINE_RESOURCE_OPTIMIZATIONS,EXECUTION +allowsMultiple: false +requiresValue: false +defaultValue: false +If set to true, the contents of stashed sandboxes for reuse_sandbox_directories will be tracked in memory. This reduces the amount of I/O needed during reuse. Depending on the build this flag may improve wall time. Depending on the build as well this flag may use a significant amount of additional memory. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --experimental_dynamic_slow_remote_time +effect: EXECUTION,HOST_MACHINE_RESOURCE_OPTIMIZATIONS +allowsMultiple: false +requiresValue: true +defaultValue: 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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --experimental_worker_allowlist +effect: EXECUTION,HOST_MACHINE_RESOURCE_OPTIMIZATIONS +allowsMultiple: false +requiresValue: true +defaultValue: +If non-empty, only allow using persistent workers with the given worker key mnemonic. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --experimental_dynamic_exclude_tools +effect: EXECUTION,HOST_MACHINE_RESOURCE_OPTIMIZATIONS +allowsMultiple: false +requiresValue: false +defaultValue: 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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --experimental_strict_fileset_output +effect: EXECUTION +allowsMultiple: false +requiresValue: false +defaultValue: 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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, mod, print_action, query, run, sync, test, vendor_ + +#### --experimental_use_semaphore_for_jobs +effect: HOST_MACHINE_RESOURCE_OPTIMIZATIONS,EXECUTION +allowsMultiple: false +requiresValue: false +defaultValue: true +If set to true, additionally use semaphore to limit number of concurrent jobs. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +### stable + +#### --worker_multiplex +effect: EXECUTION,HOST_MACHINE_RESOURCE_OPTIMIZATIONS +allowsMultiple: false +requiresValue: false +defaultValue: true +If enabled, workers will use multiplexing if they support it. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --dynamic_remote_strategy +effect: EXECUTION,HOST_MACHINE_RESOURCE_OPTIMIZATIONS +allowsMultiple: true +requiresValue: true +defaultValue: +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,...] + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --use_target_platform_for_tests +effect: EXECUTION +allowsMultiple: false +requiresValue: false +defaultValue: false +If true, then Bazel will use the target platform for running tests rather than the test exec group. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --worker_quit_after_build +effect: EXECUTION,HOST_MACHINE_RESOURCE_OPTIMIZATIONS +allowsMultiple: false +requiresValue: false +defaultValue: false +If enabled, all workers quit after a build is done. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --worker_extra_flag +effect: EXECUTION,HOST_MACHINE_RESOURCE_OPTIMIZATIONS +allowsMultiple: true +requiresValue: true +defaultValue: +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --persistent_android_resource_processor +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 +effect: HOST_MACHINE_RESOURCE_OPTIMIZATIONS,EXECUTION +allowsMultiple: false +requiresValue: false +defaultValue: +Enable persistent Android resource processor by using workers. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --strategy_regexp +effect: EXECUTION +allowsMultiple: true +requiresValue: true +defaultValue: +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'. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --internal_spawn_scheduler +effect: EXECUTION,HOST_MACHINE_RESOURCE_OPTIMIZATIONS +allowsMultiple: false +requiresValue: false +defaultValue: true +Placeholder option so that we can tell in Blaze whether the spawn scheduler was enabled. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --worker_max_multiplex_instances +effect: EXECUTION,HOST_MACHINE_RESOURCE_OPTIMIZATIONS +allowsMultiple: true +requiresValue: true +defaultValue: +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --all +effect: CHANGES_INPUTS +allowsMultiple: false +requiresValue: false +defaultValue: false +Fetches all external repositories necessary for building any target or repository. This is the default if no other flags and arguments are provided. Only works when --enable_bzlmod is on. + +_May apply to commands: fetch_ + +#### --high_priority_workers +effect: NO_OP +allowsMultiple: true +requiresValue: true +defaultValue: +No-op, will be removed soon. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --persistent_android_dex_desugar +expands to --internal_persistent_android_dex_desugar,--strategy=Desugar=worker,--strategy=DexBuilder=worker +effect: HOST_MACHINE_RESOURCE_OPTIMIZATIONS,EXECUTION +allowsMultiple: false +requiresValue: false +defaultValue: +Enable persistent Android dex and desugar actions by using workers. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --sandbox_explicit_pseudoterminal +effect: EXECUTION +allowsMultiple: false +requiresValue: false +defaultValue: 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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --strategy +effect: EXECUTION +allowsMultiple: true +requiresValue: true +defaultValue: +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --worker_sandboxing +effect: EXECUTION +allowsMultiple: false +requiresValue: false +defaultValue: false +If enabled, singleplex workers will run in a sandboxed environment. Singleplex workers are always sandboxed when running under the dynamic execution strategy, irrespective of this flag. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --genrule_strategy +effect: EXECUTION +allowsMultiple: false +requiresValue: true +defaultValue: +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --worker_max_instances +effect: EXECUTION,HOST_MACHINE_RESOURCE_OPTIMIZATIONS +allowsMultiple: true +requiresValue: true +defaultValue: +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --incompatible_use_new_cgroup_implementation +effect: EXECUTION +allowsMultiple: false +requiresValue: false +defaultValue: false +If true, use the new implementation for cgroups. The old implementation only supports the memory controller and ignores the value of --experimental_sandbox_limits. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --sandbox_base +effect: HOST_MACHINE_RESOURCE_OPTIMIZATIONS,EXECUTION +allowsMultiple: false +requiresValue: true +defaultValue: +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --keep_going +effect: EAGERNESS_TO_EXIT +allowsMultiple: false +requiresValue: false +defaultValue: 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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, query, run, sync, test, vendor_ + +#### --gc_thrashing_threshold +effect: HOST_MACHINE_RESOURCE_OPTIMIZATIONS +allowsMultiple: false +requiresValue: true +defaultValue: 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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --spawn_strategy +effect: EXECUTION +allowsMultiple: false +requiresValue: true +defaultValue: +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --reuse_sandbox_directories +effect: HOST_MACHINE_RESOURCE_OPTIMIZATIONS,EXECUTION +allowsMultiple: false +requiresValue: false +defaultValue: true +If set to true, directories used by sandboxed non-worker execution may be reused to avoid unnecessary setup costs. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --incompatible_sandbox_hermetic_tmp +effect: EXECUTION +allowsMultiple: false +requiresValue: false +defaultValue: 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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --dynamic_local_execution_delay +effect: EXECUTION,HOST_MACHINE_RESOURCE_OPTIMIZATIONS +allowsMultiple: false +requiresValue: true +defaultValue: 1000 +How many milliseconds should local execution be delayed, if remote execution was faster during a build at least once? + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --persistent_multiplex_android_resource_processor +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 +effect: HOST_MACHINE_RESOURCE_OPTIMIZATIONS,EXECUTION +allowsMultiple: false +requiresValue: false +defaultValue: +Enable persistent multiplexed Android resource processor by using workers. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --jobs +effect: HOST_MACHINE_RESOURCE_OPTIMIZATIONS,EXECUTION +allowsMultiple: false +requiresValue: true +defaultValue: 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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --persistent_multiplex_android_tools +expands to --internal_persistent_multiplex_busybox_tools,--persistent_multiplex_android_resource_processor,--persistent_multiplex_android_dex_desugar +effect: HOST_MACHINE_RESOURCE_OPTIMIZATIONS,EXECUTION +allowsMultiple: false +requiresValue: false +defaultValue: +Enable persistent and multiplexed Android tools (dexing, desugaring, resource processing). + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --loading_phase_threads +effect: BAZEL_INTERNAL_CONFIGURATION +allowsMultiple: false +requiresValue: true +defaultValue: 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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, mod, print_action, query, run, sync, test, vendor_ + +#### --dynamic_local_strategy +effect: EXECUTION,HOST_MACHINE_RESOURCE_OPTIMIZATIONS +allowsMultiple: true +requiresValue: true +defaultValue: +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,...] + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --skip_incompatible_explicit_targets +effect: LOADING_AND_ANALYSIS +allowsMultiple: false +requiresValue: false +defaultValue: 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 + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --check_up_to_date +effect: EXECUTION +allowsMultiple: false +requiresValue: false +defaultValue: 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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --persistent_multiplex_android_dex_desugar +expands to --persistent_android_dex_desugar,--internal_persistent_multiplex_android_dex_desugar +effect: HOST_MACHINE_RESOURCE_OPTIMIZATIONS,EXECUTION +allowsMultiple: false +requiresValue: false +defaultValue: +Enable persistent multiplexed Android dex and desugar actions by using workers. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --modify_execution_info +effect: EXECUTION,AFFECTS_OUTPUTS,LOADING_AND_ANALYSIS +allowsMultiple: true +requiresValue: true +defaultValue: +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. + + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, mod, print_action, query, run, sync, test, vendor_ + +#### --worker_verbose +effect: UNKNOWN +allowsMultiple: false +requiresValue: false +defaultValue: false +If enabled, prints verbose messages when workers are started, shutdown, ... + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --only +effect: CHANGES_INPUTS +allowsMultiple: true +requiresValue: true +defaultValue: +If this option is given, only sync the repositories specified with this option. Still consider all (or all configure-like, of --configure is given) outdated. + +_May apply to commands: sync_ + +#### --sandbox_tmpfs_path +effect: HOST_MACHINE_RESOURCE_OPTIMIZATIONS,EXECUTION +allowsMultiple: true +requiresValue: true +defaultValue: +For sandboxed actions, mount an empty, writable directory at this absolute path (if supported by the sandboxing implementation, ignored otherwise). + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +### incompatible_change + +#### --incompatible_modify_execution_info_additive +effect: EXECUTION,AFFECTS_OUTPUTS,LOADING_AND_ANALYSIS +allowsMultiple: false +requiresValue: false +defaultValue: false +When enabled, passing multiple --modify_execution_info flags is additive. When disabled, only the last flag is taken into account. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, mod, print_action, query, run, sync, test, vendor_ + +#### --mode +enum values: CLASSIC,CLASSIC_INTERNAL_TEST_DO_NOT_USE,SKYLARK +effect: LOADING_AND_ANALYSIS,EXECUTION +allowsMultiple: false +requiresValue: true +defaultValue: skylark +Deprecated no-effect flag. Only skylark mode is still supported. + +_May apply to commands: mobile-install_ + +## mod_command + +### stable + +#### --base_module +effect: TERMINAL_OUTPUT +allowsMultiple: false +requiresValue: true +defaultValue: <root> +Specify a module relative to which the specified target repos will be interpreted. + +_May apply to commands: mod_ + +#### --include_builtin +effect: TERMINAL_OUTPUT +allowsMultiple: false +requiresValue: false +defaultValue: false +Include built-in modules in the dependency graph. Disabled by default because it is quite noisy. + +_May apply to commands: mod_ + +#### --cycles +effect: TERMINAL_OUTPUT +allowsMultiple: false +requiresValue: false +defaultValue: false +Points out dependency cycles inside the displayed tree, which are normally ignored by default. + +_May apply to commands: mod_ + +#### --extension_filter +effect: TERMINAL_OUTPUT +allowsMultiple: false +requiresValue: true +defaultValue: +Only display the usages of these module extensions and the repos generated by them if their respective flags are set. If set, the result graph will only include paths that contain modules using the specified extensions. An empty list disables the filter, effectively specifying all possible extensions. + +_May apply to commands: mod_ + +#### --extension_info +enum values: HIDDEN,USAGES,REPOS,ALL +effect: TERMINAL_OUTPUT +allowsMultiple: false +requiresValue: true +defaultValue: hidden +Specify how much detail about extension usages to include in the query result. "Usages" will only show the extensions names, "repos" will also include repos imported with use_repo, and "all" will also show the other repositories generated by extensions. + + +_May apply to commands: mod_ + +#### --extension_usages +effect: TERMINAL_OUTPUT +allowsMultiple: false +requiresValue: true +defaultValue: +Specify modules whose extension usages will be displayed in the show_extension query. + +_May apply to commands: mod_ + +#### --include_unused +effect: TERMINAL_OUTPUT +allowsMultiple: false +requiresValue: false +defaultValue: false +The queries will also take into account and display the unused modules, which are not present in the module resolution graph after selection (due to the Minimal-Version Selection or override rules). This can have different effects for each of the query types i.e. include new paths in the all_paths command, or extra dependants in the explain command. + +_May apply to commands: mod_ + +#### --charset +enum values: UTF8,ASCII +effect: TERMINAL_OUTPUT +allowsMultiple: false +requiresValue: true +defaultValue: utf8 +Chooses the character set to use for the tree. Only affects text output. Valid values are "utf8" or "ascii". Default is "utf8" + +_May apply to commands: mod_ + +#### --verbose +effect: TERMINAL_OUTPUT +allowsMultiple: false +requiresValue: false +defaultValue: false +The queries will also display the reason why modules were resolved to their current version (if changed). Defaults to true only for the explain query. + +_May apply to commands: mod_ + +#### --depth +effect: TERMINAL_OUTPUT +allowsMultiple: false +requiresValue: true +defaultValue: -1 +Maximum display depth of the dependency tree. A depth of 1 displays the direct dependencies, for example. For tree, path and all_paths it defaults to Integer.MAX_VALUE, while for deps and explain it defaults to 1 (only displays direct deps of the root besides the target leaves and their parents). + + +_May apply to commands: mod_ + +#### --from +effect: TERMINAL_OUTPUT +allowsMultiple: false +requiresValue: true +defaultValue: <root> +The module(s) starting from which the dependency graph query will be displayed. Check each query’s description for the exact semantics. Defaults to <root>. + + +_May apply to commands: mod_ + +## output_selection + +### stable + +#### --packages +effect: BAZEL_MONITORING +allowsMultiple: false +requiresValue: false +defaultValue: false +Dump package cache content. + +_May apply to commands: dump_ + +#### --build_test_dwp +effect: LOADING_AND_ANALYSIS,AFFECTS_OUTPUTS +allowsMultiple: false +requiresValue: false +defaultValue: false +If enabled, when building C++ tests statically and with fission the .dwp file for the test binary will be automatically built as well. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --skylark_memory +effect: BAZEL_MONITORING +allowsMultiple: false +requiresValue: true +defaultValue: +Dumps a pprof-compatible memory profile to the specified path. To learn more please see https://github.com/google/pprof. + +_May apply to commands: dump_ + +#### --output_groups +effect: EXECUTION,AFFECTS_OUTPUTS +allowsMultiple: true +requiresValue: true +defaultValue: +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --skyframe +enum values: OFF,SUMMARY,COUNT,VALUE,DEPS,RDEPS,FUNCTION_GRAPH,WORKING_SET,WORKING_SET_FRONTIER_DEPS +effect: BAZEL_MONITORING +allowsMultiple: false +requiresValue: true +defaultValue: off +Dump the Skyframe graph. + +_May apply to commands: dump_ + +#### --objc_generate_linkmap +effect: AFFECTS_OUTPUTS +allowsMultiple: false +requiresValue: false +defaultValue: false +Specifies whether to generate a linkmap file. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --legacy_external_runfiles +effect: AFFECTS_OUTPUTS +allowsMultiple: false +requiresValue: false +defaultValue: false +If true, build runfiles symlink forests for external repositories under .runfiles/wsname/external/repo (in addition to .runfiles/repo). + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, mod, print_action, query, run, sync, test, vendor_ + +#### --memory +effect: BAZEL_MONITORING +allowsMultiple: false +requiresValue: true +defaultValue: +Dump the memory use of the given Skyframe node. + +_May apply to commands: dump_ + +#### --cc_proto_library_header_suffixes +effect: AFFECTS_OUTPUTS,LOADING_AND_ANALYSIS +allowsMultiple: false +requiresValue: true +defaultValue: .pb.h +Sets the suffixes of header files that a cc_proto_library creates. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --build_runfile_links +effect: AFFECTS_OUTPUTS +allowsMultiple: false +requiresValue: false +defaultValue: true +If true, build runfiles symlink forests for all targets. If false, write them only when required by a local action, test or run command. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, mod, print_action, query, run, sync, test, vendor_ + +#### --run_validations +effect: EXECUTION,AFFECTS_OUTPUTS +allowsMultiple: false +requiresValue: false +defaultValue: true +Whether to run validation actions as part of the build. See https://bazel.build/extending/rules#validation_actions + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --build +effect: EXECUTION,AFFECTS_OUTPUTS +allowsMultiple: false +requiresValue: false +defaultValue: 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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --split_apks +effect: LOADING_AND_ANALYSIS,AFFECTS_OUTPUTS +allowsMultiple: false +requiresValue: false +defaultValue: false +Whether to use split apks to install and update the application on the device. Works only with devices with Marshmallow or later + +_May apply to commands: mobile-install_ + +#### --expunge +effect: HOST_MACHINE_RESOURCE_OPTIMIZATIONS +allowsMultiple: false +requiresValue: false +defaultValue: false +If true, clean removes the entire working tree for this Bazel instance, which includes all %{product}-created temporary and build output files, and stops the %{product} server if it is running. + +_May apply to commands: clean_ + +#### --expunge_async +expands to --expunge,--async +effect: HOST_MACHINE_RESOURCE_OPTIMIZATIONS +allowsMultiple: false +requiresValue: false +defaultValue: +If specified, clean asynchronously removes the entire working tree for this Bazel instance, which includes all %{product}-created temporary and build output files, and stops the %{product} 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. + +_May apply to commands: clean_ + +#### --action_cache +effect: BAZEL_MONITORING +allowsMultiple: false +requiresValue: false +defaultValue: false +Dump action cache content. + +_May apply to commands: dump_ + +#### --build_runfile_manifests +effect: AFFECTS_OUTPUTS +allowsMultiple: false +requiresValue: false +defaultValue: true +If true, write runfiles manifests for all targets. If false, omit them. Local tests will fail to run when false. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, mod, print_action, query, run, sync, test, vendor_ + +#### --cc_proto_library_source_suffixes +effect: AFFECTS_OUTPUTS,LOADING_AND_ANALYSIS +allowsMultiple: false +requiresValue: true +defaultValue: .pb.cc +Sets the suffixes of source files that a cc_proto_library creates. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --save_temps +effect: AFFECTS_OUTPUTS +allowsMultiple: false +requiresValue: false +defaultValue: 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++). + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --skykey_filter +effect: BAZEL_MONITORING +allowsMultiple: false +requiresValue: true +defaultValue: .* +Regex filter of SkyKey names to output. Only used with --skyframe=deps, rdeps, function_graph. + +_May apply to commands: dump_ + +#### --serialized_frontier_profile +effect: BAZEL_MONITORING +allowsMultiple: false +requiresValue: true +defaultValue: +Dump a profile of serialized frontier bytes. Specifies the output path. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --iff_heap_size_greater_than +effect: LOSES_INCREMENTAL_STATE,EAGERNESS_TO_EXIT +allowsMultiple: false +requiresValue: true +defaultValue: 0 +Iff non-zero, then shutdown will only shut down the server if the total memory (in MB) consumed by the JVM exceeds this value. + +_May apply to commands: shutdown_ + +#### --apple_generate_dsym +effect: AFFECTS_OUTPUTS,ACTION_COMMAND_LINES +allowsMultiple: false +requiresValue: false +defaultValue: false +Whether to generate debug symbol(.dSYM) file(s). + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --rules +effect: BAZEL_MONITORING +allowsMultiple: false +requiresValue: false +defaultValue: false +Dump rules, including counts and memory usage (if memory is tracked). + +_May apply to commands: dump_ + +#### --rule_classes +effect: BAZEL_MONITORING +allowsMultiple: false +requiresValue: false +defaultValue: false +Dump rule classes. + +_May apply to commands: dump_ + +#### --canonicalize_policy +effect: AFFECTS_OUTPUTS,TERMINAL_OUTPUT +allowsMultiple: false +requiresValue: false +defaultValue: 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'. + +_May apply to commands: canonicalize-flags_ + +#### --incremental +effect: LOADING_AND_ANALYSIS +allowsMultiple: false +requiresValue: false +defaultValue: false +Whether to do an incremental install. If true, try to avoid unnecessary additional work by reading the state of the device the code is to be installed on and using that information to avoid unnecessary work. If false (the default), always do a full install. + +_May apply to commands: mobile-install_ + +#### --fission +effect: LOADING_AND_ANALYSIS,ACTION_COMMAND_LINES,AFFECTS_OUTPUTS +allowsMultiple: false +requiresValue: true +defaultValue: 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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --async +effect: HOST_MACHINE_RESOURCE_OPTIMIZATIONS +allowsMultiple: false +requiresValue: false +defaultValue: 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. + +_May apply to commands: clean_ + +### incompatible_change + +#### --incompatible_always_include_files_in_data +effect: AFFECTS_OUTPUTS +allowsMultiple: false +requiresValue: false +defaultValue: 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). + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, mod, print_action, query, run, sync, test, vendor_ + +#### --incompatible_compact_repo_mapping_manifest +effect: AFFECTS_OUTPUTS +allowsMultiple: false +requiresValue: false +defaultValue: false +If enabled, the <binary>.repo_mapping file emits a module extension's repo mapping only once instead of once for each repo generated by the extension that contributes runfiles. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, mod, print_action, query, run, sync, test, vendor_ + +#### --incompatible_filegroup_runfiles_for_data +effect: UNKNOWN +allowsMultiple: false +requiresValue: false +defaultValue: false +If true, runfiles of targets listed in the srcs attribute are available to targets that consume the filegroup as a data dependency. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, mod, print_action, query, run, sync, test, vendor_ + +### experimental + +#### --experimental_use_validation_aspect +effect: EXECUTION,AFFECTS_OUTPUTS +allowsMultiple: false +requiresValue: false +defaultValue: false +Whether to run validation actions using aspect (for parallelism with tests). + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --experimental_proto_descriptor_sets_include_source_info +effect: AFFECTS_OUTPUTS,LOADING_AND_ANALYSIS +allowsMultiple: false +requiresValue: false +defaultValue: false +Run extra actions for alternative Java api versions in a proto_library. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --experimental_save_feature_state +effect: AFFECTS_OUTPUTS +allowsMultiple: false +requiresValue: false +defaultValue: false +Save the state of enabled and requested feautres as an output of compilation. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --experimental_include_default_values +effect: AFFECTS_OUTPUTS,TERMINAL_OUTPUT +allowsMultiple: false +requiresValue: false +defaultValue: true +Whether Starlark options set to their default values are included in the output. + +_May apply to commands: canonicalize-flags_ + +## bzlmod + +### stable + +#### --lockfile_mode +enum values: OFF,UPDATE,REFRESH,ERROR +effect: LOADING_AND_ANALYSIS +allowsMultiple: false +requiresValue: true +defaultValue: 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, `refresh` to additionally refresh mutable information (yanked versions and previously missing modules) from remote registries from time to time, `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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --check_direct_dependencies +enum values: OFF,WARNING,ERROR +effect: LOADING_AND_ANALYSIS +allowsMultiple: false +requiresValue: true +defaultValue: 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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --allow_yanked_versions +effect: LOADING_AND_ANALYSIS +allowsMultiple: true +requiresValue: true +defaultValue: +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). + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --configure +effect: CHANGES_INPUTS +allowsMultiple: false +requiresValue: false +defaultValue: false +Only fetches repositories marked as 'configure' for system-configuration purpose. Only works when --enable_bzlmod is on. + +_May apply to commands: fetch, sync_ + +#### --repo +effect: CHANGES_INPUTS +allowsMultiple: true +requiresValue: true +defaultValue: +Only fetches the specified repository, which can be either {@apparent_repo_name} or {@@canonical_repo_name}. Only works when --enable_bzlmod is on. + +_May apply to commands: fetch, vendor_ + +#### --override_module +effect: UNKNOWN +allowsMultiple: true +requiresValue: true +defaultValue: +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`. If the given path is empty, then remove any previous overrides. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --check_bazel_compatibility +enum values: ERROR,WARNING,OFF +effect: LOADING_AND_ANALYSIS +allowsMultiple: false +requiresValue: true +defaultValue: 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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --module_mirrors +effect: LOADING_AND_ANALYSIS +allowsMultiple: false +requiresValue: true +defaultValue: +A comma-separated list of URLs under which the source URLs of Bazel modules can be found, +in addition to and taking precedence over any registry-provided mirror URLs. Set this to +an empty value to disable the use of any mirrors not specified by the registries. The +default set of mirrors may change over time, but all downloads from mirrors are verified +by hashes stored in the registry (and thus pinned by the lockfile). + + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --vendor_dir +effect: LOADING_AND_ANALYSIS +allowsMultiple: false +requiresValue: true +defaultValue: +Specifies the directory that should hold the external repositories in vendor mode, whether for the purpose of fetching them into it or using them while building. The path can be specified as either an absolute path or a path relative to the workspace directory. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --ignore_dev_dependency +effect: LOADING_AND_ANALYSIS +allowsMultiple: false +requiresValue: false +defaultValue: 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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --registry +effect: CHANGES_INPUTS +allowsMultiple: true +requiresValue: true +defaultValue: +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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --force +effect: CHANGES_INPUTS +allowsMultiple: false +requiresValue: false +defaultValue: false +Ignore existing repository if any and force fetch the repository again. Only works when --enable_bzlmod is on. + +_May apply to commands: fetch_ + +## uncategorized + +### stable + +#### --show_timestamps +effect: UNKNOWN +allowsMultiple: false +requiresValue: false +defaultValue: false +Include timestamps in messages + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --build_tests_only +effect: UNKNOWN +allowsMultiple: false +requiresValue: false +defaultValue: 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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --proto_toolchain_for_java +effect: AFFECTS_OUTPUTS,LOADING_AND_ANALYSIS +allowsMultiple: false +requiresValue: true +defaultValue: @bazel_tools//tools/proto:java_toolchain +Label of proto_lang_toolchain() which describes how to compile Java protos + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --server_javabase +effect: UNKNOWN +allowsMultiple: false +requiresValue: true +defaultValue: +Path to the JVM used to execute Bazel itself. + +_May apply to commands: startup_ + +#### --tool_java_runtime_version +effect: UNKNOWN +allowsMultiple: false +requiresValue: true +defaultValue: remotejdk_11 +The Java runtime version used to execute tools during the build + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --expand_test_suites +effect: LOADING_AND_ANALYSIS +allowsMultiple: false +requiresValue: false +defaultValue: 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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --use_ijars +effect: UNKNOWN +allowsMultiple: false +requiresValue: false +defaultValue: 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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --inject_repository +effect: UNKNOWN +allowsMultiple: true +requiresValue: true +defaultValue: +Adds a new repository with a local path in the form of <repository name>=<path>. This only takes effect with --enable_bzlmod and is equivalent to adding a corresponding `local_repository` to the root module's MODULE.bazel file via `use_repo_rule`. 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`. If the given path is empty, then remove any previous injections. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --java_header_compilation +effect: UNKNOWN +allowsMultiple: false +requiresValue: false +defaultValue: true +Compile ijars directly from source. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --java_debug +expands to --test_arg=--wrapper_script_flag=--debug,--test_output=streamed,--test_strategy=exclusive,--test_timeout=9999,--nocache_test_results +effect: UNKNOWN +allowsMultiple: false +requiresValue: false +defaultValue: +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --proguard_top +effect: UNKNOWN +allowsMultiple: false +requiresValue: true +defaultValue: +Specifies which version of ProGuard to use for code removal when building a Java binary. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --proto_profile +effect: AFFECTS_OUTPUTS,LOADING_AND_ANALYSIS +allowsMultiple: false +requiresValue: false +defaultValue: true +Whether to pass profile_path to the proto compiler. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --execution_log_json_file +effect: UNKNOWN +allowsMultiple: false +requiresValue: true +defaultValue: +Log the executed spawns into this file as newline-delimited JSON representations of SpawnExec protos, according to src/main/protobuf/spawn.proto. Prefer --execution_log_compact_file, which is significantly smaller and cheaper to produce. Related flags: --execution_log_compact_file (compact format; mutually exclusive), --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). + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --build_manual_tests +effect: UNKNOWN +allowsMultiple: false +requiresValue: false +defaultValue: 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). + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --test_filter +effect: UNKNOWN +allowsMultiple: false +requiresValue: true +defaultValue: +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --protocopt +effect: AFFECTS_OUTPUTS +allowsMultiple: true +requiresValue: true +defaultValue: +Additional options to pass to the protobuf compiler. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --show_progress +effect: UNKNOWN +allowsMultiple: false +requiresValue: false +defaultValue: true +Display progress messages during a build. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --build_metadata +effect: TERMINAL_OUTPUT +allowsMultiple: true +requiresValue: true +defaultValue: +Custom key-value string pairs to supply in a build event. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --tls_client_certificate +effect: UNKNOWN +allowsMultiple: false +requiresValue: true +defaultValue: +Specify the TLS client certificate to use; you also need to provide a client key to enable client authentication. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --workspace_status_command +effect: UNKNOWN +allowsMultiple: false +requiresValue: true +defaultValue: +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --tool_java_language_version +effect: UNKNOWN +allowsMultiple: false +requiresValue: true +defaultValue: +The Java language version used to execute the tools that are needed during a build + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --grpc_keepalive_timeout +effect: UNKNOWN +allowsMultiple: false +requiresValue: true +defaultValue: 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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --jvmopt +effect: UNKNOWN +allowsMultiple: true +requiresValue: true +defaultValue: +Additional options to pass to the Java VM. These options will get added to the VM startup options of each java_binary target. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --local_termination_grace_seconds +effect: UNKNOWN +allowsMultiple: false +requiresValue: true +defaultValue: 15 +Time to wait between terminating a local process due to timeout and forcefully shutting it down. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --auto_output_filter +enum values: NONE,ALL,PACKAGES,SUBPACKAGES +effect: UNKNOWN +allowsMultiple: false +requiresValue: true +defaultValue: 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)'. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --test_size_filters +effect: UNKNOWN +allowsMultiple: false +requiresValue: true +defaultValue: +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --java_launcher +effect: UNKNOWN +allowsMultiple: false +requiresValue: true +defaultValue: +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --execution_log_sort +effect: UNKNOWN +allowsMultiple: false +requiresValue: false +defaultValue: 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. Only applies to the binary and JSON formats; the compact format is never sorted. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --credential_helper_timeout +effect: UNKNOWN +allowsMultiple: false +requiresValue: true +defaultValue: 10s +Configures the timeout for a credential helper. + +Credential helpers failing to respond within this timeout will fail the invocation. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --plugin +effect: UNKNOWN +allowsMultiple: true +requiresValue: true +defaultValue: +Plugins to use in the build. Currently works with java_plugin. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --java_language_version +effect: UNKNOWN +allowsMultiple: false +requiresValue: true +defaultValue: +The Java language version + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --tls_client_key +effect: UNKNOWN +allowsMultiple: false +requiresValue: true +defaultValue: +Specify the TLS client key to use; you also need to provide a client certificate to enable client authentication. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --execution_log_binary_file +effect: UNKNOWN +allowsMultiple: false +requiresValue: true +defaultValue: +Log the executed spawns into this file as length-delimited SpawnExec protos, according to src/main/protobuf/spawn.proto. Prefer --execution_log_compact_file, which is significantly smaller and cheaper to produce. Related flags: --execution_log_compact_file (compact format; mutually exclusive), --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). + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --credential_helper +effect: UNKNOWN +allowsMultiple: true +requiresValue: true +defaultValue: +Configures a credential helper conforming to the <a href="https://github.com/EngFlow/credential-helper-spec">Credential Helper Specification</a> 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://blog.engflow.com/2023/10/09/configuring-bazels-credential-helper/ for instructions. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --override_repository +effect: UNKNOWN +allowsMultiple: true +requiresValue: true +defaultValue: +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`. If the given path is empty, then remove any previous overrides. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --color +enum values: YES,NO,AUTO +effect: UNKNOWN +allowsMultiple: false +requiresValue: true +defaultValue: auto +Use terminal controls to colorize output. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --proto_toolchain_for_cc +effect: AFFECTS_OUTPUTS,LOADING_AND_ANALYSIS +allowsMultiple: false +requiresValue: true +defaultValue: @bazel_tools//tools/proto:cc_toolchain +Label of proto_lang_toolchain() which describes how to compile C++ protos + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --host_jvm_args +effect: UNKNOWN +allowsMultiple: true +requiresValue: true +defaultValue: +Flags to pass to the JVM executing Blaze. + +_May apply to commands: startup_ + +#### --print_action_mnemonics +effect: UNKNOWN +allowsMultiple: true +requiresValue: true +defaultValue: +Lists which mnemonics to filter print_action data by, no filtering takes place when left empty. + +_May apply to commands: print_action_ + +#### --host_javacopt +effect: UNKNOWN +allowsMultiple: true +requiresValue: true +defaultValue: +Additional options to pass to javac when building tools that are executed during a build. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --ui_actions_shown +effect: TERMINAL_OUTPUT +allowsMultiple: false +requiresValue: true +defaultValue: 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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --test_result_expiration +effect: UNKNOWN +allowsMultiple: false +requiresValue: true +defaultValue: -1 +This option is deprecated and has no effect. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --combined_report +enum values: NONE,LCOV +effect: UNKNOWN +allowsMultiple: false +requiresValue: true +defaultValue: none +Specifies desired cumulative coverage report type. At this point only LCOV is supported. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --fetch +effect: UNKNOWN +allowsMultiple: false +requiresValue: false +defaultValue: true +Allows the command to fetch external dependencies. If set to false, the command will utilize any cached version of the dependency, and if none exists, the command will result in failure. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, mod, print_action, query, run, sync, test, vendor_ + +#### --proto_compiler +effect: AFFECTS_OUTPUTS,LOADING_AND_ANALYSIS +allowsMultiple: false +requiresValue: true +defaultValue: @bazel_tools//tools/proto:protoc +The label of the proto-compiler. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --embed_label +effect: UNKNOWN +allowsMultiple: false +requiresValue: true +defaultValue: +Embed source control revision or release label in binary + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --proto_toolchain_for_j2objc +effect: AFFECTS_OUTPUTS,LOADING_AND_ANALYSIS +allowsMultiple: false +requiresValue: true +defaultValue: @bazel_tools//tools/j2objc:j2objc_proto_toolchain +Label of proto_lang_toolchain() which describes how to compile j2objc protos + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --host_jvm_debug +expands to --host_jvm_args=-Xdebug,--host_jvm_args=-Xrunjdwp:transport=dt_socket,server=y,address=5005 +effect: UNKNOWN +allowsMultiple: false +requiresValue: false +defaultValue: +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. + +_May apply to commands: startup_ + +#### --discard_analysis_cache +effect: UNKNOWN +allowsMultiple: false +requiresValue: false +defaultValue: false +Discard the analysis cache immediately after the analysis phase completes. Reduces memory usage by ~10%, but makes further incremental builds slower. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --optimizing_dexer +effect: UNKNOWN +allowsMultiple: false +requiresValue: true +defaultValue: +Specifies a binary to use to do dexing without sharding. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --build_tag_filters +effect: UNKNOWN +allowsMultiple: false +requiresValue: true +defaultValue: +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' + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --progress_in_terminal_title +effect: UNKNOWN +allowsMultiple: false +requiresValue: false +defaultValue: false +Show the command progress in the terminal title. Useful to see what bazel is doing when having multiple terminal tabs. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --google_auth_scopes +effect: UNKNOWN +allowsMultiple: false +requiresValue: true +defaultValue: https://www.googleapis.com/auth/cloud-platform +A comma-separated list of Google Cloud authentication scopes. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --package_path +effect: UNKNOWN +allowsMultiple: false +requiresValue: true +defaultValue: %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'. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, mod, print_action, query, run, sync, test, vendor_ + +#### --runs_per_test_detects_flakes +effect: UNKNOWN +allowsMultiple: false +requiresValue: false +defaultValue: false +If true, any shard in which at least one run/attempt passes and at least one run/attempt fails gets a FLAKY status. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --config +effect: UNKNOWN +allowsMultiple: true +requiresValue: true +defaultValue: +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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --disk_cache +effect: UNKNOWN +allowsMultiple: false +requiresValue: true +defaultValue: +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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --java_runtime_version +effect: UNKNOWN +allowsMultiple: false +requiresValue: true +defaultValue: local_jdk +The Java runtime version + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --execution_log_compact_file +effect: UNKNOWN +allowsMultiple: false +requiresValue: true +defaultValue: +Log the executed spawns into this file as length-delimited ExecLogEntry protos, according to src/main/protobuf/spawn.proto. The entire file is zstd compressed. Related flags: --execution_log_binary_file (binary protobuf format; mutually exclusive), --execution_log_json_file (text JSON format; mutually exclusive), --subcommands (for displaying subcommands in terminal output). + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --google_default_credentials +effect: UNKNOWN +allowsMultiple: false +requiresValue: false +defaultValue: false +Whether to use 'Google Application Default Credentials' for authentication. See https://cloud.google.com/docs/authentication for details. Disabled by default. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --google_credentials +effect: UNKNOWN +allowsMultiple: false +requiresValue: true +defaultValue: +Specifies the file to get authentication credentials from. See https://cloud.google.com/docs/authentication for details. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --invocation_id +effect: BAZEL_MONITORING,BAZEL_INTERNAL_CONFIGURATION +allowsMultiple: false +requiresValue: true +defaultValue: +Unique identifier, in UUID format, for the command being run. If explicitly specified uniqueness must be ensured by the caller. The UUID is printed to stderr, the BEP and remote execution protocol. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --shell_executable +effect: LOADING_AND_ANALYSIS +allowsMultiple: false +requiresValue: true +defaultValue: +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:/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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --j2objc_translation_flags +effect: UNKNOWN +allowsMultiple: true +requiresValue: true +defaultValue: +Additional options to pass to the J2ObjC tool. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --enable_platform_specific_config +effect: UNKNOWN +allowsMultiple: false +requiresValue: false +defaultValue: 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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --allow_analysis_cache_discard +effect: EAGERNESS_TO_EXIT +allowsMultiple: false +requiresValue: false +defaultValue: 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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --tls_certificate +effect: UNKNOWN +allowsMultiple: false +requiresValue: true +defaultValue: +Specify a path to a TLS certificate that is trusted to sign server certificates. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --test_timeout_filters +effect: UNKNOWN +allowsMultiple: false +requiresValue: true +defaultValue: +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --show_loading_progress +effect: UNKNOWN +allowsMultiple: false +requiresValue: false +defaultValue: true +If enabled, causes Bazel to print "Loading package:" messages. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, mod, print_action, query, run, sync, test, vendor_ + +#### --curses +enum values: YES,NO,AUTO +effect: UNKNOWN +allowsMultiple: false +requiresValue: true +defaultValue: auto +Use terminal cursor controls to minimize scrolling output. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --legacy_main_dex_list_generator +effect: UNKNOWN +allowsMultiple: false +requiresValue: true +defaultValue: +Specifies a binary to use to generate the list of classes that must be in the main dex when compiling legacy multidex. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --javacopt +effect: UNKNOWN +allowsMultiple: true +requiresValue: true +defaultValue: +Additional options to pass to javac. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --test_runner_fail_fast +effect: UNKNOWN +allowsMultiple: false +requiresValue: false +defaultValue: false +Forwards fail fast option to the test runner. The test runner should stop execution upon first failure. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --proto_profile_path +effect: AFFECTS_OUTPUTS,LOADING_AND_ANALYSIS +allowsMultiple: false +requiresValue: true +defaultValue: +The profile to pass to the proto compiler as profile_path. If unset, but --proto_profile is true (the default), infers the path from --fdo_optimize. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --credential_helper_cache_duration +effect: UNKNOWN +allowsMultiple: false +requiresValue: true +defaultValue: 30m +The default duration for which credentials supplied by a credential helper are cached if the helper does not provide when the credentials expire. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --host_jvmopt +effect: UNKNOWN +allowsMultiple: true +requiresValue: true +defaultValue: +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --test_arg +effect: UNKNOWN +allowsMultiple: true +requiresValue: true +defaultValue: +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --explicit_java_test_deps +effect: UNKNOWN +allowsMultiple: false +requiresValue: false +defaultValue: 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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --compile_one_dependency +effect: UNKNOWN +allowsMultiple: false +requiresValue: false +defaultValue: 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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --proto_toolchain_for_javalite +effect: AFFECTS_OUTPUTS,LOADING_AND_ANALYSIS +allowsMultiple: false +requiresValue: true +defaultValue: @bazel_tools//tools/proto:javalite_toolchain +Label of proto_lang_toolchain() which describes how to compile JavaLite protos + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --test_sharding_strategy +effect: UNKNOWN +allowsMultiple: false +requiresValue: true +defaultValue: 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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --show_progress_rate_limit +effect: UNKNOWN +allowsMultiple: false +requiresValue: true +defaultValue: 0.2 +Minimum number of seconds between progress messages in the output. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --deleted_packages +effect: UNKNOWN +allowsMultiple: true +requiresValue: true +defaultValue: +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, mod, print_action, query, run, sync, test, vendor_ + +#### --test_tag_filters +effect: UNKNOWN +allowsMultiple: false +requiresValue: true +defaultValue: +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --grpc_keepalive_time +effect: UNKNOWN +allowsMultiple: false +requiresValue: true +defaultValue: +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 + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --test_lang_filters +effect: UNKNOWN +allowsMultiple: false +requiresValue: true +defaultValue: +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --host_java_launcher +effect: UNKNOWN +allowsMultiple: false +requiresValue: true +defaultValue: +The Java launcher used by tools that are executed during a build. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --cache_test_results +effect: UNKNOWN +allowsMultiple: false +requiresValue: false +defaultValue: 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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --java_deps +effect: UNKNOWN +allowsMultiple: false +requiresValue: false +defaultValue: true +Generate dependency information (for now, compile-time classpath) per Java target. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +### experimental + +#### --experimental_java_header_compilation_direct_deps +effect: UNKNOWN +allowsMultiple: false +requiresValue: false +defaultValue: false +Use separate outputs for header and regular compilation. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --experimental_generate_llvm_lcov +effect: AFFECTS_OUTPUTS,LOADING_AND_ANALYSIS +allowsMultiple: false +requiresValue: false +defaultValue: false +If true, coverage for clang will generate an LCOV report. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --experimental_extra_action_top_level_only +effect: UNKNOWN +allowsMultiple: false +requiresValue: false +defaultValue: false +Deprecated in favor of aspects. Only schedules extra_actions for top level targets. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --experimental_extra_action_filter +effect: UNKNOWN +allowsMultiple: false +requiresValue: true +defaultValue: +Deprecated in favor of aspects. Filters set of targets to schedule extra_actions for. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --experimental_disk_cache_gc_max_size +effect: UNKNOWN +allowsMultiple: false +requiresValue: true +defaultValue: 0 +If set to a positive value, the disk cache will be periodically garbage collected to stay under this size. If set in conjunction with --experimental_disk_cache_gc_max_age, both criteria are applied. Garbage collection occurrs in the background once the server has become idle, as determined by the --experimental_disk_cache_gc_idle_delay flag. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --experimental_j2objc_shorter_header_path +effect: AFFECTS_OUTPUTS +allowsMultiple: false +requiresValue: false +defaultValue: false +Whether to generate with shorter header path (uses "_ios" instead of "_j2objc"). + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --experimental_run_android_lint_on_java_rules +effect: AFFECTS_OUTPUTS +allowsMultiple: false +requiresValue: false +defaultValue: false +Whether to validate java_* sources. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --experimental_j2objc_header_map +effect: UNKNOWN +allowsMultiple: false +requiresValue: false +defaultValue: true +Whether to generate J2ObjC header map in parallel of J2ObjC transpilation. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --experimental_install_base_gc_max_age +effect: HOST_MACHINE_RESOURCE_OPTIMIZATIONS +allowsMultiple: false +requiresValue: true +defaultValue: 30d +How long an install base must go unused before it's eligible for garbage collection. If nonzero, the server will attempt to garbage collect other install bases when idle. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --experimental_limit_android_lint_to_android_constrained_java +effect: AFFECTS_OUTPUTS +allowsMultiple: false +requiresValue: false +defaultValue: false +No-op, kept only for backwards compatibility + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --experimental_disk_cache_gc_idle_delay +effect: UNKNOWN +allowsMultiple: false +requiresValue: true +defaultValue: 5m +How long the server must remain idle before a garbage collection of the disk cache occurs. To specify the garbage collection policy, set --experimental_disk_cache_gc_max_size and/or --experimental_disk_cache_gc_max_age. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --experimental_spawn_scheduler +[WARN] deprecated: --experimental_spawn_scheduler is deprecated. Using dynamic execution for everything is rarely a good idea (see https://bazel.build/remote/dynamic). If you really want to enable dynamic execution globally, pass `--internal_spawn_scheduler --spawn_strategy=dynamic`. +expands to --internal_spawn_scheduler,--spawn_strategy=dynamic +effect: UNKNOWN +allowsMultiple: false +requiresValue: false +defaultValue: +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --experimental_rule_extension_api +effect: LOADING_AND_ANALYSIS +allowsMultiple: false +requiresValue: false +defaultValue: true +Enable experimental rule extension API and subrule APIs + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --experimental_java_classpath +enum values: OFF,JAVABUILDER,BAZEL,BAZEL_NO_FALLBACK +effect: UNKNOWN +allowsMultiple: false +requiresValue: true +defaultValue: javabuilder +Enables reduced classpaths for Java compilations. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --experimental_fetch_all_coverage_outputs +effect: AFFECTS_OUTPUTS,LOADING_AND_ANALYSIS +allowsMultiple: false +requiresValue: false +defaultValue: false +If true, then Bazel fetches the entire coverage data directory for each test during a coverage run. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --experimental_windows_watchfs +effect: UNKNOWN +allowsMultiple: false +requiresValue: false +defaultValue: false +If true, experimental Windows support for --watchfs is enabled. Otherwise --watchfsis a non-op on Windows. Make sure to also enable --watchfs. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --experimental_cancel_concurrent_tests +enum values: NEVER,ON_FAILED,ON_PASSED +effect: AFFECTS_OUTPUTS,LOADING_AND_ANALYSIS +allowsMultiple: false +requiresValue: false +defaultValue: never +If 'on_failed' or 'on_passed, then Blaze will cancel concurrently running tests on the first run with that result. This is only useful in combination with --runs_per_test_detects_flakes. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --experimental_disk_cache_gc_max_age +effect: UNKNOWN +allowsMultiple: false +requiresValue: true +defaultValue: 0 +If set to a positive value, the disk cache will be periodically garbage collected to remove entries older than this age. If set in conjunction with --experimental_disk_cache_gc_max_size, both criteria are applied. Garbage collection occurrs in the background once the server has become idle, as determined by the --experimental_disk_cache_gc_idle_delay flag. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +### incompatible_change + +#### --incompatible_check_sharding_support +effect: UNKNOWN +allowsMultiple: false +requiresValue: false +defaultValue: 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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --incompatible_repo_env_ignores_action_env +effect: LOADING_AND_ANALYSIS +allowsMultiple: false +requiresValue: false +defaultValue: false +If true, <code>--action_env=NAME=VALUE</code> will no longer affect repository rule and module extension environments. + + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --incompatible_strict_action_env +effect: LOADING_AND_ANALYSIS +allowsMultiple: false +requiresValue: false +defaultValue: 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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --incompatible_dont_use_javasourceinfoprovider +effect: NO_OP +allowsMultiple: false +requiresValue: false +defaultValue: false +No-op + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --incompatible_exclusive_test_sandboxed +effect: UNKNOWN +allowsMultiple: false +requiresValue: false +defaultValue: true +If true, exclusive tests will run with sandboxed strategy. Add 'local' tag to force an exclusive test run locally + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --incompatible_disable_non_executable_java_binary +effect: LOADING_AND_ANALYSIS +allowsMultiple: false +requiresValue: false +defaultValue: false +If true, java_binary is always executable. create_executable attribute is removed. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## build_time_optimization + +### stable + +#### --gc_thrashing_limits +effect: HOST_MACHINE_RESOURCE_OPTIMIZATIONS +allowsMultiple: false +requiresValue: true +defaultValue: 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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --local_cpu_resources +[WARN] deprecated: --local_cpu_resources is deprecated, please use --local_resources=cpu= instead. +effect: HOST_MACHINE_RESOURCE_OPTIMIZATIONS +allowsMultiple: false +requiresValue: true +defaultValue: 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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --skyframe_high_water_mark_threshold +effect: HOST_MACHINE_RESOURCE_OPTIMIZATIONS +allowsMultiple: false +requiresValue: true +defaultValue: 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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --process_headers_in_dependencies +effect: EXECUTION +allowsMultiple: false +requiresValue: false +defaultValue: 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). + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --objc_use_dotd_pruning +effect: CHANGES_INPUTS,LOADING_AND_ANALYSIS +allowsMultiple: false +requiresValue: false +defaultValue: true +If set, .d files emitted by clang will be used to prune the set of inputs passed into objc compiles. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --track_incremental_state +effect: LOSES_INCREMENTAL_STATE +allowsMultiple: false +requiresValue: false +defaultValue: 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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --cache_computed_file_digests +effect: UNKNOWN +allowsMultiple: false +requiresValue: true +defaultValue: 50000 +If greater than 0, configures Bazel to cache file digests in memory based on their metadata instead of recomputing the digests from disk every time they are needed. Setting this to 0 ensures correctness because not all file changes can be noted from file metadata. When not 0, the number indicates the size of the cache as the number of file digests to be cached. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --heuristically_drop_nodes +effect: LOSES_INCREMENTAL_STATE +allowsMultiple: false +requiresValue: false +defaultValue: 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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --incremental_dexing +effect: AFFECTS_OUTPUTS,LOADING_AND_ANALYSIS,LOSES_INCREMENTAL_STATE +allowsMultiple: false +requiresValue: false +defaultValue: true +Does most of the work for dexing separately for each Jar file. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --skyframe_high_water_mark_minor_gc_drops_per_invocation +effect: HOST_MACHINE_RESOURCE_OPTIMIZATIONS +allowsMultiple: false +requiresValue: true +defaultValue: 10 +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 10. 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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --local_resources +effect: HOST_MACHINE_RESOURCE_OPTIMIZATIONS +allowsMultiple: true +requiresValue: true +defaultValue: +Set the number of resources available to Bazel. Takes in an assignment to a float or HOST_RAM/HOST_CPUS, optionally followed by [-|*]<float> (eg. memory=HOST_RAM*.5 to use half the available RAM). Can be used multiple times to specify multiple types of resources. Bazel will limit concurrently running actions based on the available resources and the resources required. Tests can declare the amount of resources they need by using a tag of the "resources:<resource name>:<amount>" format. Overrides resources specified by --local_{cpu|ram|extra}_resources. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --keep_state_after_build +effect: LOSES_INCREMENTAL_STATE +allowsMultiple: false +requiresValue: false +defaultValue: 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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --skyframe_high_water_mark_full_gc_drops_per_invocation +effect: HOST_MACHINE_RESOURCE_OPTIMIZATIONS +allowsMultiple: false +requiresValue: true +defaultValue: 10 +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 10. 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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --trim_test_configuration +effect: LOADING_AND_ANALYSIS,LOSES_INCREMENTAL_STATE +allowsMultiple: false +requiresValue: false +defaultValue: 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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --local_ram_resources +[WARN] deprecated: --local_ram_resources is deprecated, please use --local_resources=memory= instead. +effect: HOST_MACHINE_RESOURCE_OPTIMIZATIONS +allowsMultiple: false +requiresValue: true +defaultValue: 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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --local_extra_resources +[WARN] deprecated: --local_extra_resources is deprecated, please use --local_resources instead. +effect: HOST_MACHINE_RESOURCE_OPTIMIZATIONS +allowsMultiple: true +requiresValue: true +defaultValue: +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +### experimental + +#### --experimental_cpu_load_scheduling +effect: EXECUTION +allowsMultiple: false +requiresValue: false +defaultValue: false +Enables the experimental local execution scheduling based on CPU load, not estimation of actions one by one. Experimental scheduling have showed the large benefit on a large local builds on a powerful machines with the large number of cores. Reccommended to use with --local_resources=cpu=HOST_CPUS + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --experimental_working_set +effect: HOST_MACHINE_RESOURCE_OPTIMIZATIONS +allowsMultiple: false +requiresValue: true +defaultValue: +The working set for Skyfocus. Specify as comma-separated workspace root-relative paths. This is a stateful flag. Defining a working set persists it for subsequent invocations, until it is redefined with a new set. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --experimental_dynamic_ignore_local_signals +effect: EXECUTION +allowsMultiple: false +requiresValue: true +defaultValue: +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --experimental_retain_test_configuration_across_testonly +effect: LOADING_AND_ANALYSIS,LOSES_INCREMENTAL_STATE +allowsMultiple: false +requiresValue: false +defaultValue: 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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --experimental_filter_library_jar_with_program_jar +effect: ACTION_COMMAND_LINES +allowsMultiple: false +requiresValue: false +defaultValue: false +Filter the ProGuard ProgramJar to remove any classes also present in the LibraryJar. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --experimental_unsupported_and_brittle_include_scanning +effect: LOADING_AND_ANALYSIS,EXECUTION,CHANGES_INPUTS +allowsMultiple: false +requiresValue: false +defaultValue: 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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --experimental_inmemory_dotd_files +effect: LOADING_AND_ANALYSIS,EXECUTION,AFFECTS_OUTPUTS +allowsMultiple: false +requiresValue: false +defaultValue: true +If enabled, C++ .d files will be passed through in memory directly from the remote build nodes instead of being written to disk. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --experimental_starlark_cc_import +effect: LOADING_AND_ANALYSIS +allowsMultiple: false +requiresValue: false +defaultValue: false +If enabled, the Starlark version of cc_import can be used. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --experimental_inmemory_jdeps_files +effect: LOADING_AND_ANALYSIS,EXECUTION,AFFECTS_OUTPUTS +allowsMultiple: false +requiresValue: false +defaultValue: 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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --experimental_enable_skyfocus +effect: HOST_MACHINE_RESOURCE_OPTIMIZATIONS +allowsMultiple: false +requiresValue: false +defaultValue: false +If true, enable the use of --experimental_working_set to reduce Bazel's memory footprint for incremental builds. This feature is known as Skyfocus. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +### incompatible_change + +#### --incompatible_do_not_split_linking_cmdline +effect: LOADING_AND_ANALYSIS +allowsMultiple: false +requiresValue: false +defaultValue: 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. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +## testing + +### stable + +#### --test_env +effect: TEST_RUNNER +allowsMultiple: true +requiresValue: true +defaultValue: +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, mod, print_action, query, run, sync, test, vendor_ + +#### --ios_simulator_device +effect: TEST_RUNNER +allowsMultiple: false +requiresValue: true +defaultValue: +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --runs_per_test +effect: UNKNOWN +allowsMultiple: true +requiresValue: true +defaultValue: 1 +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --analysis_testing_deps_limit +effect: LOADING_AND_ANALYSIS +allowsMultiple: false +requiresValue: true +defaultValue: 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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, mod, print_action, query, run, sync, test, vendor_ + +#### --ios_simulator_version +effect: TEST_RUNNER +allowsMultiple: false +requiresValue: true +defaultValue: +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --zip_undeclared_test_outputs +effect: TEST_RUNNER +allowsMultiple: false +requiresValue: false +defaultValue: false +If true, undeclared test outputs will be archived in a zip file. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --test_timeout +effect: UNKNOWN +allowsMultiple: false +requiresValue: true +defaultValue: -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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --flaky_test_attempts +effect: EXECUTION +allowsMultiple: true +requiresValue: true +defaultValue: default +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --test_tmpdir +effect: UNKNOWN +allowsMultiple: false +requiresValue: true +defaultValue: +Specifies the base temporary directory for 'bazel test' to use. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --test_keep_going +effect: EXECUTION +allowsMultiple: false +requiresValue: false +defaultValue: 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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --local_test_jobs +effect: EXECUTION +allowsMultiple: false +requiresValue: true +defaultValue: 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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --check_tests_up_to_date +effect: EXECUTION +allowsMultiple: false +requiresValue: false +defaultValue: 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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --test_strategy +effect: EXECUTION +allowsMultiple: false +requiresValue: true +defaultValue: +Specifies which strategy to use when running tests. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --default_test_resources +effect: UNKNOWN +allowsMultiple: true +requiresValue: true +defaultValue: +Override the default resources amount for tests. The expected format is <resource>=<value>. If a single positive number is specified as <value> it will override the default resources for all test sizes. If 4 comma-separated numbers are specified, they will override the resource amount for respectively the small, medium, large, enormous test sizes. Values can also be HOST_RAM/HOST_CPU, optionally followed by [-|*]<float> (eg. memory=HOST_RAM*.1,HOST_RAM*.2,HOST_RAM*.3,HOST_RAM*.4). The default test resources specified by this flag are overridden by explicit resources specified in tags. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --ios_memleaks +effect: ACTION_COMMAND_LINES +allowsMultiple: false +requiresValue: false +defaultValue: false +Enable checking for memory leaks in ios_test targets. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +### experimental + +#### --break_build_on_parallel_dex2oat_failure +effect: LOADING_AND_ANALYSIS +allowsMultiple: false +requiresValue: false +defaultValue: false +If true dex2oat action failures will cause the build to break instead of executing dex2oat during test runtime. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --allow_analysis_failures +effect: LOADING_AND_ANALYSIS +allowsMultiple: false +requiresValue: false +defaultValue: 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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, mod, print_action, query, run, sync, test, vendor_ + +#### --experimental_android_use_parallel_dex2oat +effect: LOADING_AND_ANALYSIS,HOST_MACHINE_RESOURCE_OPTIMIZATIONS +allowsMultiple: false +requiresValue: false +defaultValue: false +Use dex2oat in parallel to possibly speed up android_test. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## input_strictness + +### incompatible_change + +#### --incompatible_enforce_starlark_utf8 +enum values: OFF,WARNING,ERROR +effect: LOADING_AND_ANALYSIS +allowsMultiple: false +requiresValue: false +defaultValue: warning +If enabled (or set to 'error'), fail if Starlark files are not UTF-8 encoded. If set to 'warning', emit a warning instead. If set to 'off', Bazel assumes that Starlark files are UTF-8 encoded but does not verify this assumption. Note that Starlark files which are not UTF-8 encoded can cause Bazel to behave inconsistently. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --incompatible_validate_top_level_header_inclusions +effect: NO_OP +allowsMultiple: false +requiresValue: false +defaultValue: true +This flag is a noop and scheduled for removal. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --incompatible_check_visibility_for_toolchains +effect: BUILD_FILE_SEMANTICS +allowsMultiple: false +requiresValue: false +defaultValue: false +If enabled, visibility checking also applies to toolchain implementations. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --incompatible_python_disable_py2 +effect: LOADING_AND_ANALYSIS +allowsMultiple: false +requiresValue: false +defaultValue: 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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --strict_public_imports +enum values: OFF,WARN,ERROR,STRICT,DEFAULT +effect: BUILD_FILE_SEMANTICS,EAGERNESS_TO_EXIT +allowsMultiple: false +requiresValue: true +defaultValue: off +Unless OFF, checks that a proto_library target explicitly declares all targets used in 'import public' as exported. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --incompatible_disable_native_apple_binary_rule +effect: EAGERNESS_TO_EXIT +allowsMultiple: false +requiresValue: false +defaultValue: false +No-op. Kept here for backwards compatibility. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --incompatible_legacy_local_fallback +effect: EXECUTION +allowsMultiple: false +requiresValue: false +defaultValue: 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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --strict_proto_deps +enum values: OFF,WARN,ERROR,STRICT,DEFAULT +effect: BUILD_FILE_SEMANTICS,EAGERNESS_TO_EXIT +allowsMultiple: false +requiresValue: true +defaultValue: error +Unless OFF, checks that a proto_library target explicitly declares all directly used targets as dependencies. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --incompatible_disable_native_android_rules +effect: EAGERNESS_TO_EXIT +allowsMultiple: false +requiresValue: false +defaultValue: 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 + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --incompatible_check_testonly_for_output_files +effect: BUILD_FILE_SEMANTICS +allowsMultiple: false +requiresValue: false +defaultValue: 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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, mod, print_action, query, run, sync, test, vendor_ + +### stable + +#### --check_bzl_visibility +effect: BUILD_FILE_SEMANTICS +allowsMultiple: false +requiresValue: false +defaultValue: true +If disabled, .bzl load visibility errors are demoted to warnings. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --strict_system_includes +effect: LOADING_AND_ANALYSIS,EAGERNESS_TO_EXIT +allowsMultiple: false +requiresValue: false +defaultValue: false +If true, headers found through system include paths (-isystem) are also required to be declared. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --sandbox_default_allow_network +effect: EXECUTION +allowsMultiple: false +requiresValue: false +defaultValue: true +Allow network access by default for actions; this may not work with all sandboxing implementations. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --sandbox_fake_hostname +effect: EXECUTION +allowsMultiple: false +requiresValue: false +defaultValue: false +Change the current hostname to 'localhost' for sandboxed actions. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --target_environment +effect: CHANGES_INPUTS +allowsMultiple: true +requiresValue: true +defaultValue: +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, mod, print_action, query, run, sync, test, vendor_ + +#### --sandbox_fake_username +effect: EXECUTION +allowsMultiple: false +requiresValue: false +defaultValue: false +Change the current username to 'nobody' for sandboxed actions. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --sandbox_block_path +effect: EXECUTION +allowsMultiple: true +requiresValue: true +defaultValue: +For sandboxed actions, disallow access to this path. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --sandbox_writable_path +effect: EXECUTION +allowsMultiple: true +requiresValue: true +defaultValue: +For sandboxed actions, make an existing directory writable in the sandbox (if supported by the sandboxing implementation, ignored otherwise). + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --desugar_for_android +effect: AFFECTS_OUTPUTS,LOADING_AND_ANALYSIS,LOSES_INCREMENTAL_STATE +allowsMultiple: false +requiresValue: false +defaultValue: true +Whether to desugar Java 8 bytecode before dexing. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --one_version_enforcement_on_java_tests +effect: LOADING_AND_ANALYSIS +allowsMultiple: false +requiresValue: false +defaultValue: true +When enabled, and with experimental_one_version_enforcement set to a non-NONE value, enforce one version on java_test targets. This flag can be disabled to improve incremental test performance at the expense of missing potential one version violations. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --sandbox_add_mount_pair +effect: EXECUTION +allowsMultiple: true +requiresValue: true +defaultValue: +Add additional path pair to mount in sandbox. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --check_licenses +effect: BUILD_FILE_SEMANTICS +allowsMultiple: false +requiresValue: false +defaultValue: 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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, mod, print_action, query, run, sync, test, vendor_ + +#### --python_native_rules_allowlist +effect: LOADING_AND_ANALYSIS +allowsMultiple: false +requiresValue: true +defaultValue: +An allowlist (package_group target) to use when enforcing --incompatible_python_disallow_native_rules. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --strict_filesets +effect: BUILD_FILE_SEMANTICS,EAGERNESS_TO_EXIT +allowsMultiple: false +requiresValue: false +defaultValue: false +If this option is enabled, filesets crossing package boundaries are reported as errors. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, mod, print_action, query, run, sync, test, vendor_ + +#### --check_visibility +effect: BUILD_FILE_SEMANTICS +allowsMultiple: false +requiresValue: false +defaultValue: true +If disabled, visibility errors in target dependencies are demoted to warnings. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, mod, print_action, query, run, sync, test, vendor_ + +#### --enforce_constraints +effect: BUILD_FILE_SEMANTICS +allowsMultiple: false +requiresValue: false +defaultValue: true +Checks the environments each target is compatible with and reports errors if any target has dependencies that don't support the same environments + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, mod, print_action, query, run, sync, test, vendor_ + +### experimental + +#### --experimental_strict_java_deps +enum values: OFF,WARN,ERROR,STRICT,DEFAULT +effect: BUILD_FILE_SEMANTICS,EAGERNESS_TO_EXIT +allowsMultiple: false +requiresValue: true +defaultValue: default +If true, checks that a Java target explicitly declares all directly used targets as dependencies. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --auto_cpu_environment_group +effect: NO_OP +allowsMultiple: false +requiresValue: true +defaultValue: +No-op + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --experimental_sandboxfs_map_symlink_targets +effect: HOST_MACHINE_RESOURCE_OPTIMIZATIONS,EXECUTION +allowsMultiple: false +requiresValue: false +defaultValue: false +No-op + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --desugar_java8_libs +effect: AFFECTS_OUTPUTS,LOADING_AND_ANALYSIS,LOSES_INCREMENTAL_STATE +allowsMultiple: false +requiresValue: false +defaultValue: false +Whether to include supported Java 8 libraries in apps for legacy devices. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --experimental_docker_privileged +effect: EXECUTION +allowsMultiple: false +requiresValue: false +defaultValue: 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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --experimental_one_version_enforcement +enum values: OFF,WARNING,ERROR +effect: LOADING_AND_ANALYSIS +allowsMultiple: false +requiresValue: true +defaultValue: OFF +When enabled, enforce that a java_binary rule can't contain more than one version of the same class file on the classpath. This enforcement can break the build, or can just result in warnings. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --experimental_import_deps_checking +effect: LOADING_AND_ANALYSIS +allowsMultiple: false +requiresValue: true +defaultValue: +No-op, kept only for backwards compatibility + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --experimental_check_desugar_deps +effect: EAGERNESS_TO_EXIT,LOADING_AND_ANALYSIS +allowsMultiple: false +requiresValue: false +defaultValue: true +Whether to double-check correct desugaring at Android binary level. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## toolchain + +### stable + +#### --android_manifest_merger +enum values: LEGACY,ANDROID,FORCE_ANDROID +effect: AFFECTS_OUTPUTS,LOADING_AND_ANALYSIS,LOSES_INCREMENTAL_STATE +allowsMultiple: false +requiresValue: true +defaultValue: android +Selects the manifest merger to use for android_binary rules. Flag to help thetransition to the Android manifest merger from the legacy merger. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --adb +effect: CHANGES_INPUTS +allowsMultiple: false +requiresValue: true +defaultValue: +adb binary to use for the 'mobile-install' command. If unspecified, the one in the Android SDK specified by the --android_sdk_channel command line option (or the default SDK if --android_sdk_channel is not specified) is used. + +_May apply to commands: mobile-install_ + +#### --compiler +effect: LOADING_AND_ANALYSIS,EXECUTION +allowsMultiple: false +requiresValue: true +defaultValue: +The C++ compiler to use for compiling the target. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --platforms +effect: AFFECTS_OUTPUTS,CHANGES_INPUTS,LOADING_AND_ANALYSIS +allowsMultiple: false +requiresValue: true +defaultValue: +The labels of the platform rules describing the target platforms for the current command. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --coverage_output_generator +effect: CHANGES_INPUTS,AFFECTS_OUTPUTS,LOADING_AND_ANALYSIS +allowsMultiple: false +requiresValue: true +defaultValue: @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'. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --coverage_support +effect: CHANGES_INPUTS,AFFECTS_OUTPUTS,LOADING_AND_ANALYSIS +allowsMultiple: false +requiresValue: true +defaultValue: @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'. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --minimum_os_version +effect: LOADING_AND_ANALYSIS,AFFECTS_OUTPUTS +allowsMultiple: false +requiresValue: true +defaultValue: +The minimum OS version which your compilation targets. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --apple_crosstool_top +effect: LOSES_INCREMENTAL_STATE,CHANGES_INPUTS +allowsMultiple: false +requiresValue: true +defaultValue: @bazel_tools//tools/cpp:toolchain +The label of the crosstool package to be used in Apple and Objc rules and their dependencies. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --grte_top +effect: ACTION_COMMAND_LINES,AFFECTS_OUTPUTS +allowsMultiple: false +requiresValue: true +defaultValue: +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --interface_shared_objects +effect: LOADING_AND_ANALYSIS,AFFECTS_OUTPUTS,AFFECTS_OUTPUTS +allowsMultiple: false +requiresValue: false +defaultValue: true +Use interface shared objects if supported by the toolchain. All ELF toolchains currently support this setting. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --xcode_version +effect: LOSES_INCREMENTAL_STATE +allowsMultiple: false +requiresValue: true +defaultValue: +If specified, uses Xcode of the given version for relevant build actions. If unspecified, uses the executor default version of Xcode. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --python_path +effect: LOADING_AND_ANALYSIS,AFFECTS_OUTPUTS +allowsMultiple: false +requiresValue: true +defaultValue: +The absolute path of the Python interpreter invoked to run Python targets on the target platform. Deprecated; disabled by --incompatible_use_python_toolchains. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --extra_execution_platforms +effect: EXECUTION +allowsMultiple: false +requiresValue: true +defaultValue: +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --ios_sdk_version +effect: LOSES_INCREMENTAL_STATE +allowsMultiple: false +requiresValue: true +defaultValue: +Specifies the version of the iOS SDK to use to build iOS applications. If unspecified, uses the default iOS SDK version from 'xcode_version'. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --xcode_version_config +effect: LOSES_INCREMENTAL_STATE,LOADING_AND_ANALYSIS +allowsMultiple: false +requiresValue: true +defaultValue: @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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --macos_sdk_version +effect: LOSES_INCREMENTAL_STATE +allowsMultiple: false +requiresValue: true +defaultValue: +Specifies the version of the macOS SDK to use to build macOS applications. If unspecified, uses the default macOS SDK version from 'xcode_version'. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --extra_toolchains +effect: AFFECTS_OUTPUTS,CHANGES_INPUTS,LOADING_AND_ANALYSIS +allowsMultiple: true +requiresValue: true +defaultValue: +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(). + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --cc_output_directory_tag +effect: AFFECTS_OUTPUTS +allowsMultiple: false +requiresValue: true +defaultValue: +Specifies a suffix to be added to the configuration directory. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --python_top +effect: LOADING_AND_ANALYSIS,AFFECTS_OUTPUTS +allowsMultiple: false +requiresValue: true +defaultValue: +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --custom_malloc +effect: CHANGES_INPUTS,AFFECTS_OUTPUTS +allowsMultiple: false +requiresValue: true +defaultValue: +Specifies a custom malloc implementation. This setting overrides malloc attributes in build rules. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --host_platform +effect: AFFECTS_OUTPUTS,CHANGES_INPUTS,LOADING_AND_ANALYSIS +allowsMultiple: false +requiresValue: true +defaultValue: @bazel_tools//tools:host_platform +The label of a platform rule that describes the host system. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --target_platform_fallback +effect: NO_OP +allowsMultiple: false +requiresValue: true +defaultValue: +This option is deprecated and has no effect. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --host_grte_top +effect: ACTION_COMMAND_LINES,AFFECTS_OUTPUTS +allowsMultiple: false +requiresValue: true +defaultValue: +If specified, this setting overrides the libc top-level directory (--grte_top) for the exec configuration. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --host_compiler +effect: LOADING_AND_ANALYSIS,EXECUTION +allowsMultiple: false +requiresValue: true +defaultValue: +No-op flag. Will be removed in a future release. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --watchos_sdk_version +effect: LOSES_INCREMENTAL_STATE +allowsMultiple: false +requiresValue: true +defaultValue: +Specifies the version of the watchOS SDK to use to build watchOS applications. If unspecified, uses the default watchOS SDK version from 'xcode_version'. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --android_platforms +effect: CHANGES_INPUTS,LOADING_AND_ANALYSIS,LOSES_INCREMENTAL_STATE +allowsMultiple: false +requiresValue: true +defaultValue: +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --tvos_sdk_version +effect: LOSES_INCREMENTAL_STATE +allowsMultiple: false +requiresValue: true +defaultValue: +Specifies the version of the tvOS SDK to use to build tvOS applications. If unspecified, uses the default tvOS SDK version from 'xcode_version'. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --android_compiler +effect: AFFECTS_OUTPUTS,LOADING_AND_ANALYSIS,LOSES_INCREMENTAL_STATE +allowsMultiple: false +requiresValue: true +defaultValue: +The Android target compiler. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --coverage_report_generator +effect: CHANGES_INPUTS,AFFECTS_OUTPUTS,LOADING_AND_ANALYSIS +allowsMultiple: false +requiresValue: true +defaultValue: @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'. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +### incompatible_change + +#### --incompatible_enable_proto_toolchain_resolution +effect: LOADING_AND_ANALYSIS +allowsMultiple: false +requiresValue: false +defaultValue: false +If true, proto lang rules define toolchains from protobuf repository. + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + +#### --incompatible_enable_apple_toolchain_resolution +effect: LOADING_AND_ANALYSIS +allowsMultiple: false +requiresValue: false +defaultValue: false +Use toolchain resolution to select the Apple SDK for apple rules (Starlark and native) + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --incompatible_require_ctx_in_configure_features +effect: NO_OP +allowsMultiple: false +requiresValue: false +defaultValue: true +This flag is a noop and scheduled for removal. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --incompatible_dont_enable_host_nonhost_crosstool_features +effect: LOADING_AND_ANALYSIS +allowsMultiple: false +requiresValue: false +defaultValue: 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). + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --incompatible_bazel_test_exec_run_under +effect: AFFECTS_OUTPUTS +allowsMultiple: false +requiresValue: false +defaultValue: false +If enabled, "bazel test --run_under=//:runner" builds "//:runner" in the exec configuration. If disabled, it builds "//:runner" in the target configuration. Bazel executes tests on exec machines, so the former is more correct. This doesn't affect "bazel run", which always builds "`--run_under=//foo" in the target configuration. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, mod, print_action, query, run, sync, test, vendor_ + +#### --incompatible_strip_executable_safely +effect: ACTION_COMMAND_LINES +allowsMultiple: false +requiresValue: false +defaultValue: false +If true, strip action for executables will use flag -x, which does not break dynamic symbol resolution. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --incompatible_make_thinlto_command_lines_standalone +effect: NO_OP +allowsMultiple: false +requiresValue: false +defaultValue: true +This flag is a noop and scheduled for removal. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --incompatible_remove_legacy_whole_archive +effect: LOADING_AND_ANALYSIS +allowsMultiple: false +requiresValue: false +defaultValue: 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). + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +### experimental + +#### --experimental_prefer_mutual_xcode +effect: LOSES_INCREMENTAL_STATE +allowsMultiple: false +requiresValue: false +defaultValue: 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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --experimental_include_xcode_execution_requirements +effect: LOSES_INCREMENTAL_STATE,LOADING_AND_ANALYSIS,EXECUTION +allowsMultiple: false +requiresValue: false +defaultValue: 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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --experimental_add_exec_constraints_to_targets +effect: LOADING_AND_ANALYSIS +allowsMultiple: true +requiresValue: true +defaultValue: +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'. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +### immutable + +#### --platform_mappings +effect: AFFECTS_OUTPUTS,CHANGES_INPUTS,LOADING_AND_ANALYSIS +allowsMultiple: false +requiresValue: true +defaultValue: +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). + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +## generic_inputs + +### stable + +#### --flag_alias +effect: CHANGES_INPUTS +allowsMultiple: true +requiresValue: true +defaultValue: +Sets a shorthand name for a Starlark flag. It takes a single key-value pair in the form "<key>=<value>" as an argument. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, mod, print_action, query, run, sync, test, vendor_ + +#### --python_version +effect: LOADING_AND_ANALYSIS,AFFECTS_OUTPUTS +allowsMultiple: false +requiresValue: true +defaultValue: +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --aspects_parameters +effect: LOADING_AND_ANALYSIS +allowsMultiple: true +requiresValue: true +defaultValue: +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --for_command +effect: AFFECTS_OUTPUTS,TERMINAL_OUTPUT +allowsMultiple: false +requiresValue: true +defaultValue: build +The command for which the options should be canonicalized. + +_May apply to commands: canonicalize-flags_ + +#### --target_pattern_file +effect: CHANGES_INPUTS +allowsMultiple: false +requiresValue: true +defaultValue: +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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +### incompatible_change + +#### --incompatible_py3_is_default +effect: LOADING_AND_ANALYSIS,AFFECTS_OUTPUTS +allowsMultiple: false +requiresValue: false +defaultValue: 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`. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --incompatible_default_to_explicit_init_py +effect: AFFECTS_OUTPUTS +allowsMultiple: false +requiresValue: false +defaultValue: 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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --incompatible_use_python_toolchains +effect: LOADING_AND_ANALYSIS +allowsMultiple: false +requiresValue: false +defaultValue: 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. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +#### --incompatible_py2_outputs_are_suffixed +effect: AFFECTS_OUTPUTS +allowsMultiple: false +requiresValue: false +defaultValue: 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`. + +_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_ + +### experimental + +#### --experimental_resolved_file_instead_of_workspace +effect: CHANGES_INPUTS +allowsMultiple: false +requiresValue: true +defaultValue: +If non-empty read the specified resolved file instead of the WORKSPACE file + +_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_ + diff --git a/flags-converter.sh b/flags-converter.sh new file mode 100755 index 00000000..d627cbea --- /dev/null +++ b/flags-converter.sh @@ -0,0 +1,13 @@ +#!/usr/bin/env bash +# Ask Bazel to dump the flags as a binary protobuf, and save in our repo for later rendering. +set -o errexit -o nounset -o pipefail + +cd "$(dirname "${BASH_SOURCE[0]}")" + +if [ -z "${USE_BAZEL_VERSION:-}" ]; then + export USE_BAZEL_VERSION=rolling + OUTPUT_FILE=flags.mdx +else + OUTPUT_FILE=${USE_BAZEL_VERSION}/flags.mdx +fi +bazel help flags-as-proto | node flags_to_markdown_converter/convert.js > ${OUTPUT_FILE} diff --git a/flags_to_markdown_converter/convert.js b/flags_to_markdown_converter/convert.js new file mode 100644 index 00000000..ca5f5bc7 --- /dev/null +++ b/flags_to_markdown_converter/convert.js @@ -0,0 +1,95 @@ +import { FlagCollectionSchema } from '@buf/bazel_bazel.bufbuild_es/bazel_flags/bazel_flags_pb.js'; +import { fromBinary } from '@bufbuild/protobuf' + +const writeLine = (line) => process.stdout.write(line + '\n'); +function escapeHtml(str) { + return str + .replace(/&/g, "&") + .replace(//g, ">") + .replace(/{/g, "{") + .replace(/}/g, "}"); + } + +// Read stdin as a stream +let base64String = ''; +process.stdin.setEncoding('utf8'); +for await (const chunk of process.stdin) { + base64String += chunk; +} + +const flags = fromBinary(FlagCollectionSchema, Buffer.from(base64String.trim(), 'base64')); +const documentedFlags = flags.flagInfos.filter(f => f.documentationCategory !== 'UNDOCUMENTED'); +const flagsByCategory = documentedFlags.reduce((m, f) => { + if (f.metadataTags.length > 1) throw Error(); + // Invent a metadata tag for flags that would otherwise be ungrouped. + // This is done to avoid having some nested more deeply than others. + let tag = f.metadataTags[0] || 'STABLE'; + // bugfix? + if (f.name.startsWith('experimental_')) { + tag = 'EXPERIMENTAL' + } + if (!m.has(f.documentationCategory)) { + m.set(f.documentationCategory, new Map()); + } + if (!m.get(f.documentationCategory).has(tag)) { + m.get(f.documentationCategory).set(tag, []); + } + m.get(f.documentationCategory).get(tag).push(f); + return m; +}, new Map()); + +// Write header +writeLine('---'); +writeLine('title: Bazel flags'); +writeLine('---'); + +// Write each flag +for (const category of flagsByCategory.keys()) { + writeLine(`## ${category.toLowerCase()}\n`) + for (const tag of flagsByCategory.get(category).keys()) { + writeLine(`### ${tag.toLowerCase()}\n`) + for (const flag of flagsByCategory.get(category).get(tag)) { + writeLine(`#### --${flag.name}`); + let aliases = []; + if (flag.abbreviation) { + aliases.push(`-${flag.abbreviation}`); + } + if (flag.hasNegativeFlag) { + aliases.push(`--no${flag.name}`); + } + if (flag.oldName) { + aliases.push(`previously ${flag.oldName}`); + } + if (flag.deprecationWarning) { + writeLine('[WARN] deprecated: ' + flag.deprecationWarning) + } + if (flag.optionExpansions.length > 0) { + writeLine('expands to ' + flag.optionExpansions) + } + if (flag.enumValues.length > 0) { + writeLine('enum values: ' + flag.enumValues) + } + + writeLine('effect: ' + flag.effectTags) + writeLine('allowsMultiple: ' + flag.allowsMultiple) + writeLine('requiresValue: ' + flag.requiresValue) + writeLine(`defaultValue: ${escapeHtml(flag.defaultValue)}`); + + // TODO: add history - what version of Bazel introduced this flag? + // TODO: link to GitHub issue where the flag is being managed (i.e. graduate from experimental) + // TODO: link to definition of the flag in Bazel sources + // TODO: add popularity - how many times does it appear in github search for bazelrc files? + // TODO: this is wrapped in a 
 tag to avoid invalid markdown like bare html tags
+            // also a bugfix for Bazel/Blaze placeholder.
+            writeLine(escapeHtml(flag.documentation.replace('%{product}', 'Bazel')));
+            
+            if (flag.commands.length > 0) {
+                writeLine('');
+                writeLine(`_May apply to commands: ${flag.commands.join(', ')}_`);
+            }
+            
+            writeLine('');
+        }
+    }
+}
\ No newline at end of file
diff --git a/flags_to_markdown_converter/package-lock.json b/flags_to_markdown_converter/package-lock.json
new file mode 100644
index 00000000..47589249
--- /dev/null
+++ b/flags_to_markdown_converter/package-lock.json
@@ -0,0 +1,84 @@
+{
+    
+  "name": "flags_to_markdown_converter",
+    
+  "lockfileVersion": 3,
+    
+  "requires": true,
+    
+  "packages": {
+    
+      
+  "": {
+    
+      
+      
+  "dependencies": {
+    
+      
+      
+      
+  "@buf/bazel_bazel.bufbuild_es": "^2.10.1-20251112223041-697bc75dbe09.1"
+    
+      
+      
+  }
+    
+      
+  },
+    
+      
+  "node_modules/@buf/bazel_bazel.bufbuild_es": {
+    
+      
+      
+  "version": "2.10.1-20251112223041-697bc75dbe09.1",
+    
+      
+      
+  "resolved": "https://buf.build/gen/npm/v1/@buf/bazel_bazel.bufbuild_es/-/bazel_bazel.bufbuild_es-2.10.1-20251112223041-697bc75dbe09.1.tgz",
+    
+      
+      
+  "peerDependencies": {
+    
+      
+      
+      
+  "@bufbuild/protobuf": "^2.10.1"
+    
+      
+      
+  }
+    
+      
+  },
+    
+      
+  "node_modules/@bufbuild/protobuf": {
+    
+      
+      
+  "version": "2.10.1",
+    
+      
+      
+  "resolved": "https://registry.npmjs.org/@bufbuild/protobuf/-/protobuf-2.10.1.tgz",
+    
+      
+      
+  "integrity": "sha512-ckS3+vyJb5qGpEYv/s1OebUHDi/xSNtfgw1wqKZo7MR9F2z+qXr0q5XagafAG/9O0QPVIUfST0smluYSTpYFkg==",
+    
+      
+      
+  "license": "(Apache-2.0 AND BSD-3-Clause)",
+    
+      
+      
+  "peer": true
+    
+      
+  }
+    
+  }
+}
diff --git a/flags_to_markdown_converter/package.json b/flags_to_markdown_converter/package.json
new file mode 100644
index 00000000..8c45ae2f
--- /dev/null
+++ b/flags_to_markdown_converter/package.json
@@ -0,0 +1,10 @@
+{
+    
+  "type": "module",
+  "dependencies": {
+    "@buf/bazel_bazel.bufbuild_es": "^2.10.1-20251112223041-697bc75dbe09.1"
+  },
+  "scripts": {
+    "convert": "node convert.js"
+  }
+}
diff --git a/reference-docs.zip b/reference-docs.zip
new file mode 100644
index 00000000..6c82504d
Binary files /dev/null and b/reference-docs.zip differ
diff --git a/snippets/render_flags.jsx b/snippets/render_flags.jsx
new file mode 100644
index 00000000..180bafba
--- /dev/null
+++ b/snippets/render_flags.jsx
@@ -0,0 +1,32 @@
+export const BazelFlags = () => {
+    // const [hue, setHue] = useState(180)
+    // const [saturation, setSaturation] = useState(50)
+    // const [lightness, setLightness] = useState(50)
+    // const [colors, setColors] = useState([])
+  
+    // useEffect(() => {
+    //   const newColors = []
+    //   for (let i = 0; i < 5; i++) {
+    //     const l = Math.max(10, Math.min(90, lightness - 20 + i * 10))
+    //     newColors.push(`hsl(${hue}, ${saturation}%, ${l}%)`)
+    //   }
+    //   setColors(newColors)
+    // }, [hue, saturation, lightness])
+  
+    // const copyToClipboard = (color) => {
+    //   navigator.clipboard
+    //     .writeText(color)
+    //     .then(() => {
+    //       console.log(`Copied ${color} to clipboard!`)
+    //     })
+    //     .catch((err) => {
+    //       console.error("Failed to copy: ", err)
+    //     })
+    // }
+  
+    return (
+      

+        Flag documentation goes here.
+      

+    )
+  }
\ No newline at end of file
diff --git a/upstream b/upstream
index 9b800bae..6fc0aa1e 160000
--- a/upstream
+++ b/upstream
@@ -1 +1 @@
-Subproject commit 9b800bae4c8cd970ed04d710b9c0613a9d091b16
+Subproject commit 6fc0aa1e328e4a4da1880c53906104489558f16c