Validate and score CLAUDE.md files — MCP-first AI context governance
Project description
Reporails CLI
Score your CLAUDE.md files. See what's missing. Improve your AI coding setup. Why this exists
Quick Start
One-line install (npm)
npx @reporails/cli install
This registers the MCP server with Claude Code. Then ask Claude: What ails claude?
MCP Integration (manual)
For full semantic analysis, add the MCP server:
# Add the MCP and restart Claude
claude mcp add reporails -- uvx reporails-cli ails-mcp
Then ask Claude:
❯ What ails claude?
CLI path (only deterministic rules)
# No install needed — run directly
uvx reporails-cli check
# or
npx @reporails/cli check
That's it. You'll get a score, capability level, and actionable violations.
╔══════════════════════════════════════════════════════════════╗
║ SCORE: 8.1 / 10 (partial) | CAPABILITY: Governed (L5) ║
║ ▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓░░░░░░░░░░░ ║
╚══════════════════════════════════════════════════════════════╝
Violations:
CLAUDE.md (7 issues)
○ MED C4.no-antipatterns :1 No NEVER or AVOID statements found
· LOW C12.no-version :1 No version or date marker found
...
Fix the issues, run again, watch your score and your experience improve.
Install
# Ephemeral (no install, always latest)
uvx reporails-cli check
npx @reporails/cli check
# Persistent (adds `ails` to PATH)
pip install reporails-cli
# or
npm install -g @reporails/cli
Once installed, all commands use ails directly.
What It Checks
- Structure — File organization, size limits
- Content — Clarity, completeness, anti-patterns
- Efficiency — Token usage, context management
- Maintenance — Versioning, review processes
- Governance — Ownership, security policies
Capability Levels
| Level | Name | What it means |
|---|---|---|
| L1 | Absent | No instruction file |
| L2 | Basic | Has CLAUDE.md |
| L3 | Structured | Sections, imports |
| L4 | Abstracted | .claude/rules/ directory |
| L5 | Governed | Shared files, 3+ components |
| L6 | Adaptive | Backbone + full governance |
Commands
ails check # Score your setup
ails check -f json # JSON output (for CI)
ails check --strict # Exit 1 if violations (for CI)
ails check --with-recommended # Include recommended rules
ails explain S1 # Explain a rule
ails map # Show project structure
ails map --save # Generate backbone.yml
ails update # Update rules framework
ails update --check # Check for rule updates
ails dismiss C6 # Dismiss a semantic finding
ails version # Show version info
Updating
The rules framework updates separately from the CLI:
ails update # Update rules to latest
ails update --check # Check without installing
The CLI itself updates automatically with ephemeral runners (uvx, npx).
Persistent installs: pip install --upgrade reporails-cli or npm install -g @reporails/cli@latest
Recommended Rules
The --with-recommended flag adds community recommended rules on top of the core set. These are methodology-backed checks (AILS_ namespace) that are auto-downloaded on first use:
ails check --with-recommended # Include recommended rules
ails update --recommended # Re-fetch latest recommended rules
Prerequisites
Depends on your install path:
- uvx/pip path: uv — no separate Python install needed
- npx/npm path: Node.js >= 18 — uv is auto-installed if missing
- MCP install/uninstall: Claude Code
Rules
Core rules are maintained at reporails/rules. Recommended rules at reporails/recommended.
Want to add or improve rules? Please follow Contribute guide in the Core repo.
License
Apache 2.0
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.1.0.tar.gz.
File metadata
- Download URL: reporails_cli-0.1.0.tar.gz
- Upload date:
- Size: 180.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
fc295d041fa75e003d9ba58cd382afcabca9b8f8d0268ae4878ac238822f19f4
|
|
| MD5 |
01a74398373f2d7e9022b5dc12e35d86
|
|
| BLAKE2b-256 |
8c0d6be8fcb4f8bbe563e8fc44fe3b9ef27fd7d14129a91b8464cab1892daa4f
|
Provenance
The following attestation bundles were made for reporails_cli-0.1.0.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.1.0.tar.gz -
Subject digest:
fc295d041fa75e003d9ba58cd382afcabca9b8f8d0268ae4878ac238822f19f4 - Sigstore transparency entry: 894882558
- Sigstore integration time:
-
Permalink:
reporails/cli@b4af59d2a6358e0e097303a3c7dfc4dd979fa3c9 -
Branch / Tag:
refs/tags/0.1.0 - Owner: https://github.com/reporails
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@b4af59d2a6358e0e097303a3c7dfc4dd979fa3c9 -
Trigger Event:
release
-
Statement type:
File details
Details for the file reporails_cli-0.1.0-py3-none-any.whl.
File metadata
- Download URL: reporails_cli-0.1.0-py3-none-any.whl
- Upload date:
- Size: 79.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
d78df52981da52b40c511e40c72dd61f0d4c2247ea189ed8bc9dcdc3fcba2546
|
|
| MD5 |
bc0a1cad6d60468d1c8ba13322684179
|
|
| BLAKE2b-256 |
b9e200cc2cc5914752474b09f8e91360ca78620549d675e4c468ce4a17d05c1b
|
Provenance
The following attestation bundles were made for reporails_cli-0.1.0-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.1.0-py3-none-any.whl -
Subject digest:
d78df52981da52b40c511e40c72dd61f0d4c2247ea189ed8bc9dcdc3fcba2546 - Sigstore transparency entry: 894882575
- Sigstore integration time:
-
Permalink:
reporails/cli@b4af59d2a6358e0e097303a3c7dfc4dd979fa3c9 -
Branch / Tag:
refs/tags/0.1.0 - Owner: https://github.com/reporails
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@b4af59d2a6358e0e097303a3c7dfc4dd979fa3c9 -
Trigger Event:
release
-
Statement type: