Check before admission

const report = await nika.check('workflows/release.nika', {
  model: 'mock/echo',
  nativeStrict: true,
})

if (!report.clean) {
  console.error(report)
  process.exit(report.exitCode ?? 2)
}

NikaCheckResult deliberately stays open:

interface NikaCheckResult {
  report_version?: number
  clean?: boolean
  exitCode?: number
  [key: string]: unknown
}

Findings are report data. Configuration, engine resolution, transport and protocol failures throw typed errors. Keep application policy outside the SDK: inspect engine-owned fields your pinned engine documents, and preserve unknown fields when storing or forwarding the report.

The source SDK exposes no separate dry-run-plan method. Do not manufacture a TypeScript plan contract from engine output. Use check() for SDK admission and the engine CLI when an operator needs CLI-specific planning.

Remote checks intentionally reject the local-only model and nativeStrict overrides rather than silently ignoring them. For a contained served name, the remote result is the resident’s typed acknowledgement or workflow refusal, without local findings or an exit code. An explicit local path instead captures a local engine report and snapshot; successful capture requires the resident to acknowledge that exact snapshot. See remote checks for the two forms.

Overview

Start

Project

Local API

Runtime

Remote API

Operations

Reference

Check before admission

Run and cancel

Errors