メモ
このコンテンツでは、CodeQL CLI の最新リリースについて説明します。 このリリースについて詳しくは、 https://github.com/github/codeql-cli-binaries/releases をご覧ください。
以前のリリースの、このコマンドで使えるオプションを詳しく確認するには、ターミナルで --help
オプションを指定してコマンドを実行してください。
構文
codeql generate overlay-changes [--source-root=<dir>] [--output=<file>] <options>... -- <database>
codeql generate overlay-changes [--source-root=<dir>] [--output=<file>] <options>... -- <database>
説明
[プラミング] オーバーレイ データベースを抽出するときに、codeql database create に対する --overlay-changes
オプションに使用できるファイルを生成します。
このコマンドは、主に手動テストまたは自動テストに使うためのものです。 特に効率的ではありません。 運用環境で使う場合は、変更ファイルを代わりに 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>
[詳細設定] タイムスタンプと実行中のサブコマンドの名前を含む生成された名前を使用して、指定されたディレクトリ内の 1 つまたは複数のファイルに詳細なログを書き込みます
(完全に制御できる名前でログ ファイルを書き込むには、代わりに --log-to-stderr
を指定し、必要に応じて stderr をリダイレクトします)。
--common-caches=<dir>
[[詳細設定] ダウンロードした QL パックやコンパイル済みクエリ プランなど、CLI の複数の実行間に保持される、ディスク上でキャッシュされたデータの場所を制御します。 明示的に設定されない場合、デフォルトではユーザーのホーム ディレクトリに名前が付けられた .codeql
ディレクトリになります。まだ存在しない場合は作成されます。
v2.15.2
以降で使用できます。