Skip to content

Referencia de API

Commander tiene dos capas de superficie API. La mayoría de apps solo necesitan la capa 1.

Capa 1 — Integración pública (empieza aquí)

SuperficiePaquete / entradaIdeal para
CLIcommander · packages/core/src/cliEntry.tsTerminal, scripts, CI
SDK TypeScript@commander/sdkCommanderClientEmbed en apps Node
API HTTPServidor :4000Clientes políglotas, consola web
SDK Pythoncommander-ai (cliente HTTP)Python contra el API server

SDK TypeScript

typescript
import { CommanderClient, createClient } from '@commander/sdk';

const client = new CommanderClient({ provider: 'openai' });
await client.connect();
const result = await client.run('audit this repo');
console.log(result.status, result.summary);
await client.disconnect();

const c = await createClient();
await c.run('explain the architecture');
await c.disconnect();
MétodoRol
connect / disconnectCiclo de vida
run(task)Ejecución completa → ExecutionResult
plan(task)Solo deliberación
onEvent(handler)Stream de eventos agent/tool
createAgent / helpers de memoriaControl avanzado de sesión

Estado npm: monorepo-first; publicación pública en curso. Ver Agent SDK.

HTTP (servidor)

bash
curl http://localhost:4000/health
curl http://localhost:4000/metrics

curl -X POST http://localhost:4000/execute \
  -H "Authorization: Bearer $COMMANDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"task":"analyze this repository","mode":"plan"}'

API durable Architecture V2: POST /v1/runs — ver Migración V2.

Python

python
from commander import CommanderClient
# cliente httpx fino → API server

Python SDK.


Capa 2 — Componentes de orquestación runtime

Estos módulos impulsan deliberación, presupuesto, memoria y verificación dentro de @commander/core. Úsalos al extender el runtime — no para integración normal de producto.

ComponentePropósito
Analizador de complejidadPuntuar tarea → recomendar topología
Orquestador adaptativoPlan multi-agente + coordinación
Presupuesto de tokensReparto de presupuesto entre agentes
Memoria de 3 capasWorking · episodic · long-term
Motor de reflexiónEvaluación post-run
ConsensoVotos multi-modelo en alto riesgo
InspectorSalud / detección de issues

Cuándo usar la capa 2

  • Construir topología o planner custom
  • Investigar memoria y consenso
  • Tests que aíslan un subsistema

Cuándo no usar la capa 2

  • Features de producto que solo necesitan «corre esta tarea» → CommanderClient
  • Clientes remotos multi-lenguaje → HTTP

Ejemplo mínimo capa 2

typescript
import {
  TaskComplexityAnalyzer,
  AdaptiveOrchestrator,
  TokenBudgetAllocator,
} from '@commander/core';

const analyzer = new TaskComplexityAnalyzer();
const complexity = analyzer.analyze({
  id: 'task-1',
  description: 'Build distributed logging system',
  riskLevel: 'high',
});

const allocator = new TokenBudgetAllocator({ baseBudget: 100_000 });
const budget = allocator.allocate(
  complexity.recommendedTopology,
  complexity.score,
  3,
);

Accesores globales

Algunos componentes exponen singletons de proceso (usados por runtime/SDK):

  • getGlobalTaskComplexityAnalyzer()
  • getGlobalAdaptiveOrchestrator()
  • getGlobalTokenBudgetAllocator()
  • getGlobalThreeLayerMemory()
  • getGlobalReflectionEngine()
  • getGlobalConsensusChecker()
  • getGlobalInspectorAgent()

Prefiere CommanderClient salvo que necesites estado compartido a nivel proceso.


Profundidad de arquitectura

Diseño de subsistemas (no listas de métodos): Arquitectura, Runtime, Verificación, Seguridad.

Guías relacionadas

MIT — Hecho para orquestación multi-agente.