Skip to main content

Install and Run the CLI

rei runs the same analyzers as the desktop app from a terminal — no UI, no Electron, just results. Useful for scripting, CI, or anyone who’d rather pipe output into another tool than click through tabs.

Install

Requires Node.js 18 or newer.

Run your first analysis

With no --path, it analyzes the current directory. By default you’ll see a colored terminal summary — one line per signal, with a ✓ / ⚠ / ✗ status icon based on whether the score clears your warn/fail thresholds (70/50 by default, configurable — see the CLI reference).

Other output formats

JSON output is the one to reach for if you’re piping into another tool:

Re-analyze on every commit

Stays running, re-analyzes automatically whenever you commit. Press Ctrl+C to stop.

Picking up project config

If the repo has a committed .reikon/config.json, rei reads it automatically — same teams, aliases, and ignore paths the desktop app would use. Nothing extra to configure.

Next