generate overlay-changes

[Plumbing] Generate a file that can be used for the

谁可以使用此功能？

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

GitHub.com 上的公共存储库，请参阅 GitHub CodeQL 条款和条件
启用了 GitHub Code Security 的 GitHub Team 或 GitHub Enterprise Cloud 上的组织拥有的存储库

本文内容

注意

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

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

Synopsis

Shell

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

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

Description

[Plumbing] Generate a file that can be used for the --overlay-changes option to codeql database create when extracting an overlay database.

This command is intended to be used mostly for manual or automated testing. It is not particularly efficient. For production use, consider if the changes file can instead be derived from something like git diff --name-only.

Options

Primary Options

`<database>`

[Mandatory] Path to the base database into which the overlay will be extracted.

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

The directory containing the source code to be extracted as an overlay. If not given, the current working directory is used.

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

The changes file will be written to this location. If it is not specified, the changes will be written to standard output.

Common options

`-h, --help`

Show this help text.

`-J=<opt>`

[Advanced] Give option to the JVM running the command.

(Beware that options containing spaces will not be handled correctly.)

`-v, --verbose`

Incrementally increase the number of progress messages printed.

`-q, --quiet`

Incrementally decrease the number of progress messages printed.

`--verbosity=<level>`

[Advanced] Explicitly set the verbosity level to one of errors, warnings, progress, progress+, progress++, progress+++. Overrides -v and -q.

`--logdir=<dir>`

[Advanced] Write detailed logs to one or more files in the given directory, with generated names that include timestamps and the name of the running subcommand.

(To write a log file with a name you have full control over, instead give --log-to-stderr and redirect stderr as desired.)

`--common-caches=<dir>`

[Advanced] Controls the location of cached data on disk that will persist between several runs of the CLI, such as downloaded QL packs and compiled query plans. If not set explicitly, this defaults to a directory named .codeql in the user's home directory; it will be created if it doesn't already exist.

Available since v2.15.2.