Hinweis
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 generate overlay-changes [--source-root=<dir>] [--output=<file>] <options>... -- <database>
codeql generate overlay-changes [--source-root=<dir>] [--output=<file>] <options>... -- <database>
Beschreibung
[Plumbing] Generiere eine Datei, die für die --overlay-changes-Option codeql database create verwendet werden kann, um beim Extrahieren einer Überlagerungsdatenbank zu erstellen.
Dieser Befehl ist hauptsächlich für manuelle oder automatisierte Tests vorgesehen. Er ist nicht besonders effizient. Für die Verwendung in der Produktion solltest du dir überlegen, ob die Änderungsdatei stattdessen von etwas wie git diff --name-only abgeleitet werden kann.
Optionen
Primäre Optionen
<database>
[Obligatorisch] Pfad zur Basisdatenbank, in die die Überlagerung extrahiert wird.
-s, --source-root=<dir>
Das Verzeichnis, das den Quellcode enthält, der als Überlagerung extrahiert werden soll. Wenn nicht angegeben, wird das aktuelle Arbeitsverzeichnis verwendet.
-o, --output=<file>
Die Änderungsdatei wird an diesen Speicherort geschrieben. Wenn keiner angegeben ist, werden die Änderungen in die Standardausgabe geschrieben.
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.