open-brainy/docs/guides/installation.md
David Snelling a99b1e83c4 chore: rename to @soulcraftlabs/brainy for Open Brainy on The Source
Prepares the repo for its new home at soulcraftlabs/open-brainy ahead
of the Forgejo transfer: package name, publish registry, release
script, and every install/import reference across docs, src, tests,
examples, and integrations now point at @soulcraftlabs/brainy on
The Source. The npmjs storefront leg and byte-identity pair
verification are stripped from the release script — The Source is
now the only publish target. README gains an Open Brainy explainer
and a registry note for consumers.

@soulcraft/brainy 10.4.2 was the last release under the old name.
2026-08-27 17:07:09 -07:00

2.1 KiB

title slug public category template order description next
Installation getting-started/installation true getting-started guide 1 Install Brainy with npm, bun, yarn, or pnpm. Works in Node.js 22+ and Bun 1.0+ (server-only since 8.0). TypeScript included.
getting-started/quick-start
guides/storage-adapters

Installation

Requirements

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

Install

npm install @soulcraftlabs/brainy

Or with your preferred package manager:

bun add @soulcraftlabs/brainy
yarn add @soulcraftlabs/brainy
pnpm add @soulcraftlabs/brainy

Verify

import { Brainy } from '@soulcraftlabs/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 '@soulcraftlabs/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 '@soulcraftlabs/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