Start
Pick a reading path that matches your role. Each path moves you from the platform model into the part of Nimi you actually need.
For specific personas (newcomer evaluator, world creator, app developer, AI agent integrator, Nimi Coding adopter, auditor / reviewer), see Personas.
For installable surfaces and where each one lives, see Installation And Availability.
If you are creating an app, start with Create A Nimi App before reading the deeper SDK, Runtime, and Kit sections.
If an SDK call, Tester lane, or generated app scaffold fails, use Troubleshooting to map the visible error to the public surface that owns it.
If You Are New To Nimi
Read in this order:
- Platform for the product model, the world idea, and the six protocol primitives.
- Runtime for how AI work is executed.
- SDK for the app-facing access boundary.
- Desktop for the native shell, and Web Mode for how Web differs.
- Realm for semantic truth, world state, and world history.
That order builds the mental model from "what kind of system this is" into "how AI work gets done" and then into "how apps see it." When a term is unfamiliar, Glossary collects the cross-domain vocabulary every section uses.
If You Are Evaluating The Project
For an evaluation pass:
- Platform Vision — the north-star framing.
- Platform Architecture — the cross-layer map.
- Runtime Overview and Runtime Workflows — what the AI substrate is responsible for.
- SDK Overview and SDK Boundaries — the integration discipline expected of apps.
- Nimi Coding Whitepaper — how AI-assisted engineering is governed in this repository.
This path takes about as long as reading a long blog post and gives a faithful picture of what the public surface contains today.
If You Are Building Against Nimi
Start with Create A Nimi App if you need a new developer repository. Start with SDK and Runtime if you are integrating from an existing app. The SDK is the public access surface for applications. Runtime and Realm private boundaries should not be crossed directly from apps; the SDK exists exactly so that apps do not have to.
If the immediate task is one Runtime-backed text generation call from a TypeScript app, use First AI Call after Runtime is running.
For a concrete reference app, read Use Tester As A Reference App. For shared UI, auth, shell, telemetry, and model configuration, read Use Kit In An App.
For a failing local run, SDK call, or app-tools scaffold check, read Troubleshooting before changing app code.
For native shell behavior, read Desktop. For Web behavior, read Web Mode. Web is a constrained projection and does not inherit Desktop-native capabilities by implication.
If You Are Adopting Nimi Coding
Nimi Coding is admitted as a host-agnostic methodology and a publishable npm package. Read in this order:
- Nimi Coding Overview — the paradigm and the package.
- Topic Workflow — the topic / wave / packet / preflight / audit / closeout lifecycle.
- Installation — package install and adoption path.
- First Topic Bootstrap — a tutorial that walks the first topic end-to-end.
Reader Scenario: An App Author Walks Through The Docs
Suppose you are an app author who just heard about Nimi. A useful first walkthrough:
- Read Platform to find that worlds, not chat sessions, are the central object.
- Read Runtime to find that providers, workflows, streaming, and multimodal artifacts follow Runtime contracts, not app code.
- Read SDK to find that your app should consume those contracts through the root
@nimiplatform/sdkclient, public subpaths such as@nimiplatform/sdk/runtimeand@nimiplatform/sdk/realm, feature modules, and independent adapter packages, not by importing private internals. - Read Create A Nimi App, Use Tester As A Reference App, and Use Kit In An App before writing app-local shell, model config, or shared UI code.
- Keep Troubleshooting open while wiring Runtime, SDK, AIConfig, and scaffold checks.
- Read Desktop and Web Mode to learn why Desktop and Web do not have the same capability envelope and what that means for your distribution plans.
- Read Nimi Coding once you start contributing, because that is the workflow other contributors expect for high-risk or cross-surface changes.
After that walkthrough, Spec Map tells you where to read the underlying contracts when public prose is not precise enough.