pack download

メモ

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

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

概要

Shell

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

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

Description

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

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

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

オプション

主なオプション

`<scope/name[@version]|suite.qls>...`

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

`--format=<fmt>`

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

`-d, --dir=<dir>`

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

`--for-pack=<pack>`

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

`--[no-]allow-prerelease`

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

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

`-f, --[no-]force`

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

QL パックを検索するためのオプション (クエリスイートを解釈するために必要な場合があります)

`--search-path=<dir>[:<dir>...]`

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

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

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

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

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

`--additional-packs=<dir>[:<dir>...]`

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

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

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

CodeQL パッケージマネージャーを構成するためのオプション

`--registries-auth-stdin`

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

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

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

`--github-auth-stdin`

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

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

これは、GITHUB_TOKEN 環境変数をオーバーライドします。

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

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

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

`--logdir=<dir>`

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

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

`--common-caches=<dir>`

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

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

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

この記事の内容

概要