Skip to content

az9713/open-brain-tutorial

Open Brain

Open Brain — Documentation-Enhanced Edition

This repository is a documentation-enhanced clone of NateBJones-Projects/OB1. All original code, schemas, and guides are preserved. This fork adds comprehensive documentation for developers and users new to the Open Brain ecosystem — including an architecture deep dive with ASCII diagrams, a complete API reference, a developer guide written for C/Java developers new to web development, a zero-to-hero study plan, a quick start tutorial, and a detailed technical explainer of how every piece of the system works. For the original upstream repository and community, visit github.com/NateBJones-Projects/OB1.

The infrastructure layer for your thinking. One database, one AI gateway, one chat channel. Any AI you use can plug in. No middleware, no SaaS chains, no Zapier.

This isn't a notes app. It's a database with vector search and an open protocol — built so that every AI tool you use shares the same persistent memory of you. Claude, ChatGPT, Cursor, Claude Code, whatever ships next month. One brain. All of them.

Open Brain was created by Nate B. Jones. Follow the Substack for updates, discussion, and the companion prompt pack. Join the Discord for real-time help and community.

ob1-philosophy.mp4

Getting Started

ob1-getting-started.mp4

Never built an Open Brain? Start here:

  1. Quick Start Guide — Already set up? Get your first 10 wins in 5 minutes.
  2. Setup Guide — Build the full system (database, AI gateway, Slack capture, MCP server) in about 45 minutes. No coding experience needed.
  3. AI-Assisted Setup — Prefer building with Cursor, Claude Code, or another AI coding tool? Point it at this repo and go. Same system, different workflow.
  4. CLI-Direct Approach — Use Claude Code, Codex, or Gemini CLI? Skip MCP entirely and use the lightweight ob CLI tool for direct access with just curl and jq.
  5. Companion Prompts — Five prompts that help you migrate your memories, discover use cases, and build the capture habit.
  6. Then pick Extension 1 and start building.

If you hit a wall: We built a FAQ that covers the most common questions and gotchas. And if you need real-time help, we created dedicated AI assistants that know this system inside and out: a Claude Skill, a ChatGPT Custom GPT, and a Gemini GEM. Use whichever one matches the AI tool you already use.

Documentation

Document Audience What It Covers
Quick Start Guide Users 10-step guided tutorial — first captures, searches, and quick wins
User Guide Users Complete guide with 10 use cases, tips, and troubleshooting
Architecture Developers System design, ASCII diagrams, data flows, security boundaries
Developer Guide Developers Build extensions, recipes, and integrations — with C/Java comparisons
API Reference Developers All 35+ MCP tools, database schemas, authentication, environment variables
Study Plan Learners Zero-to-hero learning path in 13 phases — theory and hands-on combined
Setup Guide Everyone Full system build from scratch in 45 minutes
Companion Prompts Users Memory migration, use case discovery, weekly review ritual
FAQ Everyone Common issues, architecture questions, community tips
AI-Assisted Setup Everyone Build with Cursor, Claude Code, or other AI coding tools
CLI-Direct Approach Developers Use Open Brain from terminal AI tools without MCP — includes the ob CLI

Extensions — The Learning Path

ob1-extensions.mp4

Build these in order. Each one teaches new concepts through something you'll actually use. By the end, your agent manages your household, your schedule, your meals, your professional network, and your career — all interconnected.

# Extension What You Build Difficulty
1 Household Knowledge Base Home facts your agent can recall instantly Beginner
2 Home Maintenance Tracker Scheduling and history for home upkeep Beginner
3 Family Calendar Multi-person schedule coordination Intermediate
4 Meal Planning Recipes, meal plans, shared grocery lists Intermediate
5 Professional CRM Contact tracking wired into your thoughts Intermediate
6 Job Hunt Pipeline Application tracking and interview pipeline Advanced

Extensions compound. Your CRM knows about thoughts you've captured. Your meal planner checks who's home this week. Your job hunt contacts automatically become professional network contacts. This is what happens when your agent can see across your whole system.

Primitives: Concepts That Compound

ob1-primitives.mp4

Some concepts show up in multiple extensions. Learn them once, apply them everywhere.

Primitive What It Teaches Used By
Row Level Security PostgreSQL policies for multi-user data isolation Extensions 4, 5, 6
Shared MCP Server Giving others scoped access to parts of your brain Extension 4

Community Contributions

ob1-community.mp4

Beyond the curated learning path, the community builds and shares:

/recipes — Step-by-step builds

Each recipe teaches you how to add a new capability to your Open Brain. Follow the instructions, run the code, get a new feature.

  • Email history import (pull your Gmail archive into searchable thoughts)
  • ChatGPT conversation import (ingest your ChatGPT data export)
  • Daily digest generator (automated summary of recent thoughts via email or Slack)

/schemas — Database extensions

New tables, metadata schemas, and column extensions for your Supabase database. Drop them in alongside your existing thoughts table.

  • CRM contact layer (track people, interactions, and relationship context)
  • Taste preferences tracker
  • Reading list with rating metadata

/dashboards — Frontend templates

Host these on Vercel or Netlify, pointed at your Supabase backend. Instant UI for your brain.

  • Personal knowledge dashboard
  • Weekly review view
  • Mobile-friendly capture UI

/integrations — New connections

MCP server extensions, webhook receivers, and capture sources beyond Slack.

  • Discord capture bot
  • Email forwarding handler
  • Browser extension connector

Using a Contribution

  1. Browse the category folders above
  2. Find what you want and open its folder
  3. Read the README — it has prerequisites, step-by-step instructions, and troubleshooting
  4. Most contributions involve running SQL against your Supabase database, deploying an edge function, or hosting frontend code. The README will tell you exactly what to do.

Contributing

Read CONTRIBUTING.md for the full details. The short version:

  • Extensions are curated — discuss with maintainers before submitting
  • Primitives should be referenced by 2+ extensions to justify extraction
  • Recipes, schemas, dashboards, integrations are open for community contributions
  • Every PR runs through an automated review agent that checks 11 rules (file structure, no secrets, SQL safety, primitive dependencies, etc.)
  • If the agent passes, a human admin reviews for quality and clarity
  • Your contribution needs a README with real instructions and a metadata.json with structured info

Community

  • Discord — Real-time help, show-and-tell, contributor discussion
  • Substack — Updates, deep dives, and the story behind Open Brain

Who Maintains This

Built by Nate B. Jones's team. Matt Hallett is the first community admin and repo manager. PRs are reviewed by the automated agent + human admins.

License

FSL-1.1-MIT

About

Documentation-enhanced clone of NateBJones-Projects/OB1 — comprehensive guides for developers and users new to Open Brain

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors