{{ theme.skipToContentLabel || 'Skip to content' }}

TypeScript SDK

Status: published 0.3.0 stable release. Supported platforms: Windows and Linux. macOS is not yet officially supported.

Purpose

Embed runtime, tools, sessions, explicit Loops, evaluation, and events in Node applications through the single coremind-ai facade.

Public interfaces

  • CoreMindRuntime
  • ChatSession
  • defineTool
  • checkProject
  • runEvaluationSuite
  • LoopConfig / LoopPhase
  • RunSnapshot / createRunSnapshot
  • Public lifecycle-extension and lightweight-experiment contracts

Errors and boundaries

  • runtime.run() and ChatSession.chat() return failure, pause, abort, timeout, and budget exhaustion through RunResult.outcome; callers do not need exceptions for run terminal states
  • Pre-run creation and configuration failures still use CoreMindError.code
  • defineTool requires a structured effect declaration
  • loop_state, RunOutcome, stable snapshots, and effect receipts share the same runtime semantics as CLI and Python
  • The facade only re-exports and never duplicates business logic
  • RunResult.snapshot is pure JSON. Protocol fully validates terminal state, metrics, trace, checkpoints, artifacts, and extension receipts to reject cross-language structural drift

CoreMind supplies mechanisms, quality guardrails, and development guidance. Users or business owners retain control of goals, rules, data fields, approval ownership, and final acceptance.

Source, tests, and examples

{{ theme.lastUpdated?.text || theme.lastUpdatedText || 'Last updated' }}:

Released under the MIT License.