compiling
- Repo stars 340
- License Apache-2.0
- Author repo skywalking-banyandb
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
- Fluxly category
- Engineering
- Author-declared agents
- No explicit declaration found; this is not inferred or tested compatibility
- Static check
- 94 / 100 · heuristic scan, not runtime safety proof
- Author / version / license
- @apache · Apache-2.0
- Fluxly token estimate
- Lean
- Fluxly setup estimate
- Plug-and-play
- External API key
- No requirement detected
- Detected OS requirements
- Unspecified
- Runtime requirements
- Unspecified
- Detected file/system behavior
-
- Read-only
- Write / modify
- Detected network behavior
- Local-only
- Install commands
- None (reference only)
Profile is derived at build time from SKILL.md and install vectors. Subject to drift from author intent.
Heads up: 未限定 allowed-tools,默认拥有全部工具权限。
The current SKILL.md does not define a fixed output example. 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
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.
# 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:
- `protoc` and 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 generate` was not run. Run it first.
- **Mock generation failures**: An interface changed but the mock wasn't regenerated. `make generate` fixes this.
- **Import errors**: Check import aliases match CLAUDE.md conventions (e.g., `commonv1`, `databasev1`).
## Other useful targets
- `make clean` — clean all build artifacts
- `make clean-build` — clean only build binaries
- `make lint` — run linters
- `make test` — run tests Author text anchors workflow facts; Fluxly only indexes current sections, terms, files, and commands.
sections -> Step 1: Generate protobuf and mock code → Step 2: Build all binaries → Troubleshooting → Other useful targets
terms -> required · Missing fields in .pb.go · Mock generation failures · Import errors
files/cmd -> make generate · .pb.go · .proto · protoc · make build · build/bin/dev/ · commonv1 · databasev1
body sha256 -> 2b31c9a193f0
Decide Fit First
Design Intent
How To Use It
Boundaries And Review