Skip to content
nikcli
Docs
Documentation

Health & Doctor

Server health, global dispose, and the doctor report that checks the install end to end.

Playground

Send these requests to your own running server. Values stay in this browser.

Not connected
How this works

Start a server with nikcli serve --hostname 127.0.0.1 --port 4096. Requests go straight from this page to that address — the browser allows it because loopback counts as a secure origin, and the server allows it because nikcli-ai.dev is in its CORS allowlist.

To try things without touching your real sessions or config, start the server with NIKCLI_TEST_HOME pointed at a throwaway directory — see the guided tour.

Operations

3 endpoints, generated from the server's own OpenAPI document. Every path also accepts the directory and workspace query parameters that select which instance handles the request.

get /doctor doctor.run
get /global/health global.health
post /global/dispose global.dispose
get /doctor # doctor.run
Parameters
Name In Type Required
directory query string optional
workspace query string optional
Responses
200 DoctorReport application/json 
{
  ok: boolean
  version: string
  channel: string
  failures: 
    | number
    | "Infinity" | "-Infinity" | "NaN"
  results: DoctorCheck[]
}
Example response from schema 
{
  "ok": false,
  "version": "",
  "channel": "",
  "failures": 0,
  "results": [
    {
      "ok": false,
      "label": "",
      "detail": "",
      "fix": ""
    }
  ]
}

Generated from the response schema — field values are placeholders, the shape is real.

SDK example
doctor.run
ts 
import { createNikcliClient } from "@nikcli-ai/sdk/httpapi"

const client = createNikcliClient()
await client.doctor.run({
  ...
})
Try it
get /global/health # global.health
Parameters
Name In Type Required
directory query string optional
workspace query string optional
Responses
200 GlobalHealth application/json 
{
  healthy: true
  version: string
  revision?: string
}
Example response captured 
{
  "healthy": true,
  "version": "local",
  "revision": "local"
}
SDK example
global.health
ts 
import { createNikcliClient } from "@nikcli-ai/sdk/httpapi"

const client = createNikcliClient()
await client.global.health({
  ...
})
Try it
post /global/dispose # global.dispose
Parameters
Name In Type Required
directory query string optional
workspace query string optional
Responses
200 Success application/json 
boolean
Example response from schema 
false

Generated from the response schema — field values are placeholders, the shape is real.

SDK example
global.dispose
ts 
import { createNikcliClient } from "@nikcli-ai/sdk/httpapi"

const client = createNikcliClient()
await client.global.dispose({
  ...
})
Try it

This changes or removes server state, against whatever base URL is set above.

Schemas

The 3 schemas reachable from these endpoints. Each is shown one level deep; nested types link to their own entry below. Names ending in _2, _3 and so on are the OpenAPI emitter disambiguating same-named schemas declared by different HttpApi groups — they are distinct shapes, not duplicates.

DoctorCheck
{
  ok: boolean
  label: string
  detail?: string | null
  fix?: string | null
}
DoctorReport
{
  ok: boolean
  version: string
  channel: string
  failures: 
    | number
    | "Infinity" | "-Infinity" | "NaN"
  results: DoctorCheck[]
}
GlobalHealth
{
  healthy: true
  version: string
  revision?: string
}