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
Pre-1.0 — moving fast, API still evolving, feedback welcome.
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 --refresh --from 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: Maintained (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
Capability levels describe what your AI instruction setup enables — not how "mature" it is. Different projects need different capabilities.
| Level | Name | What It Enables |
|---|---|---|
| L0 | Absent | No instruction file — nothing to evaluate |
| L1 | Basic | Reviewed, tracked instruction file |
| L2 | Scoped | Project-specific constraints, size control |
| L3 | Structured | External references, multiple files |
| L4 | Abstracted | Path-scoped rules, context-aware loading |
| L5 | Maintained | Structural integrity, governance, navigation |
| L6 | Adaptive | Dynamic context, extensibility, persistence |
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 --no-update-check # Skip pre-run update prompt
ails check --exclude-dir vendor # Exclude directory from scanning
ails explain CORE:S:0001 # Explain a rule
ails map # Show project structure
ails map --save # Generate backbone.yml
ails update # Update rules framework + recommended
ails update --check # Check for updates without installing
ails update --recommended # Update recommended rules only
ails update --force # Force reinstall even if current
ails update --cli # Upgrade the CLI package itself
ails dismiss CORE:C:0001 # Dismiss a semantic finding
ails version # Show version info
Updating
ails update # Update rules framework + recommended to latest
ails update --check # Check for updates without installing
ails update --recommended # Update recommended rules only
ails update --force # Force reinstall even if current
ails update --cli # Upgrade the CLI package itself
Before each scan, the CLI checks for available updates and prompts to install. Use --no-update-check to skip.
Ephemeral runners (uvx, npx) always use the latest CLI version automatically.
Recommended Rules
Recommended rules (AILS_ namespace) are included by default and auto-downloaded on first run. To opt out, add to your .reporails/config.yml:
recommended: false
To update recommended rules independently:
ails update --recommended
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
BUSL 1.1
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.2.1.tar.gz.
File metadata
- Download URL: reporails_cli-0.2.1.tar.gz
- Upload date:
- Size: 220.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
97db64f66522139d2e5aa85b3f6b4331f019572229e53380f99065013f012991
|
|
| MD5 |
4350919f17357c786837fa170ad99b98
|
|
| BLAKE2b-256 |
180f7536cdfb4d73747dabe6f1c59ca4ab1264845da256694d2270c7d9eb1889
|
Provenance
The following attestation bundles were made for reporails_cli-0.2.1.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.2.1.tar.gz -
Subject digest:
97db64f66522139d2e5aa85b3f6b4331f019572229e53380f99065013f012991 - Sigstore transparency entry: 942372778
- Sigstore integration time:
-
Permalink:
reporails/cli@dbe96e9cb2e0c50403c5af7b652a73673a1c3616 -
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@dbe96e9cb2e0c50403c5af7b652a73673a1c3616 -
Trigger Event:
push
-
Statement type:
File details
Details for the file reporails_cli-0.2.1-py3-none-any.whl.
File metadata
- Download URL: reporails_cli-0.2.1-py3-none-any.whl
- Upload date:
- Size: 107.8 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 |
1aa91d0419946a0e236d30ca30a764ee0e13c3f93bad5e341d2062c4e7828aa5
|
|
| MD5 |
b817ea2a997b94b7943b002ae7cb4d66
|
|
| BLAKE2b-256 |
bbba13584128e86b81306c1fc1361554abecbfb1cf49eaf373de342d0d4111d7
|
Provenance
The following attestation bundles were made for reporails_cli-0.2.1-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.2.1-py3-none-any.whl -
Subject digest:
1aa91d0419946a0e236d30ca30a764ee0e13c3f93bad5e341d2062c4e7828aa5 - Sigstore transparency entry: 942372785
- Sigstore integration time:
-
Permalink:
reporails/cli@dbe96e9cb2e0c50403c5af7b652a73673a1c3616 -
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@dbe96e9cb2e0c50403c5af7b652a73673a1c3616 -
Trigger Event:
push
-
Statement type: