pack download

この機能を使用できるユーザーについて

CodeQL は、次の種類のリポジトリで使用できます:

  • .com のパブリック リポジトリについては、「 CodeQL の使用条件」を参照してください
  • Code Security が有効になっている Team 上の organization 所有のリポジトリ

この記事の内容

メモ

このコンテンツでは、CodeQL CLI の最新リリースについて説明します。 このリリースについて詳しくは、 https://.com//codeql-cli-binaries/releases をご覧ください。

以前のリリースの、このコマンドで使えるオプションを詳しく確認するには、ターミナルで --help オプションを指定してコマンドを実行してください。

Shell
codeql pack download [--dir=<dir>] [--force] <options>... -- <scope/name[@version]|suite.qls>...

コマンドラインのクエリ仕様で参照される qlpack のセットをレジストリからダウンロードします。 パックは、名前で指定することも、クエリ スイート (.qls) ファイル内で暗黙的に指定することもできます。

既定では、パックはパッケージ キャッシュにダウンロードされ、解凍されます。

v2.6.0 以降で使用できます。

[必須] ダウンロードする CodeQL パックとクエリ スイートのリスト。 クエリ スイートが指定されている場合、その命令が検査され、参照されているすべての CodeQL パックがダウンロードされます。 CodeQL パックのバージョンを指定しない場合、最新バージョンがダウンロードされます。

出力形式 (text (既定値) または json) を選択します。__

パックのダウンロード先ディレクトリ。 既定では、パッケージ キャッシュにインストールされます。

依存関係がダウンロードされるパック。 各パックのパッケージ レジストは、<pack> の 'registries' プロパティによって決定されます。

プレリリース バージョン修飾子 (例: X.Y.Z-qualifier) を含むパックの使用を許可します。 このフラグがないと、プレリリース パックは無視されます。

v2.11.3 以降で使用できます。

既存のパックの上書きを許可します。

QL パックが見つかる可能性があるディレクトリの一覧。 各ディレクトリは、QL パック (またはルートに .codeqlmanifest.json ファイルを含むパックのバンドル)、または 1 つ以上のこのようなディレクトリの直接の親ディレクトリのいずれかです。

パスに複数のディレクトリを含める場合は、それらの順序で、それらの間の優先順位を定義します。解決する必要があるパック名が複数のディレクトリ ツリーで一致する場合は、最初に指定したものが優先されます。

オープンソースの CodeQL リポジトリのチェックアウトでこれを指定すると、そこにある言語の 1 つを照会するときに機能するはずです。

CodeQL リポジトリを、アンパックされた CodeQL ツールチェーンの兄弟としてチェックアウトしている場合、このオプションを指定する必要はありません。このような兄弟ディレクトリは、他の方法では見つからない QL パックについて常に検索されます (このデフォルトが機能しない場合は、ユーザーごとの構成ファイルで --search-path を一度だけ設定することを強くお勧めします)。

(注: Windows では、パスの区切り記号は ; です)。

このディレクトリ リストを指定した場合、ディレクトリは、--search-path で指定したものより前に、パックについて検索されます。 これらの間の順序は重要ではありません。このリストの 2 か所でパック名が見つかった場合は、エラーです。

これは、デフォルトのパスにも表示される新しいバージョンのパックを一時的に開発している場合に役立ちます。 一方、構成ファイルでこのオプションをオーバーライドすることは "お勧めしません"。内部アクションによっては、このオプションがオンザフライで追加され、構成済みの値がオーバーライドされます。__

(注: Windows では、パスの区切り記号は ; です)。

<registry_url>=<token> ペアのコンマ区切りのリストを渡して、 Enterprise Server コンテナー レジストリに対して認証を行います。

たとえば、https://containers.GHEHOSTNAME1/v2/=TOKEN1,https://containers.GHEHOSTNAME2/v2/=TOKEN2 を渡して、 2 つの Enterprise Server インスタンスに対して認証を行うことができます。

これを使って、CODEQL_REGISTRIES_AUTH および _TOKEN 環境変数をオーバーライドします。 .com コンテナー レジストリに対する認証のみが必要な場合は、代わりに、より単純な ---auth-stdin オプションを使って認証できます。

標準入力を介して .com Apps トークンまたは個人用アクセス トークンを渡して、.com コンテナー レジストリに対して認証を行います。

Enterprise Server コンテナー レジストリに対して認証を行うには、--registries-auth-stdin を渡すか、CODEQL_REGISTRIES_AUTH 環境変数を使います。

これを使って、_TOKEN 環境変数をオーバーライドします。

このヘルプ テキストを表示します。

[詳細設定] コマンドを実行している JVM にオプションを指定します

(スペースを含むオプションは正しく処理されないことに注意してください)。

出力される進行状況メッセージの数を段階的に増やします。

出力される進行状況メッセージの数を段階的に減らします。

[詳細設定] 詳細レベルを、errors、warnings、progress、progress+、progress++、progress+++ のいずれかに明示的に設定します。 -v と -q がオーバーライドされます。

[詳細設定] タイムスタンプと実行中のサブコマンドの名前を含む生成された名前を使用して、指定されたディレクトリ内の 1 つまたは複数のファイルに詳細なログを書き込みます

(完全に制御できる名前でログ ファイルを書き込むには、代わりに --log-to-stderr を指定し、必要に応じて stderr をリダイレクトします)。

[[詳細設定] ダウンロードした QL パックやコンパイル済みクエリ プランなど、CLI の複数の実行間に保持される、ディスク上でキャッシュされたデータの場所を制御します。 明示的に設定されない場合、デフォルトではユーザーのホーム ディレクトリに名前が付けられた .codeql ディレクトリになります。まだ存在しない場合は作成されます。

v2.15.2 以降で使用できます。