Skip to main content

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


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.1.2.tar.gz (193.0 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.1.2-py3-none-any.whl (84.5 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for reporails_cli-0.1.2.tar.gz
Algorithm Hash digest
SHA256 f6de3ec9d7d7025e188ed266dc4c0b159e839f1875419605dddbd791df635559
MD5 86401cd365ba5436c33c2f50ef0f1f8c
BLAKE2b-256 abc7b3e2ec53b48dce27a8cb7004f9c78adc54a081ebd3087be3196e37cb2c27

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: reporails_cli-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 84.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for reporails_cli-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 b59e3eec59d8f183b59ece4c5d24e57e0a479de43a74fe14714204d236a264ee
MD5 c72c53fbb05e99ab8e3ee4b29f0ef5e3
BLAKE2b-256 38399850920c2896081697f19573cd38879d3a15da49b2ef7bc89d5bf9622f93

See more details on using hashes here.

Provenance

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