Skip to main content

execute language-server

[Plumbing] Onlineunterstützung für die QL-Sprache in IDEs.

Wer kann dieses Feature verwenden?

GitHub CodeQL wird nach der Installation auf Benutzerbasis lizenziert. Du kannst CodeQL nur für bestimmte Aufgaben unter den Lizenzeinschränkungen verwenden. Weitere Informationen findest du unter Informationen zur CodeQL-CLI.

Wenn du über eine GitHub Advanced Security-Lizenz verfügst, kannst du CodeQL für eine automatisierte Analyse sowie für Continuous Integration und Continuous Delivery verwenden. Weitere Informationen findest du unter Informationen zu GitHub Advanced Security.

In diesem Inhalt wird die neueste Version von CodeQL CLI beschrieben. Weitere Informationen zu diesem Thema findest du unter https://github.com/github/codeql-cli-binaries/releases.

Um Details zu den Optionen anzuzeigen, die für diesen Befehl in früheren Releases verfügbar sind, führe den Befehl mit der Option --help im Terminal aus.

Übersicht

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

Beschreibung

[Plumbing] Onlineunterstützung für die QL-Sprache in IDEs.

Dieser Befehl ist nur für Autor*innen von QL-Spracherweiterungen für IDEs relevant. Er wird von der IDE-Erweiterung im Hintergrund gestartet und kommuniziert mit ihr über ein spezielles Protokoll für die Standardeingabe- und Ausgabeströme.

Optionen

Primäre Optionen

--check-errors=<checkErrors>

[Obligatorisch] Verfahren zur Fehlerprüfung. Eines von: ON_CHANGE, EXPLICIT.

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

Dies funktioniert wie die ähnliche Option für codeql query compile (siehe dort).

Es gibt keine --additional-packs- oder --library-path-Optionen, da die entsprechenden Werte online von der IDE-Erweiterung über das Sprachserverprotokoll bereitgestellt werden.

(Hinweis: Unter Windows wird ; als Pfadtrennzeichen verwendet.)

--synchronous

Führt Aktionen in einem einzelnen Hauptthread statt in einem Threadexecutor aus.

Allgemeine Optionen

-h, --help

Zeigt diesen Hilfetext an.

-J=<opt>

[Erweitert] Dient zum Angeben einer Option für die JVM-Instanz, die den Befehl ausführt.

(Beachte, dass Optionen, die Leerzeichen enthalten, nicht ordnungsgemäß verarbeitet werden.)

-v, --verbose

Ermöglicht die inkrementelle Erhöhung der Anzahl ausgegebener Statusmeldungen.

-q, --quiet

Ermöglicht die inkrementelle Verringerung der Anzahl ausgegebener Statusmeldungen.

--verbosity=<level>

[Erweitert] Dient zum expliziten Festlegen des Ausführlichkeitsgrads auf „errors“, „warnings“, „progress“, „progress+“, „progress++“ oder „progress+++“. Überschreibt -v und -q:

--logdir=<dir>

[Erweitert] Ermöglicht das Schreiben detaillierter Protokolle in eine oder mehrere Dateien im angegebenen Verzeichnis mit generierten Namen, die Zeitstempel und den Namen des ausgeführten Unterbefehls enthalten.

(Um eine Protokolldatei mit einem Namen zu schreiben, über den du die volle Kontrolle hast, gib stattdessen --log-to-stderr an, und leite stderr wie gewünscht um.)

--common-caches=<dir>

[Erweitert] Steuert den Speicherort zwischengespeicherter Daten auf dem Datenträger, der zwischen mehreren Ausführungsvorgängen der CLI beibehalten wird, z. B. heruntergeladene QL-Pakete und kompilierte Abfragepläne. Wenn dies nicht explizit festgelegt ist, wird dieses Verzeichnis standardmäßig auf ein Verzeichnis mit dem Namen .codeql festgelegt, das sich im Startverzeichnis des Benutzer. Es wird erstellt, wenn es noch nicht vorhanden ist.

Verfügbar seit v2.15.2.