brainy/src/connectors
David Snelling 20aada6661 chore: Update all domain references to soulcraft.com
- Updated all soulcraftlabs.com references to soulcraft.com
- Updated all soulcraft-research.com references to soulcraft.com
- Updated CLI and documentation to use new domain
2025-08-10 16:45:19 -07:00
..
interfaces feat: add Cortex CLI, augmentation system, and enterprise features 2025-08-07 19:33:03 -07:00
README.md chore: Update all domain references to soulcraft.com 2025-08-10 16:45:19 -07:00

🧠 Brainy Connectors - Open Source Interface

Standard connector interface for the Brainy ecosystem

📋 Overview

This directory contains the open source interface that all Brainy connectors implement. These interfaces provide a standardized way to connect external data sources to your Brainy database.

🔧 Interface Definition

The IConnector.ts file defines the standard interface that all connectors must implement:

import { IConnector, ConnectorConfig, SyncResult } from './interfaces/IConnector'

export class MyCustomConnector implements IConnector {
  readonly id = 'my-custom-connector'
  readonly name = 'My Custom Integration'
  readonly version = '1.0.0'
  readonly supportedTypes = ['documents', 'users']

  async initialize(config: ConnectorConfig): Promise<void> {
    // Your implementation here
  }

  async startSync(): Promise<SyncResult> {
    // Your sync logic here
  }

  // ... implement other required methods
}

🚀 Building Custom Connectors

You can build your own connectors using these interfaces:

  1. Implement IConnector - Follow the interface contract
  2. Handle Authentication - Manage your service credentials
  3. Sync Data - Pull data from your source
  4. Transform - Convert to Brainy's format
  5. Store - Save to your Brainy database

📦 Premium Connectors

For production-ready connectors with enterprise features, check out Brain Cloud:

  • Notion - Sync pages and databases
  • Salesforce - CRM integration
  • Slack - Team communication data
  • And more - Coming soon

Learn more at soulcraft.com/brain-cloud

📚 Documentation


Part of the Brainy ecosystem by Soulcraft Labs