| id | title |
|---|---|
index |
Introduction |
Welcome to Buck2, a large scale, fast, reliable, and extensible build tool developed and used by Meta. Buck2 supports a variety of languages on many platforms.
Buck2's core is written in Rust. Starlark, which is a deterministic, immutable dialect of Python, is used to extend the Buck2 build system, enabling Buck2 to be language-agnostic. With Starlark, users can define their own custom rules.
Buck2 leverages the Bazel spec of Remote Build Execution as the primary means of parallelization and caching, which increases the importance of idempotency (no matter how many times an operation is performed, it yields the same result) and hermeticity (code is sealed off from the world), giving the right results, reliably.
Buck2 multi-language support includes C++, Python, Java, Go, Rust, Erlang, OCaml, and more.
The following sub-sections contain a list of links to key points in the Buck2 Documentation website that explain the advantages of using Buck2 for you and your team.
- Getting Started - how to get started with using Buck2.
- Benefits - the benefits of using Buck2.
- Migration Guide - how to port projects from Buck to Buck2, including the issues you might face and notable differences.
- Buck2 and Build Observability - how to use Buck2's datasets to analyze specific invocations or classes of invocations.
- Migrating builds to work VPNless - how to migrate builds to work without VPN or lighthouse access.
- Writing Rules - how to write rules to support new languages.
- Build APIs - documentation for the APIs available when writing rules.
- Starlark Types - rules are written in Starlark (which is approximately Python), but our version adds types.
- Rule Writing Tips - tips for migrating rules from Buck1 to Buck2.
- Extending Buck via BXL - powerful Starlark scripts for introspection of Buck2's graphs.
- Buck2 change detector - tools for building a CI that only builds/tests what has changed in diff/PR.
- Buck2 GitHub actions installer - script to make GitHub CI with Buck2 easier.
- Reindeer - a set of tools for importing Rust crates from crates.io, git repos etc and generating a BUCK file for using them.
- ocaml-scripts - scripts to generate a BUCK file enabling the use of OCaml packages from an OPAM switch.
- Buckle - a launcher for Buck2 on a per-project basis. Enables a project or team to do seamless upgrades of their build system tooling.
- Introducing Buck2 - our initial introduction when we open sourced Buck2.
- Reddit AMA where the Buck2 team answered a number of questions.
- Using buck to build Rust projects - working through an initial small Rust project, by Steve Klabnik. Followed up by building from crates.io and updating Buck2.
- Awesome Buck2 is a collection of resources about Buck2.
- Buck2 Unboxing is a general review of Buck2 by Son Luong Ngoc.
- A tour around Buck2 gives an overview of Buck2 and how it differs from Bazel.
- Accelerating builds with Buck2 Neil talks about why Buck2 is fast.
- Buck2: optimizations & dynamic dependencies Neil and Chris talk about why Buck2 is fast and some of the advanced dependency features.
- Building Erlang with Buck2 Andreas talks about building WhatsApp with Buck2.
- antlir2: Deterministic image bulids with Buck2 talks about layering a packaging system over Buck2.
- System Initiative build their DevOps product using Buck2, with their own custom prelude.
- Rust
cxxlibrary has examples and tests with a wide variety of build systems, including Buck2. ocamlreplibrary allows for interop between OCaml and Rust code, and can be built with Buck2.buck2-nixis an experiment to integrate Buck2, Sapling and Nix together in a harmonious way.
Feel free to send a PR adding your project.
- Basic README - how to get started, compile Buck2 and the basic workflows.
- Notes for Developers - more advanced workflows and notes around debugging, profiling etc.