Quick Start¶

Back to main README

Get up and running with cov-loupe in 3 steps.

1. Install¶

gem install cov-loupe

2. Generate Coverage¶

Run your test suite with SimpleCov enabled:

bundle exec rspec  # or your test command

This creates coverage/.resultset.json.

3. View Coverage¶

cov-loupe

You'll see a table showing coverage for each file, sorted by lowest coverage first.

Common Commands¶

# Check a specific file
cov-loupe summary lib/my_file.rb

# See uncovered lines
cov-loupe uncovered lib/my_file.rb

# Get overall project stats
cov-loupe totals

# View all commands
cov-loupe --help

Next Steps¶

• Installation Guide - Platform-specific setup, environment variables
• CLI Usage - Complete command reference
• Examples - Common workflows and recipes
• MCP Integration - Connect to AI assistants (Claude, ChatGPT)
• Troubleshooting - Common issues and solutions

Integration with AI Assistants¶

If you're using Claude Code, ChatGPT, or another MCP-compatible assistant:

1. Install the MCP server (see MCP Integration Guide)
2. Use ready-made prompts from Prompt Library
3. Let AI analyze your coverage and suggest improvements

Back to main README