Skip to content

Buf CLI#

The Buf CLI is the ultimate tool for modern, fast, and efficient Protobuf API management. It makes crucial tasks like code generation, breaking change detection, and linting easy to configure, and integrates seamlessly with your existing workflows, so you can focus on what matters most: writing great APIs.

Commands#

The links below go to detailed usage guides. See the Buf CLI reference for complete options and flags for each command.

  • build: Build Protobuf files into a Buf image (key to many other buf operations)
  • generate: Generate code stubs from Protobuf files using protoc plugins
  • breaking: Verify no breaking changes have been made, to guard against compatibility issues
  • lint and format: Lint and format your Protobuf files according to best practice and your org rules
  • curl: Test your APIs by invoking an RPC endpoint, similar to using curl
  • convert: Convert a message from binary to JSON or vice versa—useful when debugging or testing
  • config, registry, push, and export: Manage your repositories in the Buf Schema Registry

Configuration files#

The Buf CLI interacts with several configuration files, depending on the operation.

buf.yaml#

buf.yaml defines a workspace and the configurations for each module within it. It's the primary configuration file, and defines each module's directory, name, lint and breaking configurations, and any files to exclude, along with the workspace's shared dependencies.

buf.lock#

buf.lock contains the workspace's dependency manifest, and represents a single, reproducible build of its dependencies.

buf.gen.yaml#

buf.gen.yaml defines the set of code generation plugins, their options, and the inputs used by the buf generate command to generate code from your Protobuf files. It also allows you to enable and configure managed mode.

Default configuration#

The default configuration location depends on the input. If the Buf CLI is executed with an input that contains a buf.yaml file, it's used for the given operation. Running buf lint, for example, uses the lint configuration for the workspace and (if specified) each module in the input's buf.yaml.

If the input doesn't contain a buf.yaml file, the Buf CLI operates as if there is a buf.yaml file with these default values:

buf.yaml default configuration if missing
version: v2
lint:
  use:
    - STANDARD
breaking:
  use:
    - FILE
# This is the default behavior if the modules key isn't specified.
# Deleting the modules section here has no effect.
modules:
  - path: .