diagnostic export

注意

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

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

概要

Shell

codeql diagnostic export --format=<format> [--output=<output>] <options>...

codeql diagnostic export --format=<format> [--output=<output>] <options>...

Description

          \[实验性] 导出失败分析的诊断信息。

自 v2.12.6 起可用。

选项

主要选项

`--format=<format>`

          \[必选] 写入结果的格式。 下列其中一项：

          `raw`：原始、未解释的诊断消息列表（作为 JSON 对象）。

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

          `sarifv2.1.0`：SARIF v2.1.0。

          `text`：诊断消息的项目符号列表。

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

要向其写入诊断信息的输出路径。

`--sarif-exit-code=<sarifExitCode>`

          \[仅 SARIF 格式] 失败进程的退出代码。

`--sarif-exit-code-description=<sarifExitCodeDescription>`

          \[仅 SARIF 格式] 失败进程退出的原因。

`--sarif-category=<category>`

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

如果以多种不同方式分析同一版本的代码库（例如，针对不同语言）并将结果上传到 GitHub 以在代码扫描中呈现，则每次分析的此值应不同，这会告知代码扫描这些分析是_补充_而非_替代_彼此。（对于代码库的_不同_版本，同一分析的运行之间的值应保持一致。）

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

`--diagnostic-dir=<diagnosticDirs>`

包含 CodeQL 诊断消息的目录。可以多次传递此内容以包含多个目录。

常用选项

`-h, --help`

显示此帮助文本。

`-J=<opt>`

          \[高级] 向运行命令的 JVM 提供选项。

（请注意，无法正确处理包含空格的选项。）

`-v, --verbose`

以增量方式增加输出的进度消息数。

`-q, --quiet`

以增量方式减少输出的进度消息数。

`--verbosity=<level>`

          \[高级] 明确将详细级别设置为 errors、warnings、progress、progress+、progress++、progress+++ 之一。 重写 `-v` 和 `-q`。

`--logdir=<dir>`

          \[高级] 将详细日志写入指定目录中的一个或多个文件，生成的文件名包含时间戳和正在运行的子命令名称。

（要使用可以完全控制的名称编写日志文件，请根据需要提供 --log-to-stderr 并重定向 stderr。）

`--common-caches=<dir>`

          \[高级] 控制磁盘上缓存数据的位置，这些数据将在 CLI 的多次运行之间保留，例如下载的 QL 包和编译的查询计划。 如果未明确设置，则默认为用户主目录中名为 `.codeql` 的目录；如果尚不存在，则会创建该目录。

自 v2.15.2 起可用。

谁可以使用此功能？

本文内容

概要