Skip to main content

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

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

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

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

メモ

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

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

bqrs をデコードする

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

bqrs diff

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

bqrs ハッシュ

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

bqrs 情報

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

bqrs 解釈

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

データベースに診断を追加

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

データベース分析

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

データベース バンドル

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

データベースのクリーンアップ

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

データベースの作成

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

データベースエクスポート診断

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

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

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

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

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

データベース インデックスファイル

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

データベース初期化

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

データベース 解釈結果

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

データベース印刷ベースライン

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

データベース実行クエリ

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

データベース トレースコマンド

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

データベースの分割

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

データベースのアップグレード

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

データセットのチェック

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

データセットのクリーンアップ

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

データセットのインポート

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

データセット測定

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

データセットのアップグレード

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

診断機能を追加

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

診断エクスポート

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

cli-server の実行

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

言語サーバーを実行する

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

クエリの実行

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

クエリサーバーを実行する

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

クエリを実行する: query-server2

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

アップグレードの実行

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

extensible-predicate-metadata を生成する

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

ログサマリーを生成する

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

オーバーレイの変更を生成する

[プラミング] 使用できるファイルを生成します

クエリ ヘルプを生成する

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

github マージ結果

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

GitHubで結果をアップロード (github upload-results)

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

パック追加

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

パックバンドル

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

パックCI

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

パック作成

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

パックのダウンロード

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

パック初期化 (pack init)

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

パックのインストール

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

パック ls

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

パック パックリスト

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

パック発行

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

pack リゾルブ・ディペンデンシー

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

パックのアップグレード

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

クエリのコンパイル

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

クエリ逆コンパイル

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

クエリ形式

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

クエリの実行

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

データベースを修正する

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

拡張機能を解決する

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

拡張機能をパックごとに解決する

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

リゾルバーエクストラクター

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

ファイルを解決する

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

言語を解決する

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

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

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

メタデータの解決

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

ml モデルを解決する

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

resolve pack

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

QL パックを解決する

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

qlref を解決する

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

クエリを解決する

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

ram を解決する

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

テストを解決する

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

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

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

テスト受け入れ

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

テストデータ抽出

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

テストの実行

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

バージョン

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