pack add

概要

codeql pack add <options>... -- <scope/name[@range]>...

codeql pack add <options>... -- <scope/name[@range]>...

描述

将一系列带有可选版本范围的 QL 库包添加为当前包的依赖项，然后进行安装。

此命令会修改当前包的 qlpack.yml 文件。格式和注释将被移除。

自 v2.6.0 起可用。

选项

主要选项

<scope/name[@range]>...

【必填】要添加到依赖列表的包的作用域、名称以及可选的版本范围。

如果未指定版本范围，或将版本范围指定为 'latest'，则会下载该包的最新版本，并在 qlpack.yml 中添加一个依赖，允许任何与下载的版本兼容的版本。

如果指定了单个版本，则下载该版本的包，并在 qlpack.yml 中添加一个依赖，允许任何与指定版本兼容的版本。

如果指定了版本范围，则下载满足该范围的最新包版本，并在 qlpack.yml 中添加一个使用指定版本范围的依赖。

--dir=<dir>

包的根目录。

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

--[no-]allow-prerelease

允许使用带有预发布版本标识（例如 X.Y.Z-qualifier）的包。若未使用此标志，预发布包将被忽略。

自 v2.11.3 起可用。

常用选项

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