Skip to content

Runtime CLI and Startup Paths ​

The source development supervisor and the installed fixed service rely on different entry points. Identify your target environment before choosing startup or diagnostic commands.

Source Development ​

At the Nimi repository root, run this in a dedicated terminal:

sh
pnpm dev:runtime

The script starts the current-user source Runtime supervisor and prints its logs directly to the terminal. Next, run pnpm dev:desktop and sign in through Home. Ensure dependencies, Realm/Web, and OS prerequisites are prepared according to Development Environment Setup and the repository's LOCAL_DEVELOPMENT.md.

You cannot substitute pnpm dev:runtime with nimi serve in a standard Windows development terminal. The nimi serve command enters the production daemon lifecycle and requires the fixed Windows service identity.

Installed Windows Fixed Service ​

These commands require the corresponding fixed service to be installed and its control prerequisites satisfied. Current macOS/Linux builds do not provide this background service controller. These commands also do not manage the source supervisor.

CommandPurpose
nimi statusInspect fixed-service status
nimi startStart the installed fixed service
nimi stopStop that fixed service
nimi logsInspect its logs

nimi serve is an entry point for the production daemon itself; executing it in an unprivileged terminal will not launch or manage the protected service.

Environment and Service Diagnostics ​

  • nimi doctor checks local environment and dependency prerequisites.
  • nimi version reports the binary version.
  • nimi health --json reads the running service's health summary, subject to reachability and access conditions.

A READY state indicates that the daemon is actively serving RPC requests. However, executing a specific AI operation still requires a valid session and execution configuration, plus a ready local Loadout or supported cloud target according to the selected route. Running the source supervisor in current-user mode does not establish the identity or configuration of a production fixed service.

Source Basis ​

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