Buf is currently available for Mac and Linux.
An example is available at bufbuild/buf-example that:
buffrom GitHub Releases.
- Runs linting and breaking change detection.
CI is set up for:
Within this example are the following main targets:
make localruns linting, and then breaking change detection against your local git repository. This is useful for development.
make remoteruns linting, and then breaking change detection against your remote git repository. This is useful because most CI providers only clone the branch under test and to a certain depth.
Note that GitHub Actions
makes it possible to use
make local by cloning the branch you want, creating a local head for
it, and then cloning the commit under test. See ci.yaml
for an example.
This will install:
- The binaries
- Bash completion for
- Zsh completion for
Via GitHub Releases
Buf is released via the bufbuild/buf repository.
Two types of assets are available:
- The single
- A tarball containing the binaries, bash completion, and zsh completion.
See the Releases page for the current release.
The binary is all that is needed to get started.
To install just the
/usr/local/bin for version
/usr/local/bin should be on your
To uninstall from
To install the
bash completion, and zsh completion to
/usr/local for version
The binaries will be installed to
/usr/local/bin, which should be on your
To uninstall from
The binaries can be installed from source if Golang is installed, however we recommend using one of the release assets instead.
Future Windows Support
Windows support is not yet available, however will be released in the future. Buf is designed from the ground up to be OS and platform independent, however we have not yet set up the requisite testing required to be comfortable releasing Windows assets. If this is something you are interested in, please contact us.