GRCOV(1)

📦
version 0.10.7 · 6 versions
, in ubuntu stonking

💖 GRCOV(1) — User Commands energy 💖

okay bestie, pull up a chair, we're doing grcov(1), the coolest little coverage gremlin in the User Commands section 💅

✨ NAME ✨

grcov — literally just grcov, that's the whole name, she needs no introduction 👑

🌈 SYNOPSIS 🌈

grcov [OPTIONS] <PATHS>...

she takes paths and she takes options and she does the thing 🦋

🎀 DESCRIPTION 🎀

grcov — brought to you by Marco Castelluccio <mcastelluccio@mozilla.com> 🫶 — parses, collects and aggregates code coverage data for multiple source files. that's it. that's the whole job. she ate and left no crumbs 💖

🌸 Arguments:

  • <PATHS>... — sets the input paths to use 🔥 like, the actual files you want her to look at, bestie. feed her the paths.

💅 OPTIONS 💅

the main character section. every single flag, all of them, no skips, no cuts, periodt ✨

  • -b, --binary-path <PATH> — sets the path to the compiled binary to be used 🧚
  • --llvm-path <PATH> — sets the path to the LLVM bin directory 🍓
  • -t, --output-types <OUTPUT TYPE> — comma separated list of custom output types, and bestie there are SO many flavors 🌈:
    • html for a HTML coverage report
    • coveralls for the Coveralls specific format
    • lcov for the lcov INFO format
    • covdir for the covdir recursive JSON format
    • coveralls+ for the Coveralls specific format with function information
    • ade for the ActiveData-ETL specific format
    • files to only return a list of files
    • markdown for human easy read
    • cobertura for output in cobertura format
    • cobertura-pretty to pretty-print in cobertura format

[default: lcov] — so if you don't say anything she picks lcov for you, she's thoughtful like that 💖

  • -o, --output-path <PATH> — specifies the output path. this is a file for a single output type and must be a folder for multiple output types 📁 (yes, one type = file, many types = folder, don't fight her on this)
  • --output-config-file <PATH> — specifies the output config file 🎀
  • -s, --source-dir <DIRECTORY> — specifies the root directory of the source files 🌸
  • -p, --prefix-dir <PATH> — specifies a prefix to remove from the paths (like, e.g. if grcov is run on a different machine than the one that generated the code coverage information) 🖥️✨
  • --ignore-not-existing — ignore source files that can't be found on the disk 🙈 ghost files? not her problem
  • --ignore-parsing-error — ignore error when parsing the coverage files 💀 she's choosing peace
  • --ignore <PATH> — ignore files/directories specified as globs 🦋
  • --keep-only <PATH> — keep only files/directories specified as globs 👑
  • --path-mapping <PATH> — yeah the manpage gives you no description here, bestie, she just exists. iconic mysterious behavior fr fr
  • --branch — enables parsing branch coverage information 🌿
  • --filter <FILTER> — filters out covered/uncovered files. use 'covered' to only return covered files, 'uncovered' to only return uncovered files 🔍

[possible values: covered, uncovered]

  • --sort-output-types <OUTPUT TYPES> — comma separated list of output types to sort files lexicographically for 📚

[default: markdown]

  • --llvm — speeds-up parsing, when the code coverage information is exclusively coming from a llvm build ⚡
  • --token <TOKEN> — sets the repository token from Coveralls, required for the 'coveralls' and 'coveralls+' formats 🔑 (required bestie, don't forget it)
  • --commit-sha <COMMIT HASH> — sets the hash of the commit used to generate the code coverage data 💾
  • --service-name <SERVICE NAME> — sets the service name 🏷️
  • --service-number <SERVICE NUMBER> — sets the service number 🔢
  • --service-job-id <SERVICE JOB ID> — sets the service job id 💼

[aliases: --service-job-number]

  • --service-pull-request <SERVICE PULL REQUEST> — sets the service pull request number 🫶
  • --service-flag-name <SERVICE FLAG NAME> — sets the service flag name for coveralls parallel/carryover mode 🚩
  • --parallel — sets the build type to be parallel for 'coveralls' and 'coveralls+' formats 🏃♀️💨
  • --threads <NUMBER> — another one where the manpage just leaves you hanging, no description, she's a woman of mystery 🧚 (but the number is right there in the name, iykyk)
  • --precision <NUMBER> — sets coverage decimal point precision on output reports 🎯

[default: 2]

  • --guess-directory-when-missing — again, no description in the original. she guesses. the directory. when it's missing. do with that what you will ✨
  • --vcs-branch <VCS BRANCH> — set the branch for coveralls report. defaults to 'master' 🌳

[default: master]

  • --log <LOG> — set the file where to log (or stderr or stdout). defaults to 'stderr' 📝

[default: stderr]

  • --log-level <LEVEL> — set the log level 🔊

[default: ERROR] [possible values: OFF, ERROR, WARN, INFO, DEBUG, TRACE]

  • --incl-explicit <PATH> — provides a json file with explicit list of files and lines to include into the report. the json format is { "path": [[1, 2], ...], ... }, where the numbers are inclusive and 1-based line ranges 📋 (inclusive AND 1-based, bestie, write that down)
  • --excl-line <regex> — lines in covered files containing this marker will be excluded ✂️
  • --excl-start <regex> — marks the beginning of an excluded section. the current line is part of this section 🚧
  • --excl-stop <regex> — marks the end of an excluded section. the current line is part of this section 🛑
  • --excl-br-line <regex> — lines in covered files containing this marker will be excluded from branch coverage 🌿✂️
  • --excl-br-start <regex> — marks the beginning of a section excluded from branch coverage. the current line is part of this section 🚧🌿
  • --excl-br-stop <regex> — marks the end of a section excluded from branch coverage. the current line is part of this section 🛑🌿
  • --no-demangle — no symbol demangling 🤐
  • --abs-link-prefix <LINK PREFIX> — generate absolute HTML links with the given prefix 🔗
  • --no-date — do not include the current date in the HTML report 📅🚫
  • --html-resources <SOURCE> — where to retrieve the CSS files used to style the HTML reports 🎨

[default: bundled] [possible values: bundled, cdn]

  • -h, --help — print help (see a summary with '-h') 💬
  • -V, --version — print version 🏷️
⚠️ bestie reminder: --token is required for the 'coveralls' and 'coveralls+' formats, and -o, --output-path has to be a folder the moment you're doing multiple output types. rules are rules 💅

and that's the whole page, no notes 🫶 this was grcov version 0.10.7, fresh from July 2026 — go get your coverage, main character 💖✨🦋🌸🎀💅👑

📦 where this page comes from