buf build#
Build Protobuf files into a Buf image
Usage#
Description#
The first argument is the source or module to build or image to convert, which must be one of format [binpb,dir,git,json,mod,protofile,tar,txtpb,yaml,zip]. This defaults to "." if no argument is specified.
Flags#
--as-file-descriptor-set#
Output as a google.protobuf.FileDescriptorSet instead of an image Note that images are wire compatible with FileDescriptorSets, but this flag strips the additional metadata added for Buf usage
--config string#
The buf.yaml file or data to use for configuration
--disable-symlinks#
Do not follow symlinks when reading sources or configuration from the local filesystem By default, symlinks are followed in this CLI, but never followed on the Buf Schema Registry
--error-format string#
The format for build errors printed to stderr. Must be one of [text,json,msvs,junit,github-actions,gitlab-code-quality]
--exclude-imports#
Exclude imports.
--exclude-path strings#
Exclude specific files or directories, e.g. "proto/a/a.proto", "proto/a" If specified multiple times, the union is taken
--exclude-source-info#
Exclude source info
--exclude-source-retention-options#
Exclude options whose retention is source
-h, --help#
help for build
-o, --output string#
The output location for the built image. Must be one of format [binpb,json,txtpb,yaml]
--path strings#
Limit to specific files or directories, e.g. "proto/a/a.proto", "proto/a" If specified multiple times, the union is taken
--type strings#
The types (package, message, enum, extension, service, method) that should be included in this image. When specified, the resulting image will only include descriptors to describe the requested types. A type name may end with ".**" to recursively include the named element and everything nested beneath it, such as a package and all of its sub-packages
Flags inherited from parent commands#
--debug#
Turn on debug logging
--log-format string#
The log format [text,color,json]
--timeout duration#
The duration until timing out, setting it to 0 means no timeout
Parent Command#
- buf - The Buf CLI