Skip to main content

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

CodeQL CLI コマンドのマニュアル

CodeQL CLI の最新リリースで使用できるコマンドのリファレンス情報。

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

CodeQL は、次の種類のリポジトリで使用できます:

Note

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

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

bqrs decode

結果データを BQRS から他の形式に変換します。

bqrs diff

2 つの結果セット間の差異を計算します。

bqrs hash

[プラミング] BQRS ファイルの安定したハッシュを計算します。

bqrs info

BQRS ファイルのメタデータを表示します。

bqrs interpret

[プラミング] 単一の BQRS 内のデータを解釈します。

database add-diagnostic

[試験的] 診断情報の一部をデータベースに追加します。

database analyze

データベースを分析し、ソース コードのコンテキストで意味のある結果を生成します。

database bundle

CodeQL データベースの再配置可能なアーカイブを作成します。

database cleanup

ディスク上の CodeQL データベースを圧縮します。

database create

いずれかの CodeQL 製品を使用して分析できるソース ツリー用の CodeQL データベースを作成します。

database export-diagnostics

[試験的] データベースから失敗した分析の診断情報をエクスポートします。

データベースのファイナライズ

[プラミング] データベース作成の最後の手順。

データベースのインポート

[詳細設定] [プラミング] ファイナライズされていないデータベースを、別のファイナライズされていないデータベースにインポートします。

database index-files

[プラミング] 指定した CodeQL エクストラクターを使用してスタンドアロン ファイルのインデックスを作成します。

database init

[プラミング] 空の CodeQL データベースを作成します。

database interpret-results

[プラミング] 計算されたクエリ結果を SARIF や CSV などの意味のある形式に解釈します。

database print-baseline

[プラミング] 表示されたコードのベースライン行の概要を印刷します。

database run-queries

[プラミング] 一連のクエリを一緒に実行します。

database trace-command

[プラミング] トレースされたビルドの一部として単一のコマンドを実行します。

database unbundle

CodeQL データベース アーカイブを抽出します。

database upgrade

データベースをアップグレードして、現在のツールで使用できるようにします。

dataset check

[プラミング] 特定のデータセットで内部整合性を確認します。

dataset cleanup

[プラミング] データセットから一時ファイルをクリーンアップします。

dataset import

[プラミング] TRAP ファイルのセットを生のデータセットにインポートします。

dataset measure

[プラミング] 特定のデータセット内の関係に関する統計を収集します。

dataset upgrade

[プラミング] データセットをアップグレードして、現在のツールで使用できるようにします。

diagnostic add

[試験的] [プラミング] 診断情報の一部を追加します。

diagnostic export

[試験的] 失敗した分析の診断情報をエクスポートします。

execute cli-server

[ディープ プラミング] JVM の初期化を繰り返さないで複数のコマンドを実行するためのサーバー。

execute language-server

[プラミング] IDE での QL 言語のオンライン サポート。

クエリの実行

[配管] データセットに対して 1 つ以上のクエリを実行します。

execute query-server

[プラミング] IDE からのクエリ実行のサポート。

execute query-server2

[プラミング] IDE からのクエリ実行のサポート。

アップグレードの実行

[配管] 既存の生の QL データセットでアップグレード スクリプトを実行します。

extensible-predicate-metadata を生成する

[試験段階] [ディープ プラミング] 指定されたパックで見つかった拡張可能な述語を報告します。

generate log-summary

[詳細設定] 構造化ログ ファイルの概要を作成します。

クエリ ヘルプを生成する

.qhelp ファイルからエンド ユーザー クエリ ヘルプを生成します。

github merge-results

[ディーププラミング] 複数の SARIF ファイルを 1 つの SARIF ファイルにマージします。

github upload-results

GitHub コード スキャンに SARIF ファイルをアップロードします。

pack add

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

pack bundle

[プラミング] QL ライブラリ パックをバンドルします。

pack ci

このパックの依存関係をインストールし、既存のロック ファイルが最新であることを確認します。

pack create

[プラミング] ソース コードから QL パッケージの内容をビルドします。

pack download

コマンドラインのクエリ仕様で参照される qlpack のセットをレジストリからダウンロードします。 パックは、名前で提供することも、クエリ スイート (.qls) ファイル内で暗黙的に提供することもできます。

pack init

指定したディレクトリ内の qlpack を初期化します。

pack install

このパックの依存関係をインストールします。

pack ls

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

pack packlist

[プラミング] QL クエリ パックまたはライブラリ パックに含めるファイルのセットを計算します。

pack publish

QL ライブラリ パックを、パッケージ レジストリに発行します。

pack resolve-dependencies

[プラミング] この QL パックに必要な依存関係のセットを計算します。

pack upgrade

このパックの依存関係を、利用可能な最新バージョンに更新します。

クエリのコンパイル

QL コードをコンパイルまたはチェックします。

query decompile

[プラミング] コンパイル済みクエリの中間表現を .qlo ファイルから読み取ります。

query format

QL ソース コードのオートフォーマット。

クエリの実行

単一のクエリを実行します。

resolve database

[ディープ プラミング] データベースに関するメタデータを報告します。

拡張機能を解決する

[試験段階] [ディープ プラミング] アクセス可能な拡張機能を決定します。 これには、機械学習モデルとデータ拡張機能が含まれます。

resolve extensions-by-pack

[試験段階] [ディープ プラミング] パック ルートへの特定のパスでアクセスできる拡張機能を特定します。 これには、機械学習モデルとデータ拡張機能が含まれます。

resolve extractor

[ディープ プラミング] 特定の言語に使用するエクストラクター パックを決定します。

ファイルを解決する

[ディープ プラミング] ファイル包含/除外 glob のセットを拡張します。

resolve languages

インストールされている CodeQL エクストラクター パックを一覧表示します。

ライブラリ パスを解決する

[ディープ プラミング] クエリの QL ライブラリ パスと dbscheme を決定します。

resolve metadata

[ディープ プラミング] クエリ ソース ファイルのキーと値のメタデータのペアを解決して返します。

ml モデルを解決する

[非推奨] [試験段階] [ディープ プラミング] アクセス可能な機械学習モデルを決定します。

resolve pack

使用可能な CodeQL パックとその場所の一覧を表示します。

QL パックを解決する

インストールされている QL パックとその場所のリストを作成します。

qlref を解決する

[ディープ プラミング].qlref ファイルを逆参照して、.ql ファイルを返します。

クエリを解決する

[ディープ プラミング] クエリ ディレクトリとスイートの仕様を拡張します。

resolve ram

[ディープ プラミング] RAM オプションを準備します。

resolve tests

[ディープ プラミング] 特定のディレクトリで QL 単体テストを検索します。

アップグレードを解決する

[ディープ プラミング] 生データセットに対して実行するアップグレードを決定します。

test accept

失敗した単体テストの結果を受け入れます。

test extract

[プラミング] テスト ディレクトリのデータセットを作成します。

テストの実行

QL クエリの単体テストを実行します。

version

CodeQL ツールチェーンのバージョンを表示します。