此内容描述了 CodeQL CLI 的最新版本。 有关此版本的详细信息,请参阅 https://github.com/github/codeql-cli-binaries/releases 。
若要查看早期版本中此命令可用选项的详细信息,请在终端中使用 --help
选项运行命令。
摘要
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>...]
[高级] 将添加到 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 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
起可用。