Installation And Availability
Nimi has several public surfaces, and each one has its own distribution channel. This page lists what you can install today, and what is currently documented only at the contract level.
Installable Today
Nimi Coding
Nimi Coding is admitted as host-agnostic canonical-authority tooling and is distributed as the npm package @nimiplatform/nimi-coding.
For the Nimi workspace install and host compatibility checks, see Nimi Coding → Host Integration.
A minimal first-run path:
- Install the Nimi workspace dependencies.
- Run
pnpm nimicoding:syncandpnpm nimicoding:doctor. - Use the CLI Reference for bounded authority context, formatting, validation, and the code-reading commands available in the installed version.
The package remains host-agnostic; the Nimi repository applies its own explicit admission boundary around it.
Nimi App Tools
@nimiplatform/app-tools is the public app-authoring CLI for Nimi App developer repositories.
pnpm dlx --package @nimiplatform/app-tools nimi-app create --profile standaloneFor the full scaffold path, see Create A Nimi App. The CLI creates scaffold inputs and local checks only. It does not create public app admission, permission grants, registry visibility, release descriptors, or installed-app update truth.
Package Channel Matrix
| Package | npm install path | Source checkout path | Notes |
|---|---|---|---|
@nimiplatform/app-tools | Public package with the nimi-app binary | app-tools/ | Standalone scaffolds run it through pnpm dlx --package; workspace scaffolds may use workspace:*. |
@nimiplatform/kit | Public package | kit/ | Kit is not a Runtime substitute; apps use its published subpath exports only. |
@nimiplatform/sdk | Public package for app consumers | sdks/typescript/ active public package source | Generated standalone apps depend on the published 0.6.x range from app-tools; repository development uses the same package through the workspace. |
Do not assume a source checkout automatically opens every product release channel. Use npm packages for standalone app repositories, and use workspace:* only inside this monorepo or generated workspace-app scaffolds.
Surfaces Documented As Contract
The following surfaces are documented at the contract level. Their read paths describe what the surface is, what it owns, and how it relates to the rest of the platform.
| Surface | Read path | What it documents |
|---|---|---|
| Platform | Platform | The world model, six protocol primitives, authority rules |
| Runtime | Runtime | LocalAgent execution, Conversation, Memory, Knowledge, streaming, multimodal, provider routing |
| SDK | SDK and First AI Call | The app-facing access boundary and first Runtime-backed text generation path |
| App Tools | Create A Nimi App | App authoring scaffold commands and local checks |
| Kit | Platform Kit | Shared UI, shell, auth, telemetry, AI capability configuration, and feature modules |
| Nimi Lab | Use Nimi Lab | Capability integration scripts, Runtime auth, Kit, AIConfig, and fail-closed states |
| Desktop | Desktop | The native first-party shell |
| Web Mode | Web Mode | The constrained browser projection |
| Realm | Realm | Semantic truth, world state, world history |
| Avatar | Avatar | Embodied agent presentation |
When a surface adds an install command, a download link, or a release notes path, the corresponding section page is updated to expose it.
Tracking Availability
The Compatibility Posture page lists the constraints that govern when a surface is allowed to publish install or release information.
The Forbidden Claims page enumerates the install-style and release-style strings that public docs refuse to publish without admitted evidence.
Source Basis
nimi-coding/README.mdnimi-coding/methodology/authority-authoring.yaml.nimi/spec/platform/product-lifecycle.authority.yaml.nimi/spec/runtime/service-operations.authority.yaml.nimi/spec/platform/app-ecosystem.authority.yamlapp-tools/README.mdapp-tools/lib/index.mjsapp-tools/lib/app-scaffold.mjskit/package.jsonsdks/typescript/package.jsonnimi-coding/package.json