Skip to content

Nimi Coding Installation

Nimi Coding is distributed as the public npm package @nimiplatform/nimi-coding. Install it in the project where you want the .nimi/** governance layer and the nimicoding CLI.

Requirements

RequirementNotes
Node.js24 or newer
Package managernpm, pnpm, yarn, or another tool that can install npm packages
Project rootA version-controlled project is recommended because start creates files

Install

Use your project's package manager:

bash
npm install --save-dev @nimiplatform/nimi-coding

or:

bash
pnpm add -D @nimiplatform/nimi-coding

After installation, the project should have a nimicoding binary available through the package manager:

bash
npx nimicoding --version
npx nimicoding --help

Bootstrap

Run start from the project root:

bash
npx nimicoding start

For a non-interactive smoke test, use:

bash
npx nimicoding start --yes
npx nimicoding doctor --json

start creates or updates the package-owned bootstrap layer under .nimi/**, adds managed AI entrypoint blocks when you accept them, and prepares the next handoff payload. It preserves project-owned truth: .nimi/spec/**, .nimi/local/**, .nimi/cache/**, and locally modified bootstrap files are not silently deleted or overwritten.

First Checks

CheckExpected result
nimicoding --versionPrints the installed package version
nimicoding --helpLists bootstrap, topic, sweep audit, sweep design, handoff, closeout, and validator commands
nimicoding doctor --jsonReports the bootstrap health state in machine-readable form

Remove Package-Managed Bootstrap

If you need to remove the package-managed bootstrap files from a test project, run:

bash
npx nimicoding clear --yes

clear removes managed AI blocks and package-owned bootstrap files only when they still match the packaged seed. It preserves project-owned truth and local operational evidence.

Source Basis

Nimi AI open world platform documentation.