Skip to main content

bqrs interpret

[Plumbing] 解释单个 BQRS 中的数据。

谁可以使用此功能?

GitHub CodeQL 在安装后按用户授权。 根据许可证限制,只能将 CodeQL 用于某些任务。 有关详细信息,请参阅“关于 CodeQL CLI”。

如果你有 GitHub Advanced Security 许可证,则可以使用 CodeQL 进行自动分析、持续集成和持续交付。 有关详细信息,请参阅“关于 GitHub 高级安全性”。

本文内容

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

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

摘要

Shell
codeql bqrs interpret --format=<format> --output=<output> -t=<String=String> [--threads=<num>] [--source-archive=<sourceArchive>] [--source-location-prefix=<sourceLocationPrefix>] <options>... -- <bqrs-file>

说明

[管道] 解释单个 BQRS 中的数据。

根据提供的元数据解释单个 BQRS 文件并以指定格式生成输出的命令。

选项

主要选项

<bqrs-file>

[必需] 要解释的 BQRS 文件。

--format=<format>

[必需] 写入结果时采用的格式。 下列其中一项:

csv:逗号分隔的带格式的值,包括具有规则和警报元数据的列。

sarif-latest:静态分析结果交换格式 (SARIF),这是一种基于 JSON 的格式,用于描述静态分析结果。 此格式选项使用最新的受支持版本 (v2.1.0)。 此选项不适合用于自动化,因为它在不同 CodeQL 版本之间生成不同版本的 SARIF。

sarifv2.1.0:SARIF v2.1.0。

graphtext:表示图形的文本格式。 仅与具有 @kind 图形的查询兼容。

dgml:有向图形标记语言,一种基于 XML 的格式,用于描述图形。 仅与具有 @kind 图形的查询兼容。

dot:Graphviz DOT 语言,一种基于文本的格式,用于描述图形。 仅与具有 @kind 图形的查询兼容。

-o, --output=<output>

[必需] 要向其写入结果的输出路径。 对于图形格式,这应该是一个目录,结果将写入该目录中(如果此命令支持解释多个查询,将写入多个结果)。

-t=<String=String>

[必需] 查询元数据键值对。 对每段元数据重复此操作。 至少必须指定键“kind”和“id”。 键不需要以 @ 作为前缀。

--max-paths=<maxPaths>

要为每个具有路径的警报生成的最大路径数。 (默认值:4)

--[no-]sarif-add-file-contents

[仅限 SARIF 格式] 包括至少一个结果中引用的所有文件的完整文件内容。

--[no-]sarif-add-snippets

[仅限 SARIF 格式] 包括结果中提到的每个位置的代码片段,在报告的位置前后包含两行上下文。

--[no-]sarif-add-query-help

[仅限 SARIF 格式] [已弃用] 包含所有查询的 Markdown 查询帮助。 它从 /path/to/query.md 文件加载 /path/to/query.ql 的查询帮助。 如果未提供此标志,则默认行为仅包含自定义查询(即查询包中并非 `codeql/<lang&rt;-queries` 形式的查询)的帮助。 此选项在传递给 codeql bqrs interpret 时不起作用。

--sarif-include-query-help=<mode>

[仅限 SARIF 格式] 指定是否在 SARIF 输出中包含查询帮助。 下列其中一项:

always:包含所有查询的查询帮助。

custom_queries_only(默认值)__:仅包含自定义查询(即查询包中并非 `codeql/<lang&rt;-queries` 形式的查询)的查询帮助。

never:不包含任何查询的查询帮助。

此选项在传递给 codeql bqrs interpret 时不起作用。

v2.15.2 起可用。

--no-sarif-include-alert-provenance

[高级] [仅限 SARIF 格式] 不要在 SARIF 输出中包含警报来源信息。

v2.18.1 起可用。

--[no-]sarif-group-rules-by-pack

[仅限 SARIF 格式] 将每个查询的规则对象置于 <run>.tool.extensions 属性中的相应 QL 包下。 此选项在传递给 codeql bqrs interpret 时不起作用。

--[no-]sarif-multicause-markdown

[仅限 SARIF 格式] 对于有多种原因的警报,除作为纯字符串外,还应将它们作为 Markdown 格式的逐项列表包含在输出中。

--no-sarif-minify

[仅限 SARIF 格式] 生成整齐打印的 SARIF 输出。 默认情况下,SARIF 输出会缩小,以减少输出文件的大小。

--sarif-run-property=<String=String>

[仅限 SARIF 格式] 要添加到生成的 SARIF“run”属性包的键值对。 可以重复。

--no-group-results

[仅限 SARIF 格式] 每条消息生成一个结果,而不是每个唯一位置生成一个结果。

--csv-location-format=<csvLocationFormat>

在 CSV 输出中生成位置时采用的格式。 即以下值之一:uri、line-column、offset-length。 (默认值:line-column)

--dot-location-url-format=<dotLocationUrlFormat>

一个格式字符串,用于定义在 DOT 输出中生成文件位置 URL 时采用的格式。 可使用以下占位符:{path} {start:line} {start:column} {end:line} {end:column}, {offset}, {length}

--[no-]sublanguage-file-coverage

[仅 GitHub.com 和 GitHub Enterprise Server v3.12.0+] 使用子语言文件覆盖信息。 这会为共享 C 和 C++、Java 和 Kotlin,以及 JavaScript 和 TypeScript 等 CodeQL 提取程序包的语言计算、显示和导出单独的文件覆盖信息。

v2.15.2 起可用。

--sarif-category=<category>

[仅限 SARIF 格式] [建议] 指定要包含在 SARIF 输出中的此分析的类别。 类别可用于区分在同一提交和存储库上(但在不同语言或代码的不同部分)执行的多次分析。

如果以几种不同的方式(例如,针对不同的语言)分析同一版本的代码库并将结果上传到 GitHub 以在代码扫描中展示,则该值在每次分析之间应该不同,这告知代码扫描分析是相互补充的而不是相互取代的 。 (对于不同版本的代码库,相同分析的运行之间的值应保持一致。)

此值将显示为 <run>.automationDetails.id 属性(如果尚不存在,则会在结尾追加斜线)。

-j, --threads=<num>

用于计算路径的线程数。

默认值为 1。 可以传递 0 以在计算机上每个核心使用一个线程,也可以传递 -N 将 N 个核心保留为未使用状态(除仍至少使用一个线程外) 。

--column-kind=<columnKind>

[仅限 SARIF] 用于解释位置列的列类型。 即以下值之一:utf8、utf16、utf32、字节。

--[no-]unicode-new-lines

[仅限 SARIF] 解释位置行号时,unicode 换行符 LS(行分隔符 U+2028)和 PS(段分隔符 U+2029)是否被视为新行。

源存档选项 - 必须同时提供或不提供

-s, --source-archive=<sourceArchive>

包含源存档的目录或 zip 文件。

-p, --source-location-prefix=<sourceLocationPrefix>

原始文件系统上存储源代码的文件路径。

常用选项

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