buf generate

$ buf generate <input> [flags]

# buf.gen.yaml
# The version of the generation template.
# The valid values are v1beta1, v1 and v2.
# Required.
version: v2
# The plugins to run.
# Required.
plugins:
    # Use the plugin hosted at buf.build/protocolbuffers/go at version v1.28.1.
    # If version is omitted, uses the latest version of the plugin.
    # One of "remote", "local" and "protoc_builtin" is required.
  - remote: buf.build/protocolbuffers/go:v1.28.1
    # The relative output directory.
    # Required.
    out: gen/go
    # The revision of the remote plugin to use, a sequence number that Buf
    # increments when rebuilding or repackaging the plugin.
    revision: 4
    # Any options to provide to the plugin.
    # This can be either a single string or a list of strings.
    # Optional.
    opt: paths=source_relative
    # Whether to generate code for imported files as well.
    # Optional.
    include_imports: false
    # Whether to generate code for the well-known types.
    # Optional.
    include_wkt: false

    # The name of a local plugin if discoverable in "${PATH}" or its path in the file system.
  - local: protoc-gen-es
    out: gen/es
    include_imports: true
    include_wkt: true

    # The full invocation of a local plugin can be specified as a list.
  - local: ["go", "run", "path/to/plugin.go"]
    out: gen/plugin
    # The generation strategy to use. There are two options:
    #
    # 1. "directory"
    #
    #   This will result in buf splitting the input files by directory, and making separate plugin
    #   invocations in parallel. This is roughly the concurrent equivalent of:
    #
    #     for dir in $(find . -name '*.proto' -print0 | xargs -0 -n1 dirname | sort | uniq); do
    #       protoc -I . $(find "${dir}" -name '*.proto')
    #     done
    #
    #   Almost every Protobuf plugin either requires this, or works with this,
    #   and this is the recommended and default value.
    #
    # 2. "all"
    #
    #   This will result in buf making a single plugin invocation with all input files.
    #   This is roughly the equivalent of:
    #
    #     protoc -I . $(find . -name '*.proto')
    #
    #   This is needed for certain plugins that expect all files to be given at once.
    #   This is also the only strategy for remote plugins.
    #
    # If omitted, "directory" is used. Most users should not need to set this option.
    # Optional.
    strategy: directory

    # "protoc_builtin" specifies a plugin that comes with protoc, without the "protoc-gen-" prefix.
  - protoc_builtin: java
    out: gen/java
    # Path to protoc. If not specified, the protoc installation in "${PATH}" is used.
    # Optional.
    protoc_path: path/to/protoc

# Managed mode modifies file options and/or field options on the fly.
managed:
  # Enables managed mode.
  enabled: true

  # Each override rule specifies an option, the value for this option and
  # optionally the files/fields for which the override is applied.
  #
  # The accepted file options are:
  #  - java_package
  #  - java_package_prefix
  #  - java_package_suffix
  #  - java_multiple_files
  #  - java_outer_classname
  #  - java_string_check_utf8
  #  - go_package
  #  - go_package_prefix
  #  - optimize_for
  #  - csharp_namespace
  #  - csharp_namespace_prefix
  #  - ruby_package
  #  - ruby_package_suffix
  #  - objc_class_prefix
  #  - php_namespace
  #  - php_metadata_namespace
  #  - php_metadata_namespace_suffix
  #  - cc_enable_arenas
  #
  # An override rule can apply to a field option.
  # The accepted field options are:
  #  - jstype
  #
  # If multple overrides for the same option apply to a file or field,
  # the last rule takes effect.
  # Optional.
  override:
      # Sets "go_package_prefix" to "foo/bar/baz" for all files.
    - file_option: go_package_prefix
      value: foo/bar/baz

      # Sets "java_package_prefix" to "net.foo" for files in "buf.build/foo/bar".
    - file_option: java_package_prefix
      value: net.foo
      module: buf.build/foo/bar

      # Sets "java_package_prefix" to "dev" for "file.proto".
      # This overrides the value "net.foo" for "file.proto" from the previous rule.
    - file_option: java_package_prefix
      value: dev
      module: buf.build/foo/bar
      path: file.proto

      # Sets "go_package" to "x/y/z" for all files in directory "x/y/z".
    - file_option: go_package
      value: foo/bar/baz
      path: x/y/z

      # Sets a field's "jstype" to "JS_NORMAL".
    - field_option: jstype
      value: JS_STRING
      field: foo.v1.Bar.baz

  # Disables managed mode under certain conditions.
  # Takes precedence over "overrides".
  # Optional.
  disable:
      # Do not modify any options for files in this module.
    - module: buf.build/googleapis/googleapis

      # Do not modify any options for this file.
    - module: buf.build/googleapis/googleapis
      path: foo/bar/file.proto

      # Do not modify "java_multiple_files" for any file
    - file_option: java_multiple_files

      # Do not modify "csharp_namespace" for files in this module.
    - module: buf.build/acme/weather
      file_option: csharp_namespace

# The inputs to generate code for.
# The inputs here are ignored if an input is specified as a command line argument.
# Each input is one of "directory", "git_repo", "module", "tarball", "zip_archive",
# "proto_file", "binary_image", "json_image", "text_image" and "yaml_image".
# Optional.
inputs:
    # The path to a directory.
  - directory: x/y/z

    # The URL of a Git repository.
  - git_repo: https://github.com/acme/weather.git
    # The branch to clone.
    # Optional.
    branch: dev
    # The subdirectory in the repository to use.
    # Optional.
    subdir: proto
    # How deep of a clone to perform.
    # Optional.
    depth: 30

    # The URL of a BSR module.
  - module: buf.build/acme/weather
    # Only generate code for these types.
    # Optional.
    types:
      - "foo.v1.User"
      - "foo.v1.UserService"
    # Only generate code for files in these paths.
    # If empty, include all paths.
    paths:
      - a/b/c
      - a/b/d
    # Do not generate code for files in these paths.
    exclude_paths:
      - a/b/c/x.proto
      - a/b/d/y.proto

    # The URL or path to a tarball.
  - tarball: a/b/x.tar.gz
    # The relative path within the archive to use as the base directory.
    # Optional.
    subdir: proto

    # The compression scheme, derived from the file extension if unspecified.
    # ".tgz" and ".tar.gz" extensions automatically use Gzip.
    # ".tar.zst" automatically uses Zstandard.
    # Optional.
    compression: gzip

    # Reads at the relative path and strips some number of components.
    # Optional.
    strip_components: 2

    # The URL or path to a zip archive.
  - zip_archive: https://github.com/googleapis/googleapis/archive/master.zip
    # The number of directories to strip.
    # Optional.
    strip_components: 1

    # The path to a specific proto file.
  - proto_file: foo/bar/baz.proto
    # Whether to generate code for files in the same package as well, default to false.
    # Optional.
    include_package_files: true

    # A Buf image in binary format.
    # Other image formats are "yaml_image", "text_image" and "json_image".
  - binary_image: image.binpb.gz
    # The compression scheme of the image file, derived from file extension if unspecified.
    # Optional.
    compression: gzip

# buf.gen.yaml
version: v2
plugins:
  - local: protoc-gen-go
    out: gen/go
    opt: paths=source_relative
  - local: protoc-gen-go-grpc
    out: gen/go
    opt:
      - paths=source_relative
      - require_unimplemented_servers=false

$ buf generate

$ buf generate --template buf.gen.yaml .

$ buf generate --template '{"version":"v2","plugins":[{"local":"protoc-gen-go","out":"gen/go"}]}'

$ buf generate --template bar.yaml https://github.com/foo/bar.git

$ buf generate --template bar.yaml -o bar https://github.com/foo/bar.git

$ buf generate --path proto/foo --path proto/bar

$ buf generate --path proto/foo/foo.proto --path proto/foo/bar.proto

$ buf generate --template buf.gen.yaml https://github.com/foo/bar.git --path proto/foo