跳至主要内容

解析提取器

【深入解析】确定要用于特定语言的提取器包。

谁可以使用此功能?

CodeQL 可用于以下代码库类型

本文内容

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

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

概要

Shell
codeql resolve extractor --language=<lang> <options>...

说明

【深入解析】确定要用于特定语言的提取器包。

选项

主要选项

-l, --language=<lang>

【必填】要查找的提取器的名称。

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

可能找到提取器包的目录列表。这些目录可以是提取器包本身,也可以是包含提取器作为直接子目录的目录。

如果路径包含多个目录树,则它们的顺序定义了它们之间的优先级:如果在多个目录树中匹配目标语言,则首先给出的目录树优先。

与 CodeQL 工具链捆绑在一起的提取器始终可以找到,但如果您需要使用单独分发的提取器,则需要提供此选项(或者,更好的方法是,在每个用户的配置文件中设置 --search-path)。

(注意:在 Windows 上,路径分隔符为 ;)。

--just-check

不打印任何输出,但如果找到提取器则退出代码为 0,否则退出代码为 1。

--format=<fmt>

选择输出格式。选项包括

text (默认):将找到的提取器包的路径打印到标准输出。

json:将找到的提取器包的路径作为 JSON 字符串打印。

betterjson:将有关找到的提取器包的详细信息作为 JSON 字符串打印。

常用选项

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