open-nomad/tools/buf
hashicorp-copywrite[bot] 005636afa0 [COMPLIANCE] Add Copyright and License Headers 2023-04-10 15:36:59 +00:00
..
README.md
buf.gen.yaml [COMPLIANCE] Add Copyright and License Headers 2023-04-10 15:36:59 +00:00
buf.yaml [COMPLIANCE] Add Copyright and License Headers 2023-04-10 15:36:59 +00:00

README.md

Buf

buf is a high-performance protoc replacement.

Installation

Use make bootstrap in the root of this repo to install the version of buf used by Nomad.

Usage

make proto in the root of this repo will invoke buf using the configuration in this directory.

Why use buf instead of protoc?

Buf is a user-friendly tool to work with Protobuf that outperforms protoc in every conceivable way. It was written by the author(s) of prototool, another tool that made generating Protobuf easier, but which is now deprecated in favor of buf. Buf also does linting and breaking-change detection.