Getting Started

Integrate OrkaJS DevTools into your application in less than 5 minutes. Visualize, debug and optimize your AI workflows in real-time.

Installation

OrkaJS DevTools is designed to be lightweight. Install it as a dev dependency to keep your production bundle clean.

npm install @orka-js/collector express

Note: Express is required to serve the dashboard locally. It is listed as an optional peer dependency to give you control over the version.

Initialize Dashboard

import { collector } from '@orka-js/collector';
// Start collector server (returns tracer instance)
const { tracer, server, stop } = await collector({
  port: 3001,
  open: true, // Automatically opens the browser
});
// tracer is the TraceCollector instance for advanced usage

Instrument your Code

Option A: The Wrapper (Recommended)

Best for tracing existing async functions without changing logic.

import { trace } from '@orka-js/collector';
const data = await trace.wrap('agent', 'market-analysis', async () => {
  return myAgent.run("Analyze NVDA stock");
});

Option B: The Decorator

Elegant for Class-based agents or services.

import { Trace } from '@orka-js/collector';
class LLMService {
  @Trace({ type: 'llm', name: 'chat' })
  async chat(prompt: string) { ... }
}

Semantic Trace Types

agent

llm

tool

retrieval

chain

workflow

graph

custom

Next Concept

Deep Dive into Features

Learn how to use the Replay, Cost Tracking, and Prompt Versioning features.

Reference

Full API Specs

Complete documentation of all methods, types, and configuration options.