此内容描述了 CodeQL CLI 的最新版本。有关此版本的更多信息，请参阅 https://github.com/github/codeql-cli-binaries/releases。
要在早期版本中查看此命令可用的选项的详细信息，请在终端中使用 --help 选项运行该命令。
摘要
codeql database add-diagnostic --source-id=<id> --source-name=<name> <options>... -- <database>
codeql database add-diagnostic --source-id=<id> --source-name=<name> <options>... -- <database>
说明
[实验性] 将诊断信息片段添加到数据库中。
自 v2.12.6 起可用。
选项
主要选项
<database>
[必填] 要捆绑的 CodeQL 数据库的路径。
--markdown-message=<markdownMessage>
诊断消息，采用 GitHub 风格的 Markdown 格式。
--plaintext-message=<plaintextMessage>
诊断消息，采用纯文本格式。仅当使用 --markdown-message 填充 Markdown 消息不切实际时，才应使用此选项。
--severity=<severity>
诊断的严重性。可以是“error”、“warning”或“note”。
--help-link=<helpLinks>
与诊断相关的帮助链接。
--attributes-json=<attributesJson>
与诊断相关的结构化元数据。
指示诊断消息显示位置的选项
--ready-for-status-page
指示诊断适合在状态页面上显示。
--ready-for-cli-summary-table
指示诊断适合在诸如 database analyze 之类的命令打印的诊断摘要表中显示。
描述诊断来源的选项
--source-id=<id>
[必填] 此诊断来源的标识符。
--source-name=<name>
[必填] 此诊断来源的人类可读描述。
--extractor-name=<extractorName>
如果此诊断是由 CodeQL 提取器生成的，则为 CodeQL 提取器的名称。
描述诊断位置的选项
--file-path=<file>
诊断适用的文件路径，相对于源根目录。
--start-line=<startLine>
诊断位置开始处的基于 1 的行号（包含）。
--start-column=<startColumn>
诊断位置开始处的基于 1 的列号（包含）。
--end-line=<endLine>
诊断位置结束处的基于 1 的行号（包含）。
--end-column=<endColumn>
诊断位置结束处的列号（包含），从 1 开始计数。
常用选项
-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 版本起可用。