{"meta":{"title":"bqrs interpret","intro":"[管道] 解释单个 BQRS 中的数据。","product":"安全性和代码质量","breadcrumbs":[{"href":"/zh/code-security","title":"安全性和代码质量"},{"href":"/zh/code-security/reference","title":"Reference"},{"href":"/zh/code-security/reference/code-scanning","title":"代码扫描"},{"href":"/zh/code-security/reference/code-scanning/codeql","title":"CodeQL"},{"href":"/zh/code-security/reference/code-scanning/codeql/codeql-cli-manual","title":"CodeQL CLI 手册"},{"href":"/zh/code-security/reference/code-scanning/codeql/codeql-cli-manual/bqrs-interpret","title":"bqrs interpret"}],"documentType":"article"},"body":"# bqrs interpret\n\n[管道] 解释单个 BQRS 中的数据。\n\n> [!NOTE]\n> 此内容描述了 CodeQL CLI 的最新版本。 有关此版本的详细信息，请参阅 https://github.com/github/codeql-cli-binaries/releases 。\n>\n> 若要查看早期版本中此命令可用选项的详细信息，请在终端中使用 <span style=\"white-space: nowrap;\">`--help`</span> 选项运行命令。\n\n## 概要\n\n```shell copy\ncodeql bqrs interpret --format=<format> --output=<output> -t=<String=String> [--threads=<num>] [--source-archive=<sourceArchive>] [--source-location-prefix=<sourceLocationPrefix>] <options>... -- <bqrs-file>\n```\n\n## Description\n\n              \\[管道] 解释单个 BQRS 中的数据。\n\n根据提供的元数据解释单个 BQRS 文件并以指定格式生成输出的命令。\n\n## 选项\n\n### 主要选项\n\n#### `<bqrs-file>`\n\n              \\[必选] 要解释的 BQRS 文件。\n\n#### `--format=<format>`\n\n              \\[必选] 写入结果的格式。 下列其中一项：\n\n              `csv`：带格式的逗号分隔值，包括包含规则和警报元数据的列。\n\n              `sarif-latest`：静态分析结果交换格式 (SARIF)，一种基于 JSON 的静态分析结果描述格式。 此格式选项使用最新的受支持版本 (v2.1.0)。 此选项不适合用于自动化，因为它在不同 CodeQL 版本之间生成不同版本的 SARIF。\n\n              `sarifv2.1.0`：SARIF v2.1.0。\n\n              `graphtext`：表示图形的文本格式。 仅与具有 @kind 图形的查询兼容。\n\n              `dgml`：有向图标记语言，一种基于 XML 的图形描述格式。 仅与具有 @kind 图形的查询兼容。\n\n              `dot`：Graphviz DOT 语言，一种基于文本的图形描述格式。\n仅与具有 @kind 图形的查询兼容。\n\n#### `-o, --output=<output>`\n\n              \\[必选] 写入结果的输出路径。 对于图形格式，这应该是一个目录，结果（如果此命令支持解释多个查询，则为多个结果）将写入该目录中。\n\n#### `-t=<String=String>`\n\n              \\[必选] 一个查询元数据键值对。 对每段元数据重复此操作。 至少必须指定键“kind”和“id”。 键不需要以 @ 作为前缀。\n\n#### `--max-paths=<maxPaths>`\n\n要为每个具有路径的警报生成的最大路径数。\n（默认值：4）\n\n#### `--[no-]sarif-add-file-contents`\n\n              \\[仅 SARIF 格式] 包含至少一个结果中引用的所有文件的完整文件内容。\n\n#### `--[no-]sarif-add-snippets`\n\n              \\[仅 SARIF 格式] 包含结果中提到的每个位置的代码段，报告位置前后各包含两行上下文。\n\n#### `--[no-]sarif-add-query-help`\n\n              \\[仅 SARIF 格式] \\[已弃用] 包含所有查询的 Markdown 查询帮助。 它从 /path/to/query.md 文件加载 /path/to/query.ql 的查询帮助。 如果未提供此标志，则默认行为仅包含自定义查询（即查询包中并非 \\`codeql/\\<lang\\&rt;-queries\\` 形式的查询）的帮助。 此选项在传递给 codeql bqrs interpret 时不起作用。\n\n#### `--sarif-include-query-help=<mode>`\n\n              \\[仅 SARIF 格式] 指定是否在 SARIF 输出中包含查询帮助。 下列其中一项：\n\n              `always`：包含所有查询的查询帮助。\n\n              `custom_queries_only`\n              _（默认）_：仅包含自定义查询的查询帮助，即查询包中不属于 \\`codeql/\\<lang\\&rt;-queries\\` 格式的查询。\n\n              `never`：不包含任何查询的查询帮助。\n\n此选项在传递给 codeql bqrs interpret 时不起作用。\n\n自 `v2.15.2` 起可用。\n\n#### `--no-sarif-include-alert-provenance`\n\n              \\[高级] \\[仅 SARIF 格式] 不在 SARIF 输出中包含警报来源信息。\n\n自 `v2.18.1` 起可用。\n\n#### `--[no-]sarif-group-rules-by-pack`\n\n              \\[仅 SARIF 格式] 将每个查询的规则对象放在其对应的 QL 包下的 `<run>.tool.extensions` 属性中。 此选项在传递给 codeql bqrs interpret 时不起作用。\n\n#### `--[no-]sarif-multicause-markdown`\n\n              \\[仅 SARIF 格式] 对于有多个原因的警报，除了以纯字符串形式外，还以 Markdown 格式的项目符号列表形式包含在输出中。\n\n#### `--no-sarif-minify`\n\n              \\[仅 SARIF 格式] 生成格式美观的 SARIF 输出。 默认情况下，SARIF 输出会缩小，以减少输出文件的大小。\n\n#### `--sarif-run-property=<String=String>`\n\n              \\[仅 SARIF 格式] 要添加到生成的 SARIF“run”属性包中的键值对。 可以重复。\n\n#### `--no-group-results`\n\n              \\[仅 SARIF 格式] 每条消息生成一个结果，而非每个唯一位置生成一个结果。\n\n#### `--csv-location-format=<csvLocationFormat>`\n\n在 CSV 输出中生成位置时采用的格式。 即以下值之一：uri、line-column、offset-length。 （默认值：line-column）\n\n#### `--dot-location-url-format=<dotLocationUrlFormat>`\n\n一个格式字符串，用于定义在 DOT 输出中生成文件位置 URL 时采用的格式。 可使用以下占位符：{path} {start:line} {start:column} {end:line} {end:column}, {offset}, {length}\n\n#### `--[no-]sublanguage-file-coverage`\n\n              \\[仅 GitHub.com 和 GitHub Enterprise Server v3.12.0+] 使用子语言文件覆盖率信息。 这会为共享 C 和 C++、Java 和 Kotlin，以及 JavaScript 和 TypeScript 等 CodeQL 提取程序包的语言计算、显示和导出单独的文件覆盖信息。\n\n自 `v2.15.2` 起可用。\n\n#### `--sarif-category=<category>`\n\n              \\[仅 SARIF 格式] \\[建议] 指定要包含在 SARIF 输出中的此分析的类别。 类别可用于区分在同一提交和存储库上（但在不同语言或代码的不同部分）执行的多次分析。\n\n如果以多种不同方式分析同一版本的代码库（例如，针对不同语言）并将结果上传到 GitHub 以在代码扫描中呈现，则每次分析的此值应不同，这会告知代码扫描这些分析是_补充_而非_替代_彼此。 （对于代码库的_不同_版本，同一分析的运行之间的值应保持一致。）\n\n此值将显示为 `<run>.automationDetails.id` 属性（如果尚不存在，则会在结尾追加斜线）。\n\n#### `-j, --threads=<num>`\n\n用于计算路径的线程数。\n\n默认值为 1。 可以传递 0 以在机器上每个内核使用一个线程，或传递 -_N_ 以保留 _N_ 个内核不使用（但仍至少使用一个线程）。\n\n#### `--column-kind=<columnKind>`\n\n              \\[仅 SARIF] 用于解释位置列的列类型。 即以下值之一：utf8、utf16、utf32、字节。\n\n#### `--[no-]unicode-new-lines`\n\n              \\[仅 SARIF] 在解释位置行号时，是否将 Unicode 换行字符 LS（行分隔符，U+2028）和 PS（段落分隔符，U+2029）视为换行符。\n\n### 源存档选项 - 必须同时提供或不提供\n\n#### `-s, --source-archive=<sourceArchive>`\n\n包含源存档的目录或 zip 文件。\n\n#### `-p, --source-location-prefix=<sourceLocationPrefix>`\n\n原始文件系统上存储源代码的文件路径。\n\n### 常用选项\n\n#### `-h, --help`\n\n显示此帮助文本。\n\n#### `-J=<opt>`\n\n              \\[高级] 向运行命令的 JVM 提供选项。\n\n（请注意，无法正确处理包含空格的选项。）\n\n#### `-v, --verbose`\n\n以增量方式增加输出的进度消息数。\n\n#### `-q, --quiet`\n\n以增量方式减少输出的进度消息数。\n\n#### `--verbosity=<level>`\n\n              \\[高级] 明确将详细级别设置为 errors、warnings、progress、progress+、progress++、progress+++ 之一。 重写 `-v` 和 `-q`。\n\n#### `--logdir=<dir>`\n\n              \\[高级] 将详细日志写入指定目录中的一个或多个文件，生成的文件名包含时间戳和正在运行的子命令名称。\n\n（要使用可以完全控制的名称编写日志文件，请根据需要提供 `--log-to-stderr` 并重定向 stderr。）\n\n#### `--common-caches=<dir>`\n\n              \\[高级] 控制磁盘上缓存数据的位置，这些数据将在 CLI 的多次运行之间保留，例如下载的 QL 包和编译的查询计划。 如果未明确设置，则默认为用户主目录中名为 `.codeql` 的目录；如果尚不存在，则会创建该目录。\n\n自 `v2.15.2` 起可用。"}