bqrs interpret

此内容描述了 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>

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 graph 的查询兼容。

dgml：定向图标记语言，一种基于 XML 的格式，用于描述图形。仅与 @kind graph 的查询兼容。

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

`-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 格式] 将每个查询的规则对象放置在其对应的 QL 包中的<run>.tool.extensions属性下。将此选项传递给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+] 使用子语言文件覆盖率信息。这将计算、显示和导出共享 CodeQL 提取器（如 C 和 C++、Java 和 Kotlin 以及 JavaScript 和 TypeScript）的语言的单独文件覆盖率信息。

自 v2.15.2 起可用。

`--sarif-category=<category>`

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

如果您以几种不同的方式分析代码库的同一版本（例如，针对不同的语言），并将结果上传到 GitHub 以在代码扫描中显示，则此值在每个分析之间应有所不同，这告诉代码扫描这些分析是 *补充* 而不是 *替代* 彼此。（对于代码库的 *不同* 版本，相同分析的运行之间，这些值应保持一致。）

此值将显示为<run>.automationDetails.id属性（如果尚未存在尾部斜杠，则会附加尾部斜杠）。

哪些用户可以使用此功能？

本文内容

概要

描述

选项

主要选项

`<bqrs-file>`

`--format=<format>`

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

`-t=<String=String>`

`--max-paths=<maxPaths>`

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

`--[no-]sarif-add-snippets`

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

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

`--no-sarif-include-alert-provenance`

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

`--[no-]sarif-multicause-markdown`

`--no-sarif-minify`

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

`--no-group-results`

`--csv-location-format=<csvLocationFormat>`

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

`--[no-]sublanguage-file-coverage`

`--sarif-category=<category>`

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

`--column-kind=<columnKind>`

`--[no-]unicode-new-lines`

源代码存档选项 - 必须一起提供或完全不提供

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

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

常用选项

`-h, --help`

`-J=<opt>`

`-v, --verbose`

`-q, --quiet`

`--verbosity=<level>`

`--logdir=<dir>`

`--common-caches=<dir>`