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

Install the package:

CODEBLOCK0

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

CODEBLOCK1

Then use either:

• - npx indexbind ... for local installs and per-project workflows
• INLINECODE7 after a global install
• INLINECODE8 or indexbind/build for programmatic usage

Platform notes:

• - native prebuilds exist for macOS arm64, macOS x64, and Linux x64 (glibc)
• Windows usage should go through WSL

Install and packaging docs:

• - INLINECODE10
• INLINECODE11

Choose the right interface

• - 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 INLINECODE21

API docs:

• - INLINECODE22
• INLINECODE23

Choose the artifact

• - 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:

• - INLINECODE24
• INLINECODE25

Common commands

Typical CLI commands:

• - INLINECODE26
• INLINECODE27
• INLINECODE28
• INLINECODE29
• INLINECODE30
• INLINECODE31
• INLINECODE32
• INLINECODE33
• INLINECODE34
• INLINECODE35
• INLINECODE36

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

Index-scoped conventions

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

CODEBLOCK2

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

• - skip a few files from indexing
• derive INLINECODE39
• inject metadata such as is_default_searchable, source_root, content_kind, or INLINECODE43
• normalize title or INLINECODE45

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

• - a default search profile
• a metadata filter
• score adjustment defaults
• lightweight query rewrite or alias expansion

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

• - if you index ./docs, the files live in INLINECODE48
• they affect only that indexed root
• there is no repo-root fallback

Common APIs

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

• - openIndex(...) from INLINECODE50
• INLINECODE51 from INLINECODE52
• INLINECODE53 from INLINECODE54
• INLINECODE55 from INLINECODE56
• INLINECODE57 from INLINECODE58
• INLINECODE59 from INLINECODE60
• INLINECODE61 from INLINECODE62
• INLINECODE63 from INLINECODE64
• INLINECODE65 from INLINECODE66
• INLINECODE67 from INLINECODE68
• INLINECODE69 from INLINECODE70
• INLINECODE71 from INLINECODE72

Docs:

• - INLINECODE73
• INLINECODE74
• INLINECODE75

Cloudflare rule

Inside Cloudflare Workers:

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

Docs:

• - INLINECODE80
• INLINECODE81

Read in this order when unsure

1. 1. INLINECODE82
2. INLINECODE83
3. INLINECODE84
4. INLINECODE85