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
codeql query format [--output=<file>] [--in-place] [--backup=<ext>] <options>... -- <file>...
codeql query format [--output=<file>] [--in-place] [--backup=<ext>] <options>... -- <file>...
Beschreibung
Automatische Formatierung von QL-Quellcode
Tastatur
Primäre Optionen
<file>...
Eine oder mehrere .ql- oder .qll-Quelldateien, die automatisch formatiert werden sollen. Ein Bindestrich kann zum Lesen aus der Standardeingabe angegeben werden.
-o, --output=<file>
Schreibt den formatierten QL-Code in diese Datei anstelle des Standardausgabestreams. Darf nicht angegeben werden, wenn mehrere Eingaben vorhanden sind.
-i, --[no-]in-place
Überschreibt jede Eingabedatei mit einer formatierten Version des Inhalts.
--[no-]check-only
Anstatt die Ausgabe zu schreiben, wird die Ausführung mit dem Status 1 beendet, wenn Eingabedateien von der korrekten Formatierung abweichen. Eine Meldung, die angibt, welche Dateien abweichen, wird als Standardfehlermeldung ausgegeben, sofern nicht ebenfalls -qq angegeben ist.
-b, --backup=<ext>
Beim Schreiben einer bereits vorhandenen Datei wird die vorhandene Datei in eine Sicherung umbenannt, indem dem Namen die entsprechende Erweiterung angefügt wird. Wenn die Sicherungsdatei bereits vorhanden ist, wird sie automatisch gelöscht.
--no-syntax-errors
Wenn eine QL-Eingabedatei nicht syntaktisch korrekt ist, wird vorgegeben, dass sie bereits korrekt formatiert ist. (Normalerweise führt eine solche Datei dazu, dass der Befehl mit einer Fehlermeldung beendet wird.)
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.