Reporails CLI

Reporails CLI is a command-line interface designed to evaluate and enhance the configuration of your AI coding agent by checking CLAUDE.md files against predefined guidelines. This tool highlights any deficiencies, allowing users to refine their coding setup effectively.

Key Features

The CLI provides a comprehensive score for your setup, offering insights into various aspects:

• Structure: Assesses file organization and adheres to size limits.
• Content: Evaluates clarity, completeness, and identifies anti-patterns.
• Efficiency: Monitors token usage and manages context efficiently.
• Maintenance: Reviews versioning and establishes processes for ongoing updates.
• Governance: Ensures compliance with ownership and security policies.

Getting Started

To achieve full semantic analysis, integration with the MCP (Multi-Component Processor) server is recommended. The below command initializes this integration, after which users can query the status of their setup.

# Add the MCP and restart Claude
claude mcp add reporails -- uvx reporails-cli ails-mcp

Once set up, the following command can be used to quickly check your project:

# Check your setup (auto-installs OpenGrep + rules on first run)
uvx reporails-cli check .

This will yield a detailed output, allowing users to see their score along with specific violations detected in their CLAUDE.md files:

╔══════════════════════════════════════════════════════════════╗
║   SCORE: 8.1 / 10 (partial)  |  CAPABILITY: Governed (L5)    ║
║   ▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓░░░░░░░░░░░         ║
╚══════════════════════════════════════════════════════════════╝

Capability Levels

Assessing the capability of your coding setup is straightforward. Each level signifies a different state of readiness:

Commands Summary

Users can leverage a variety of commands to enhance their workflow:

ails check .              # Score your setup
ails check . -f json      # JSON output (for CI)
ails check . --strict     # Exit 1 if violations (for CI)
ails map .                # Show project structure
ails map . --save         # Generate backbone.yml
ails explain S1           # Explain a rule

For further customization and rule refinement, users are encouraged to contribute through reporails/rules.

By utilizing Reporails CLI, improve the quality and governance of AI coding setups to ensure they meet established standards.