Skip to main content

生成覆盖更改

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

谁可以使用此功能?

CodeQL 可用于以下存储库类型:

本文内容

注意

此内容描述了 CodeQL CLI 的最新版本。 有关此版本的详细信息,请参阅 https://github.com/github/codeql-cli-binaries/releases

若要查看早期版本中此命令可用选项的详细信息,请在终端中使用 --help 选项运行命令。

摘要

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

说明

[管道] 生成一个文件,该文件可用于 --overlay-changes 选项,以便在提取覆盖数据库时执行 codeql 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>

[高级] 将详细级别显式设置为“错误”、“警告”、“进度”、“进度+”、“进度++”、“进度+++”之一。 重写 -v-q

--logdir=<dir>

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

(若要使用可以完全控制的名称编写日志文件,请根据需要提供 --log-to-stderr 并重定向 stderr。)

--common-caches=<dir>

[高级] 控制磁盘上缓存数据的位置,此位置会在多次运行 CLI(例如下载的 QL 包和已编译查询计划)期间暂留。 如果未明确设置,则默认为用户主目录中名为 .codeql 的目录;如果尚不存在,则会创建该目录。

v2.15.2 起可用。