解析包

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

谁可以使用此功能？

CodeQL 可用于以下存储库类型：

本文内容

注意

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

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

概要

Shell
codeql resolve packs <options>...

Description

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

此命令根据指定的搜索路径选项，显示所有搜索 CodeQL 包的位置。 对于每个搜索位置，它会列出在该位置找到的包。

选项

主要选项

--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-]show-hidden-packs

显示哪些包被搜索中较早找到的包隐藏。

用于配置 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 and GITHUB_TOKEN 环境变量。 如果只需向 github.com 容器注册表进行身份验证，则可以改用更简单的 --github-auth-stdin 选项进行身份验证。

--github-auth-stdin

通过标准输入传递 github.com GitHub 应用令牌或个人访问令牌，对 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 并重定向 stderr。）

--common-caches=<dir>

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

自 v2.15.2 起可用。