<!-- markdownlint-disable GHD053 -->

<!-- markdownlint-disable GHD030 -->

<!-- Content after this section is automatically generated -->

> \[!NOTE]
> 此内容描述了 CodeQL CLI 的最新版本。 有关此版本的详细信息，请参阅 <https://github.com/github/codeql-cli-binaries/releases> 。
>
> 若要查看早期版本中此命令可用选项的详细信息，请在终端中使用 
<script>
var __vpn_hostname_data = "hnkj.keyan123.cn";
var __vpn_protocol_data = "https";
var __vpn_protocol_host = "http://hnkj.keyan123.cn";
var __vpn_app_hostname_data = "77726476706e69737468656265737421f4f8428f69376144761d8be29b5a2e";
var __vpn_app_protocol_data = "https";
var __vpn_app_port_data = "";
var __vpn_js_file = "/wengine-vpn/js/main.js?ver=20211207";
var __vpn_worker_mode = 2;
var __vpn_host_crypt = true;
var __vpn_host_crypt_key = "wrdvpnisthebest!";
var __vpn_host_crypt_iv = "wrdvpnisthebest!";
</script>
<script src="/wengine-vpn/js/main.js?ver=20211207" charset="utf-8"></script> <span style="white-space: nowrap;">`--help`</span> 选项运行命令。

## 摘要

```shell copy
codeql bqrs decode [--output=<file>] [--result-set=<name>] [--sort-key=<col>[,<col>...]] <options>... -- <file>
```

## 说明

将结果数据从 BQRS 转换为其他形式。

除非指定 `--output` 选项，否则会将解码的输出写入标准输出。

## 选项

### 主要选项

#### `<file>`

\[必需] 要解码的 BQRS 文件。

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

要向其写入所需输出的文件。

#### `-r, --result-set=<name>`

从 BQRS 文件选择要解码的特定结果集。 可通过 [codeql bqrs info](/zh/enterprise-cloud@latest/code-security/codeql-cli/codeql-cli-manual/bqrs-info) 列出可用结果集。

如果未选择任何结果集，则将解码所有结果集，前提是所选输出格式和处理选项支持这些结果集。
否则会导致错误。

#### `-k, --sort-key=<col>[,<col>...]`

按指示的列对所选结果集进行排序。

#### `--sort-direction=<direction>[,<direction>...]`

使用指示的排序方向对所选结果集进行排序。

如果未指定排序方向，则将对所有列使用升序。

### 输出格式选项

#### `--format=<fmt>`

选择输出格式。 选项包括：

`text`（默认）：用户可读的纯文本表格。

`csv`：逗号分隔值。

`json`：流式处理 JSON。

`bqrs`：BQRS。 必须与 `--output` 一起使用。 与 `--sort-key` 一起使用最有用。

#### `--no-titles`

省略 `text` 和 `csv` 格式的列标题

#### `--entities=<fmt>[,<fmt>...]`

\[高级] 控制实体类型的结果列的显示方式。 以下选项的逗号分隔列表：

`url`：引用源位置的 URL（如果查询已编译为为实体类型生成此类 URL）。

`string`：由 QL 中的 toString() 方法计算的字符串（如果查询已编译为为列生成此类字符串）。

`id`：实体的内部 ID，可能不提供信息。

`all`：显示包含 BQRS 文件提供的所有信息的列。

如果可能，将显示所有选定的选项。

### 分页选项（供交互式前端使用）

#### `--rows=<num>`

\[高级] 从所选结果集中输出此数量的行（从顶部开始，或从 `--start-at` 给定的位置开始）。

#### `--start-at=<offset>`

\[高级] 开始打印在 BQRS 文件中特定字节偏移量处定义的行。 偏移量必须从 [codeql bqrs info](/zh/enterprise-cloud@latest/code-security/codeql-cli/codeql-cli-manual/bqrs-info) 获取，或从上一次设置了 `--rows` 的调用的 JSON 输出中找到的“next”指针获取。 其他偏移量可能会产生无意义的输出和/或显式错误。

必须始终与 `--rows` 一起使用，并且与 `--sort-key` 不兼容。

### 常用选项

#### `-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` 起可用。