Browse docs
Izri docs

Documentation

Everything you need to install Izri, understand the four signals, and configure them for your repository. Every page is also available as raw markdown — append .md to any URL. Agents can curl /llms.txt for the curated map or /llms-full.txt for the whole corpus in one shot.

21 pages.

Getting started

  • Four independent signals, one merge verdict — what Izri computes, and what it deliberately does not.

  • Add the GitHub Action, mint a token, and get your first verdict on a pull request in about five minutes.

  • How to read the izri/quality check and the sticky pull-request comment, and what passing and failing actually mean.

Install

  • The recommended install path — every input, every output, and how to make the verdict block a merge.

  • Install @izri/cli, configure it with three environment variables, and run the four signals from your terminal.

  • Mount @izri/mcp in Claude Code, Cursor, or Windsurf so your coding agent can score its own pull requests.

  • Run Izri on your own infrastructure with Docker Compose — services, environment, and the runner you must not forget.

The four signals

  • How four independent signals aggregate into one izri/quality verdict — every weight, every hard rule, and what each severity does.

  • Does the diff match what the pull request says it does — and did it touch paths it shouldn't?

  • Did the relevant tests run against this diff, and did they pass?

  • Your suite went green — but did any of those tests touch the lines you changed?

  • Did the rendered UI change on the routes this diff touches — and does the change matter?

Configure

  • The checked-in config that teaches the scope signal your project's modules, categories, and sensitive paths.

  • Connect the GitHub App, bind repositories to projects, and understand how Izri resolves which project a diff belongs to.

  • Every permission in Izri is organization-scoped — the four roles, the scopes each one grants, and what that means for tokens.

  • Mint, scope, and rotate the izri_ tokens the CLI, Action, and MCP server authenticate with.

  • Receive a POST when Izri emits an event — the three event types, signature verification, and the retry model.

Reference

  • The HTTP surface — authentication, the REST endpoints, and where tRPC takes over.

  • Every status, what it means, and exactly how it maps to a CI exit code — enough to write a build script against without reading source.

  • Four tiers, priced per organization rather than per seat — what each unlocks and what happens when you hit a quota.

  • Organized by what you're seeing, not by which subsystem is at fault — find your symptom and the fix.