Skip to content

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:

  1. Install the Nimi workspace dependencies.
  2. Run pnpm nimicoding:sync and pnpm nimicoding:doctor.
  3. 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.

bash
pnpm dlx --package @nimiplatform/app-tools nimi-app create --profile standalone

For 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

Packagenpm install pathSource checkout pathNotes
@nimiplatform/app-toolsPublic package with the nimi-app binaryapp-tools/Standalone scaffolds run it through pnpm dlx --package; workspace scaffolds may use workspace:*.
@nimiplatform/kitPublic packagekit/Kit is not a Runtime substitute; apps use its published subpath exports only.
@nimiplatform/sdkPublic package for app consumerssdks/typescript/ active public package sourceGenerated 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.

SurfaceRead pathWhat it documents
PlatformPlatformThe world model, six protocol primitives, authority rules
RuntimeRuntimeLocalAgent execution, Conversation, Memory, Knowledge, streaming, multimodal, provider routing
SDKSDK and First AI CallThe app-facing access boundary and first Runtime-backed text generation path
App ToolsCreate A Nimi AppApp authoring scaffold commands and local checks
KitPlatform KitShared UI, shell, auth, telemetry, AI capability configuration, and feature modules
Nimi LabUse Nimi LabCapability integration scripts, Runtime auth, Kit, AIConfig, and fail-closed states
DesktopDesktopThe native first-party shell
Web ModeWeb ModeThe constrained browser projection
RealmRealmSemantic truth, world state, world history
AvatarAvatarEmbodied 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

Documentation for Nimi — the installable, open-source, local-first personal AI product.