David Snelling bf4a333f9b docs: rename the native provider to @soulcraft/cor across public docs and JSDoc

The 3.0 native engine ships as @soulcraft/cor (brainy 8.x <-> cor 3.x are a
version-matched pair); the old @soulcraft/cortex package stays on the 2.x/7.x
line. Public docs and .d.ts-visible comments now name the correct package.
Historical 2.x contract references (e.g. the 2.3.1 read-side fallback) keep
the old name deliberately.

2026-07-02 15:11:41 -07:00

2.1 KiB

Raw Blame History

title

slug

public

Installation

Requirements

Node.js 22+ or Bun 1.0+
TypeScript is optional — Brainy ships with full type definitions

Install

npm install @soulcraft/brainy

Or with your preferred package manager:

bun add @soulcraft/brainy
yarn add @soulcraft/brainy
pnpm add @soulcraft/brainy

Verify

import { Brainy } from '@soulcraft/brainy'

const brain = new Brainy()
await brain.init()

console.log('Brainy ready.')

Native Acceleration (Optional)

For production workloads, add Cor for Rust-accelerated SIMD distance calculations and native embeddings:

npm install @soulcraft/cor

import { Brainy } from '@soulcraft/brainy'

const brain = new Brainy({ plugins: ['@soulcraft/cor'] })
await brain.init()  // native providers registered during init

Cor registers native (Rust/SIMD) vector, metadata, and graph engines behind the same Brainy find() API — no code changes, an optional dependency for production-scale workloads.

Server-only since 8.0

Brainy 8.0 runs on Node.js 22+ and Bun 1.0+. Browser support (OPFS storage, Web Workers, in-browser WASM embeddings) was removed in 8.0 — the 7.x line remains available on npm if you need it.

TypeScript

Brainy ships with full TypeScript types. No @types/ package needed:

import { Brainy, NounType, VerbType } from '@soulcraft/brainy'

const brain = new Brainy()
await brain.init()

const id = await brain.add({
  data: 'Hello, Brainy',
  type: NounType.Concept,
  metadata: { created: Date.now() }
})

Next Steps

Quick Start — build your first knowledge graph in 60 seconds
Storage Adapters — choose the right storage for your deployment

2.1 KiB Raw Blame History