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 a folder 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 reporails-cli ails…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 tiers: Free and Pro. Free is every user without an active Pro subscription — whether you are anonymous (no account) or signed in with a free account. Both share identical limits and identical diagnostic detail: the score…Configuration
Reporails provides two configuration surfaces: global (per-user) and project (per-repo). Global supplies the defaults and project overrides them per-repo: a single-value setting takes the project value, and a list setting combines both…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…