# Niro (niro-cli with the local engine)

> Niro builds a code graph on the developer's own computer, and serves it to coding agents over MCP and to the developer through `niro ask`. These pages ship inside the @niroai/niro package. Pull request review and root cause analysis are features of hosted Niro, not of this package.

How an agent should use this index:

- Read this file once.

- Open only the page that matches the question.

- When the user pastes an error message, open [Error messages](https://help.niroai.dev/cli/reference-messages/) first.

- Never run `niro start`, `niro login` or `niro uninstall` on the user's behalf. Ask before `niro plan remove`.

- Every factual sentence in these pages has its source in an HTML comment beside it.

llms-full.txt holds every page below in one file.

## Reference and help (most used)

- [Error messages](https://help.niroai.dev/cli/reference-messages/): every user-visible message with an answer, linked to its explanation

- [Troubleshooting](https://help.niroai.dev/cli/troubleshooting/): the first three checks, and where each kind of problem is answered

- [MCP tools reference](https://help.niroai.dev/cli/reference-mcp-tools/): every MCP tool and its inputs, as the engine serves them

- [CLI commands](https://help.niroai.dev/cli/reference-cli/): every niro command and option

- [Engine commands](https://help.niroai.dev/cli/reference-engine-commands/): the commands niro passes to the engine (ask, ui, env, route-rule and others)

- [Environment variables](https://help.niroai.dev/cli/reference-environment-variables/): every environment variable and its default

- [Settings files](https://help.niroai.dev/cli/reference-config-files/): settings files and keys

- [Exit codes](https://help.niroai.dev/cli/reference-exit-codes/): what each exit code means

- [Limits](https://help.niroai.dev/cli/reference-limits/): every size, time and count limit

## FAQ

- [FAQ: install and setup](https://help.niroai.dev/cli/faq-install-and-setup/): installing, the engine, the background watcher

- [FAQ: login and account](https://help.niroai.dev/cli/faq-login-and-account/): signing in, accounts

- [FAQ: licence and plans](https://help.niroai.dev/cli/faq-licence-and-plans/): line limits, the licence

- [FAQ: indexing and builds](https://help.niroai.dev/cli/faq-indexing/): a folder not added yet, building the graph, files left out

- [FAQ: wrong or missing answers](https://help.niroai.dev/cli/faq-wrong-or-missing-answers/): known gaps in answers, by kind and by language

- [FAQ: coding agents and MCP](https://help.niroai.dev/cli/faq-assistants-and-mcp/): connecting agents, agents not using Niro

- [FAQ: worktrees and branches](https://help.niroai.dev/cli/faq-worktrees-and-branches/): branches, worktrees, temporary projects

- [FAQ: privacy and security](https://help.niroai.dev/cli/faq-privacy-and-security/): what is sent, masking, files never read

- [FAQ: performance](https://help.niroai.dev/cli/faq-performance/): slow builds and answers, disk

- [FAQ: updates](https://help.niroai.dev/cli/faq-updates/): upgrading

- [FAQ: uninstall](https://help.niroai.dev/cli/faq-uninstall/): removing Niro from this computer: common questions

- [FAQ: offline use](https://help.niroai.dev/cli/faq-offline/): working without a network

- [FAQ: feedback and receipts](https://help.niroai.dev/cli/faq-feedback-and-receipts/): the end-of-task line, feedback

## Ways in

- [Ways to connect](https://help.niroai.dev/cli/connect-overview/): which ways of using Niro work today: coding agents, the terminal, review bots, CI, a shared server

- [Use Niro from the terminal](https://help.niroai.dev/cli/connect-terminal/): niro ask, niro ui and other terminal use

- [Connect your coding agent to Niro](https://help.niroai.dev/cli/connect-your-ai-assistant/): connecting coding agents over MCP

- [Review bots and Niro](https://help.niroai.dev/cli/connect-review-bots/): review bots (not supported locally)

- [Web agents](https://help.niroai.dev/cli/connect-web-agents/): browser agents (not in a release yet; use hosted Niro)

- [Niro in CI](https://help.niroai.dev/cli/connect-ci/): build machines (partial)

- [Shared team server](https://help.niroai.dev/cli/connect-team-server/): a shared server (not in a release yet)

- [Connect Claude Code to Niro](https://help.niroai.dev/cli/agent-claude-code/): Claude Code

- [Connect Codex to Niro](https://help.niroai.dev/cli/agent-codex/): Codex

- [Connect Claude Desktop to Niro](https://help.niroai.dev/cli/agent-claude-desktop/): Claude Desktop

- [Connect Cursor to Niro](https://help.niroai.dev/cli/agent-cursor/): Cursor

- [Connect Windsurf to Niro](https://help.niroai.dev/cli/agent-windsurf/): Windsurf

- [Connect VS Code (GitHub Copilot) to Niro](https://help.niroai.dev/cli/agent-vscode/): VS Code (GitHub Copilot)

- [Connect Gemini CLI to Niro](https://help.niroai.dev/cli/agent-gemini-cli/): Gemini CLI

- [Connect GitHub Copilot CLI to Niro](https://help.niroai.dev/cli/agent-copilot-cli/): GitHub Copilot CLI

- [Connect Factory (droid) to Niro](https://help.niroai.dev/cli/agent-factory/): Factory (droid)

- [Connect Goose to Niro](https://help.niroai.dev/cli/agent-goose/): Goose

- [Connect OpenCode to Niro](https://help.niroai.dev/cli/agent-opencode/): OpenCode

- [Connect Cline to Niro](https://help.niroai.dev/cli/agent-cline/): Cline

- [Connect Kiro to Niro](https://help.niroai.dev/cli/agent-kiro/): Kiro

- [Connect Antigravity to Niro](https://help.niroai.dev/cli/agent-antigravity/): Antigravity

## How it works

- [How the graph works](https://help.niroai.dev/cli/how-the-graph-works/): what the graph holds, and how to read an answer

- [Builds and updates](https://help.niroai.dev/cli/builds-and-updates/): adding another folder (`niro init`), rebuilding a graph, the background watcher, files left out

- [Worktrees and branches](https://help.niroai.dev/cli/worktrees-and-branches/): one graph per folder and branch, temporary projects, clean-up

- [Where things are stored](https://help.niroai.dev/cli/where-things-are-stored/): every file Niro writes

- [What leaves your machine](https://help.niroai.dev/cli/what-leaves-your-machine/): every upload, and the Data Processing Agreement in short

- [Secrets and masking](https://help.niroai.dev/cli/secrets-and-masking/): masking, files never opened

- [Licence and plans](https://help.niroai.dev/cli/licence-and-plans/): plans, line counting, the licence

- [Coverage audit](https://help.niroai.dev/cli/coverage-audit-and-consent/): the coverage audit and code sharing

- [Configure a folder](https://help.niroai.dev/cli/configuring-a-folder/): telling Niro what the code does not say: env values, a service's address, route rules that connect calls between services

- [Uninstall](https://help.niroai.dev/cli/uninstall/): removing Niro from this computer, or only one folder or one coding agent

## Where Niro fits

- [How Niro fits your workflow](https://help.niroai.dev/cli/lifecycle-overview/): where Niro helps at each stage of work on code: plan, write, review, test, debug

- [Plan and design with Niro](https://help.niroai.dev/cli/lifecycle-plan-and-design/): blast radius before a change

- [Write code with Niro](https://help.niroai.dev/cli/lifecycle-write-code/): agents asking the graph while coding

- [Review changes with Niro](https://help.niroai.dev/cli/lifecycle-review/): reviewing a branch

- [Choose what to test](https://help.niroai.dev/cli/lifecycle-test/): what a change reaches, which tests reach it

- [Debug with Niro](https://help.niroai.dev/cli/lifecycle-debug/): debugging with Niro: from an error to the code that throws it, its callers and its catches

- [Learn a codebase with Niro](https://help.niroai.dev/cli/lifecycle-onboarding/): learning a codebase

- [Security and privacy across the lifecycle](https://help.niroai.dev/cli/lifecycle-security-and-privacy/): security review with Niro

- [Playbook: debug an error message or a stack trace](https://help.niroai.dev/cli/playbook-debug-exception/): an error message or stack trace to its thrower, callers and catches

- [Playbook: debug a wrong value](https://help.niroai.dev/cli/playbook-debug-wrong-value/): who writes a table or field, which event delivered a value

- [Playbook: debug a failing call between services](https://help.niroai.dev/cli/playbook-debug-failing-service-call/): caller, handler, address, two services on one route

- [Playbook: "it broke after my change"](https://help.niroai.dev/cli/playbook-debug-after-a-change/): what a change reaches, tests first

- [Playbook: debug config and environment](https://help.niroai.dev/cli/playbook-debug-config/): settings the code reads, where they are set, calls with no address

- [Playbook: debug a slow path](https://help.niroai.dev/cli/playbook-debug-slow-path/): what a slow method calls and where it reads the database

- [Playbook: change code safely](https://help.niroai.dev/cli/playbook-change-safely/): callers before an edit, overloads, static imports

- [Playbook: add a feature](https://help.niroai.dev/cli/playbook-add-a-feature/): the interface to implement and existing implementations

- [Playbook: review a change](https://help.niroai.dev/cli/playbook-review-a-change/): one blast-radius call for a whole change

- [Playbook: test a change](https://help.niroai.dev/cli/playbook-test-a-change/): the tests that reach a change

- [Playbook: learn a new codebase](https://help.niroai.dev/cli/playbook-onboard/): services, routes, stores, events, types

- [Playbook: data stores and events](https://help.niroai.dev/cli/playbook-data-and-events/): readers and writers of a table, publishers and handlers of a topic

- [Get shorter answers](https://help.niroai.dev/cli/answer-shapes/): shorter tool answers: the `answer` input (exists, count, locations, names, match)

- [Tokens, speed and accuracy](https://help.niroai.dev/cli/tokens-speed-and-accuracy/): how tokens, speed and accuracy are measured, and how to measure them on your own work

- [Check what Niro did](https://help.niroai.dev/cli/evaluate-what-niro-did/): the end-of-task line, the call record, `niro impact` over 7 and 30 days, a do-it-yourself A/B

## What is supported

- [Supported languages](https://help.niroai.dev/cli/supported-overview/): computers, languages, and library counts per language

- [Supported in C](https://help.niroai.dev/cli/supported-c/)

- [Supported in C++](https://help.niroai.dev/cli/supported-cpp/)

- [Supported in C#](https://help.niroai.dev/cli/supported-csharp/)

- [Supported in Go](https://help.niroai.dev/cli/supported-go/)

- [Supported in Java](https://help.niroai.dev/cli/supported-java/)

- [Supported in JavaScript](https://help.niroai.dev/cli/supported-javascript/)

- [Supported in Kotlin](https://help.niroai.dev/cli/supported-kotlin/)

- [Supported in PHP](https://help.niroai.dev/cli/supported-php/)

- [Supported in Python](https://help.niroai.dev/cli/supported-python/)

- [Supported in Ruby](https://help.niroai.dev/cli/supported-ruby/)

- [Supported in Rust](https://help.niroai.dev/cli/supported-rust/)

- [Supported in Swift](https://help.niroai.dev/cli/supported-swift/)

- [Supported in TypeScript](https://help.niroai.dev/cli/supported-typescript/)

## Other

- [Niro CLI](https://help.niroai.dev/cli/): the start page for people

- [Features of hosted Niro](https://help.niroai.dev/cli/hosted-only/): pull request review and root cause analysis (hosted Niro)