Compiling SkyWalking BanyanDB
Follow these steps to compile the project.
Step 1: Generate protobuf and mock code
Run make generate first. This regenerates .pb.go files from .proto definitions and mock files via mockgen.
This step is required whenever:
- Proto files (
.proto) have been added or modified - Go interfaces used by mockgen have changed
If generate fails, check:
protocand Go protobuf plugins are installed- Proto file syntax is valid
- Interface signatures match mock expectations
Step 2: Build all binaries
Run make build to compile all project components: ui, banyand, bydbctl, mcp, fodc/agent, fodc/proxy.
Binaries are output to each component's build/bin/dev/ directory.
Troubleshooting
- Missing fields in .pb.go: Proto files were updated but
make generatewas not run. Run it first. - Mock generation failures: An interface changed but the mock wasn't regenerated.
make generatefixes this. - Import errors: Check import aliases match CLAUDE.md conventions (e.g.,
commonv1,databasev1).
Other useful targets
make clean— clean all build artifactsmake clean-build— clean only build binariesmake lint— run lintersmake test— run tests