Skip to main content

📖 Package Overview

Core Components​

  • @okcashpro/core: Central framework and shared functionality
  • @okcashpro/agent: Agent runtime and management
  • @okcashpro/adapters: Database implementations (PostgreSQL, SQLite, etc.)
  • @okcashpro/clients: Platform integrations (Discord, Telegram, etc.)
  • @okcashpro/plugins: Extension modules for additional functionality

Package Architecture​

The OKai framework is built on a modular architecture where each package serves a specific purpose:

  1. Core Package: Provides the fundamental building blocks
  2. Agent Package: Handles agent lifecycle and runtime
  3. Adapters: Enable different storage backends
  4. Clients: Connect to various platforms
  5. Plugins: Add specialized capabilities

Package Dependencies​

Getting Started​

# Install core package
pnpm add @okcashpro/core

# Install specific adapters
pnpm add @okcashpro/adapter-postgres
pnpm add @okcashpro/adapter-sqlite

# Install clients
pnpm add @okcashpro/client-discord
pnpm add @okcashpro/client-Telegram