此内容描述了 CodeQL CLI 的最新版本。 有关此版本的详细信息，请参阅 https://github.com/github/codeql-cli-binaries/releases 。
若要查看早期版本中此命令可用选项的详细信息，请在终端中使用 --help 选项运行命令。
CodeQL CLI 命令手册
最新版 CodeQL CLI 中可用命令的参考信息。
谁可以使用此功能？
CodeQL 可用于以下存储库类型：
- GitHub.com 上的公共存储库，请参阅 GitHub CodeQL 条款和条件
- 启用了 GitHub Advanced Security 的 GitHub Enterprise Cloud 上的组织拥有的存储库
bqrs 解码
将结果数据从 BQRS 转换为其他形式。
bqrs diff
计算两个结果集之间的差异。
bqrs 哈希
[测量] 计算 BQRS 文件的稳定哈希。
bqrs info
显示 BQRS 文件的元数据。
bqrs interpret
[Plumbing] 解释单个 BQRS 中的数据。
database add-diagnostic
[实验性] 向数据库添加一条诊断信息。
数据库分析
分析数据库，在源代码的上下文中生成有意义的结果。
数据库捆绑包
创建 CodeQL 数据库的可重定位存档。
database cleanup
在磁盘上压缩 CodeQL 数据库。
database create
为可以使用一个 CodeQL 产品进行分析的源树创建 CodeQL 数据库。
database export-diagnostics
[实验性] 从数据库导出失败分析的诊断信息。
database finalize
[Plumbing] 创建数据库的最终步骤。
数据库导入
[高级] [Plumbing] 将未完成的数据库导入另一个未完成的数据库。
database index-files
[Plumbing] 使用给定的 CodeQL 提取程序为独立文件编制索引。
database init
[Plumbing] 创建空的 CodeQL 数据库。
database interpret-results
[Plumbing] 将计算的查询结果解释为有意义的格式，例如 SARIF 或 CSV。
database print-baseline
[Plumbing] 打印所见基线代码行的摘要。
数据库运行查询
[Plumbing] 一起运行一组查询。
database trace-command
[Plumbing] 在跟踪生成过程中运行单个命令。
database unbundle
提取 CodeQL 数据库存档。
database upgrade
升级数据库，使其可供当前工具使用。
dataset check
[Plumbing] 检查特定数据集的内部一致性。
数据集清理
[Plumbing] 从数据集中清理临时文件。
dataset import
[Plumbing] 将一组 TRAP 文件导入原始数据集。
数据集度量值
[Plumbing] 收集有关特定数据集中关系的统计信息。
dataset upgrade
[Plumbing] 升级数据集，使其可供当前工具使用。
诊断添加
[实验] [Plumbing] 添加一条诊断信息。
diagnostic export
[实验性] 导出失败分析的诊断信息。
execute cli-server
[Deep plumbing] 用于运行多个命令的服务器，同时避免重复的 JVM 初始化。
execute language-server
[Plumbing] IDE 中对 QL 语言的在线支持。
执行查询
[管道] 对数据集运行一个或多个查询。
execute query-server
[Plumbing] 支持从 IDE 运行查询。
execute query-server2
[Plumbing] 支持从 IDE 运行查询。
execute upgrades
[Plumbing] 在现有的原始 QL 数据集上运行升级脚本。
生成 extensible-predicate-metadata
[实验性] [Deep plumbing] 报告在给定包中找到的可扩展谓词。
generate log-summary
[高级] 创建结构化日志文件的摘要。
generate query-help
从 .qhelp 文件生成最终用户查询帮助。
github merge-results
[深度联结] 将多个 SARIF 文件合并到单个 SARIF 文件中。
github upload-results
将 SARIF 文件上传到 GitHub 代码扫描。
pack add
添加具有可选版本范围的 QL 库包的列表作为当前包的依赖项，然后安装这些包。
pack bundle
[联结] 捆绑 QL 库包。
包 ci
安装此包的依赖项，验证现有锁文件是否为最新。
pack create
[联结] 从源代码生成 QL 包的内容。
pack download
从注册表下载命令行的查询规范引用的 qlpack 集。 包可以按名称提供，也可以在查询套件 (.qls) 文件中隐式提供。
pack init
初始化指定目录中的 qlpack。
pack install
安装此包的依赖项。
pack ls
[深层联结] 列出以此目录为根的 CodeQL 包。 此目录必须包含 qlpack.yml 或 .codeqlmanifest.json 文件。
打包包列表
[联结] 计算要包含在 QL 查询包或库包中的文件集。
包发布
将 QL 库包发布到包注册表。
pack resolve-dependencies
[联结] 计算此 QL 包所需的依赖项集。
pack upgrade
将此包的依赖项更新为最新可用版本。
query compile
编译或检查 QL 代码。
查询反向编译
[管道] 从 .qlo 文件读取已编译查询的中间表示形式。
query format
自动设置 QL 源代码的格式。
query run
运行单个查询。
resolve database
[Deep plumbing] 报告有关数据库的元数据。
resolve extensions
[实验性] [Deep plumbing] 确定可访问的扩展。 这包括机器学习模型和数据扩展插件。
按包解析扩展
[实验性] [深度管道] 确定用于打包根目录的给定路径的可访问扩展。 这包括机器学习模型和数据扩展插件。
resolve extractor
[Deep plumbing] 确定要用于给定语言的提取程序包。
resolve files
[Deep plumbing] 展开一组文件包含/排除 glob。
解析语言
列出已安装的 CodeQL 提取程序包。
resolve library-path
[Deep plumbing] 确定查询的 QL 库路径和 dbscheme。
解析元数据
[深层管道] 从查询源文件中解析并返回键值元数据对。
resolve ml-models
[已弃用] [实验性] [Deep plumbing] 确定可访问的机器学习模型。
解析包
显示可用 CodeQL 包及其位置的列表。
resolve qlpacks
创建已安装的 QL 包及其位置的列表。
resolve qlref
[Deep plumbing] 取消引用 .qlref 文件以返回 .ql 文件。
解析查询
[深层管道] 展开查询目录和套件规范。
resolve ram
[Deep plumbing] 准备 RAM 选项。
解析测试
[深层管道] 在给定目录中查找 QL 单元测试。
resolve upgrades
[Deep plumbing] 确定要针对原始数据集运行的升级。
test accept
接受失败的单元测试的结果。
测试提取
[Plumbing] 为测试目录生成数据集。
test run
针对 QL 查询运行单元测试。
版本
显示 CodeQL 工具链的版本。