Introduction
The tour introduces you to the buf CLI and the Buf Schema Registry (BSR). Along the way, you
will enforce lint standards, detect breaking changes, generate code, create a module, manage a
non-trivial dependency graph, and publish the module to the BSR so that it can be consumed by others. The tour takes
approximately 20 minutes to complete.
At any time, you can see the help for a command using --help:
$ buf --help$ buf build --help$ buf generate --help$ buf breaking --help$ buf lint --help$ buf config ls-breaking-rules --help$ buf config ls-lint-rules --help$ buf ls-files --help$ buf protoc --helpPrerequisites#
- Install
git - Install
jq - Install
buf - (Optional) Editor Integration
Clone the Git Repository#
First, clone the Git repository that contains the starter code for the PetStore service.
From the development directory of your choice, run the following command:
$ git clone https://github.com/bufbuild/buf-tourYou'll notice that the repository contains a start directory and a finish directory. During the tour
you'll work on files in the start directory, and at the end they should match the files in the finish directory.
buf-tour/├── finish│ ├── buf.gen.yaml│ ├── buf.work.yaml│ ├── client│ │ └── main.go│ ├── gen│ │ └── proto│ │ └── go│ │ ├── payment│ │ │ └── v1alpha1│ │ │ └── payment.pb.go│ │ └── pet│ │ └── v1│ │ ├── pet.pb.go│ │ └── pet_grpc.pb.go│ ├── go.mod│ ├── go.sum│ ├── paymentapis│ │ ├── buf.lock│ │ ├── buf.yaml│ │ └── payment│ │ └── v1alpha1│ │ └── payment.proto│ ├── petapis│ │ ├── buf.lock│ │ ├── buf.md│ │ ├── buf.yaml│ │ └── pet│ │ └── v1│ │ └── pet.proto│ └── server│ └── main.go└── start └── petapis ├── google │ └── type │ └── datetime.proto └── pet └── v1 └── pet.protoTo begin, move into the start directory and continue to the next step:
$ cd buf-tour/start