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 install [--force] <options>... -- <dir>説明
[試験段階] このパックの依存関係をインストールします。
このコマンドは、パックの依存関係をインストールします。 codeql-pack.lock.yml が存在する場合、そのロック ファイルのバージョンが qlpack.yml ファイルで指定されたバージョン制約と互換性があれば、それらのバージョンがインストールされます。 ロック ファイルで指定された依存関係のバージョンがこのパックの制約と互換性がない場合、このコマンドは、それらの各依存関係の互換性のある最新バージョンをインストールし、新しく選択されたバージョンでロック ファイルを更新します。 ロック ファイルが存在しない場合、このコマンドはすべての依存関係の互換性のある最新バージョンをインストールし、新しいロック ファイルを作成します。
v2.6.0 以降で使用できます。
主なオプション
<dir>
パッケージのルート ディレクトリ。
--format=<fmt>
出力形式 (text (既定値) または json) を選択します。**
-f, --[no-]force
既存のパックの上書きを許可します。
--[no-]allow-prerelease
プレリリース バージョン修飾子 (例: X.Y.Z-qualifier) を含むパックの使用を許可します。 このフラグがないと、プレリリース パックは無視されます。
v2.11.3 以降で使用できます。
--lock-override=<file>
[詳細設定] 依存関係解決への入力として使う代替のロック ファイルを指定します。
--no-strict-mode
[詳細設定] 厳密モードをオフにして、--additional-packs および他のローカルで解決された場所からパッケージを解決するときに
警告が表示されないようにします。 ローカルで解決されたパッケージがダウンロードされることはなく、
パッケージ ロックにも追加されません。
--mode=<mode>
[非推奨] 依存関係の解決方法を指定します。
minimal-update "(既定値)": qlpack.yml ファイルの既存の内容に基づいて、codeql-pack.lock.yml を更新または作成します。** 既存の codeql-pack.lock.yml で qlpack.yml の現在の依存関係が満たされない場合、ロック ファイルは必要に応じて更新されます。
upgrade: qlpack.yml ファイルの制約に従って、すべての依存関係の最新バージョンを使用するように codeql-pack.lock.yml を更新または作成します。 このモードは、"codeql pack upgrade" コマンドに置き換えられました。
verify: qlpack.yml ファイルで指定された依存関係に関して既存の codeql-pack.lock.yml がまだ有効であることを確認します。そうしなければ、ロック ファイルが存在しない場合、失敗します。 このモードは、"codeql pack ci" コマンドに置き換えられました。
no-lock: 既存の codeql-pack.lock.yml を無視し、qlpack.yml ファイルに基づいて解決を実行します。 ロック ファイルを作成または更新しません。
use-lock: 既存の codeql-pack.lock.yml ファイルを使用して依存関係を解決するか、ロック ファイルが存在しない場合は作成します。
update: [非推奨] qlpack.yml ファイルの制約に従って、すべての依存関係の最新バージョンを使用するように codeql-pack.lock.yml を更新または作成します。 このモードは、"codeql pack upgrade" コマンドに置き換えられました。
パッケージ レジストリの外部で 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>=\
たとえば、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 環境変数をオーバーライドします。
共通オプション
-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 をリダイレクトします)。