解析包

概要

codeql resolve packs <options>...

codeql resolve packs <options>...

描述

显示可用 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 和 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>

[高级] 将详细程度显式设置为错误、警告、进度、进度+、进度++、进度+++ 之一。覆盖 -v 和 -q。

--logdir=<dir>

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

(要写入名称完全受您控制的日志文件，请改用 --log-to-stderr 并根据需要重定向 stderr。)

--common-caches=<dir>

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

自 v2.15.2 版本起可用。