Installation

Installez OrkaJS et configurez votre premier fournisseur LLM.

Option 1 : Package Complet

Installez le package OrkaJS complet avec toutes les fonctionnalités:

npm

npm install orkajs

pnpm

pnpm add orkajs

yarn

yarn add orkajs

Option 2 : Packages Sélectifs(Recommandé)

Installez uniquement ce dont vous avez besoin pour des bundles plus légers :

# Core
npm install @orka-js/core
 
# LLM Adapters
npm install @orka-js/openai        # OpenAI (GPT-4, etc.)
npm install @orka-js/anthropic     # Anthropic (Claude)
npm install @orka-js/mistral       # Mistral
npm install @orka-js/google        # Google Gemini
npm install @orka-js/ollama        # Ollama (local models)
npm install @orka-js/cohere        # Cohere
npm install @orka-js/replicate     # Replicate
 
# Vector Databases
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
npm install @orka-js/pgvector      # PostgreSQL / Supabase
 
# Agents & Workflows
npm install @orka-js/agent         # Agents (ReAct, HITL, Toolkits)
npm install @orka-js/workflow      # Multi-step workflows
npm install @orka-js/graph         # Graph-based workflows
npm install @orka-js/durable       # Durable, resumable & scheduled agents
npm install @orka-js/a2a           # Agent-to-Agent (Google A2A protocol)
 
# Tools & Memory
npm install @orka-js/tools         # Loaders, splitters, parsers, chains
npm install @orka-js/memory-store  # Conversation memory
npm install @orka-js/prompts       # Prompt versioning & registry
npm install @orka-js/mcp           # Model Context Protocol (MCP)
 
# Multimodal
npm install @orka-js/multimodal    # Vision, Audio agents
npm install @orka-js/realtime      # Voice agent (STT → LLM → TTS)
npm install @orka-js/ocr           # OCR & document extraction
 
# Reliability & Orchestration
npm install @orka-js/cache         # Caching layer (Memory, Redis)
npm install @orka-js/resilience    # Retry, fallback, ResilientLLM
npm install @orka-js/orchestration # Router, Consensus, Race, LoadBalancer
 
# Observability & Evaluation
npm install @orka-js/observability # Tracer, hooks, logging
npm install @orka-js/otel          # OpenTelemetry (OTLP exporter)
npm install @orka-js/evaluation    # Testing, metrics, assertions
npm install @orka-js/devtools      # Visual debugging dashboard
npm install @orka-js/finetuning    # Model fine-tuning orchestration
 
# Framework Integrations
npm install @orka-js/nestjs        # NestJS (DI, modules, SSE, CQRS)
npm install @orka-js/express       # Express.js middleware
npm install @orka-js/hono          # Hono (edge-compatible)
npm install @orka-js/react         # React — graph workflow visualizer
npm install @orka-js/server        # Dev server with Vite playground
npm install @orka-js/cli           # CLI — npx orka init, orka dev
npm install @orka-js/test          # Testing utilities & mock LLM

Package	Description
@orka-js/core	Types, erreurs, utils, Knowledge
@orka-js/openai	OpenAI adapter (GPT-4, etc.)
@orka-js/anthropic	Anthropic adapter (Claude)
@orka-js/mistral	Mistral adapter
@orka-js/google	Google Gemini adapter
@orka-js/ollama	Adapter Ollama (modèles locaux)
@orka-js/cohere	Cohere adapter
@orka-js/replicate	Replicate adapter
@orka-js/agent	Agents (ReAct, HITL, Toolkits)
@orka-js/workflow	Workflows multi-étapes
@orka-js/graph	Workflows basés sur graphes
@orka-js/durable	Agents durables, reprenables et planifiés
@orka-js/a2a	Agent-à-Agent (protocole Google A2A)
@orka-js/tools	Loaders, splitters, parsers, chains
@orka-js/memory-store	Mémoire conversationnelle
@orka-js/prompts	Versioning de prompts, registre
@orka-js/mcp	Client, serveur et gateway MCP
@orka-js/multimodal	Agents Vision, Audio
@orka-js/realtime	Agent vocal — pipeline STT → LLM → TTS
@orka-js/ocr	OCR et extraction de documents
@orka-js/cache	Cache Memory/Redis, CachedLLM
@orka-js/resilience	Retry, fallback, ResilientLLM
@orka-js/orchestration	Router, Consensus, Race, LoadBalancer
@orka-js/observability	Tracer, hooks, logging
@orka-js/otel	OpenTelemetry — export OTLP, W3C TraceContext
@orka-js/evaluation	Tests, métriques, assertions
@orka-js/devtools	Dashboard de debug et observabilité
@orka-js/finetuning	Orchestration du fine-tuning (dataset, API, versioning)
@orka-js/nestjs	NestJS — DI, modules, SSE streaming, CQRS
@orka-js/express	Middleware Express.js avec SSE streaming
@orka-js/hono	Middleware Hono (compatible edge)
@orka-js/react	React — visualiseur de workflows graphes
@orka-js/server	Serveur de dev avec playground React+Vite
@orka-js/cli	CLI — npx orka init, orka dev
@orka-js/test	Utilitaires de test, mock LLM, AgentTestBed, matchers Vitest

Installer un SDK Fournisseur LLM

OpenAI

Recommandé pour débuter

npm install openai

Anthropic

Claude models

npm install @anthropic-ai/sdk

Ollama

Local, sans clé API

ollama pull llama3.2

Base Vectorielle (Optionnel)

Fournisseur	Commande	Cas d'usage
Memory	Intégré	Développement, tests
Pinecone	`npm install @pinecone-database/pinecone`	Cloud managé
Qdrant	`npm install @qdrant/js-client-rest`	Auto-hébergé ou cloud
ChromaDB	`npm install chromadb`	Open-source

Compatibilité TypeScript

OrkaJS fonctionne avec tous les modes de résolution de modules :

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

Configuration Environnement

Stockez vos clés API dans des variables d'environnement. Créez un fichier .env :

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

Prochaines Étapes

Démarrage Rapide →