This content describes the most recent release of the CodeQL CLI. For more information about this release, see https://github.com/github/codeql-cli-binaries/releases.
To see details of the options available for this command in an earlier release, run the command with the --help option in your terminal.
構文
codeql pack add <options>... -- <scope/name[@range]>...説明
[試験段階] 現在のパッケージの依存関係として、省略可能なバージョン範囲を含む QL ライブラリ パックのリストを追加し、それらをインストールします。
このコマンドでは、現在のパッケージの qlpack.yml ファイルが変更されます。 書式設定とコメントは削除されます。
主なオプション
<scope/name[@range]>...
[必須] 依存関係リストに追加するパックのスコープ、名前、および省略可能なバージョン範囲。 指定した範囲を満たす最新バージョンがダウンロードされ、指定した範囲が qlpack.yml に追加されます。 バージョンが欠落している場合は、このパックの最新バージョンが取得され、そのバージョンが qlpack.yml に追加されます。
--dir=<dir>
パッケージのルート ディレクトリ。
--registries-auth-stdin
\<registry_url>=\
たとえば、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) を含むパックの使用を許可します。 このフラグがないと、プレリリース パックは無視されます。
共通オプション
-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 をリダイレクトします)。