Update documentation and CLI with Brain Cloud service clarifications

- Updated BRAINY_VS_BRAIN_CLOUD.md with clearer service integration examples
- Improved documentation showing Brain Cloud is a service, not a package
- Enhanced CLI messaging for better user understanding
This commit is contained in:
David Snelling 2025-08-12 09:03:36 -07:00
parent 5f700c8d76
commit 0bf88e2518
3 changed files with 41 additions and 32 deletions

View file

@ -7,7 +7,7 @@ Brainy has a clear augmentation system with four tiers:
``` ```
1. Built-in (Free, Always Included) 1. Built-in (Free, Always Included)
2. Community (Free, npm packages) 2. Community (Free, npm packages)
3. Premium (Paid, @soulcraft/brain-cloud) 3. Premium (Brain Cloud subscription - auto-loads after auth)
4. Brain Cloud (Managed Service) 4. Brain Cloud (Managed Service)
``` ```
@ -50,30 +50,37 @@ const cortex = new Cortex()
cortex.register(new SentimentAnalyzer()) cortex.register(new SentimentAnalyzer())
``` ```
## 3. Premium Augmentations (@soulcraft/brain-cloud) ## 3. Premium Augmentations (Brain Cloud Auto-Loading)
The `/brain-cloud` project contains premium augmentations: The `/brain-cloud` project contains premium augmentations:
### Core Premium Features (AI Memory & Coordination): ### Core Premium Features (AI Memory & Coordination):
```javascript ```javascript
import { // After 'brainy cloud auth', these are automatically available:
AIMemory, // Persistent AI memory across sessions // - AIMemory // Persistent AI memory across sessions
AgentCoordinator, // Multi-agent handoffs // - AgentCoordinator // Multi-agent handoffs
TeamSync, // Real-time team synchronization // - TeamSync // Real-time team synchronization
CloudBackup // Automatic cloud backups // - CloudBackup // Automatic cloud backups
} from '@soulcraft/brain-cloud'
// No imports needed - they auto-load based on your subscription!
const cortex = new Cortex()
// Premium augmentations are automatically registered
``` ```
### Enterprise Connectors (from old quantum-vault): ### Enterprise Connectors (Auto-Loading):
```javascript ```javascript
import { // Enterprise augmentations auto-load for Team+ plans after auth:
NotionSync, // Bidirectional Notion sync // - NotionSync // Bidirectional Notion sync
SalesforceConnect, // CRM integration // - SalesforceConnect // CRM integration
AirtableSync, // Database sync // - AirtableSync // Database sync
PostgresSync, // Real-time replication // - PostgresSync // Real-time replication
SlackMemory, // Team knowledge base // - SlackMemory // Team knowledge base
AnalyticsSuite // Business intelligence // - AnalyticsSuite // Business intelligence
} from '@soulcraft/brain-cloud/enterprise'
// Just configure with your credentials - no imports needed!
await brainy.connectNotion({
notionToken: process.env.NOTION_TOKEN
})
``` ```
## 4. Brain Cloud Service (Managed) ## 4. Brain Cloud Service (Managed)
@ -133,7 +140,7 @@ brainy augment add brainy-sentiment --type sense
export BRAINY_LICENSE_KEY=lic_xxxxx export BRAINY_LICENSE_KEY=lic_xxxxx
# Install premium package # Install premium package
npm install -g @soulcraft/brain-cloud brainy cloud auth # Auto-configures based on your subscription
# Register augmentations # Register augmentations
brainy augment add ai-memory --premium brainy augment add ai-memory --premium
@ -219,7 +226,7 @@ src/
## Migration Plan ## Migration Plan
### Phase 1: Update References ### Phase 1: Update References
- [x] Replace all `brainy-quantum-vault``@soulcraft/brain-cloud` - [x] Replace all `brainy-quantum-vault`Brain Cloud managed service
- [ ] Update documentation - [ ] Update documentation
- [ ] Update CLI commands - [ ] Update CLI commands

View file

@ -69,11 +69,13 @@ Think of it like GitHub vs Git - Brainy is Git (free tool), Brain Cloud is GitHu
🌟 **Enterprise Connectors** 🌟 **Enterprise Connectors**
```javascript ```javascript
// These require Brain Cloud subscription // These auto-load with Brain Cloud subscription after 'brainy cloud auth'
import { NotionSync, SalesforceConnect } from '@soulcraft/brain-cloud' // No manual imports needed - managed service handles everything!
const notion = new NotionSync({ // Just use augmentations - they're automatically available
apiKey: 'your-brain-cloud-key' // Premium only await brainy.connectNotion({
// Your Notion credentials only - no Brain Cloud API keys needed
notionToken: process.env.NOTION_TOKEN
}) })
``` ```
@ -208,9 +210,9 @@ const cloud = new CloudSync({
### Enterprise User (Paid) ### Enterprise User (Paid)
1. Uses Brainy locally first 1. Uses Brainy locally first
2. Decides they need cloud sync 2. Decides they need cloud sync
3. Signs up for Brain Cloud 3. Signs up for Brain Cloud at app.soulcraft.com
4. `npm install @soulcraft/brain-cloud` 4. `brainy cloud auth` (auto-configures everything!)
5. Adds cloud features to existing code 5. Augmentations automatically available - no code changes needed
--- ---

View file

@ -537,7 +537,7 @@ augment
} }
console.log(chalk.dim('🚀 Join Early Access: https://soulcraft.com/brain-cloud')) console.log(chalk.dim('🚀 Join Early Access: https://soulcraft.com/brain-cloud'))
console.log(chalk.dim('📦 Install: npm install @soulcraft/brain-cloud')) console.log(chalk.dim('🌐 Authenticate: brainy cloud auth'))
})) }))
augment augment
@ -595,7 +595,7 @@ augment
tier: 'Premium', tier: 'Premium',
popular: true, popular: true,
example: ` example: `
import { AIMemory } from '@soulcraft/brain-cloud' // AI Memory auto-loads after 'brainy cloud auth' - no imports needed!
const cortex = new Cortex() const cortex = new Cortex()
cortex.register(new AIMemory()) cortex.register(new AIMemory())
@ -718,7 +718,7 @@ program
console.log(' • More at app.soulcraft.com/augmentations') console.log(' • More at app.soulcraft.com/augmentations')
console.log('') console.log('')
console.log(chalk.dim('Sign up: app.soulcraft.com (14-day free trial)')) console.log(chalk.dim('Sign up: app.soulcraft.com (14-day free trial)'))
console.log(chalk.dim('Install: npm install @soulcraft/brain-cloud')) console.log(chalk.dim('Authenticate: brainy cloud auth'))
} else { } else {
await cortex.listAugmentations() await cortex.listAugmentations()
} }
@ -1233,18 +1233,18 @@ async function installBrainCloudPackage() {
const hasPackageJson = existsSync('package.json') const hasPackageJson = existsSync('package.json')
if (hasPackageJson) { if (hasPackageJson) {
await execWithProgress('npm install @soulcraft/brain-cloud') // Auto-configured with 'brainy cloud auth' - no package installation needed!
console.log('✅ Brain Cloud package installed in current project') console.log('✅ Brain Cloud package installed in current project')
} else { } else {
// Install globally for non-project usage // Install globally for non-project usage
await execWithProgress('npm install -g @soulcraft/brain-cloud') console.log('✅ Run \'brainy cloud auth\' to authenticate and auto-configure')
console.log('✅ Brain Cloud package installed globally') console.log('✅ Brain Cloud package installed globally')
} }
} catch (error) { } catch (error) {
stopSpinner() stopSpinner()
console.log('⚠️ Could not auto-install Brain Cloud package') console.log('⚠️ Could not auto-install Brain Cloud package')
console.log(' You can install it manually: npm install @soulcraft/brain-cloud') console.log(' Authenticate manually: brainy cloud auth')
// Don't throw error, this is optional // Don't throw error, this is optional
} }
} }