{"meta":{"title":"软件包安装","intro":"安装此包的依赖项。","product":"安全性和代码质量","breadcrumbs":[{"href":"/zh/code-security","title":"安全性和代码质量"},{"href":"/zh/code-security/reference","title":"Reference"},{"href":"/zh/code-security/reference/code-scanning","title":"代码扫描"},{"href":"/zh/code-security/reference/code-scanning/codeql","title":"CodeQL"},{"href":"/zh/code-security/reference/code-scanning/codeql/codeql-cli-manual","title":"CodeQL CLI 手册"},{"href":"/zh/code-security/reference/code-scanning/codeql/codeql-cli-manual/pack-install","title":"软件包安装"}],"documentType":"article"},"body":"# 软件包安装\n\n安装此包的依赖项。\n\n> [!NOTE]\n> 此内容描述了 CodeQL CLI 的最新版本。 有关此版本的详细信息，请参阅 https://github.com/github/codeql-cli-binaries/releases 。\n>\n> 若要查看早期版本中此命令可用选项的详细信息，请在终端中使用 <span style=\"white-space: nowrap;\">`--help`</span> 选项运行命令。\n\n## 概要\n\n```shell copy\ncodeql pack install [--force] <options>... -- <dir>\n```\n\n## Description\n\n安装此包的依赖项。\n\n此命令安装包的依赖项。 如果存在 codeql-pack.lock.yml，并且该锁文件中指定的版本与 qlpack.yml 文件中指定的版本约束兼容，则会安装该指定的版本。 如果锁文件中指定的任何依赖项版本与此包的约束不兼容，此命令会安装其中每个依赖项的最新兼容版本，并使用新选择的版本更新锁文件。 如果没有锁文件，此命令会安装所有依赖项的最新兼容版本，并创建新的锁文件。\n\n自 `v2.6.0` 起可用。\n\n## 选项\n\n### 主要选项\n\n#### `<dir>`\n\n包的根目录。\n\n#### `--format=<fmt>`\n\n选择输出格式，可选`text`_（默认）_ 或 `json`。\n\n#### `-f, --[no-]force`\n\n允许覆盖已存在的包。\n\n#### `--[no-]allow-prerelease`\n\n允许使用具有预发布版本限定符（例如 `X.Y.Z-qualifier`）的包。 如果没有此标志，预发布包将被忽略。\n\n自 `v2.11.3` 起可用。\n\n#### `--lock-override=<file>`\n\n              \\[高级] 指定备用锁定文件用作依赖项解析的输入。\n\n#### `--lock-output=<file>`\n\n              \\[高级] 指定备用位置保存依赖项解析生成的锁定文件。\n\n自 `v2.14.1` 起可用。\n\n#### `--no-strict-mode`\n\n              \\[高级] 关闭严格模式，以避免从 `--additional-packs` 解析包时出现警告\n\n出现警告。 永远不会下载本地解析的包，\n\n也不会将本地解析的包添加到包锁中。\n\n#### `--mode=<mode>`\n\n              \\[已弃用] 指定如何解析依赖项：\n\n              `minimal-update`\n              _（默认）_：根据 qlpack.yml 文件的现有内容更新或创建 codeql-pack.lock.yml。 如果任何现有 codeql-pack.lock.yml 不满足 qlpack.yml 中的当前依赖项，则会根据需要更新锁文件。\n\n              `upgrade`：更新或创建 codeql-pack.lock.yml，以使用所有依赖项的最新版本（受 qlpack.yml 文件中的约束限制）。 此模式已被“codeql pack upgrade”命令取代。\n\n              `verify`：验证现有 codeql-pack.lock.yml 相对于 qlpack.yml 文件中指定的依赖项是否仍然有效，如果不存在则锁定文件失败。 此模式已被“codeql pack ci”命令取代。\n\n              `no-lock`：忽略现有 codeql-pack.lock.yml，基于 qlpack.yml 文件执行依赖项解析。 不创建或更新锁文件。\n\n              `use-lock`：使用现有的 codeql-pack.lock.yml 文件解析依赖项，或者创建锁文件（如果不存在）。\n\n              `update`：\\[已弃用] 更新或创建 codeql-pack.lock.yml，以使用所有依赖项的最新版本（受 qlpack.yml 文件中的约束限制）。 此模式已被“codeql pack upgrade”命令取代。\n\n### 用于在包注册表外解析 QL 包的选项\n\n#### `--search-path=<dir>[:<dir>...]`\n\n可在其中找到 QL 包的目录列表。 每个目录可以是一个 QL 包（或在根目录下包含一个 `.codeqlmanifest.json` 文件的多个包），也可以是一个或多个此类目录的直接父目录。\n\n如果路径包含多个目录，则它们的顺序定义了它们之间的优先级：当必须解析的包名称在多个目录树中匹配时，给定的第一个目录树优先。\n\n在查询其中一种语言时，将其指向开源 CodeQL 存储库的签出应该是可行的。\n\n如果已将 CodeQL 存储库签出为未打包的 CodeQL 工具链的同级，则无需提供此选项；将始终在此类同级目录中搜索以其他方式找不到的 QL 包。 （如果此默认值不起作用，强烈建议在每用户配置文件中一次性设置 `--search-path`）。\n\n（注意：在 Windows 上，路径分隔符为 `;`）。\n\n#### `--additional-packs=<dir>[:<dir>...]`\n\n如果给定了此目录列表，则先在这些目录中的搜索包，然后在 `--search-path` 中的目录搜索包。 它们之间的顺序并不重要；如果在此列表的两个不同位置发现同一个包名称，这是一个错误。\n\n如果你正临时开发一个同时出现在默认路径中的新版本的包，这将非常有用。 另一方面，_不建议_在配置文件中覆盖此选项；某些内部操作会动态添加此选项，覆盖任何已配置的值。\n\n（注意：在 Windows 上，路径分隔符为 `;`）。\n\n### 用于配置 CodeQL 包管理器的选项\n\n#### `--registries-auth-stdin`\n\n通过传递逗号分隔的 \\<registry\\_url>=\\<token> 对列表，向 GitHub Enterprise Server 容器注册表进行身份验证。\n\n例如，可以传递 `https://containers.GHEHOSTNAME1/v2/=TOKEN1,https://containers.GHEHOSTNAME2/v2/=TOKEN2`\n向两个 GitHub Enterprise Server 实例进行身份验证。\n\n这会替代 CODEQL\\_REGISTRIES\\_AUTH and GITHUB\\_TOKEN 环境变量。 如果只需向 github.com 容器注册表进行身份验证，则可以改用更简单的 `--github-auth-stdin` 选项进行身份验证。\n\n#### `--github-auth-stdin`\n\n通过标准输入传递 github.com GitHub 应用令牌或个人访问令牌，对 github.com 容器注册表进行身份验证。\n\n要向 GitHub Enterprise Server 容器注册表进行身份验证，请传递 `--registries-auth-stdin` 或使用 CODEQL\\_REGISTRIES\\_AUTH 环境变量。\n\n这会替代 GITHUB\\_TOKEN 环境变量。\n\n### 常用选项\n\n#### `-h, --help`\n\n显示此帮助文本。\n\n#### `-J=<opt>`\n\n              \\[高级] 向运行命令的 JVM 提供选项。\n\n（请注意，无法正确处理包含空格的选项。）\n\n#### `-v, --verbose`\n\n以增量方式增加输出的进度消息数。\n\n#### `-q, --quiet`\n\n以增量方式减少输出的进度消息数。\n\n#### `--verbosity=<level>`\n\n              \\[高级] 明确将详细级别设置为 errors、warnings、progress、progress+、progress++、progress+++ 之一。 重写 `-v` 和 `-q`。\n\n#### `--logdir=<dir>`\n\n              \\[高级] 将详细日志写入指定目录中的一个或多个文件，生成的文件名包含时间戳和正在运行的子命令名称。\n\n（要使用可以完全控制的名称编写日志文件，请根据需要提供 `--log-to-stderr` 并重定向 stderr。）\n\n#### `--common-caches=<dir>`\n\n              \\[高级] 控制磁盘上缓存数据的位置，这些数据将在 CLI 的多次运行之间保留，例如下载的 QL 包和编译的查询计划。 如果未明确设置，则默认为用户主目录中名为 `.codeql` 的目录；如果尚不存在，则会创建该目录。\n\n自 `v2.15.2` 起可用。"}