pack add

Note

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

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

構文

Shell

codeql pack add <options>... -- <scope/name[@range]>...

codeql pack add <options>... -- <scope/name[@range]>...

説明

現在のパッケージの依存関係として、省略可能なバージョン範囲を含む QL ライブラリパックのリストを追加し、それらをインストールします。

このコマンドでは、現在のパッケージの qlpack.yml ファイルが変更されます。書式設定とコメントは削除されます。

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

[オプション]

主なオプション

`<scope/name[@range]>...`

[必須] 依存関係リストに追加するパックのスコープ、名前、および省略可能なバージョン範囲。

バージョン範囲を指定していない場合、またはバージョン範囲を 'latest' と指定した場合、パックの最新バージョンがダウンロードされ、ダウンロードされたバージョンと互換性がある任意のバージョンを許可する依存関係が qlpack.yml に追加されます。

1 つのバージョンを指定した場合、パックのそのバージョンがダウンロードされ、指定したバージョンと互換性がある任意のバージョンを許可する依存関係が qlpack.yml に追加されます。

バージョン範囲を指定した場合、指定した範囲を満たすパックの最新バージョンがダウンロードされ、指定したバージョン範囲の依存関係が qlpack.yml に追加されます。

`--dir=<dir>`

パッケージのルートディレクトリ。

`--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 環境変数がオーバーライドされます。

`--[no-]allow-prerelease`

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

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

共通オプション

`-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 以降で使用できます。