Prerequisites

You need the Rust toolchain (both stable and nightly) to build the project. You can use rustup to manage the Rust toolchain in your local environment.

You need Node.js to build the documentation.

On macOS, you can install rustup and the Node.js runtime via Homebrew.

brew install rustup
brew install node

Use the following commands to install the Rust toolchains via rustup.

rustup toolchain install stable --component rustfmt clippy
rustup toolchain install nightly --component rustfmt

You also need the following tools when working on the project.

1. The Protocol Buffers compiler (protoc).
2. Hatch.
3. Maturin.
4. Zig.
5. pnpm.

On macOS, you can install these tools via Homebrew.

brew install protobuf hatch maturin zig pnpm

If Homebrew overrides your default Rust installation, you can prioritize the rustup-managed Rust by adding the following line to your shell profile.

export PATH="$HOME/.cargo/bin:$PATH"