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

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

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 Maintained 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 --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


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.2.0.tar.gz (218.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.2.0-py3-none-any.whl (94.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: reporails_cli-0.2.0.tar.gz
  • Upload date:
  • Size: 218.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.2.0.tar.gz
Algorithm Hash digest
SHA256 40232c742060d5c10b93ddc550e13a8d2393469b3b25a17835c2643cf4248b5a
MD5 a435a33cb8b29d9cc7934583f3525649
BLAKE2b-256 566c0c603593320887f9aff6bcf2792d6433d7c0e167f754f2cb47397fa10878

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: reporails_cli-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 94.6 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.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 920474a8d73a5846ab471b8fd09d101dd17afbd9810428a402243935fb6b3f65
MD5 f2794ce4f0562dd9325cf47b55514090
BLAKE2b-256 846c8f492f88542ba514f673b816089a4f24ae082ceeea59919be66127a22d95

See more details on using hashes here.

Provenance

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