Installation

Install OrkaJS and configure your first LLM provider.

Option 1: Full Package

Install the full OrkaJS package with all features included:

npm

npm install orkajs

pnpm

pnpm add orkajs

yarn

yarn add orkajs

Option 2: Selective Packages (Recommended)

Install only what you need for smaller bundle sizes:

# Core + OpenAI adapter
npm install @orka-js/core @orka-js/openai
npm install @orka-js/anthropic
npm install @orka-js/mistral
 
# Add vector database
npm install @orka-js/memory    # In-memory (dev/testing)
npm install @orka-js/pinecone  # Pinecone
npm install @orka-js/qdrant    # Qdrant
npm install @orka-js/chroma    # ChromaDB
 
# Add features as needed
npm install @orka-js/agent         # Agents (ReAct, HITL, etc.)
npm install @orka-js/tools         # Loaders, parsers, chains
npm install @orka-js/cache         # Caching layer
npm install @orka-js/resilience    # Retry, fallback
npm install @orka-js/orchestration # Router, Consensus, LoadBalancer
npm install @orka-js/workflow      # Multi-step workflows
npm install @orka-js/graph         # Graph workflows
npm install @orka-js/multimodal    # Vision, Audio agents
npm install @orka-js/evaluation    # Testing, metrics
npm install @orka-js/observability # Tracer, logging
npm install @orka-js/prompts       # Prompt versioning
npm install @orka-js/memory-store  # Conversation memory
npm install @orka-js/collector     # Development tools,Observability & monitoring
npm install @orka-js/evaluation    # Automate quality testing
npm install @orka-js/telemetry     # Observability & monitoring
npm install @orka-js/mcp           # MCP servers
npm install @orka-js/finetuning    # Model fine-tuning
npm install @orka-js/ocr           # OCR
npm install @orka-js/adapters      # Configure the adapters for OpenAI, Anthropic, Mistral, and Ollama

Package	Description
@orka-js/core	Types, errors, utils, Knowledge
@orka-js/openai	OpenAI adapter (GPT-4, GPT-3.5)
@orka-js/anthropic	Anthropic adapter (Claude)
@orka-js/mistral	Mistral adapter
@orka-js/ollama	Ollama adapter (local models)
@orka-js/agent	Agents (ReAct, HITL, Toolkits)
@orka-js/tools	Loaders, splitters, parsers, chains
@orka-js/cache	Memory/Redis cache, CachedLLM
@orka-js/resilience	Retry, fallback, ResilientLLM
@orka-js/orchestration	Router, Consensus, Race, LoadBalancer
@orka-js/google	Google Gemini adapter
@orka-js/cohere	Cohere adapter
@orka-js/replicate	Replicate adapter
@orka-js/multimodal	Vision, Audio agents
@orka-js/workflow	Multi-step workflows
@orka-js/graph	Graph-based workflows
@orka-js/evaluation	Testing, metrics, assertions
@orka-js/observability	Tracer, hooks, logging
@orka-js/prompts	Prompt versioning, registry
@orka-js/memory-store	Conversation memory
@orka-js/devtools	Development tools

Install an LLM Provider SDK

OpenAI

Recommended to start

npm install openai

Anthropic

Claude models

npm install @anthropic-ai/sdk

Ollama

Local, no API key

ollama pull llama3.2

Vector Database (Optional)

Provider	Install Command	Use Case
Memory	Built-in	Development, testing
Pinecone	`npm install @pinecone-database/pinecone`	Managed cloud
Qdrant	`npm install @qdrant/js-client-rest`	Self-hosted or cloud
ChromaDB	`npm install chromadb`	Open-source

✅ TypeScript Compatibility

OrkaJS works with all moduleResolution modes:

// tsconfig.json - All supported ✅
{
  "compilerOptions": {
    "moduleResolution": "node"      // Legacy (supported)
    // or "node16"                   // Modern
    // or "nodenext"                 // Modern  
    // or "bundler"                  // Bundlers (Vite, Webpack)
  }
}

⚠️ Environment Setup

Store your API keys in environment variables. Create a .env file:

OPENAI_API_KEY=sk-...
ANTHROPIC_API_KEY=sk-ant-...
PINECONE_API_KEY=...

Next Steps

Quick Start →