Reference

Exhaustive technical documentation, CLI command references, API specifications, and configuration schemas for the Niksphere platform.

Generated with every build

The content on these pages isn't maintained by hand in this documentation — it's authored once, alongside each product's own source code (OpenAPI annotations, CLI/config schema descriptions, release notes), and published alongside every release. This reference is rendered fresh from those published specs on every build, so the pages here always reflect exactly what was published, never a stale copy drifting apart from the code.

What each product documents

Not every product publishes every kind of reference — a product only gets a column entry once a release actually publishes that spec. Installable products are downloaded and run in your own environment; Hosted services are Niksphere-operated and reached over the network, so there's nothing to install and no Configuration/Commands reference for them.

Product	Release Notes	Commands	API	Configuration	SBOM
Installable products
Engine	✅	✅	✅	✅	✅
CLI	✅	✅	–	–	✅
VS Code Extension	✅	–	–	–	✅
Hosted services
Cloud	✅	–	✅	–	–
Website	✅	–	–	–	–

Looking for SBOM / supply-chain information? See Security & Supply Chain in Concepts.

Stable & Insider channels

Each product ships two channels: Stable, the latest supported release, and Insider, rolling preview builds published ahead of a stable release. A product's reference hub (e.g. cli/) always documents its latest Stable release; every build — Stable and Insider alike — remains browsable in that product's Release Archive, and the version switcher at the top of each page jumps between them.

Cross-product release notes are split the same way: Release Notes covers Stable, Release Notes (Insider) covers Insider.