Skip to main content

AI instruction diagnostics for coding agents

Project description

Reporails CLI (v0.5.8)

AI Instruction Diagnostics for coding agents. Validates the entire agentic instruction system against 92+ rules across six categories. 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. Actionable findings in seconds - fix them, run again, watch the score improve:

Reporails - Diagnostics

  ┌─ Main (4)  61 directive / 9 constraint · 71% prose
  │ CLAUDE.md  10 dir / 1 con / 1 amb · 71% prose
  │           Missing tech stack declaration - list languages, frameworks, and runtimes  CORE:C:0034
  │           Missing MCP documentation - describe MCP server configuration if applicable  CORE:C:0027
  │     ... and 3 more
  │     4 brief · 1 orphan
  │
  └─ 181 findings

  [⋯ Agents (3) · Skills (10) · Rules (13)  +318 findings ⋯]

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

  Score: 7.3 / 10  ▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓░░░░░░░░  (3.9s)
  Agent: Claude

  Scope:
    instructions: 277 directive / 448 prose (56%)
                  75 constraint / 10 ambiguous

  Main (4):     ▓▓▓▓▓▓▓▓▓▓░░░░░   6.9    Rules (13):   ▓▓▓▓▓▓▓▓▓▓▓▓░░░   7.9
  Skills (10):  ▓▓▓▓▓▓▓▓▓▓▓░░░░   7.2    Agents (3):   ▓▓▓▓▓▓▓▓▓▓░░░░░   6.9

  499 findings · 5 errors · 416 warnings · 70 info
  2 cross-file conflicts · 7 cross-file repetitions

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 score < 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

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.8.tar.gz (631.1 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.8-py3-none-any.whl (83.5 MB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: reporails_cli-0.5.8.tar.gz
  • Upload date:
  • Size: 631.1 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.8.tar.gz
Algorithm Hash digest
SHA256 fbff729878972ceccadfe849bbed9aeef5dd6cb7f58b5edd29f7fad0f737a49d
MD5 b741360a80c4bb626e3f0eaf874afb61
BLAKE2b-256 c3b0bafa2f2b23caae2dec9f0d4ce57be80a6e5da94c2a773a926b4bc80b3ea2

See more details on using hashes here.

Provenance

The following attestation bundles were made for reporails_cli-0.5.8.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.8-py3-none-any.whl.

File metadata

  • Download URL: reporails_cli-0.5.8-py3-none-any.whl
  • Upload date:
  • Size: 83.5 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.8-py3-none-any.whl
Algorithm Hash digest
SHA256 f5c5a018c76527bf6eb63517df1ca5db1fb1581bd66d5109ccbd443540043ff6
MD5 7fa8c306b482845b067abd687184985c
BLAKE2b-256 f8805283196c7af376756bcc0ec39a9aaafd8510615e9b2e5db76647040deeab

See more details on using hashes here.

Provenance

The following attestation bundles were made for reporails_cli-0.5.8-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