解析 qlpacks

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

谁可以使用此功能？

CodeQL 可用于以下存储库类型

本文档内容

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

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

概要

Shell
codeql resolve qlpacks <options>...

描述

[已弃用] 创建已安装的 QL 包及其位置的列表。

此命令已弃用。请改用 codeql resolve packs 命令。

此命令会创建根据配置的（或给定的）搜索路径可以解析的 QL 包列表。

当与选择的 JSON 输出一起运行时，它可以为每个包名称报告多个位置。发生这种情况时，意味着该包在一个搜索元素中具有冲突的位置，因此实际上无法解析。调用者可以使用实际位置来格式化错误消息。

选项

主要选项

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

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

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

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

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

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

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

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

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

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

--kind=<kind>

指定要返回的包类型。选项包括：query、library、extension 和 all（默认值）。

请注意，扩展包是一种库包，当类型为 library 时包含在内。

--format=<fmt>

选择输出格式，text（默认值）或 json。

--no-recursive

不递归遍历依赖项。仅返回可直接从 --additional-packs、--search-path 和分发版访问的包。

配置 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 起可用。