Interface AgentOSConfig

Configuration for the GMIManager.

Configuration for the AgentOSOrchestrator.

Configuration for the PromptEngine.

Configuration for the ToolOrchestrator.

Configuration for the ToolPermissionManager.

Configuration for the ConversationManager.

Configuration for the StreamingManager.

Configuration for the AIModelProviderManager.

The default Persona ID to use if none is specified in an interaction.

An instance of the Prisma client for database interactions.

Optional when storageAdapter is provided:

• If storageAdapter is provided, Prisma is only used for server-side features (auth, subscriptions).
• If storageAdapter is omitted, Prisma is required for all database operations.

Client-side usage:

const storage = await createAgentOSStorage({ platform: 'web' });
await agentos.initialize({
  storageAdapter: storage.getAdapter(),
  prisma: mockPrisma,  // Stub for compatibility (can be minimal mock)
  // ...
});
Copy

An instance of the authentication service, conforming to IAuthService.

An instance of the subscription service, conforming to ISubscriptionService.

Optional guardrail service implementation used for policy enforcement.

Optional map of secretId -> value for extension/tool credentials.

Optional. An instance of a utility AI service. This service should conform to IUtilityAI for general utility tasks. If the PromptEngine is used and requires specific utility functions (like advanced summarization for prompt construction), this service must also fulfill the contract of IPromptEngineUtilityAI. It's recommended that the concrete class for this service implements both interfaces if needed.

Optional extension manifest describing packs to load.

Declarative overrides applied after packs are loaded.

Optional registry configuration for loading extensions and personas from custom sources. Allows self-hosted registries and custom git repositories.

Example

registryConfig: {
  registries: {
    'extensions': {
      type: 'github',
      location: 'your-org/your-extensions',
      branch: 'main',
    },
    'personas': {
      type: 'github',
      location: 'your-org/your-personas',
      branch: 'main',
    }
  },
  defaultRegistries: {
    tool: 'extensions',
    persona: 'personas',
  }
}
Copy

Optional workflow engine configuration.

Optional workflow store implementation. Defaults to the in-memory store if omitted.

Optional multilingual configuration enabling detection, negotiation, translation.

Optional custom persona loader (useful for browser/local runtimes).

Optional cross-platform storage adapter for client-side persistence. Enables fully offline AgentOS in browsers (IndexedDB), desktop (SQLite), mobile (Capacitor).

Platform Support:

• Web: IndexedDB (recommended) or sql.js
• Electron: better-sqlite3 (native) or sql.js (fallback)
• Capacitor: @capacitor-community/sqlite (native) or IndexedDB
• Node: better-sqlite3 or PostgreSQL

Usage:

import { createAgentOSStorage } from '@framers/sql-storage-adapter/agentos';

const storage = await createAgentOSStorage({ platform: 'auto' });

await agentos.initialize({
  storageAdapter: storage.getAdapter(),
  // ... other config
});
Copy

Graceful Degradation:

• If omitted, AgentOS falls back to Prisma (server-side only).
• If provided, AgentOS uses storageAdapter for conversations, Prisma only for auth/subscriptions.
• Recommended: Always provide storageAdapter for cross-platform compatibility.