Skip to content

ciroautuori/brainhub

🧠 BrainHub Obsidian Plugin

License: MIT GitHub release GitHub Downloads CodeQL CI Obsidian Plugin

Official Obsidian Plugin for BrainHub SaaS Platform

Enterprise AI-Powered Knowledge Assistant for Obsidian with Cloud Integration.


⭐ Star History

Star History Chart


πŸš€ Features

  • πŸ€– AI Chat Interface - Chat with BrainHub AI directly in Obsidian
  • πŸ” Semantic Search - Search across your vault with AI-powered understanding
  • πŸ“Š Vault Statistics - Real-time vault analytics and usage tracking
  • πŸ’‘ Knowledge Graph - Visualize connections between your notes
  • πŸ”— Auto-Linking - Intelligent note linking suggestions
  • ☁️ Cloud Sync - Sync with BrainHub cloud platform
  • πŸ” API Key Authentication - Secure connection to BrainHub services

πŸ“¦ Installation

Quick Install

Download Latest Release

Method 1: Manual Installation

  1. Download the latest release from Releases
  2. Extract the files to your Obsidian vault:
    .obsidian/plugins/brainhub/
    
  3. Enable the plugin in Obsidian Settings β†’ Community Plugins

Method 2: Community Plugins

  1. Go to Settings β†’ Community Plugins β†’ Browse
  2. Search for "BrainHub"
  3. Click Install

βš™οΈ Configuration

Cloud Mode (Recommended)

  1. Sign up at brainhub.website
  2. Get your API Key from the Dashboard
  3. In plugin settings:
    • API URL: https://brainhub.website/api
    • API Key: Your API key from dashboard
    • Mode: Cloud

Self-Hosted Mode

  1. Run BrainHub server locally:
    docker-compose up -d
  2. In plugin settings:
    • API URL: http://localhost:3000
    • Mode: Self-Hosted

πŸ“– Usage

Index Your Vault

  1. Open Command Palette (Ctrl/Cmd + P)
  2. Run: "BrainHub: Index Vault"
  3. Wait for indexing to complete

Search Notes

  1. Open Command Palette
  2. Run: "BrainHub: Search Notes"
  3. Type your query
  4. Browse results with scores

Chat with AI

  1. Open BrainHub Sidebar (click 🧠 icon)
  2. Type your question
  3. Get AI responses with context from your vault

View Statistics

  1. Open Command Palette
  2. Run: "BrainHub: View Statistics"
  3. See vault metrics and usage

πŸ”§ Development

Prerequisites

  • Node.js >= 20
  • pnpm >= 9

Setup

# Install dependencies
pnpm install

# Development mode (watch)
pnpm dev

# Production build
pnpm build

Project Structure

brainhub-obsidian-plugin/
β”œβ”€β”€ src/
β”‚   β”œβ”€β”€ main.ts              # Plugin entry point
β”‚   β”œβ”€β”€ api-client.ts        # Cloud API client
β”‚   β”œβ”€β”€ config/              # Configuration
β”‚   β”œβ”€β”€ services/            # Core services
β”‚   β”œβ”€β”€ views/               # UI components
β”‚   └── utils/               # Utilities
β”œβ”€β”€ manifest.json            # Plugin metadata
β”œβ”€β”€ styles.css               # Plugin styles
β”œβ”€β”€ esbuild.config.mjs       # Build configuration
└── package.json             # Dependencies

πŸ”Œ API Endpoints

The plugin connects to BrainHub Cloud API:

  • POST /api/v1/index - Index a note
  • POST /api/v1/batch-index - Index multiple notes
  • POST /api/v1/search - Semantic search
  • POST /api/v1/chat - AI chat with RAG
  • GET /api/v1/stats - Vault statistics
  • DELETE /api/v1/index - Delete indexed note
  • GET /api/v1/collections - List collections

πŸ” Security

  • API keys are stored locally in Obsidian settings
  • All communications use HTTPS
  • API keys have scopes (read, write, chat)
  • Rate limiting enforced server-side

πŸ“Š Subscription Tiers

Feature Free Pro Enterprise
Notes 100 Unlimited Unlimited
Search Basic Advanced Advanced
Chat 5/day Unlimited Unlimited
API Access ❌ βœ… βœ…

πŸ› Troubleshooting

"Cannot connect to API"

  1. Check your API URL is correct
  2. Verify your API key is valid
  3. Check internet connection (for cloud mode)
  4. Ensure server is running (for self-hosted)

"API Key Invalid"

  1. Go to brainhub.website
  2. Generate a new API key
  3. Update plugin settings

"Indexing Failed"

  1. Check vault path in settings
  2. Ensure you have write permissions
  3. Check server logs for errors

οΏ½ Stats

GitHub stars GitHub forks GitHub issues GitHub pull requests

🀝 Contributing

We welcome contributions! Please see our Contributing Guide for details.

πŸ“œ License

This project is licensed under the MIT License - see the LICENSE file for details.

πŸ”’ Security

For security concerns, please see our Security Policy.

πŸ’¬ Support

πŸ™ Sponsors

Support this project by becoming a sponsor! ❀️

Sponsor

πŸ“š Resources

🌟 Acknowledgments

Built with ❀️ by the BrainHub Team

Special thanks to:

  • Obsidian for the amazing note-taking platform
  • Qdrant for the vector database
  • All our contributors and users

Made with ❀️ by the BrainHub Team

⬆ Back to Top

οΏ½πŸ“ License

MIT License - see LICENSE file

🀝 Contributing

Contributions welcome! Please read CONTRIBUTING.md

πŸ“ž Support

🌟 Credits

Built with ❀️ by the BrainHub Team


Version: 3.2.0
Last Updated: 2026-01-14

About

No description, website, or topics provided.

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Sponsor this project

Packages

No packages published

Languages