This page lists every niro command in this release, with its options. Run niro <command> --help for the same text in the terminal. The commands that niro passes to the local engine (ask, ui, env, impact and others) are in Engine commands.
Global options
| Option |
What it does |
--version |
Prints the version |
--api-url <url> |
The Niro service address to sign in to. Only niro login accepts it. Any other command refuses it |
Typing niro with nothing after it, before you have signed in, runs niro start.
Setting up
| Command |
What it does |
Options |
niro start [path] |
First-time setup in five steps: checks this computer, signs you in, installs the local engine, builds the folder's graph, connects your agents. It also installs the background watcher. Running it again resumes at the first step that did not finish. Needs a terminal |
none |
niro login |
Signs in through your browser |
--api-key (paste a key instead; due to be removed), --password (email and password instead), --email <email> (with --password) |
niro logout |
Signs out on the server where it can, and deletes the saved sign-in |
none |
niro whoami |
Shows who is signed in |
--json (includes authed: true or false) |
niro engine [status|install] |
status (the default) shows the platform, where the engine is, its cache folder and whether its database opens. install downloads the engine |
--force (download again even if it is there) |
Folders and the graph
| Command |
What it does |
Options |
niro init [path] |
Adds a folder and builds its graph. Needs niro start to have set up this computer |
--project <name> (project to join or create; defaults to the folder's name), --branch <name> (for a folder not in git), --path <folder>, --base-url <url> (the address the service answers on; an empty value leaves it unset), --force (add a folder that does not look like a project; never your home folder, the root or a system folder) |
niro build [path] |
Rebuilds a folder's graph. A folder not added yet is refused |
--full (read every file again), --project <name> (when several projects hold the folder) |
niro status |
This folder's project, last build, plan, sharing, agent and background updates, then the engine's own status |
--json (niro's part only) |
niro plan |
Your plan, lines used, and the folders using them |
--json |
niro plan remove <folder> |
Stops indexing a folder, to free lines |
none |
Coding agents
| Command |
What it does |
Options |
niro mcp install |
Connects coding agents. See Connect your coding agent to Niro |
--client <id>[,<id>], --list |
niro mcp uninstall |
Removes Niro from agents |
--client <id>[,<id>], --all (or --client all), -y / --yes |
niro mcp serve |
The MCP server your agent starts. You do not run it yourself |
none |
niro mcp receipt |
Shows, or switches, the end-of-task Niro line |
--on, --off |
niro mcp line-check |
Used by Claude Code's end-of-task hook. You do not run it yourself |
none |
Background updates
| Command |
What it does |
niro service install |
Installs and starts the background watcher (niro-watch, run by PM2) |
niro service uninstall |
Removes it |
niro service status |
Shows whether it is running |
Uploads
| Command |
What it does |
Options |
niro audit-send |
Sends the coverage audit now. The watcher also does this every 5 minutes |
--limit <n> (default 50) |
niro journal-send |
Sends the tool-usage record now |
--limit <n> (default 20) |
niro audit-push-repo [path] |
Sends one folder's indexed files to Niro, masked, so Niro can look at a problem with you. Works with code sharing on or off, on every plan. It shows the count and size and asks first; your yes is the consent. For a folder you excluded with niro share exclude, it asks "Send it anyway?" and sends only on yes |
--force (send again if it was sent before), -y / --yes (skip the size question; needed without a terminal. It does not answer the excluded-folder question, so an excluded folder is never sent without a terminal) |
niro share |
Lists the folders kept out of code sharing |
|
niro share exclude <folder> |
Keeps a folder, and every folder inside it, out of code sharing while sharing stays on |
|
niro share include <folder> |
Shares an excluded folder again |
|
While code sharing is on, the watcher also sends the files Niro indexes by itself, every 5 minutes. See What leaves your machine.
Seeing what Niro did
| Command |
What it does |
Options |
niro impact |
What Niro did for you in the last 7 and 30 days, from the record on this computer: tasks, answers, tokens against the by-hand estimate (labelled as one), searches avoided, look-ups avoided, round trips avoided, answers by kind, the median answer time, a line per project, good moments in the agents' own words, and the graph kept current. Nothing is sent. Passed to the local engine. See Check what Niro did |
--days <n> (one window, 1 to 365), --project <name>, --json |
Reading this documentation
These pages ship inside the package, so niro guide reads them with no network and no sign-in.
| Command |
What it does |
Options |
niro guide |
Lists every page, grouped as the start page groups them, one line each. A page the start page does not group is listed under "Other pages" |
--json |
niro guide <topic> |
Shows one page. The topic can be a page name (agent-cursor), a page title, or a few words. When several pages match, it lists them. When no page is called that, it shows the pages that mention it. Only when nothing mentions it does it exit with 1 |
--json, --no-pager |
niro guide --search <words> |
Searches every page and shows each matching page with the lines that matched. A pasted error message finds the page that explains it, even with your own folder names and numbers in it, because each of the pages' placeholders (such as <folder> and N) stands for one value. Words a question is phrased with (how, do, I, what, the and the like) are left out, so a question in plain words searches for the words that matter, and the heading says which words those were. Without a line holding the phrase, it shows the lines that hold the most of your words; when no line holds enough of them, the pages that hold them across their lines; and it says "closest" when a word you typed is on no page. When fewer than half your words are on any page, or nothing matches, it exits with 1 |
--json, --no-pager |
Pages are shown as plain text. The source notes are left out, and a link shows the command that opens it, such as niro guide what-leaves-your-machine. Long text goes through a pager ($PAGER, or less when it is not set) only when it is printed to a terminal and is taller than the window. $PAGER runs through your shell, as it does for git and man. With --json, every answer is one JSON object with the same keys (mode, query, page, matches, results, total, error and others), for a coding agent to read.
Updating and removing
| Command |
What it does |
Options |
niro upgrade |
Installs the newest niro with npm, then refreshes your agents, the engine and the watcher |
--finish (only the refresh, no npm), --force (upgrade even from a linked or local copy), --from <version> (set by Niro itself) |
niro uninstall |
Removes Niro from this computer. See Uninstall |
-y / --yes |
Hidden commands
| Command |
Why it is hidden |
niro watch |
The background watcher runs it. Typed with a folder, it refuses: "niro watch <path> syncs a folder to Niro's cloud, which this release does not include." |
niro docs-send |
For LLM documentation, which this release does not include. It prints "LLM documentation is not available in this release." and exits with 2 |
Commands of hosted Niro
These belong to hosted Niro and are not in this release: add, info, edit, delete, doctor, ab, new-temp-project, discard-temp-project, and the hosted versions of init, build, status, remove and projects. The local remove and projects are in Engine commands. See Features of hosted Niro.