Which computers does Niro run on?

macOS and Linux, on Intel and ARM processors. Windows is supported, and the details are coming.

I am on Windows. Setup says "Niro Local runs on macOS and Linux. On Windows, use WSL 2."

Windows support is coming to this guide. Until it arrives, follow the message: install WSL 2 (Windows Subsystem for Linux, which runs Linux inside Windows), and run Niro inside it.

"Node vX. Niro needs Node 18 or newer."

Install Node.js 18 or newer, then run niro start again.

"N GB free. A large repository's graph may need more."

This is a warning, not a stop. It appears when less than 2 GB of disk is free. Free some space if you are indexing a large repository.

"niro start is interactive and there is no terminal to prompt on."

niro start asks questions, so it needs a terminal. Run it in a terminal window. For a machine with no person at it, see Niro in CI.

"Global install failed. Install it yourself, then run niro start"

You ran Niro through npx, and Niro tried to install itself for good, so that background updates keep working after npx clears its cache. That failed, often for lack of permission. Run npm install -g @niroai/niro, then niro start.

"<folder> is your home folder ... Niro will not index it."

Niro refuses your home folder, a folder above it, the root of the disk and system folders, because it would index everything below as one project. Run niro start from your project's folder instead. --force does not change this.

"<folder> does not exist." or "<folder> is a file, not a folder."

Check the path you gave, then run the command again.

"Nothing that looks like a project in <folder>."

Niro looks for a build file (such as package.json, pom.xml or go.mod) in the folder, or up to three levels below it. If your folder really is a project without one, add it anyway with niro init --force.

"It holds more than 60 repositories, too many to index as one folder."

Add the repositories one by one, or add a smaller folder.

"It holds no source file niro-local can read."

The folder has no file in a language Niro reads. See Supported languages.

I ran niro start again. Will it redo everything?

No. It carries on from the first step that did not finish.

I typed niro on its own and it started setup.

Before you have signed in, niro on its own runs niro start.

"The local engine is not installed. Run niro start once to set up this machine."

The engine (the program that builds and answers from the graph) is missing. Run niro start, or niro engine install.

"Downloading the local engine failed: HTTP n" or "The engine manifest came back incomplete."

The download did not finish. Check your connection, then run niro engine install.

"The local engine that arrived is not the one Niro published, so it was not installed."

The downloaded file did not match its published fingerprint (SHA-256), so Niro threw it away. Try again. If it keeps happening, tell Niro (help@niro.ai).

"Another process has been downloading the local engine for too long."

A lock folder from an earlier download is still there. If nothing else is downloading, remove the lock folder the message names, and try again.

"There is no local engine for <platform> <arch>."

There is no engine built for this kind of computer.

niro engine status says another niro-local is on my PATH.

A second copy of the engine is installed somewhere on your PATH. niro does not use it. Remove it, so that only one version is on this computer.

The engine install ended with "Nothing was installed."

Niro's service refused the download. The message above it gives the service's reason, for example that your plan does not include the engine.

"The local engine cannot open its graph on this machine" or "Make that folder writable, or set NIRO_LOCAL_HOME"

The engine cannot write to ~/.niro-local. Make that folder writable by you. Or set NIRO_LOCAL_HOME to a folder you can write, and run niro service install so the watcher uses it too.

"PM2 is not installed." / "PM2 install failed" / "PM2 was installed but [is not] runnable from this shell"

PM2 is the tool that keeps Niro's background watcher running.

"Could not set niro-watch to start on login"

The watcher runs, but will not start again by itself after you log out. The message gives the command to try again. That command may need sudo.

niro status says the background updates are "stopped", "not installed" or "OFF".

The graph will not follow your edits until the watcher runs. The status line names the fix: