此内容描述了 CodeQL CLI 的最新版本。 有关此版本的详细信息,请参阅 https://github.com/github/codeql-cli-binaries/releases 。
若要查看早期版本中此命令可用选项的详细信息,请在终端中使用 --help
选项运行命令。
摘要
codeql pack add <options>... -- <scope/name[@range]>...
codeql pack add <options>... -- <scope/name[@range]>...
说明
添加具有可选版本范围的 QL 库包的列表作为当前包的依赖项,然后安装这些包。
此命令修改当前包的 qlpack.yml 文件。 将删除格式和批注。
自 v2.6.0
起可用。
选项
主要选项
<scope/name[@range]>...
[必需] 要添加到依赖项列表的包的范围、名称和可选版本范围。
如果未指定版本范围,或者版本范围指定为“最新”,则下载最新版本的包,并将依赖项添加到 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 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 环境变量。
--[no-]allow-prerelease
允许使用具有预发布版本限定符(例如 X.Y.Z-qualifier
)的包。 如果没有此标志,预发布包将被忽略。
自 v2.11.3
起可用。
常用选项
-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
起可用。