Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
🦋 Project arming and the resident firer are live. nika.yaml proposes; the machine disposes. Read the current status →
Reference local binary options and preview HTTP, retry, polling, concurrency and logging options.
interface LocalNikaOptions {
bin?: string
cwd?: string
}
| Option | Default | Meaning |
|---|---|---|
bin | explicit option, then NIKA_BIN, then nika on PATH | Executable to spawn |
cwd | current Node process directory | Base for relative workflows and traces |
interface CheckOptions {
model?: string
nativeStrict?: boolean
}
interface RunOptions {
vars?: Record<string, string | number | boolean>
model?: string
maxCostUsd?: number
resume?: string
signal?: AbortSignal
}
vars field maps to repeatable CLI --var KEY=VALUE overrides. It does
not reintroduce a top-level vars: key in the workflow envelope.
| Option | Required | Default |
|---|---|---|
url | yes | none |
token | yes | none |
timeout | no | 30 seconds |
retries | no | 2 |
concurrency | no | 24 |
pollInterval | no | 2 seconds |
pollTimeout | no | 5 minutes |
pollBackoff | no | 1.5 |
fetch | no | bound globalThis.fetch |
logger | no | none |
const nika = Nika.fromEnv({
timeout: 15_000,
retries: 1,
concurrency: 8,
})
fromEnv() reads NIKA_URL and NIKA_TOKEN.
Was this page helpful?