Skip to main content

AI instruction diagnostics for coding agents

Project description

Reporails CLI (v0.5.12)

AI Instruction Diagnostics for coding agents. Validates the entire agentic instruction system against 120+ rules across six rule packs (core + per-agent). Supports Claude, Codex, Copilot, Cursor, and Gemini.

Beta phase - moving fast, feedback welcome.

Quick Start

npx @reporails/cli check
# or
uvx --from reporails-cli ails check

No install, no account. The headline is a single Quality score (the analysis service's verdict on how well-formed your instructions are); fix the findings that move it, run again, watch it climb:

Reporails — Diagnostics

  ┌─ Main (1)  10 directive / 1 constraint · 71% prose
  │ CLAUDE.md  10 dir / 1 con / 1 amb · 71% prose
  │   ✗       Missing tech stack declaration — list languages, frameworks, runtimes  CORE:C:0034
  │       → Name the languages, frameworks, and runtimes the project targets.
  │   ⚠       'pytest' should be in backticks (×3)  CORE:E:0003
  │       → Wrap in backticks: `pytest`
  │     ◦ +4 lower-priority (won't move your score yet) · -v to list
  │     ⊕ 6 Pro diagnostics (1 error) — isolated instructions, buried directives
  │
  └─ 12 findings

  ── Summary ────────────────────────────────────────────────────────

  Quality   6.4 / 10  ▓▓▓▓▓▓▓▓▓▓▓▓░░░░░░░░  (4.1s)
  Findings 3 errors · 38 warnings · 12 info
  Agent: Claude
  Level: L4 Delegated

  Scope:
    instructions: 64 directive / 102 prose (61%)
                  18 constraint / 4 ambiguous

  Main (1):    ▓▓▓▓▓▓▓▓▓░░░░░░   6.4  1 err    Rules (2):   ▓▓▓▓▓▓▓▓▓▓▓▓░░░   7.9
  Skills (3):  ▓▓▓▓▓▓▓▓▓▓▓░░░░   7.2           Agents (1):  ▓▓▓▓▓▓▓▓▓▓░░░░░   6.6

  + 41 Pro diagnostics (1 error · 32 warnings) — sign in for line numbers + fix coordinates

Install permanently

npx @reporails/cli install
# or
uvx --from reporails-cli ails install

Puts ails on your PATH.

Anonymous vs signed

Anonymous mode needs no account. Signing in raises the rate / payload caps and unlocks per-finding fix text and exact cross-file conflict locations.

# GitHub Device Flow - authorize in browser
ails auth login

Full breakdown: Tiers and Limits.

In CI

Run on every PR so instruction-quality regressions (contradictions, oversized files, weak reinforcement) get caught the same way test or lint regressions do — before merge, not after a teammate's agent has been silently misbehaving for a week.

- uses: reporails/cli/action
  with:
    api-key: ${{ secrets.REPORAILS_API_KEY }}   # optional - sign-in for full diagnostic detail
    strict: "true"                              # exit 1 if any rule fires
    min-score: "7.0"                            # exit 1 if Quality < 7.0

Capture your API key with ails auth token and store it as REPORAILS_API_KEY in your CI secret store. See Configuration → Authentication.

Documentation

  • Getting Started - install, first run, what the output means
  • Agent Support - which agents are recognized and what's covered
  • Tiers and Limits - anonymous vs signed in, what each mode includes
  • Configuration - disabling rules, project / global config, exclude paths
  • Score Guide - how the score is built and what it tells you
  • Capability Levels - the L0-L7 ladder and what each level requires
  • Rules CLI - ails rules list --capability=skill and friends — preflight rules before authoring
  • FAQ - common questions

Built and validated for

License

BUSL 1.1 - converts to Apache 2.0 three years after each release.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

reporails_cli-0.5.12.tar.gz (755.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

reporails_cli-0.5.12-py3-none-any.whl (96.4 MB view details)

Uploaded Python 3

File details

Details for the file reporails_cli-0.5.12.tar.gz.

File metadata

  • Download URL: reporails_cli-0.5.12.tar.gz
  • Upload date:
  • Size: 755.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for reporails_cli-0.5.12.tar.gz
Algorithm Hash digest
SHA256 63457d93ca3d4a3d5ac0b5ce89d92a563a288890d41b6d083e79f8d81d55b9e1
MD5 4b47a962dfb523591c4a86f0f9bc9098
BLAKE2b-256 5e2b8560f084a826e0c315f09d068daf82cd834a11954feb29c4251b117c44f0

See more details on using hashes here.

Provenance

The following attestation bundles were made for reporails_cli-0.5.12.tar.gz:

Publisher: release.yml on reporails/cli

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file reporails_cli-0.5.12-py3-none-any.whl.

File metadata

  • Download URL: reporails_cli-0.5.12-py3-none-any.whl
  • Upload date:
  • Size: 96.4 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for reporails_cli-0.5.12-py3-none-any.whl
Algorithm Hash digest
SHA256 18122b71ea75d47fed7d500883fea4ca14fdc447cbb84ed6a4952b4d939285db
MD5 ba38e86eddb273c5c285ddfba34504b4
BLAKE2b-256 519c96a2fedfebd95025001e080718b16164d8cdd203b89c6dc9e5fda4d01530

See more details on using hashes here.

Provenance

The following attestation bundles were made for reporails_cli-0.5.12-py3-none-any.whl:

Publisher: release.yml on reporails/cli

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page