The file is used to define a workspace, where one or more modules can coexist and interoperate within a common directory. Workspaces make it possible for local modules to import Protobuf files from other local modules, and unlock other powerful use cases that operate on multiple modules at the same time.

The diagram and file below represent a complete example of a configuration file and its corresponding tree layout containing the and modules:

├── paymentapis
│   ├── acme
│   │   └── payment
│   │       └── v2
│   │           └── payment.proto
│   └── buf.yaml
└── petapis
    ├── acme
    │   └── pet
    │       └── v1
    │           └── pet.proto
    └── buf.yaml
version: v1
  - paymentapis
  - petapis



Required. Defines the current configuration version. The only accepted value is v1.


Required. Lists the directories that define modules to be included in the workspace. The directory paths must be relative to the, and can't point to a location outside of the directory where your is. For example, ../external is invalid.

The directory . is invalid as well. Given the requirement to have no overlapping directories, and given that a directory can't point to a location outside of your directory, listing a directory named . in your would mean that the only contains that single directory. It's no different than having no at all.

Each directory is included as an independent module, such that all of the Protobuf files defined within the paymentapis and petapis directories are included in the workspace, relative to the respective module root. For more information about how to import modules into each other, see the importing across modules section of the workspaces documentation.