注意
此内容描述了 CodeQL CLI 的最新发布版本。有关此版本的更多信息,请参阅 https://github.com/github/codeql-cli-binaries/releases。
要查看早期版本中此命令可用的选项详情,请在终端中使用 --help 选项运行该命令。
概要
codeql pack ci [--force] <options>... -- <dir>
codeql pack ci [--force] <options>... -- <dir>
描述
干净地为该 pack 安装依赖,并验证现有的锁文件是否为最新。
此命令根据 codeql-pack.lock.yml 文件中指定的版本安装 pack 的依赖。如果锁文件中指定的任何版本与 qlpack.yml 文件中指定的版本约束不兼容,或不存在锁文件,则此命令会失败。
此命令类似于 codeql pack install,但它旨在用于自动化环境,例如测试平台、持续集成和部署——或任何希望确保对依赖进行干净安装的情况。
自 v2.12.4 起可用。
选项
主要选项
<dir>
包的根目录。
--format=<fmt>
选择输出格式,可为 text (默认) 或 json。
-f, --[no-]force
允许覆盖已存在的 pack。
--[no-]allow-prerelease
允许使用带有预发布版本标识(例如 X.Y.Z-qualifier)的包。若未使用此标志,预发布包将被忽略。
自 v2.11.3 起可用。
--lock-override=<file>
[高级] 指定一个备用锁文件作为依赖解析的输入。
--lock-output=<file>
[高级] 指定一个备用位置来保存依赖解析生成的锁文件。
自 v2.14.1 起可用。
--no-strict-mode
[高级] 关闭严格模式,以避免在从 --additional-packs 解析包时出现警告
以及其他本地解析的位置。本地解析的包永不下载
并且不会被添加到包锁中。
在包注册表之外解析 QL pack 的选项
--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>
[高级] 将详细程度显式设置为以下之一:errors、warnings、progress、progress+、progress++、progress+++。会覆盖 -v 和 -q。
--logdir=<dir>
[高级] 将详细日志写入指定目录中的一个或多个文件,文件名会包含时间戳和运行的子命令名称。
(若希望自行完全控制日志文件名,请改用 --log-to-stderr 并按需重定向 stderr。)
--common-caches=<dir>
[高级] 控制磁盘上缓存数据的位置,这些数据会在 CLI 的多次运行之间保持,例如已下载的 QL 包和已编译的查询计划。如果未显式设置,则默认使用用户主目录下名为 .codeql 的目录;如该目录不存在,则会自动创建。
自 v2.15.2 起可用。