SDK method index - Nika

LocalNika

Method	Returns	Machine twin
`version()`	`Promise<string>`	`nika --version`
`check(file, options?)`	`Promise<LocalCheckReport>`	`nika check --json`
`dryRunPlan(file)`	`Promise<LocalPlan>`	`nika run --dry-run --json`
`run(file, options?)`	`RunHandle`	`nika run --json`
`runToEnd(file, options?)`	`Promise<LocalRunOutcome>`	same stream, buffered
`test(file, options?)`	`Promise<GoldenVerdict>`	`nika test`
`traceVerify(path?)`	`Promise<TraceVerdict>`	`nika trace verify`

Jobs

Method	Returns
`submit(workflow, inputs?, options?)`	`Promise<RunResponse>`
`status(jobId)`	`Promise<NikaJob>`
`cancel(jobId)`	`Promise<CancelResponse>`
`run(workflow, inputs?, options?)`	`Promise<NikaJob>`
`stream(jobId, options?)`	`AsyncIterable<NikaEvent>`
`artifacts(jobId)`	`Promise<NikaArtifact[]>`
`artifact(jobId, name)`	`Promise<string>`
`artifactJson<T>(jobId, name)`	`Promise<T>`
`artifactBinary(jobId, name)`	`Promise<Uint8Array>`
`artifactStream(jobId, name)`	`Promise<ReadableStream<Uint8Array>>`
`runAndCollect(workflow, inputs?, options?)`	`Promise<Record<string, unknown>>`

Workflows

Method	Returns
`list()`	`Promise<WorkflowInfo[]>`
`listPage(options?)`	`Promise<ListWorkflowsResponse>`
`reload()`	`Promise<WorkflowInfo[]>`
`source(name)`	`Promise<string>`

System

Method	Returns
`nika.health()`	`Promise<NikaHealth>`
`Nika.fromEnv(overrides?)`	`Nika`
`Nika.verifyWebhook(body, signature, secret, tolerance?)`	`Promise<boolean>`

Continue

Configuration

Constructor and transport defaults.

Types

Expand every return shape.

Source

Read the implementation.

SDK map

See the visual reference system.