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.