跳至主要内容

pack add

将一组带有可选版本范围的 QL 库包添加为当前包的依赖项,然后安装它们。

谁可以使用此功能?

CodeQL 可用于以下存储库类型

本文档内容

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

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

摘要

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