Indexbind

Use this skill when the task is about using indexbind from a host application or environment.

Usage examples

"Use indexbind to add local search to a docs folder."
"Help me choose between indexbind, indexbind/web, and indexbind/cloudflare."
"Show me how to build a SQLite artifact for Node and a bundle for Workers."

Install the package:

npm install indexbind

Optional global install when the goal is using indexbind as a shell command from arbitrary directories:

npm install -g indexbind

Then use either:

Platform notes:

Install and packaging docs:

Index a local docs folder or local knowledge-base directory from the shell: use npx indexbind ...
Local Node querying over a built SQLite artifact: use indexbind
Programmatic build, incremental cache update, inspect, or benchmark: use indexbind/build
Mixed local knowledge bases that need host-defined document classification, metadata, or directory weighting: normalize documents in the host first, then pass them to indexbind/build
A mostly-default local docs or knowledge-base directory that only needs light host policy: use indexbind.build.js and indexbind.search.js beside that directory’s .indexbind/
Browser or standard worker querying over a canonical bundle: use indexbind/web
Cloudflare Worker querying: use indexbind/cloudflare
Shell-driven build/update/export/inspect flows: use npx indexbind ...

API docs:

Local directory indexing for later Node queries: build a native SQLite artifact
Local directory indexing for browser or worker delivery: build a canonical bundle
Node runtime: use a native SQLite artifact
Browser, Web Worker, Cloudflare Worker: use a canonical bundle
Repeated rebuilds over a stable corpus: use the build cache, then export fresh artifacts or bundles

Concepts:

Typical CLI commands:

npx indexbind build ./docs
npx indexbind build-bundle ./docs
npx indexbind update-cache ./docs --git-diff
npx indexbind build [input-dir] [output-file] [--backend <hashing|model-id>]
npx indexbind build-bundle [input-dir] [output-dir] [--backend <hashing|model-id>]
npx indexbind update-cache [input-dir] [cache-file] [--git-diff] [--git-base <rev>] [--backend <hashing|model-id>]
npx indexbind export-artifact <output-file> [--cache-file <path>]
npx indexbind export-bundle <output-dir> [--cache-file <path>]
npx indexbind inspect <artifact-file>
npx indexbind search <artifact-file> <query>
npx indexbind benchmark <artifact-file> <queries-json>

Use indexbind/build instead when the host already has documents in memory or wants tighter control from code.

When one indexed root only needs a small amount of host-specific behavior, place convention files beside that root:

docs/
  indexbind.build.js
  indexbind.search.js
  .indexbind/

Use indexbind.build.js when the default directory scanner is already correct and you only need to:

skip a few files from indexing
derive canonicalUrl
inject metadata such as is_default_searchable, source_root, content_kind, or directory_weight
normalize title or summary

Use indexbind.search.js when CLI or Node search should automatically apply:

These convention files are index-scoped, not repo-global:

Use these APIs when the host already has documents or wants tighter control:

Docs:

Inside Cloudflare Workers:

prefer indexbind/cloudflare
if bundle files are not directly exposed as public URLs, pass a custom fetch to openWebIndex(...)
use the host asset loader such as ASSETS.fetch(...) rather than monkey-patching global fetch

Docs: