Skip to content

Other commands

Analysis and ops commands that are not the golden path (initchecksuggestrecord). Each section is synopsis + flags + one example — scan, don’t scroll a tutorial.

Command One-liner
pr-comment Post coverage as a PR/MR comment
compare Diff two coverage profiles
badge Write an SVG coverage badge
trend Show history trend
record Append a history snapshot
suggest Propose domain thresholds
debt Rank coverage gaps
ignore List exclude patterns
detect Autodetect domains / write config
mcp MCP server / doctor
version / help Meta

Terminal window
coverctl pr-comment [flags]

Posts a coverage report on GitHub, GitLab, or Bitbucket. Prefer CI after coverctl check.

Flag Description Default
-c, --config Config path .coverctl.yaml
-p, --profile Coverage profile .cover/coverage.out
--base-profile Base profile for deltas
--provider github / gitlab / bitbucket / auto auto
--pr PR/MR number auto-detected
--owner / --repo Repository identity auto-detected
--update Update existing coverctl comment true
--dry-run Print body without posting false
Terminal window
coverctl pr-comment --pr 123 --dry-run

Provider tokens: GITHUB_TOKEN, GITLAB_TOKEN / CI_JOB_TOKEN, or BITBUCKET_TOKEN (+ workspace/repo vars).


Terminal window
coverctl compare --base <profile> [--head <profile>]
Flag Description Default
--base Base profile (required)
--head Head profile .cover/coverage.out
-o, --output text / json text
Terminal window
coverctl compare --base main.out --head .cover/coverage.out -o json

Terminal window
coverctl badge [flags]
Flag Description Default
-p, --profile Coverage profile .cover/coverage.out
-o, --output SVG path coverage.svg
--label Badge label coverage
--style flat / flat-square flat
Terminal window
coverctl badge -o docs/badge.svg --style flat-square

Terminal window
coverctl trend [flags]
Flag Description Default
--history History file .cover/history.json
-o, --output text / json text
Terminal window
coverctl trend -o json

Terminal window
coverctl record [flags]

Prefer profiles from coverctl check / coverctl run so history matches policy instrumentation.

Flag Description Default
-p, --profile Coverage profile .cover/coverage.out
--history History file .cover/history.json
--commit / --branch Git metadata auto-detected
--run Run coverage before recording false
-l, --language Override language detection auto
Terminal window
coverctl record --commit "$GITHUB_SHA" --branch "$GITHUB_REF_NAME"

Terminal window
coverctl suggest [--strategy current|aggressive|conservative]
Strategy Behavior
current Thresholds slightly below observed coverage
aggressive Push targets up
conservative Smaller incremental mins
Terminal window
coverctl suggest --strategy current

Terminal window
coverctl debt [flags]

Ranks files/domains by shortfall vs policy. Use after a failing check to decide where to write tests.

Terminal window
coverctl debt -o json

Terminal window
coverctl ignore

Lists exclude patterns from .coverctl.yaml and matching files.


Terminal window
coverctl detect [--dry-run] [--force]

Non-interactive domain detection (sibling of coverctl init --no-interactive).

Terminal window
coverctl detect --dry-run

Terminal window
coverctl mcp serve [--mode=agent|ci|auto] [--mcp-telemetry]
coverctl mcp doctor

Agent mode advertises check / suggest / debt. Use --mode=ci for the full tool surface. doctor validates MCP wiring end-to-end. Full contract: MCP server.


Terminal window
coverctl version
Terminal window
coverctl help [command]
coverctl check --help

Same family as the rest of the CLI: 0 success, 1 policy/soft failure, 2 usage/config, 3 runner failure (where applicable).

Next