包下载

概要

codeql pack download [--dir=<dir>] [--force] <options>... -- <scope/name[@version]|suite.qls>...

codeql pack download [--dir=<dir>] [--force] <options>... -- <scope/name[@version]|suite.qls>...

说明

从注册表下载命令行查询规范引用的 qlpack 集。可以使用名称提供包，或者隐式地包含在查询套件 (.qls) 文件中。

默认情况下，包将被下载并解压缩到包缓存中。

自 v2.6.0 起可用。

选项

主要选项

<scope/name[@version]|suite.qls>...

[必填] 要下载的 CodeQL 包和查询套件列表。如果提供了查询套件，则将检查其指令并下载所有引用的 CodeQL 包。如果未为 CodeQL 包指定版本，则将下载最新版本。

--format=<fmt>

选择输出格式，text *(默认)* 或 json。

-d, --dir=<dir>

下载包到的目录。默认为安装到包缓存中。

--for-pack=<pack>

正在下载其依赖项的包。每个包的包注册表将由<pack>的“注册表”属性确定。

--[no-]allow-prerelease

允许使用具有预发行版本限定符（例如，X.Y.Z-qualifier）的包。没有此标志，预发行包将被忽略。

自 v2.11.3 起可用。

-f, --[no-]force

允许覆盖已存在的包。

查找 QL 包的选项（可能需要解释查询套件）

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

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

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

指向开源 CodeQL 存储库的检出应该在查询其中一个语言时有效。

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

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

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

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

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

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

配置 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 并根据需要重定向标准错误输出。)

--common-caches=<dir>

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

自v2.15.2版本起可用。