Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.

Skip to main content

The new site is online! Please use this issue to report any problems.

Bazel Documentation home page

Module Registry
Blog
Github

Getting started

Concepts

Extension Overview
Depsets
Macros
Legacy Macros
Aspects
Rules
Configurations
Execution Groups
Automatic Execution Groups (AEGs)

Writing rules

Rules Tutorial
Creating a Symbolic Macro
Creating a Legacy Macro
Using Macros to Create Custom Verbs
Starlark Language
.bzl style guide
Challenges of Writing Rules
Writing Rules on Windows

Distributing rules

Testing
Optimizing Performance
Deploying Rules

Platforms & toolchains

Platforms
Toolchains

API Reference Overview

One-Page Overview
Rules
Frequently Asked Questions

Starlark Builtins

Error: Variable x is read only
Built-in Types
Action {#modules.Action}
actions {#modules.actions}
Args {#modules.Args}
Aspect {#modules.Aspect}
Attribute {#modules.Attribute}
BuildSetting {#modules.BuildSetting}
CcCompilationOutputs {#modules.CcCompilationOutputs}
CcLinkingOutputs {#modules.CcLinkingOutputs}
CompilationContext {#modules.CompilationContext}
DirectoryExpander {#modules.DirectoryExpander}
DottedVersion {#modules.DottedVersion}
ExecGroupCollection {#modules.ExecGroupCollection}
ExecGroupContext {#modules.ExecGroupContext}
ExecTransitionFactory {#modules.ExecTransitionFactory}
ExpandedDirectory {#modules.ExpandedDirectory}
Facts {#modules.Facts}
FeatureConfiguration {#modules.FeatureConfiguration}
File {#modules.File}
Label {#modules.Label}
LateBoundDefault {#modules.LateBoundDefault}
LibraryToLink {#modules.LibraryToLink}
License {#modules.License}
LinkerInput {#modules.LinkerInput}
LinkingContext {#modules.LinkingContext}
Provider {#modules.Provider}
Subrule {#modules.Subrule}
SymlinkEntry {#modules.SymlinkEntry}
Target
TemplateDict {#modules.TemplateDict}
ToolchainContext {#modules.ToolchainContext}
apple_platform {#modules.apple_platform}
bazel_module {#modules.bazel_module}
bazel_module_tags {#modules.bazel_module_tags}
configuration {#modules.configuration}
ctx {#modules.ctx}
depset {#modules.depset}
exec_result {#modules.exec_result}
extension_metadata {#modules.extension_metadata}
fragments {#modules.fragments}
java_annotation_processing {#modules.java_annotation_processing}
java_output {#modules.java_output}
macro {#modules.macro}
mapped_root {#modules.mapped_root}
module_ctx {#modules.module_ctx}
path {#modules.path}
propagation_ctx {#modules.propagation_ctx}
repo_metadata {#modules.repo_metadata}
repository_ctx {#modules.repository_ctx}
repository_os {#modules.repository_os}
repository_rule {#modules.repository_rule}
root {#modules.root}
rule {#modules.rule}
rule_attributes {#modules.rule_attributes}
runfiles {#modules.runfiles}
struct {#modules.struct}
subrule_ctx {#modules.subrule_ctx}
tag_class {#modules.tag_class}
template_ctx {#modules.template_ctx}
toolchain_type {#modules.toolchain_type}
transition {#modules.transition}
wasm_exec_result {#modules.wasm_exec_result}
wasm_module {#modules.wasm_module}

Core Types

Core Starlark data types
bool {#modules.bool}
builtin_function_or_method {#modules.builtin_function_or_method}
dict {#modules.dict}
float {#modules.float}
function {#modules.function}
int {#modules.int}
json {#modules.json}
list {#modules.list}
range {#modules.range}
set {#modules.set}
string {#modules.string}
tuple {#modules.tuple}

Providers

Providers
AnalysisTestResultInfo {#modules.AnalysisTestResultInfo}
CcInfo {#modules.CcInfo}
CcToolchainConfigInfo {#modules.CcToolchainConfigInfo}
CcToolchainInfo {#modules.CcToolchainInfo}
ConstraintCollection {#modules.ConstraintCollection}
ConstraintSettingInfo {#modules.ConstraintSettingInfo}
ConstraintValueInfo {#modules.ConstraintValueInfo}
DebugPackageInfo {#modules.DebugPackageInfo}
DefaultInfo {#modules.DefaultInfo}
ExecutionInfo {#modules.ExecutionInfo}
FeatureFlagInfo {#modules.FeatureFlagInfo}
FilesToRunProvider {#modules.FilesToRunProvider}
IncompatiblePlatformProvider {#modules.IncompatiblePlatformProvider}
InstrumentedFilesInfo {#modules.InstrumentedFilesInfo}
JavaInfo {#modules.JavaInfo}
JavaPluginInfo {#modules.JavaPluginInfo}
JavaRuntimeInfo {#modules.JavaRuntimeInfo}
JavaToolchainInfo {#modules.JavaToolchainInfo}
MaterializedDepsInfo {#modules.MaterializedDepsInfo}
ObjcProvider {#modules.ObjcProvider}
OutputGroupInfo {#modules.OutputGroupInfo}
PackageSpecificationInfo {#modules.PackageSpecificationInfo}
PlatformInfo {#modules.PlatformInfo}
RunEnvironmentInfo {#modules.RunEnvironmentInfo}
TemplateVariableInfo {#modules.TemplateVariableInfo}
ToolchainInfo {#modules.ToolchainInfo}
ToolchainTypeInfo {#modules.ToolchainTypeInfo}
file_provider {#modules.file_provider}
java_compilation_info {#modules.java_compilation_info}
java_output_jars {#modules.java_output_jars}

Global Functions

Global functions
All Bazel files {#modules.all}
BUILD files {#modules.build}
REPO.bazel files {#modules.repo}
VENDOR.bazel files {#modules.vendor}
Bzl
MODULE.bazel files {#modules.module}

Configuration Fragments

Configuration Fragments
apple {#modules.apple}
bazel_android {#modules.bazel_android}
coverage {#modules.coverage}
cpp {#modules.cpp}
java {#modules.java}
objc {#modules.objc}
platform {#modules.platform}
proto {#modules.proto}

Toplevel APIs

Top-level Modules
apple_common {#modules.apple_common}
attr {#modules.attr}
cc_common {#modules.cc_common}
config {#modules.config}
config_common {#modules.config_common}
coverage_common {#modules.coverage_common}
java_common {#modules.java_common}
native {#modules.native}
platform_common {#modules.platform_common}
proto {#modules.proto}
testing {#modules.testing}

Repo rules

Repository Rules
cache repository rules
git repository rules
http repository rules
local repository rules
utils repository rules

Module system

External dependencies overview
Bazel modules
Module extensions
Bazel registries
Bazel Lockfile
Vendor Mode
Repository Rules
Mod command
Bzlmod Migration Guide
Migration tool
Frequently asked questions

Starlark Builtins

tag_class {#modules.tag_class}

Defines a schema of attributes for a tag, created by tag_class().

subrule_ctx {#modules.subrule_ctx}

template_ctx {#modules.template_ctx}

Bazel Documentation home page

x github reddit

About

Who's using Bazel Contribute Governance model Release model Brand guidelines

Stay Connected

Blog GitHub Twitter YouTube

Support

Support Issue tracker Slack Stack Overflow

Legal

Privacy Policy Terms of Service

Powered byThis documentation is built and hosted on Mintlify, a developer documentation platform

Assistant

Responses are generated using AI and may contain mistakes.