Brainy Documentation
Learn how to build intelligent applications with Brainy, the knowledge operating system that unifies vector search, graph relationships, and document storage.
Installation
Get Brainy installed in under a minute with npm, yarn, or pnpm.
Quick Start
Build your first knowledge graph in 60 seconds.
Triple Intelligence
Understand vector + graph + metadata search in one query.
API Reference
Complete reference for all Brainy methods.
What is Brainy?
Brainy is a knowledge operating system that combines three types of data intelligence into one simple API:
- Vector Search - Find content by meaning, not just keywords
- Graph Relationships - Connect entities with typed relationships
- Document Filtering - Query metadata with MongoDB-style operators
This combination, called Triple Intelligence, lets you replace multiple specialized databases (Pinecone, Neo4j, MongoDB) with one unified system.
Quick Example
import { Brainy } from '@soulcraft/brainy'
// Initialize - zero configuration needed
const brain = new Brainy()
await brain.init()
// Add knowledge with automatic embeddings
await brain.add({
data: "TypeScript adds static types to JavaScript",
metadata: { category: "programming", year: 2012 }
})
// Triple Intelligence query
const results = await brain.find({
query: "typed programming languages", // Vector search
where: { year: { greaterThanOrEqual: 2010 } } // Metadata filter
})
Key Features
Zero Config
Auto-detects storage, embeddings, and indexes. Just install and use.
Git-Style Versioning
Fork, merge, and time-travel your data. No other vector DB has this.
Runs Anywhere
Browser, Node.js, Deno, Bun, serverless, edge workers.
MIT Licensed
Free forever. No vendor lock-in. Self-host or use our cloud.
Ready to get started?
Install Brainy