使用包解析扩展名

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

谁可以使用此功能？

CodeQL 可用于以下存储库类型

本文档内容

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

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

概要

Shell
codeql resolve extensions-by-pack <options>... -- <pack>...

描述

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

此底层命令解析作为命令行参数传入的路径可用的数据扩展和 GitHub 创建的机器学习模型集。

自 v2.13.3 起可用。

选项

主要选项

<pack>...

要为其解析扩展的包根路径。

--search-path=<dir>[:<dir>...]

可以在其中找到 QL 包的目录列表。每个目录可以是 QL 包（或包含根目录中 .codeqlmanifest.json 文件的包捆绑包），也可以是此类目录的一个或多个的直接父目录。

如果路径包含多个目录，则它们的顺序定义了它们之间的优先级：当必须解析的包名称在多个目录树中匹配时，首先给出的目录树优先。

当查询其中一种语言时，指向开源 CodeQL 存储库的检出应该可以工作。

如果您已将 CodeQL 存储库检出为解压缩的 CodeQL 工具链的同级目录，则无需提供此选项；否则无法找到的 QL 包始终会在这些同级目录中进行搜索。（如果此默认值不起作用，强烈建议在每个用户的配置文件中设置 --search-path 一劳永逸）。

（注意：在 Windows 上，路径分隔符为 ;）。

--additional-packs=<dir>[:<dir>...]

如果提供了此目录列表，则在 --search-path 中的目录之前搜索这些目录中的包。它们之间的顺序无关紧要；如果通过此列表在两个不同位置找到包名称，则为错误。

如果您暂时正在开发也出现在默认路径中的新版本包，这将非常有用。另一方面，**不建议**在配置文件中覆盖此选项；某些内部操作会动态添加此选项，覆盖任何已配置的值。

（注意：在 Windows 上，路径分隔符为 ;）。

--model-packs=<name@range>...

CodeQL 包名称列表，每个名称都有一个可选的版本范围，用作模型包以自定义即将评估的查询。

--threat-model=<name>...

要启用或禁用的威胁模型列表。

参数是威胁模型的名称，前面可选地带有一个“！”。如果不存在“！”，则启用指定的威胁模型及其所有后代。如果存在“！”，则禁用指定的威胁模型及其所有后代。

默认情况下启用“default”威胁模型，但可以通过指定“--threat-model !default”来禁用它。

“all”威胁模型可用于启用或禁用所有威胁模型。

按顺序处理 --threat-model 选项。例如，“--threat-model local --threat-model !environment”启用“local”组中的所有威胁模型，但“environment”威胁模型除外。

此选项仅对支持威胁模型的语言有效。

自 v2.15.3 起可用。

用于配置 CodeQL 包管理器的选项

--registries-auth-stdin

通过传递以逗号分隔的 <registry_url>=<token> 对列表来对 GitHub Enterprise Server 容器注册表进行身份验证。

例如，您可以传递 https://containers.GHEHOSTNAME1/v2/=TOKEN1,https://containers.GHEHOSTNAME2/v2/=TOKEN2 以对两个 GitHub Enterprise Server 实例进行身份验证。

此选项会覆盖 CODEQL_REGISTRIES_AUTH 和 GITHUB_TOKEN 环境变量。如果您只需要对 github.com 容器注册表进行身份验证，则可以使用更简单的 --github-auth-stdin 选项进行身份验证。

--github-auth-stdin

通过标准输入传递 github.com GitHub Apps 令牌或个人访问令牌，对 github.com 容器注册表进行身份验证。

要对 GitHub Enterprise Server 容器注册表进行身份验证，请传递 --registries-auth-stdin 或使用 CODEQL_REGISTRIES_AUTH 环境变量。

此选项会覆盖 GITHUB_TOKEN 环境变量。

常用选项

-h, --help

显示此帮助文本。

-J=<opt>

【高级】向运行命令的 JVM 提供选项。

（请注意，包含空格的选项将无法正确处理。）

-v, --verbose

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

-q, --quiet

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

--verbosity=<level>

【高级】显式将详细程度级别设置为 errors、warnings、progress、progress+、progress++、progress+++ 之一。覆盖 -v 和 -q。

--logdir=<dir>

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

（要写入一个您完全控制名称的日志文件，请改为使用 --log-to-stderr 并根据需要重定向标准错误。）

--common-caches=<dir>

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

自 v2.15.2 版本起可用。