pack create

注意

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

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

概要

Shell

codeql pack create [--output=<output>] [--threads=<num>] [--ram=<MB>] <options>... -- <dir>

codeql pack create [--output=<output>] [--threads=<num>] [--ram=<MB>] <options>... -- <dir>

描述

[底层] 从源代码构建 QL 包的内容。

此命令构建 QL 包的完整内容，包括原始源代码、库依赖、已编译的查询以及包元数据。

自 v2.6.0 起可用。

选项

主要选项

`<dir>`

包的根目录。

`-o, --output=<output>`

用于写入已构建包的输出目录。

默认值为 ./.codeql/pack。

`--format=<fmt>`

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

`-j, --threads=<num>`

使用此数量的线程来编译查询。

默认值为 1。可以传入 0 以在机器上每个核心使用一个线程，或者使用 -N 来保留 N 个核心不使用（但仍会使用至少一个线程）。

`-M, --ram=<MB>`

设置编译器可使用的 RAM 总量。

`--no-precompile`

[高级] 避免在包输出目录中预编译编译缓存。这将减小包的体积并缩短创建时间，但在运行包之前需要进行编译。仅对查询包有意义。

`--no-validate-extensions`

[高级] 在编译步骤中避免验证数据扩展。

自 v2.13.3 起可用。

`--no-overwrite`

[高级] 避免重新编译并覆盖该命令上一次调用生成的已编译输出。

设置编译环境的选项

`--search-path=<dir>[:<dir>...]`

一个目录列表，QL 包可能位于这些目录下。每个目录可以是一个 QL 包（或包含根目录下 .codeqlmanifest.json 文件的包集合），也可以是一个或多个此类目录的直接父目录。

如果路径中包含多个目录，它们的顺序决定了优先级：当需要解析的包名在多个目录树中匹配时，首先出现的目录中的包将被优先使用。

将其指向开源 CodeQL 仓库的检出版本时，查询其中的某种语言应当可行。

如果你已将 CodeQL 仓库签出为已解压的 CodeQL 工具链的同级目录，则无需提供此选项；此类同级目录始终会被搜索，以查找其他方式找不到的 QL 包。（如果默认行为无效，强烈建议在每用户配置文件中一次性设置 --search-path。）

（注意：在 Windows 上，路径分隔符是 ;）。

`--additional-packs=<dir>[:<dir>...]`

如果提供了此目录列表，它们将在 --search-path 中的目录之前被搜索。列表内部的顺序无关紧要；如果同一包名在该列表的两个不同位置出现，则会报错。

当你暂时在开发一个已出现在默认路径中的包的新版本时，这很有用。另一方面，不建议在配置文件中覆盖此选项；某些内部操作会动态添加此选项，从而覆盖任何已配置的值。

（注意：在 Windows 上，路径分隔符是 ;）。

`--library-path=<dir>[:<dir>...]`

[Advanced] 可选的目录列表，这些目录将被添加到 QL 库的原始导入搜索路径中。仅在使用尚未打包为 QL 包的 QL 库时才应使用。

（注意：在 Windows 上，路径分隔符是 ;）。

`--dbscheme=<file>`

[Advanced] 明确指定应针对哪个 dbscheme 查询进行编译。仅在调用者对自己的操作极其确定时才应提供此选项。

`--compilation-cache=<dir>`

[Advanced] 指定一个额外的目录，用作编译缓存。

`--no-default-compilation-cache`

[Advanced] 不使用标准位置（例如包含查询的 QL 包或 CodeQL 工具链目录）中的编译缓存。

用于配置 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 环境变量。

谁可以使用此功能？

本文内容

概要

描述

选项

主要选项

`<dir>`

`-o, --output=<output>`

`--format=<fmt>`

`-j, --threads=<num>`

`-M, --ram=<MB>`

`--no-precompile`

`--no-validate-extensions`

`--no-overwrite`

设置编译环境的选项

`--search-path=<dir>[:<dir>...]`

`--additional-packs=<dir>[:<dir>...]`

`--library-path=<dir>[:<dir>...]`

`--dbscheme=<file>`

`--compilation-cache=<dir>`

`--no-default-compilation-cache`

用于配置 CodeQL 包管理器的选项

`--registries-auth-stdin`

`--github-auth-stdin`

常用选项

`-h, --help`

`-J=<opt>`

`-v, --verbose`

`-q, --quiet`

`--verbosity=<level>`

`--logdir=<dir>`

`--common-caches=<dir>`