Documentation ¶
Overview ¶
Package proto contains protocol buffers that are exchanged between the client and server, as well as convenience configuration definitions for tools.
Generating Protocol Buffer Code ¶
Anytime the Protocol Buffer definitions change, the generated Go code must be regenerated. This can be done with "go generate". Just run:
go generate ./...
Upstream documentation: https://developers.google.com/protocol-buffers/docs/reference/go-generated
Code Generation Dependencies ¶
To generate the Go code, your system must have "protoc" installed. See: https://github.com/protocolbuffers/protobuf#protocol-compiler-installation
The "protoc-gen-go" tool must also be installed. To install it, run:
go install google.golang.org/protobuf/cmd/protoc-gen-go
If you see a 'protoc-gen-go: program not found or is not executable' error for the 'go generate' command, run the following:
echo 'export PATH=$PATH:$GOPATH/bin' >> $HOME/.bashrc source $HOME/.bashrc
If you see 'google/protobuf/wrappers.proto not found', then you need to similarly set your PROTOC_INSTALL_DIR environment variable to the protoc installation directory which should have the "well-known types" in the include subdirectory.