building
Skill390 starsChanged 10 days agoApache-2.0View on GitHub
Use when building knowhere from source, configuring build options (CPU/GPU/DISKANN/ASAN), or troubleshooting compilation errors
5 other projects use a version of this.
Adopted by
Most recently taken up by
- nguyenvanphituoc/shapeup-sdlc-plugintheir own version, first seen Nov 8, 2026
- Conceptual-Machines/magda-coretheir own version, first seen Nov 7, 2026
- kju4q/q-claude-skillstheir own version, first seen Oct 27, 2026
- pytorch/executorchtheir own version, first seen Oct 8, 2026
- CapSoftware/Captheir own version, first seen Oct 8, 2026
Other versions5 projects use a version of this.
Word for word · 0
None found.
Edited · 0
None found.
Wrote their own version · 5
- CapSoftware/Cap★ 25ksame name
- pytorch/executorch★ 5.2ksame name
- Conceptual-Machines/magda-core★ 258same name
- kju4q/q-claude-skills★ 21same name
- nguyenvanphituoc/shapeup-sdlc-plugin★ 3same name
How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.
In this repository7 other files it gives its agents.
- AGENTS.mdAGENTS.md
- CLAUDE.mdCLAUDE.md
- architectureSkill
- code-qualitySkill
- git-workflowSkill
- index-optimizationSkill
- testingSkill
The file
We split this skill into the rules it gives an agent
3 rules. 0 are common, 3 are distinctive, and 0 are very specific to this project.
0
Common
Most of the 4 edited versions we read keep these.
3
Distinctive
This author's own choices. Worth a look.
0
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Distinctive: line 10
Run commands from the repository root.
- Distinctive: line 71
ASAN failures: Check for memory leaks, use-after-free, buffer overflows
- Distinctive: line 75
If the build changes a feature or interface, update the corresponding repository documentation.
“Common” is measured: kept by at least 6 in 10 of the 4 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
Building Knowhere
Prerequisites
Run commands from the repository root. Reuse an existing compiler and Conan environment when available. For initial setup, scripts/install_deps.sh is the maintained source for platform dependencies and tool versions, including CMake, ccache, and Conan. The script also configures the default Conan profile and remote; review it before using it in an existing environment.
Build options and output paths are defined in Makefile and
conanfile.py. Use make help to inspect the available targets and flags.
Build Commands
| Build Type | Command |
| CPU Release | make |
| CPU Debug | make WITH_DEBUG=True |
| CPU + UT | make WITH_UT=True |
| CPU + UT + ASAN | make WITH_UT=True WITH_ASAN=True |
| Cardinal GPU | make WITH_CARDINAL=True WITH_GPU=True |
| Cardinal CPU only | make WITH_CARDINAL=True |
| Cardinal GPU + cuVS | make WITH_CARDINAL=True WITH_GPU=True WITH_CUVS=True |
| GPU (cuVS) | make WITH_GPU=True |
| GPU (cuVS) + UT | make WITH_GPU=True WITH_UT=True |
| macOS | make (auto-detects libc++) |
Build outputs default to build/Release/ or build/Debug/. Run tests after building with WITH_UT=True:
make test
# Match the build configuration and any custom output directory
make test WITH_DEBUG=True
make test BUILD_DIR=/path/to/buildBuild Flags
| Flag | Description |
WITH_GPU=True/False | Enable Cardinal GPU with Cardinal, otherwise enable cuVS; defaults to False |
WITH_CUVS=True/False | Explicit cuVS selection, including alongside Cardinal |
WITH_CARDINAL=True | Enable Cardinal |
WITH_UT=True | Enable unit tests |
WITH_BENCHMARK=True | Enable benchmarks |
WITH_ASAN=True | Enable AddressSanitizer |
WITH_DISKANN=False | Disable DiskANN (enabled by default by Makefile on Linux) |
WITH_SVS=True | Enable SVS on x86 |
WITH_DEBUG=True | Debug build (default: Release) |
BUILD_DIR=<path> | Set the output root; binaries remain under its Release/Debug subdirectory |
CONAN_PROFILE=<p> | Use one custom Conan profile for host and build |
LIBCXX=<lib> | Override compiler.libcxx (auto-detected from OS) |
GPU, cuVS and Cardinal flags accept True/False, ON/OFF and 1/0. Other enable flags use Make's ifdef:
leave them unset to disable them; WITH_UT=False, for example, still enables tests. WITH_DISKANN explicitly accepts true/false values.
WITH_CUVS=True enables cuVS independently of WITH_GPU. Without Cardinal, WITH_GPU=True
still enables cuVS even when WITH_CUVS=False.
Common Issues
- libstdc++ errors: Override with
make LIBCXX=libstdc++11 - macOS:
libc++is auto-detected; OpenMP uses Homebrew's libomp - CMake 4.x: Makefile already exports
CMAKE_POLICY_VERSION_MINIMUM=3.5for old dependency recipes - ASAN failures: Check for memory leaks, use-after-free, buffer overflows
If the build changes a feature or interface, update the corresponding repository documentation.
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.