诊断导出

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

描述

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

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

[高级] 将详细程度级别显式设置为错误、警告、进度、进度+、进度++、进度+++ 之一。覆盖-v 和 -q。

`--logdir=<dir>`

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

(要写入一个您可以完全控制名称的日志文件，请改用--log-to-stderr并将stderr重定向到所需位置。)

`--common-caches=<dir>`

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

自 v2.15.2 版本起可用。

谁可以使用此功能？

本文内容

概要

描述

选项