Packaging
The published npm release is split into:
indexbindfor the TypeScript API, wasm runtime files, and native loader- platform packages such as
@indexbind/native-darwin-x64for prebuilt NAPI binaries
In normal use you install indexbind only. npm resolves the matching native package automatically when a supported prebuilt target exists.
Current Native Support
Published native prebuilds currently cover:
- macOS arm64
- macOS x64
- Linux x64 (glibc)
Windows native prebuilds are not published. On Windows, use WSL for:
npm install indexbind- local build commands
- local Node query flows that open SQLite artifacts through the native addon
If a prebuilt package is unavailable for your environment, install and build in a Rust toolchain environment instead of assuming npm can resolve a matching native binary.
What Ships in the npm Package
The root package contains:
- runtime entrypoints such as
indexbind,indexbind/build,indexbind/web, andindexbind/cloudflare - wasm runtime files in
dist/wasmanddist/wasm-bundler - the native loader that resolves prebuilt platform packages when they exist
The browser and worker entrypoints still come from the root package even when your host development machine is Windows. The current guidance is simply to do the install and build side inside WSL.
What Ships in the Canonical Bundle
The canonical bundle contains your retrieval data:
- manifest
- documents
- chunks
- vectors
- postings
- optional model assets
When you build with model2vec, these files are copied into the bundle:
model/tokenizer.jsonmodel/config.jsonmodel/model.safetensors
Those model files are not shipped inside the root npm package.