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

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 属性（如果尚不存在，则会在结尾追加斜线）。

bqrs interpret

谁可以使用此功能？

本文内容

摘要

说明

选项

主要选项

`<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>`