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 first.
- Never run
niro start,niro loginorniro uninstallon the user's behalf. Ask beforeniro 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: every user-visible message with an answer, linked to its explanation
- Troubleshooting: the first three checks, and where each kind of problem is answered
- MCP tools reference: every MCP tool and its inputs, as the engine serves them
- CLI commands: every niro command and option
- Engine commands: the commands niro passes to the engine (ask, ui, env, route-rule and others)
- Environment variables: every environment variable and its default
- Settings files: settings files and keys
- Exit codes: what each exit code means
- Limits: every size, time and count limit
FAQ
- FAQ: install and setup: installing, the engine, the background watcher
- FAQ: login and account: signing in, accounts
- FAQ: licence and plans: line limits, the licence
- FAQ: indexing and builds: a folder not added yet, building the graph, files left out
- FAQ: wrong or missing answers: known gaps in answers, by kind and by language
- FAQ: coding agents and MCP: connecting agents, agents not using Niro
- FAQ: worktrees and branches: branches, worktrees, temporary projects
- FAQ: privacy and security: what is sent, masking, files never read
- FAQ: performance: slow builds and answers, disk
- FAQ: updates: upgrading
- FAQ: uninstall: removing Niro from this computer: common questions
- FAQ: offline use: working without a network
- FAQ: feedback and receipts: the end-of-task line, feedback
Ways in
- Ways to connect: which ways of using Niro work today: coding agents, the terminal, review bots, CI, a shared server
- Use Niro from the terminal: niro ask, niro ui and other terminal use
- Connect your coding agent to Niro: connecting coding agents over MCP
- Review bots and Niro: review bots (not supported locally)
- Web agents: browser agents (not in a release yet; use hosted Niro)
- Niro in CI: build machines (partial)
- Shared team server: a shared server (not in a release yet)
- Connect Claude Code to Niro: Claude Code
- Connect Codex to Niro: Codex
- Connect Claude Desktop to Niro: Claude Desktop
- Connect Cursor to Niro: Cursor
- Connect Windsurf to Niro: Windsurf
- Connect VS Code (GitHub Copilot) to Niro: VS Code (GitHub Copilot)
- Connect Gemini CLI to Niro: Gemini CLI
- Connect GitHub Copilot CLI to Niro: GitHub Copilot CLI
- Connect Factory (droid) to Niro: Factory (droid)
- Connect Goose to Niro: Goose
- Connect OpenCode to Niro: OpenCode
- Connect Cline to Niro: Cline
- Connect Kiro to Niro: Kiro
- Connect Antigravity to Niro: Antigravity
How it works
- How the graph works: what the graph holds, and how to read an answer
- Builds and updates: adding another folder (
niro init), rebuilding a graph, the background watcher, files left out - Worktrees and branches: one graph per folder and branch, temporary projects, clean-up
- Where things are stored: every file Niro writes
- What leaves your machine: every upload, and the Data Processing Agreement in short
- Secrets and masking: masking, files never opened
- Licence and plans: plans, line counting, the licence
- Coverage audit: the coverage audit and code sharing
- Configure a folder: telling Niro what the code does not say: env values, a service's address, route rules that connect calls between services
- Uninstall: removing Niro from this computer, or only one folder or one coding agent
Where Niro fits
- How Niro fits your workflow: where Niro helps at each stage of work on code: plan, write, review, test, debug
- Plan and design with Niro: blast radius before a change
- Write code with Niro: agents asking the graph while coding
- Review changes with Niro: reviewing a branch
- Choose what to test: what a change reaches, which tests reach it
- Debug with Niro: debugging with Niro: from an error to the code that throws it, its callers and its catches
- Learn a codebase with Niro: learning a codebase
- Security and privacy across the lifecycle: security review with Niro
- Playbook: debug an error message or a stack trace: an error message or stack trace to its thrower, callers and catches
- Playbook: debug a wrong value: who writes a table or field, which event delivered a value
- Playbook: debug a failing call between services: caller, handler, address, two services on one route
- Playbook: "it broke after my change": what a change reaches, tests first
- Playbook: debug config and environment: settings the code reads, where they are set, calls with no address
- Playbook: debug a slow path: what a slow method calls and where it reads the database
- Playbook: change code safely: callers before an edit, overloads, static imports
- Playbook: add a feature: the interface to implement and existing implementations
- Playbook: review a change: one blast-radius call for a whole change
- Playbook: test a change: the tests that reach a change
- Playbook: learn a new codebase: services, routes, stores, events, types
- Playbook: data stores and events: readers and writers of a table, publishers and handlers of a topic
- Get shorter answers: shorter tool answers: the
answerinput (exists, count, locations, names, match) - Tokens, speed and accuracy: how tokens, speed and accuracy are measured, and how to measure them on your own work
- Check what Niro did: the end-of-task line, the call record,
niro impactover 7 and 30 days, a do-it-yourself A/B
What is supported
- Supported languages: computers, languages, and library counts per language
- Supported in C
- Supported in C++
- Supported in C#
- Supported in Go
- Supported in Java
- Supported in JavaScript
- Supported in Kotlin
- Supported in PHP
- Supported in Python
- Supported in Ruby
- Supported in Rust
- Supported in Swift
- Supported in TypeScript
Other
- Niro CLI: the start page for people
- Features of hosted Niro: pull request review and root cause analysis (hosted Niro)