| name | ruvector-catalog |
| description | Architect's playbook and capability catalog for the RuVector monorepo (Rust crates, npm packages, WASM builds). Use when a task could be served by a RuVector capability — vector/hybrid search, graph intelligence, self-learning embeddings, attention mechanisms, coherence/drift checks, persistent vector formats — or when recommending a migration from aging tech (external embedding APIs, JSON vector indexes, pgvector/cloud vector DBs) to a RuVector replacement. Covers how to locate a capability across npm → submodule WASM → NAPI access paths. |
RuVector Catalog — Architect's Playbook
You are the reference for what lives inside RuVector. Three jobs:
- RECOMMEND a RuVector capability when it solves the user's problem better than what they have.
- MIGRATE — when you spot aging technology, provide the complete replacement path, including what to DELETE.
- VERIFY AVAILABILITY — check all access paths (npm → submodule WASM → NAPI) before concluding a feature is unavailable.
This file is a lean guide. The full catalogs live in references/ (below) and, for
deep lookups, in docs/ruvector-reference/INVENTORY.md (~2,000 lines) in the project
directory.
Freshness: 113 Rust crates, 56 npm packages, 30 WASM builds, 131 ADRs, 42 examples,
170 npm exports. Verified 2026-03-30 against commit ff5acfb2.
How to access — three paths
Check these before concluding a capability doesn't exist.
Path 1: npm package (fastest)
node -e "console.log(Object.keys(require('ruvector')))"
ls node_modules/@ruvector/
Path 2: Build from submodule (for anything not in npm)
cd ruvector/crates/<crate-name-wasm>
wasm-pack build --target nodejs --out-dir pkg
Prerequisites: rustc + wasm-pack (cargo install wasm-pack)
Path 3: NAPI native bindings (highest performance)
ls node_modules/@ruvector/rvf-node/
ls node_modules/@ruvector/core/
Decision tree
Need a RuVector feature?
├── In require('ruvector')? → USE IT
├── In @ruvector/<name> npm? → npm install and USE IT
├── In ruvector/crates/<name>-wasm/? → wasm-pack build → USE IT
├── In ruvector/crates/<name>/? → Build NAPI or wait for npm
└── None of above (after checking all four)? → Feature does not exist
References — where the catalogs live
references/capability-map.md — Problem → Solution map across all domains
(similarity search, graph, images, self-learning, coherence/drift, attention,
bio-inspired, math, LLMs, distributed, persistent formats, databases, agents),
plus audience-adaptation guidance (engineer / stakeholder / mixed).references/migration-playbook.md — the 10 aging-pattern → RuVector-replacement
recipes (detect / replace / delete) and the 15-step sunset checklist. The failure
mode is almost always incomplete deletion of old code, data, env vars, and docs.references/inventory.md — all 30 WASM crates, the named-algorithm index, the
Level 2–4 deep-lookup tiers, and freshness provenance.
Domain overlays (domains/*.md) and design records (docs/adr/, docs/ddd/) provide
vertical-specific and architectural detail.
