打包捆绑包

概要

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

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

描述

[内部实现] 打包 QL 库包。

此命令从当前目录的内容打包 QL 库包。

自 v2.6.3 起可用。

选项

主要选项

<dir>

包的根目录。

--format=<fmt>

选择输出格式，text （默认）或 json。

--pack-path=<packPath>

将存储编译文件的路径。

-o, --output=<file.tgz>

要创建的查询包文件的路径。此文件尚不存在。

-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>...]

[高级] 一个可选的目录列表，这些目录将添加到 QL 库的原始导入搜索路径中。只有在使用未打包为 QL 包的 QL 库时才应使用此选项。

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

--dbscheme=<file>

[高级] 明确定义应针对其编译 dbscheme 查询。只有非常确定自己在做什么的调用者才应提供此选项。

--compilation-cache=<dir>

[高级] 指定另一个目录用作编译缓存。

--no-default-compilation-cache

[高级] 不要使用标准位置中的编译缓存，例如包含查询的 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 环境变量。

常用选项

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