bqrs interpret

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

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

構文

Shell

codeql bqrs interpret --format=<format> --output=<output> -t=<String=String> [--threads=<num>] [--source-archive=<sourceArchive>] [--source-location-prefix=<sourceLocationPrefix>] <options>... -- <bqrs-file>

codeql bqrs interpret --format=<format> --output=<output> -t=<String=String> [--threads=<num>] [--source-archive=<sourceArchive>] [--source-location-prefix=<sourceLocationPrefix>] <options>... -- <bqrs-file>

説明

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

指定されたメタデータに従って単一の BQRS ファイルを解釈し、指定された形式で出力を生成するコマンド。

[オプション]

主なオプション

`--format=<format>`

[必須] 結果を書き込む形式。つぎのいずれかです。

csv: ルールとアラートメタデータの両方がある列を含む、書式設定されたコンマ区切りの値。

sarif-latest: Static Analysis Results Interchange Format (SARIF)。静的な分析結果を記述するための JSON ベースの形式。この形式オプションでは、サポートされている最新バージョン (v2.1.0) が使用されます。このオプションは、異なる CodeQL バージョン間で異なるバージョンの SARIF が生成されるため、自動化での使用には適していません。

sarifv2.1.0: SARIF v2.1.0。

graphtext: グラフを表すテキスト形式。 @kind グラフを使用するクエリとのみ互換性があります。

dgml: Directed Graph Markup Language。グラフを記述するための XML ベースの形式。 @kind グラフを使用するクエリとのみ互換性があります。

dot: Graphviz DOT 言語。グラフを記述するためのテキストベースの形式。 @kind グラフを使用するクエリとのみ互換性があります。

`-o, --output=<output>`

[必須] 結果を書き込む出力パス。グラフ形式の場合、これはディレクトリである必要があり、結果 (このコマンドで複数のクエリの解釈がサポートされている場合は複数の結果) がそのディレクトリ内に書き込まれます。

`-t=<String=String>`

[必須] クエリメタデータのキーと値のペア。各メタデータに対して繰り返します。少なくともキー 'kind' と 'id' を指定する必要があります。キーの前に @ を付ける必要はありません。

`--max-paths=<maxPaths>`

パスを含むアラートごとに生成するパスの最大数。 (デフォルト値: 4)

`--[no-]sarif-add-file-contents`

[SARIF 形式のみ] 少なくとも 1 つの結果で参照されるすべてのファイルの完全なファイルコンテンツを含めます。

`--[no-]sarif-add-snippets`

[SARIF 形式のみ] 結果に示されている各場所のコードスニペットを含めます。報告された場所の前後に 2 行のコンテキストがあります。

`--[no-]sarif-add-query-help`

[SARIF 形式のみ] [非推奨] すべてのクエリの Markdown クエリヘルプを含めます。 /path/to/query.md ファイルから /path/to/query.ql のクエリヘルプが読み込まれます。このフラグが指定されていない場合のデフォルトの動作では、カスタムクエリ (`codeql/<lang&rt;-queries` 形式ではないクエリパック内のクエリ) に対してのみヘルプを含めます。このオプションは、codeql bqrs interpret に渡しても効果はありません。

`--sarif-include-query-help=<mode>`

[SARIF 形式のみ] SARIF 出力にクエリヘルプを含めるかどうかを指定します。次のいずれか:

always: すべてのクエリにクエリヘルプを含めます。

custom_queries_only(デフォルト値): カスタムクエリ (`codeql/<lang&rt;-queries` 形式ではないクエリ) にのみクエリヘルプを含めます。

never: どのクエリにもヘルプを含めません。

このオプションは、codeql bqrs interpret に渡しても効果はありません。

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

`--[no-]sarif-group-rules-by-pack`

[SARIF 形式のみ] <run>.tool.extensions プロパティの対応する QL パックの下に、各クエリのルールオブジェクトを配置します。このオプションは、codeql bqrs interpret に渡しても効果はありません。

`--[no-]sarif-multicause-markdown`

[SARIF 形式のみ] 複数の原因があるアラートの場合は、プレーン文字列に加え、マークダウン形式の明細化されたリストとして出力に含めます。

`--no-sarif-minify`

[SARIF 形式のみ] 再フォーマットされた SARIF 出力を生成します。既定では、SARIF 出力はミニファイ処理され、出力ファイルのサイズが小さくなります。

`--no-group-results`

[SARIF 形式のみ] 一意の場所ごとに 1 つの結果ではなく、メッセージごとに 1 つの結果を生成します。

`--csv-location-format=<csvLocationFormat>`

CSV 出力で場所を生成する形式。次のいずれか: uri、行列、オフセット長。 (デフォルト値: 行列)

`--dot-location-url-format=<dotLocationUrlFormat>`

DOT 出力でファイルの場所 URL を生成する形式を定義する書式設定文字列。プレースホルダーとして、{path} {start:line} {start:column} {end:line} {end:column}、{offset}、{length} を使用できます

`--[no-]sublanguage-file-coverage`

[GitHub.com および GitHub Enterprise Server v3.12.0 以降のみ] サブ言語のファイルカバレッジ情報を使用します。これにより、C と C++、Java と Kotlin、JavaScript、TypeScript などの CodeQL エクストラクターを共有する言語の個別のファイルカバレッジ情報を計算、表示、エクスポートします。

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

`--sarif-category=<category>`

[SARIF 形式のみ] [推奨] SARIF 出力に含めるこの分析のカテゴリを指定します。カテゴリを使用して、同じコミットとリポジトリ (ただし、異なる言語またはコードの異なる部分) で実行される複数の分析を区別できます。

同じバージョンのコードベースを複数の異なる方法で分析し (たとえば、言語が異なる場合)、コードスキャンでプレゼンテーションするために GitHub に結果をアップロードする場合、この値は各分析間で異なる必要があります。これにより、コードスキャンに対して、分析では互いに ''置き換える'' のではなく ''補足する'' ことが示されます __ __ (コードベースの ''異なる'' バージョンに対して同じ分析の実行間で値の一貫性を保つ必要があります)。__

この値は <run>.automationDetails.id プロパティとして表示されます (存在しない場合は末尾にスラッシュが追加される)。

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

この記事の内容

構文

説明

[オプション]

主なオプション

`<bqrs-file>`

`--format=<format>`

`-o, --output=<output>`

`-t=<String=String>`

`--max-paths=<maxPaths>`

`--[no-]sarif-add-file-contents`

`--[no-]sarif-add-snippets`

`--[no-]sarif-add-query-help`

`--sarif-include-query-help=<mode>`

`--[no-]sarif-group-rules-by-pack`

`--[no-]sarif-multicause-markdown`

`--no-sarif-minify`

`--no-group-results`

`--csv-location-format=<csvLocationFormat>`

`--dot-location-url-format=<dotLocationUrlFormat>`

`--[no-]sublanguage-file-coverage`

`--sarif-category=<category>`

`-j, --threads=<num>`

`--sarif-run-property=<String=String>`

`--column-kind=<columnKind>`

`--[no-]unicode-new-lines`

ソースアーカイブオプション - 一緒に指定するか、まったく指定しない必要がある

`-s, --source-archive=<sourceArchive>`

`-p, --source-location-prefix=<sourceLocationPrefix>`

共通オプション

`-h, --help`

`-J=<opt>`

`-v, --verbose`

`-q, --quiet`

`--verbosity=<level>`

`--logdir=<dir>`

`--common-caches=<dir>`