跳至主要内容

数据库打印基线

[管道] 打印看到的基线代码行摘要。

谁可以使用此功能?

CodeQL 可用于以下代码库类型

本文档内容

此内容描述了 CodeQL CLI 的最新版本。有关此版本的更多信息,请参阅 https://github.com/github/codeql-cli-binaries/releases

要在较早版本中查看此命令可用的选项详细信息,请在终端中使用 --help 选项运行该命令。

摘要

Shell
codeql database print-baseline <options>... -- <database>

描述

[管道] 打印看到的基线代码行摘要。

此命令将打印在 codeql database init 时在指定源根目录中看到的基线代码行摘要到标准输出,每个数据库中都存在相应的语言。

基线是数据库中非空、非注释代码行的估计值。此计数与 CodeQL 度量查询计算的代码行数不同,后者仅计算传递给 CodeQL 评估器的代码。在某些情况下,基线计数可能低于度量查询中的计数,因为度量查询可能包含传递给评估器但未包含在源根目录中的外部文件。

选项

主要选项

<database>

[必填] 要构建的 CodeQL 数据库的路径。必须已使用 codeql database init 准备好进行提取。

如果给出了 --db-cluster 选项,则这不是数据库本身,而是一个包含数据库的目录,并且所有这些数据库将一起处理。

--[no-]db-cluster

指示命令行上给定的目录本身不是数据库,而是一个包含一个或多个正在构建的数据库的目录。这些数据库将一起处理。

常用选项

-h, --help

显示此帮助文本。

-J=<opt>

[高级] 向运行命令的 JVM 提供选项。

(请注意,包含空格的选项将无法正确处理。)

-v, --verbose

逐步增加打印的进度消息数量。

-q, --quiet

逐步减少打印的进度消息数量。

--verbosity=<level>

[高级] 将详细程度级别明确设置为错误、警告、进度、进度+、进度++、进度+++ 之一。覆盖 -v-q

--logdir=<dir>

[高级] 将详细日志写入给定目录中的一个或多个文件,生成的文件名包含时间戳和正在运行的子命令的名称。

(要写入您完全控制名称的日志文件,请改用 --log-to-stderr 并根据需要重定向 stderr。)

--common-caches=<dir>

[高级] 控制磁盘上缓存数据的存储位置,这些数据将在 CLI 的多次运行之间持久存在,例如下载的 QL 包和已编译的查询计划。如果未明确设置,则默认为用户主目录中名为 .codeql 的目录;如果该目录不存在,则会创建它。

v2.15.2 起可用。