包安装

概要

codeql pack install [--force] <options>... -- <dir>

codeql pack install [--force] <options>... -- <dir>

描述

安装此包的依赖项。

此命令安装包的依赖项。如果存在 codeql-pack.lock.yml，则如果这些版本与 qlpack.yml 文件中指定的版本约束兼容，则将安装其中指定的版本。如果锁定文件中指定的任何依赖项版本与此包的约束不兼容，则此命令将安装每个依赖项的最新兼容版本，并使用新选择的版本更新锁定文件。如果不存在锁定文件，则此命令将安装所有依赖项的最新兼容版本，并创建一个新的锁定文件。

自 v2.6.0 起可用。

选项

主要选项

<dir>

包的根目录。

--format=<fmt>

选择输出格式，text (默认) 或 json。

-f, --[no-]force

允许覆盖已存在的包。

--[no-]allow-prerelease

允许使用具有预发布版本限定符（例如 X.Y.Z-qualifier）的包。没有此标志，预发布包将被忽略。

自 v2.11.3 起可用。

--lock-override=<file>

[高级] 指定要作为依赖项解析输入使用的备用锁定文件。

--lock-output=<file>

[高级] 指定保存依赖项解析生成的锁定文件的备用位置。

自 v2.14.1 起可用。

--no-strict-mode

[高级] 关闭严格模式以避免在从 --additional-packs

和其他本地解析的位置解析包时出现警告。本地解析的包永远不会下载

并且不会添加到包锁定中。

--mode=<mode>

[已弃用] 指定如何解析依赖项

minimal-update (默认)：根据 qlpack.yml 文件的现有内容更新或创建 codeql-pack.lock.yml。如果任何现有的 codeql-pack.lock.yml 不满足 qlpack.yml 中的当前依赖项，则将根据需要更新锁定文件。

upgrade：更新或创建 codeql-pack.lock.yml 以使用所有依赖项的最新版本，但要遵守 qlpack.yml 文件中的约束。此模式已被“codeql pack upgrade”命令取代。

verify：验证现有的 codeql-pack.lock.yml 是否仍然相对于 qlpack.yml 文件中指定的依赖项有效，或者如果锁定文件不存在则使其失败。此模式已被“codeql pack ci”命令取代。

no-lock：忽略现有的 codeql-pack.lock.yml 文件，并根据 qlpack.yml 文件执行解析。不会创建或更新锁定文件。

use-lock：使用现有的 codeql-pack.lock.yml 文件解析依赖项，或者在不存在时创建锁定文件。

update： [已弃用] 更新或创建 codeql-pack.lock.yml 以使用所有依赖项的最新版本，但需遵守 qlpack.yml 文件中的约束条件。此模式已被“codeql pack upgrade”命令取代。

在包注册表之外解析 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 和 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 起可用。