此版本的 GitHub Enterprise Server 已于以下日期停止服务 2024-07-09. 即使针对重大安全问题，也不会发布补丁。为了获得更好的性能、更高的安全性和新功能，请升级到最新版本的 GitHub Enterprise。如需升级帮助，请联系 GitHub Enterprise 支持。

pack install

安装此包的依赖项。

谁可以使用此功能？

GitHub CodeQL 在安装后按用户授权。根据许可证限制，只能将 CodeQL 用于某些任务。有关详细信息，请参阅“关于 CodeQL CLI”。

如果你有 GitHub Advanced Security 许可证，则可以使用 CodeQL 进行自动分析、持续集成和持续交付。有关详细信息，请参阅“关于 GitHub 高级安全性”。

本文内容

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

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

摘要

Shell

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

常用选项

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