pack download

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

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

GitHub CodeQL は、インストール時にユーザーごとにライセンスされます。 CodeQL は、ライセンスの制限の下で特定のタスクでのみ使用できます。詳しくは、「CodeQL CLI について」を参照してください。

GitHub Advanced Security ライセンスがある場合は、CodeQL を使用して、自動分析、継続的インテグレーション、継続的デリバリーを行うことができます。詳しくは、「GitHub Advanced Security について」を参照してください。

この記事の内容

このコンテンツでは、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>...

説明

コマンドラインのクエリ仕様で参照される 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 および 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 環境変数をオーバーライドします。

pack download

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

この記事の内容

構文

説明

[オプション]

主なオプション

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

`--format=<fmt>`

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

`--for-pack=<pack>`

`--[no-]allow-prerelease`

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

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

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

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

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

`--registries-auth-stdin`

`--github-auth-stdin`

共通オプション

`-h, --help`

`-J=<opt>`

`-v, --verbose`

`-q, --quiet`

`--verbosity=<level>`

`--logdir=<dir>`

`--common-caches=<dir>`