API Reference

This section contains auto-generated API documentation from the TypeScript source code.

Nexus API

This API reference covers the Nexus orchestration system.

Overview

The Conductor API is organized into the following modules:

Core Components

• MultiProjectConductor - Main orchestration engine managing multiple projects
• AgentManager - CLI-based agent spawning and lifecycle management
• SDKAgentManager - Modern SDK-based agent control
• RedisState - State management and persistence layer

Integrations

• JiraClient - Single project Jira integration
• MultiProjectJiraClient - Multi-project Jira polling and updates

Validation & Testing

• ChecklistValidator - Evidence-based checklist enforcement
• ValidatorAgent - Reality validation and verification

Monitoring & Metrics

• BudgetTracker - Cost tracking and budget enforcement
• LeanMetricsTracker - Flow efficiency and cycle time metrics
• WebServer - Dashboard API and real-time updates

Worker Management

• WorkerPool - Parallel ticket processing using git worktrees

Generating API Documentation

To regenerate the API documentation from source:

npm run docs:generate-api

This uses TypeDoc to extract documentation from TypeScript source files in src/.

Type Definitions

All types are fully documented in the source code with JSDoc comments. The TypeScript compiler enforces type safety across the entire codebase.

Usage Examples

See the Development Patterns guide for common usage patterns and best practices.