Skip to content

Installation And Availability

Nimi has multiple public surfaces. Each surface has its own distribution channel, and the public docs only describe a surface as installable when its release evidence has been admitted under the matching authority contract.

Installable Today

Nimi Coding

Nimi Coding is admitted as a host-agnostic methodology and is distributed as the npm package @nimiplatform/nimi-coding.

For the install command, project bootstrap layout, host adapter selection, and adoption path, see Nimi Coding → Installation.

A minimal first-run path:

  1. Add the package to a host project.
  2. Run the bootstrap command described on the installation page.
  3. Walk through First Topic Bootstrap to confirm the methodology surface works end-to-end.

The package is host-agnostic, so the same install path applies under any admitted AI host.

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/ private vNext workspace packageGenerated standalone apps depend on the published SDK range from app-tools; repository development uses the workspace package.

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
RuntimeRuntimeAI execution, workflows, 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, model config, and feature modules
Tester / Nimi LabUse Tester As A Reference AppReference app 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
CognitionCognitionStandalone memory, knowledge, prompt serving

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 Spec Map lists which authority surface a public section traces to. 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 AI open world platform documentation.