跳至主要内容

generate overlay-changes

[Plumbing] 生成一个可用于的文件

谁可以使用此功能?

CodeQL 可用于以下仓库类型

本文内容

注意

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

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

概要

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

描述

[Plumbing] 生成一个可用于 --overlay-changes 选项的文件,以便在提取覆盖数据库时调用 codeql database create

该命令主要用于手动或自动化测试。它的效率并不高。用于生产环境时,建议考虑是否可以通过类似 git diff --name-only 的方式生成变更文件。

选项

主要选项

<database>

[Mandatory] base 数据库的路径,覆盖内容将被提取到该数据库中。

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

© . This site is unofficial and not affiliated with GitHub, Inc.