Skip to main content
Nika’s documentation teaches you how to write workflows and use the engine. When you need to check a precise behavior, follow the reference to its source and compare it with the version you have installed.

​
Which source answers your question?

​
Contract, implementation and explanation

The specification defines the language contract, schemas and conformance fixtures. The reference engine implements that contract. These guides explain how to use it. The product website introduces Nika; keep documentation bookmarks on docs.nika.sh. A schema declaration describes a contract. It does not, by itself, prove that an installed binary implements that behavior. Check engine status and validate your complete workflow before running it.

​
Read the version with the example

Generated field and builtin references link to a specific specification revision. A Git revision identifies the exact source used for the explanation. Schema pointers locate the declaration inside that source file. For example, a field can be allowed in several places with different requirements. Read the Meaning and placement section for the object you are editing; a shared field name does not mean it is valid everywhere.
A source excerpt is a fragment. Its surrounding tasks, inputs and permissions may be omitted. Use a complete example or template when you need a runnable starting point.

​
What verification tells you

For an integration, prefer the versioned machine interfaces to parsing prose. For documentation used by an agent, start with the documentation index. If an explanation and your installed version disagree, report the page URL, nika --version, a minimal example and the diagnostic in a documentation issue. Remove credentials and personal data from your example before sharing it.