Skip to main content
ドキュメントへの更新が頻繁に発行されており、このページの翻訳はまだ行われている場合があります。 最新の情報については、「英語のドキュメント」を参照してください。

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

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

GitHub CodeQL は、インストール時にユーザーごとにライセンスされます。 CodeQL は、ライセンスの制限の下で特定のタスクでのみ使用できます。 詳しくは、「CodeQL CLI について」を参照してください。

GitHub Enterprise アカウントと GitHub Advanced Security ライセンスがある場合は、CodeQL を使用して、自動分析、継続的インテグレーション、継続的デリバリーを行うことができます。 営業チームに連絡することで、Enterprise アカウントを作成できます。 詳しくは、「GitHub Advanced Security について」を参照してください。

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.

  • bqrs decode

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

  • bqrs diff

    Compute the difference between two result sets.

  • bqrs hash

    [Plumbing] Compute a stable hash of a BQRS file.

  • bqrs info

    Display metadata for a BQRS file.

  • bqrs interpret

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

  • database add-diagnostic

    [Experimental] Add a piece of diagnostic information to a database.

  • database analyze

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

  • database bundle

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

  • database cleanup

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

  • database create

    Create a CodeQL database for a source tree that can be analyzed using one of the CodeQL products.

  • database export-diagnostics

    [Experimental] Export diagnostic information from a database for a failed analysis.

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

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

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

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

  • database index-files

    [Plumbing] Index standalone files with a given CodeQL extractor.

  • database init

    [Plumbing] Create an empty CodeQL database.

  • database interpret-results

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

  • database print-baseline

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

  • database run-queries

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

  • database trace-command

    [Plumbing] Run a single command as part of a traced build.

  • database unbundle

    Extracts a CodeQL database archive.

  • database upgrade

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

  • dataset check

    [Plumbing] Check a particular dataset for internal consistency.

  • dataset cleanup

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

  • dataset import

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

  • dataset measure

    [Plumbing] Collect statistics about the relations in a particular dataset.

  • dataset upgrade

    [Plumbing] Upgrade a dataset so it is usable by the current tools.

  • diagnostic add

    [Experimental][Plumbing] Add a piece of diagnostic information.

  • diagnostic export

    [Experimental] Export diagnostic information for a failed analysis.

  • execute cli-server

    [Deep plumbing] Server for running multiple commands while avoiding repeated JVM initialization.

  • execute language-server

    [Plumbing] On-line support for the QL language in IDEs.

  • クエリの実行

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

  • execute query-server

    [Plumbing] Support for running queries from IDEs.

  • execute query-server2

    [Plumbing] Support for running queries from IDEs.

  • アップグレードの実行

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

  • generate log-summary

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

  • クエリ ヘルプを生成する

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

  • github upload-results

    Uploads a SARIF file to GitHub code scanning.

  • pack add

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

  • pack bundle

    [Experimental][Plumbing] Bundle a QL library pack.

  • pack ci

    [Experimental] Install dependencies for this pack, verifying that the existing lock file is up to date.

  • pack create

    [Experimental][Plumbing] Builds the contents of a QL package from source code.

  • pack download

    [Experimental] Download the set of qlpacks referenced by the query spec of the command line from the registry. Packs can be provided by name or implicitly inside of a query suite (.qls) file.

  • pack init

    [Experimental] Initializes a qlpack in the specified directory.

  • pack install

    [Experimental] Install dependencies for this pack.

  • pack ls

    [Experimental][Deep plumbing] List the CodeQL packages rooted at this directory. This directory must contain a qlpack.yml or .codeqlmanifest.json file.

  • pack packlist

    [Experimental][Plumbing] Compute the set of files to be included in a QL query pack or library pack.

  • pack publish

    [Experimental] Publishes a QL library pack to a package registry.

  • pack resolve-dependencies

    [Experimental][Plumbing] Compute the set of required dependencies for this QL pack.

  • pack upgrade

    [Experimental] Update the dependencies for this pack to the latest available versions.

  • クエリのコンパイル

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

  • query decompile

    [Plumbing] Read an intermediate representation of a compiled query from a .qlo file.

  • query format

    Autoformat QL source code.

  • クエリの実行

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

  • resolve database

    [Deep plumbing] Report metadata about the database.

  • 拡張機能を解決する

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

  • resolve extractor

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

  • ファイルを解決する

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

  • resolve languages

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

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

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

  • resolve metadata

    [Deep plumbing] Resolve and return the key-value metadata pairs from a query source file.

  • ml モデルを解決する

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

  • QL パックを解決する

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

  • qlref を解決する

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

  • クエリを解決する

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

  • resolve ram

    [Deep plumbing] Prepare RAM options.

  • resolve tests

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

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

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

  • test accept

    Accept results of failing unit tests.

  • test extract

    [Plumbing] Build a dataset for a test directory.

  • テストの実行

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

  • version

    Show the version of the CodeQL toolchain.