pack install

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

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

構文

Shell

codeql pack install [--force] <options>... -- <dir>

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>`

[詳細設定] 依存関係解決への入力として使う代替のロックファイルを指定します。

`--lock-output=<file>`

[詳細設定] 依存関係の解決によって生成されたロックファイルを保存する代替場所を指定します。

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

`--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>=<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 環境変数をオーバーライドします。

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

この記事の内容

構文

説明

[オプション]

主なオプション

`<dir>`

`--format=<fmt>`

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

`--[no-]allow-prerelease`

`--lock-override=<file>`

`--lock-output=<file>`

`--no-strict-mode`

`--mode=<mode>`

パッケージレジストリの外部で 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>`