Skip to main content

このバージョンの GitHub Enterprise サーバーはこの日付をもって終了となります: 2024-03-07. 重大なセキュリティの問題に対してであっても、パッチリリースは作成されません。 パフォーマンスの向上、セキュリティの向上、新機能の向上を図るために、最新バージョンの GitHub Enterprise サーバーにアップグレードしてください。 アップグレードに関するヘルプについては、GitHub Enterprise サポートにお問い合わせください

pack ls

[試験段階] [ディープ プラミング] このディレクトリにルート化された CodeQL パッケージを一覧表示します。 このディレクトリには、qlpack.yml または .codeqlmanifest.json ファイルが含まれている必要があります。

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

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 ls <options>... -- <dir>

説明

[ディープ プラミング] このディレクトリにルート化された CodeQL パッケージを一覧表示します。 このディレクトリには、qlpack.yml または .codeqlmanifest.json ファイルが含まれている必要があります。

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

[オプション]

主なオプション

<dir>

パッケージまたはワークスペースのルート ディレクトリ。既定値は現在の作業ディレクトリです。 このパラメーターが qlpack.yml を含むディレクトリを指している場合、この操作はその CodeQL パッケージでのみ実行されます。 このパラメーターが codeql-workspace.yml を含むディレクトリを指している場合、この操作はワークスペース内のすべての CodeQL パッケージで実行されます。

このコマンドを適用する CodeQL パックを構成するためのオプション。

--format=<fmt>

出力形式 (text (既定値) または json) を選択します。__

--groups=[-]<group>[,[-]<group>...]

この操作に含める、またはこの操作から除外する CodeQL パック グループのリスト。 次の場合、特定のワークスペースの qlpack が含まれます。

  • マイナス記号なしで一覧表示されているグループの少なくとも 1 つに属している (マイナス記号なしでリストされているグループがない場合、この条件は自動的に満たされます)。
  • マイナス記号が付いた一覧表示されているどのグループにも属していない

共通オプション

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