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:
parent
148699f8e3
commit
6c5130bc99
2 changed files with 32 additions and 25 deletions
|
|
@ -7,7 +7,7 @@ Brainy has a clear augmentation system with four tiers:
|
|||
```
|
||||
1. Built-in (Free, Always Included)
|
||||
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)
|
||||
```
|
||||
|
||||
|
|
@ -50,30 +50,37 @@ const cortex = new Cortex()
|
|||
cortex.register(new SentimentAnalyzer())
|
||||
```
|
||||
|
||||
## 3. Premium Augmentations (@soulcraft/brain-cloud)
|
||||
## 3. Premium Augmentations (Brain Cloud Auto-Loading)
|
||||
|
||||
The `/brain-cloud` project contains premium augmentations:
|
||||
|
||||
### Core Premium Features (AI Memory & Coordination):
|
||||
```javascript
|
||||
import {
|
||||
AIMemory, // Persistent AI memory across sessions
|
||||
AgentCoordinator, // Multi-agent handoffs
|
||||
TeamSync, // Real-time team synchronization
|
||||
CloudBackup // Automatic cloud backups
|
||||
} from '@soulcraft/brain-cloud'
|
||||
// After 'brainy cloud auth', these are automatically available:
|
||||
// - AIMemory // Persistent AI memory across sessions
|
||||
// - AgentCoordinator // Multi-agent handoffs
|
||||
// - TeamSync // Real-time team synchronization
|
||||
// - CloudBackup // Automatic cloud backups
|
||||
|
||||
// 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
|
||||
import {
|
||||
NotionSync, // Bidirectional Notion sync
|
||||
SalesforceConnect, // CRM integration
|
||||
AirtableSync, // Database sync
|
||||
PostgresSync, // Real-time replication
|
||||
SlackMemory, // Team knowledge base
|
||||
AnalyticsSuite // Business intelligence
|
||||
} from '@soulcraft/brain-cloud/enterprise'
|
||||
// Enterprise augmentations auto-load for Team+ plans after auth:
|
||||
// - NotionSync // Bidirectional Notion sync
|
||||
// - SalesforceConnect // CRM integration
|
||||
// - AirtableSync // Database sync
|
||||
// - PostgresSync // Real-time replication
|
||||
// - SlackMemory // Team knowledge base
|
||||
// - AnalyticsSuite // Business intelligence
|
||||
|
||||
// Just configure with your credentials - no imports needed!
|
||||
await brainy.connectNotion({
|
||||
notionToken: process.env.NOTION_TOKEN
|
||||
})
|
||||
```
|
||||
|
||||
## 4. Brain Cloud Service (Managed)
|
||||
|
|
@ -133,7 +140,7 @@ brainy augment add brainy-sentiment --type sense
|
|||
export BRAINY_LICENSE_KEY=lic_xxxxx
|
||||
|
||||
# Install premium package
|
||||
npm install -g @soulcraft/brain-cloud
|
||||
brainy cloud auth # Auto-configures based on your subscription
|
||||
|
||||
# Register augmentations
|
||||
brainy augment add ai-memory --premium
|
||||
|
|
@ -219,7 +226,7 @@ src/
|
|||
## Migration Plan
|
||||
|
||||
### 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 CLI commands
|
||||
|
||||
|
|
|
|||
|
|
@ -537,7 +537,7 @@ augment
|
|||
}
|
||||
|
||||
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
|
||||
|
|
@ -595,7 +595,7 @@ augment
|
|||
tier: 'Premium',
|
||||
popular: true,
|
||||
example: `
|
||||
import { AIMemory } from '@soulcraft/brain-cloud'
|
||||
// AI Memory auto-loads after 'brainy cloud auth' - no imports needed!
|
||||
|
||||
const cortex = new Cortex()
|
||||
cortex.register(new AIMemory())
|
||||
|
|
@ -718,7 +718,7 @@ program
|
|||
console.log(' • More at app.soulcraft.com/augmentations')
|
||||
console.log('')
|
||||
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 {
|
||||
await cortex.listAugmentations()
|
||||
}
|
||||
|
|
@ -1233,18 +1233,18 @@ async function installBrainCloudPackage() {
|
|||
const hasPackageJson = existsSync('package.json')
|
||||
|
||||
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')
|
||||
} else {
|
||||
// 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')
|
||||
}
|
||||
|
||||
} catch (error) {
|
||||
stopSpinner()
|
||||
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
|
||||
}
|
||||
}
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue