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.
構文
codeql generate query-help --format=<format> [--output=<dir|file>] <options>... -- <qhelp|query|dir|suite>...説明
.qhelp ファイルからエンド ユーザー クエリ ヘルプを生成します。
主なオプション
<qhelpdir|suite>...
[必須] 表示するヘルプ ファイルにクエリを実行します。 各引数は、次のいずれかです。
- 表示する .qhelp ファイル。
- 表示するための対応する .qhelp ファイルを含む .ql ファイル。
- 対応する .qhelp ファイルを持つ .ql ファイルを再帰的に検索するためのディレクトリ。
- 特定のクエリ セットを定義する .qls ファイル。
- インストールされている QL パックの 1 つによってエクスポートされた "既知の" .qls ファイルのベース名。
--format=<format>
[必須] ドキュメントを表示する形式。 つぎのいずれかです。
markdown: GitHub Flavored Markdown。
sarif-latest: Static Analysis Results Interchange Format (SARIF)。静的な分析結果を記述するための JSON ベースの形式。 この形式オプションでは、サポートされている最新バージョン (v2.1.0) が使用されます。 このオプションは、異なる CodeQL バージョン間で異なるバージョンの SARIF が生成されるため、自動化での使用には適していません。
sarifv2.1.0: SARIF v2.1.0。
-o, --output=<dir|file>
表示されたドキュメントを書き込むパス。 通常、これは、表示される出力が書き込まれるディレクトリです。
1 つの .qhelp または .ql ファイルのみが指定され、出力パスにディレクトリが存在しない場合、出力はそのパスの 1 つのファイルに書き込まれます。
出力パスが指定されていない場合は、1 つの .qhelp または .ql ファイルのみが受け入れられ、出力は stdout に書き込まれます。
出力ディレクトリを使用する場合、出力ディレクトリ "内" のファイル名は .qhelp ファイル名から派生します。**
--warnings=<mode>
クエリ ヘルプ レンダラーからの警告を処理する方法。 つぎのいずれかです。
hide: 警告を表示しません。
show "(既定値)": 警告を出力しますが、レンダリングを続けます。**
error: 警告をエラーとして扱います。
QL パックを検索するためのオプション (クエリ スイートを解決するために必要な場合があります)
--search-path=<dir>[:<dir>...]
QL パックが見つかる可能性があるディレクトリの一覧。 各ディレクトリは、QL パック (またはルートに .codeqlmanifest.json ファイルを含むパックのバンドル)、または 1 つ以上のこのようなディレクトリの直接の親ディレクトリのいずれかです。
パスに複数のディレクトリが含まれる場合、それらの順序によってそれらの間の優先順位が定義されます。解決する必要があるパック名が複数のディレクトリ ツリーで一致する場合は、最初に指定されたものが優先されます。
オープンソースの CodeQL リポジトリのチェックアウトでこれを指定すると、そこにある言語の 1 つを照会するときに機能するはずです。
アンパックされた CodeQL ツールチェーンの兄弟として CodeQL リポジトリをチェックアウトした場合は、このオプションを指定する必要はありません。他の方法では見つからない QL パックは、このような兄弟ディレクトリで常に検索されます (この既定値が機能しない場合、ユーザーごとの構成ファイルで --search-path を一度にすべて設定することを強くお勧めします)。
(注: Windows では、パスの区切り記号は ; です)。
--additional-packs=<dir>[:<dir>...]
このディレクトリの一覧が指定されている場合、パックは、--search-path 内のディレクトリの前に、これらのディレクトリで検索されます。 これらの間の順序は重要ではありません。この一覧の 2 つの異なる場所でパック名が見つかった場合はエラーです。
これは、既定のパスにも表示されるパックの新しいバージョンを一時的に開発している場合に役立ちます。 一方、構成ファイルでこのオプションを上書きすることは "お勧めしません"。一部の内部アクションでは、このオプションをオンザフライで追加し、構成された値がオーバーライドされます。**
(注: Windows では、パスの区切り記号は ; です)。
CodeQL パッケージ マネージャーを構成するためのオプション
--registries-auth-stdin
\<registry_url>=\
たとえば、https://containers.GHEHOSTNAME1/v2/=TOKEN1,https://containers.GHEHOSTNAME2/v2/=TOKEN2 を渡して、
2 つの GitHub Enterprise Server インスタンスに対して認証を行うことができます。
これは、CODEQL_REGISTRIES_AUTH and GITHUB_TOKEN 環境変数をオーバーライドします。 github.com コンテナー レジストリに対する認証のみが必要な場合は、代わりに、より単純な --github-auth-stdin オプションを使って認証できます。
--github-auth-stdin
標準入力を使って github.com GitHub Apps トークンまたは個人用アクセス トークンを渡すことにより、github.com コンテナー レジストリに対して認証を行います。
GitHub Enterprise Server コンテナー レジストリに対して認証を行うには、--registries-auth-stdin を渡すか、CODEQL_REGISTRIES_AUTH 環境変数を使ってください。
これにより、GITHUB_TOKEN 環境変数がオーバーライドされます。
共通オプション
-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 をリダイレクトします)。