Documentation
CLI reference, framework reference, and per-agent integration notes.
Guides for the Reporails CLI — install, run a one-off check, interpret scores, configure per-agent. Source markdown lives in the cli/docs directory and is synced into this site.
Filtering by
Getting Started
Quick start From the root of any repository that has at least one instruction file (CLAUDE.md, AGENTS.md, .cursorrules, .github/copilot-instructions.md, or GEMINI.md) — no install, no account: npx @reporails/cli check # or uvx --from…Agent Support
Reporails recognizes the instruction-file conventions of five coding agents and runs the rules that match the files actually present in your repo. Each agent has its own root config plus optional rule / skill / sub-agent directories and (…Tiers and Limits
Reporails has two access modes: anonymous (no account, no setup) and signed in (free, GitHub Device Flow). The CLI auto-detects which mode you're in based on whether ails auth login has been run, and the diagnostic backend applies the…Configuration
Reporails provides two configuration surfaces: global (per-user) and project (per-repo). Project config wins where both define the same key — global supplies the defaults, project overrides per-repo. Project config — .ails/config.yml Lives…Score Guide
Every ails check run produces a single composite score between 0 and 10, plus per-surface scores for the parts of your instruction system that have content (Main / Rules / Skills / Agents / Memory). The number is meant to give you a quick…Capability Levels
ails check reports a Level: L# <Name> line in the scorecard between Agent: and Scope:. The level is a read-out, not a gate — every rule fires when its match conditions apply regardless of which level your project is at. Use the level…FAQ
Why is my score lower than I expected? The score is a single quality verdict, not a tally of findings. It measures how strongly your instructions are written — how specific, direct, and well-structured they are, and how little they compete…