AI instruction diagnostics for coding agents
Project description
Reporails CLI (v0.5.6)
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
- 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
- FAQ - common questions
Built and validated for
License
BUSL 1.1 - converts to Apache 2.0 three years after each release.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file reporails_cli-0.5.6.tar.gz.
File metadata
- Download URL: reporails_cli-0.5.6.tar.gz
- Upload date:
- Size: 598.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
32d5e86a3fe118e4199b4de81a22f87358a449cd6a8159f6f7c2a709abc359a2
|
|
| MD5 |
033dbd331383215b4c375978659af70a
|
|
| BLAKE2b-256 |
4f32fa3961ee378aba529749f1b0564b3304e8d898b7ec89a101a6d3b52be7af
|
Provenance
The following attestation bundles were made for reporails_cli-0.5.6.tar.gz:
Publisher:
release.yml on reporails/cli
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
reporails_cli-0.5.6.tar.gz -
Subject digest:
32d5e86a3fe118e4199b4de81a22f87358a449cd6a8159f6f7c2a709abc359a2 - Sigstore transparency entry: 1438830841
- Sigstore integration time:
-
Permalink:
reporails/cli@ec3adfb8c62764590b6783af01b56c7ef32c30ad -
Branch / Tag:
refs/heads/main - Owner: https://github.com/reporails
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@ec3adfb8c62764590b6783af01b56c7ef32c30ad -
Trigger Event:
push
-
Statement type:
File details
Details for the file reporails_cli-0.5.6-py3-none-any.whl.
File metadata
- Download URL: reporails_cli-0.5.6-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
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
ec93b58afdeeee6443a289376abe3082e53abb09fda3194db1f2c6ba2685c97c
|
|
| MD5 |
8ab5ab90b6d00acff384156268528e7c
|
|
| BLAKE2b-256 |
d97ecd11a7d1f444f24b1cdee2e4c75c4efe8f7481c0b3650895005ec03e7029
|
Provenance
The following attestation bundles were made for reporails_cli-0.5.6-py3-none-any.whl:
Publisher:
release.yml on reporails/cli
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
reporails_cli-0.5.6-py3-none-any.whl -
Subject digest:
ec93b58afdeeee6443a289376abe3082e53abb09fda3194db1f2c6ba2685c97c - Sigstore transparency entry: 1438830890
- Sigstore integration time:
-
Permalink:
reporails/cli@ec3adfb8c62764590b6783af01b56c7ef32c30ad -
Branch / Tag:
refs/heads/main - Owner: https://github.com/reporails
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@ec3adfb8c62764590b6783af01b56c7ef32c30ad -
Trigger Event:
push
-
Statement type: