database print-baseline
[Plumbing] Print a summary of the baseline lines of code seen.
Who can use this feature?
CodeQL is available for the following repository types:
- Public repositories on GitHub.com, seeGitHub CodeQL Terms and Conditions
- Organization-owned repositories on GitHub Team withGitHub Code Security enabled
In this article
Note
This content describes the most recent release of the CodeQL CLI. For more information about this release, seehttps://github.com/github/codeql-cli-binaries/releases.
To see details of the options available for this command in an earlier release, run the command with the--help option in your terminal.
Synopsis
codeql database print-baseline <options>... -- <database>
codeql database print-baseline <options>... -- <database>Description
[Plumbing] Print a summary of the baseline lines of code seen.
This command will print to standard out the baseline lines of code seenwithin the source root specified atcodeql database init time for each language present in the database.
The baseline is an estimate of the non-empty, non-comment lines of codein a database. This count is different from the lines of code counted byCodeQL metrics queries, which only counts code that is passed to theCodeQL evaluator. In some cases, the baseline count may be lower thanthe count in metrics queries since metrics queries may include externalfiles that are passed to the evaluator, but are not included in thesource root.
Options
Primary Options
<database>
[Mandatory] Path to the CodeQL database under construction. This musthave been prepared for extraction withcodeql database init.
If the--db-cluster option is given, this is not a database itself,but a directory thatcontains databases, and all of those databaseswill be processed together.
--[no-]db-cluster
Indicates that the directory given on the command line is not a databaseitself, but a directory thatcontains one or more databases underconstruction. Those databases will be processed together.
Common options
-h, --help
Show this help text.
-J=<opt>
[Advanced] Give option to the JVM running the command.
(Beware that options containing spaces will not be handled correctly.)
-v, --verbose
Incrementally increase the number of progress messages printed.
-q, --quiet
Incrementally decrease the number of progress messages printed.
--verbosity=<level>
[Advanced] Explicitly set the verbosity level to one of errors,warnings, progress, progress+, progress++, progress+++. Overrides-vand-q.
--logdir=<dir>
[Advanced] Write detailed logs to one or more files in the givendirectory, with generated names that include timestamps and the name ofthe running subcommand.
(To write a log file with a name you have full control over, insteadgive--log-to-stderr and redirect stderr as desired.)
--common-caches=<dir>
[Advanced] Controls the location of cached data on disk that willpersist between several runs of the CLI, such as downloaded QL packs andcompiled query plans. If not set explicitly, this defaults to adirectory named.codeql in the user's home directory; it will becreated if it doesn't already exist.
Available sincev2.15.2.