David Snelling
33caa52c2d
The installation guide asserted a '5.2x geometric mean speedup' linking a /docs/cortex/comparison page that does not exist (404) and has no backing benchmark — an unbacked performance claim shipping in the public package, against the evidence rule. Replaced with a qualitative native-acceleration statement (no number, no dead link) until a measured, reproducible open-core-vs-native comparison is published. Also dropped the dead 'cortex/comparison' next-link from PLUGINS.md frontmatter.
89 lines
2.1 KiB
Markdown
89 lines
2.1 KiB
Markdown
---
|
|
title: Installation
|
|
slug: getting-started/installation
|
|
public: true
|
|
category: getting-started
|
|
template: guide
|
|
order: 1
|
|
description: Install Brainy with npm, bun, yarn, or pnpm. Works in Node.js 22+ and Bun 1.0+ (server-only since 8.0). TypeScript included.
|
|
next:
|
|
- 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
|
|
|
|
```bash
|
|
npm install @soulcraft/brainy
|
|
```
|
|
|
|
Or with your preferred package manager:
|
|
|
|
```bash
|
|
bun add @soulcraft/brainy
|
|
yarn add @soulcraft/brainy
|
|
pnpm add @soulcraft/brainy
|
|
```
|
|
|
|
## Verify
|
|
|
|
```typescript
|
|
import { Brainy } from '@soulcraft/brainy'
|
|
|
|
const brain = new Brainy()
|
|
await brain.init()
|
|
|
|
console.log('Brainy ready.')
|
|
```
|
|
|
|
## Native Acceleration (Optional)
|
|
|
|
For production workloads, add Cortex for Rust-accelerated SIMD distance calculations and native embeddings:
|
|
|
|
```bash
|
|
npm install @soulcraft/cortex
|
|
```
|
|
|
|
```typescript
|
|
import { Brainy } from '@soulcraft/brainy'
|
|
|
|
const brain = new Brainy({ plugins: ['@soulcraft/cortex'] })
|
|
await brain.init() // native providers registered during init
|
|
```
|
|
|
|
Cortex 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:
|
|
|
|
```typescript
|
|
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](/docs/getting-started/quick-start) — build your first knowledge graph in 60 seconds
|
|
- [Storage Adapters](/docs/guides/storage-adapters) — choose the right storage for your deployment
|