CPANCOVER(1)

💖 NAME 💖

okay bestie, welcome to CPANCOVER(1) — a User Contributed Perl Documentation moment — aka cpancover, and it's literally here to report coverage statistics on CPAN modules ✨ no cap, that's the whole name vibe.

🌸 VERSION 🌸

version 1.50 — periodt 💅

✨ SYNOPSIS ✨

okay so here's the exact command-line blueprint, and yes I'm keeping it character-for-character because we do not play with syntax around here 🫶

  cpancover --help --info --version
            --collect --redo_cpancover_html --redo_html --force --dryrun
            --modules module_name
            --results_dir /path/to/dir
            --outputdir /path/to/dir
            --outputfile filename.html
            --report report_name
            --generate_html
            --compress_old_versions number_to_keep
            --local
            --local_build

also peep --results_dir /path/to/dir up in the synopsis — the original options list doesn't give it its own separate line, so I'm not out here inventing extra lore for it 👀

💅 DESCRIPTION 💅

okay so the original page slides straight from the DESCRIPTION heading into the options, so there's no extra prose here to rewrite. We're not making up technical backstory, bestie — we're just moving on with main character energy 🎀

🔥 OPTIONS 🔥

the command line is giving options, and here's the full lineup. defaults are in the parentheses exactly like the page serves them ✨

• -h, --help — show help
• -i, --info — show documentation
• -v, --version — show version
• --collect — collect coverage from modules (on)
• --compress_old_versions — compress data older than n versions (3)
• --directory — location of the modules ($cwd)
• --dryrun — don't execute (for some commands) (off)
• --force — recollect coverage (off)
• --generate_html — generate html (off)
• --local — use local (uninstalled) code (off)
• --local_build — build coveraage for all the modules (off)
• --modules — modules to use (all in $dir)
• --outputdir — where to store output ($directory)
• --outputfile — top level index (coverage.html)
• --redo_cpancover_html — don't set default modules (off)
• --redo_html — force html generation for modules (off)
• --report — report to use (html_basic)

small note: I kept the coveraage spelling exactly as the original has it — no autocorrect, no cap 💅

🦋 DETAILS 🦋

the original page doesn't add extra prose under this heading, so this is just the DETAILS section doing its little moment. no invented details from me, bestie 🫶

🌈 REQUIREMENTS 🌈

Collect coverage for results and create html, csv and json output.

The modules Template and Parallel::Iterator are required. iconic, necessary, required — that's the vibe 🔥

⭐ EXIT STATUS ⭐

The following exit values are returned:

• 0 — All operations were completed successfully.
• >0 — An error occurred.

💜 SEE ALSO 💜

Devel::Cover — go peep that one too, iykyk 👑

💀 BUGS 💀

Undocumented.

🎀 LICENCE 🎀

Copyright 2002-2025, Paul Johnson (paul@pjcj.net)

This software is free. It is licensed under the same terms as Perl itself.

The latest version of this software should be available from my homepage: https://pjcj.net

---

okay that's the whole page, bestie — source/version perl v5.42.0, date 2025-06-11, manual CPANCOVER(1) — mwah 💋✨