pack download

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

谁可以使用此功能？

GitHub CodeQL 在安装后按用户授权。根据许可证限制，只能将 CodeQL 用于某些任务。有关详细信息，请参阅“关于 CodeQL CLI”。

如果你有 GitHub Advanced Security 许可证，则可以使用 CodeQL 进行自动分析、持续集成和持续交付。有关详细信息，请参阅“关于 GitHub 高级安全性”。

本文内容

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

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

摘要

Shell

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 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 环境变量。

pack download

谁可以使用此功能？

本文内容

摘要

说明

选项

主要选项

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

`--format=<fmt>`

`-d, --dir=<dir>`

`--for-pack=<pack>`

`--[no-]allow-prerelease`

`-f, --[no-]force`

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

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

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

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

`--registries-auth-stdin`

`--github-auth-stdin`

常用选项

`-h, --help`

`-J=<opt>`

`-v, --verbose`

`-q, --quiet`

`--verbosity=<level>`

`--logdir=<dir>`

`--common-caches=<dir>`