# 生成覆盖更改

\[管道] 生成文件，且可用于

> \[!NOTE]
> 此内容描述了 CodeQL CLI 的最新版本。 有关此版本的详细信息，请参阅 <https://github.com/github/codeql-cli-binaries/releases> 。
>
> 若要查看早期版本中此命令可用选项的详细信息，请在终端中使用 <span style="white-space: nowrap;">`--help`</span> 选项运行命令。

## 概要

```shell copy
codeql generate overlay-changes [--source-root=<dir>] [--output=<file>] <options>... -- <database>
```

## Description

```
          \[管道] 生成一个文件，该文件可在提取覆盖数据库时用作 `--overlay-changes` 的 [](/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-create) 选项。
```

此命令主要用于手动或自动测试。 它不是特别高效。 用于生产环境时，需考虑变更文件是否可转而从 `git diff --name-only` 这类内容中获取。

## 选项

### 主要选项

#### `<database>`

```
          \[必选] 要将覆盖提取到的_基础_数据库的路径。
```

#### `-s, --source-root=<dir>`

包含要作为覆盖内容提取的源代码的目录。
如果未给出，则使用当前工作目录。

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

更改文件将写入此位置。 如果未指定，则更改将写入标准输出。

### 常用选项

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