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.1.tar.gz (184.2 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.1-py3-none-any.whl (80.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: reporails_cli-0.1.1.tar.gz
  • Upload date:
  • Size: 184.2 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.1.tar.gz
Algorithm Hash digest
SHA256 d7c466152aa83971d3d253d86015196434b8df2a0bdc49f6de0da5e018e44317
MD5 989c7308d5d60b26c7fd29af366a6462
BLAKE2b-256 f423e1ca21f1b43062551ecf16e5913ba3dcd581a3f1de4f79393ca8b96bdbc4

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: reporails_cli-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 80.7 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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 60d1d6442090e4c2140254e21224d06b2bd4e03a6fe63dcf5b7316977335e4e1
MD5 abae4a4f31d2bb079bd8a78afad67831
BLAKE2b-256 c1c25620c5faaf8f0c4efca6b98619b5f7c74ee1f18c9f5e9003ba160ac9c75f

See more details on using hashes here.

Provenance

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