Documentation

Edit

Bazel BUILD Encyclopedia of Functions

Contents

Concepts and terminology

Functions

Rules

Native rules ship with the Bazel binary and do not require a load statement. Native rules are available globally in BUILD files. In .bzl files, you can find them in the native module.

Language-specific native rules

Language Binary rules Library rules Test rules Other rules
Android android_binary
aar_import
android_library
android_instrumentation_test
android_local_test
android_device
android_ndk_repository
android_sdk_repository
C / C++ cc_binary
cc_import
cc_library
cc_proto_library
fdo_prefetch_hints
fdo_profile
cc_test
Java java_binary
java_import
java_library
java_lite_proto_library
java_proto_library
java_test
java_plugin
Objective-C apple_binary
apple_static_library
apple_stub_binary
j2objc_library
objc_bundle
objc_bundle_library
objc_framework
objc_import
objc_library
objc_proto_library
Protocol Buffer proto_lang_toolchain
proto_library
Python py_binary
py_library
py_test
py_runtime
Shell sh_binary
sh_library
sh_test

Native rules that do not apply to a specific programming language

Extra Actions action_listener
extra_action
General filegroup
genquery
test_suite
alias
config_setting
genrule
Platform constraint_setting
constraint_value
platform
toolchain
Workspace bind
git_repository
http_archive
http_file
http_jar
local_repository
maven_jar
maven_server
new_git_repository
new_http_archive
new_local_repository
xcode_config
xcode_version

Additional rules

Non-native rules extend Bazel's capabilities. Rules for many popular languages have been created and are being maintained outside of Bazel. Contact the respective rule set's maintainers regarding issues and feature requests.

To find more Bazel rules, use a search engine or look on GitHub.

Here is a selection of popular rules:

The repository Skylib contains additional functions that can be useful when writing new rules and new macros.