OpenParable
Skip to content
← Back to skills

Bazel usage

Development

Bazel usage is an Agent Skill for development published in the carbon-language/carbon-lang repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.

Instructions that **MUST** be followed when using Bazel or Bazelisk to build, test, and debug in the Carbon repository.

View on GitHub ↗
QUICK START

How to use this skill

Bring this guide into your coding agent with a prompt tailored to the tool you use.

  1. Open your project in Codex.
  2. Copy and paste the prompt below.
  3. Review files and risks before approving any action.
Prompt to paste
Inspect the Agent Skill at https://github.com/carbon-language/carbon-lang/blob/HEAD/.agents/skills/bazel/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/bazel-usage, but wait for my approval before writing files or running scripts.

Copying this prompt does not install or run the skill. Review third-party files before use.

Bazel usage

This skill documents how best to use Bazel when building, testing, or manipulating the Carbon repository's Bazel in any way.

Bazel wrappers

Carbon uses Bazel for its build system. To ensure consistent versions, the project uses Bazelisk.

[!IMPORTANT] Always use bazelisk whenever you want to run Bazel. Never run bazel directly in the Carbon project. Anything you want to do with bazel can be done with the bazelisk command instead.

  • Bazelisk: Try to use bazelisk in your existing $PATH if available.
    • run_bazelisk.py: If bazelisk isn't available, use ./scripts/run_bazelisk.py to run bazelisk without it being installed.

Essential commands

Building

  • Build all: bazelisk build //...
  • Build toolchain: bazelisk build //toolchain/...
  • Build specific target: bazelisk build //toolchain:carbon

Testing

  • Test all: bazelisk test //...:all
  • Test toolchain: bazelisk test //toolchain/...
  • Test examples: bazelisk test //examples/...

[!TIP] Running all of the tests can be slow, so try to narrowly test the immediately relevant parts of the project first, and only expand coverage as necessary to be confident in the changes.

[!TIP] For specialized instructions on testing and developing the Carbon toolchain, consult these skills:

Running binaries built by Bazel

[!IMPORTANT] Always manually run binaries built by Bazel using the bazelisk run command. Never run the binary directly from bazel-bin/.

You can run the Carbon driver or command line directly via Bazel:

  • bazelisk run //toolchain -- compile --phase=parse toolchain/parse/testdata/basics/empty.carbon

Advanced configurations

AddressSanitizer (ASan)

To enable ASan for local testing:

  • Pass --config=asan: bazelisk test --config=asan //...

Common pitfalls and troubleshooting

bazel clean

Changes to packages installed on your system (like changing LLVM versions or installing libc++) may not be noticed by Bazel.

  • Run bazelisk clean to force cached state to be rebuilt when environment changes occur.