跳至主要内容

CodeQL CLI 命令手册

最新版 CodeQL CLI 可用命令的参考信息。

谁可以使用此功能?

CodeQL 可用于以下类型的仓库:

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

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

bqrs decode

将 BQRS 中的结果数据转换为其他格式。

bqrs diff

计算两个结果集之间的差异。

bqrs hash

[底层] 计算 BQRS 文件的稳定哈希值。

bqrs info

显示 BQRS 文件的元数据。

bqrs interpret

[底层] 解释单个 BQRS 中的数据。

database add-diagnostic

[实验性] 向数据库添加诊断信息。

database analyze

分析数据库,在源代码上下文中生成有意义的结果。

database bundle

创建 CodeQL 数据库的可重定位存档。

database cleanup

压缩磁盘上的 CodeQL 数据库。

database create

为可以使用 CodeQL 产品之一进行分析的源代码树创建 CodeQL 数据库。

database export-diagnostics

[实验性] 导出失败分析的数据库诊断信息。

database finalize

[底层] 数据库创建的最后步骤。

database import

[高级] [底层] 将未完成的数据库导入另一个未完成的数据库。

database index-files

[底层] 使用给定的 CodeQL 提取器索引独立文件。

database init

[底层] 创建一个空的 CodeQL 数据库。

database interpret-results

[底层] 将计算出的查询结果解释为有意义的格式,例如 SARIF 或 CSV。

database print-baseline

[底层] 打印看到的基线代码行的摘要。

database run-queries

[底层] 同时运行一组查询。

database trace-command

[底层] 作为跟踪构建的一部分运行单个命令。

database unbundle

提取 CodeQL 数据库存档。

database upgrade

升级数据库,以便当前工具可以使用它。

dataset check

[底层] 检查特定数据集的内部一致性。

dataset cleanup

[底层] 清理数据集的临时文件。

dataset import

[底层] 将一组 TRAP 文件导入原始数据集。

dataset measure

[底层] 收集有关特定数据集中的关系的统计信息。

dataset upgrade

[底层] 升级数据集,以便当前工具可以使用它。

diagnostic add

[实验性] [底层] 添加诊断信息。

diagnostic export

[实验性] 导出失败分析的诊断信息。

execute cli-server

[深度底层] 用于运行多个命令同时避免重复 JVM 初始化的服务器。

execute language-server

[底层] IDE 中 QL 语言的在线支持。

execute queries

[底层] 对数据集运行一个或多个查询。

execute query-server

[底层] IDE 中运行查询的支持。

execute query-server2

[底层] IDE 中运行查询的支持。

execute upgrades

[底层] 在现有的原始 QL 数据集上运行升级脚本。

generate extensible-predicate-metadata

[实验性] [深度底层] 报告给定包中找到的可扩展谓词。

generate log-summary

[高级] 创建结构化日志文件的摘要。

generate query-help

从 .qhelp 文件生成最终用户查询帮助。

github merge-results

[深度底层] 将多个 SARIF 文件合并到单个 SARIF 文件中。

github upload-results

将 SARIF 文件上传到 GitHub 代码扫描。

pack add

添加具有可选版本范围的 QL 库包列表作为当前包的依赖项,然后安装它们。

pack bundle

[底层] 捆绑 QL 库包。

pack ci

安装此包的依赖项,并验证现有的锁定文件是否为最新版本。

pack create

[底层] 从源代码构建 QL 包的内容。

pack download

从注册表下载命令行查询规范引用的 qlpack 集。包可以按名称提供,也可以隐式地包含在查询套件 (.qls) 文件中。

pack init

在指定的目录中初始化 qlpack。

pack install

安装此包的依赖项。

pack ls

[深度底层] 列出以该目录为根的 CodeQL 包。此目录必须包含 qlpack.yml 或 .codeqlmanifest.json 文件。

pack packlist

[底层] 计算要包含在 QL 查询包或库包中的文件集。

pack publish

将 QL 库包发布到包注册表。

pack resolve-dependencies

[底层实现] 计算此 QL 包所需的依赖项集。

pack upgrade

将此包的依赖项更新到最新可用版本。

query compile

编译或检查 QL 代码。

query decompile

[底层实现] 从 .qlo 文件读取已编译查询的中间表示。

query format

自动格式化 QL 源代码。

query run

运行单个查询。

resolve database

[底层实现] 报告有关数据库的元数据。

resolve extensions

[实验性] [底层实现] 确定可访问的扩展。这包括机器学习模型和数据扩展。

resolve extensions-by-pack

[实验性] [底层实现] 为给定的包根路径确定可访问的扩展。这包括机器学习模型和数据扩展。

resolve extractor

[底层实现] 确定要为给定语言使用的提取器包。

resolve files

[底层实现] 展开一组文件包含/排除通配符。

resolve languages

列出已安装的 CodeQL 提取器包。

resolve library-path

[底层实现] 确定查询的 QL 库路径和 dbscheme。

resolve metadata

[底层实现] 解析并返回查询源文件中的键值元数据对。

resolve ml-models

[已弃用] [实验性] [底层实现] 确定可访问的机器学习模型。

resolve packs

显示可用 CodeQL 包及其位置的列表。

resolve qlpacks

创建已安装的 QL 包及其位置的列表。

resolve qlref

[底层实现] 取消引用 .qlref 文件以返回 .ql 文件。

resolve queries

[底层实现] 展开查询目录和套件规范。

resolve ram

[底层实现] 准备 RAM 选项。

resolve tests

[底层实现] 在给定目录中查找 QL 单元测试。

resolve upgrades

[底层实现] 确定要为原始数据集运行的升级。

test accept

接受失败单元测试的结果。

test extract

[底层实现] 为测试目录构建数据集。

test run

运行 QL 查询的单元测试。

version

显示 CodeQL 工具链的版本。