execute language-server

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

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

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

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

この記事の内容

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

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

構文

Shell

codeql execute language-server --check-errors=<checkErrors> <options>...

codeql execute language-server --check-errors=<checkErrors> <options>...

説明

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

このコマンドは、IDE の QL 言語拡張機能の作成者にのみ関連します。これは、バックグラウンドで IDE 拡張機能によって開始され、標準の入力ストリームと出力ストリームで特別なプロトコルを介してそれと通信します。

[オプション]

主なオプション

`--check-errors=<checkErrors>`

[必須] エラーをチェックする方法。次のいずれか: ON_CHANGE、EXPLICIT。

`--search-path=<dir>[:<dir>...]`

これは、codeql query compile (q.v.) の同様のオプションのように機能します。

--additional-packs または --library-path オプションは、対応する値が言語サーバープロトコルを介して IDE 拡張機能によってオンラインで提供されるため、ありません。

(注: Windows では、パスの区切り記号は ; です)。

`--synchronous`

スレッド化された Executor ではなく、1 つのメインスレッドでアクションを実行します。

共通オプション

`-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 をリダイレクトします)。

`--common-caches=<dir>`

[[詳細設定] ダウンロードした QL パックやコンパイル済みクエリプランなど、CLI の複数の実行間に保持される、ディスク上でキャッシュされたデータの場所を制御します。明示的に設定されない場合、既定ではユーザーのホームディレクトリに名前が付けられた .codeql ディレクトリになります。まだ存在しない場合は作成されます。

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