Generieren von Überlagerungsänderungen

Hinweis

In diesem Inhalt wird die neueste Version von CodeQL CLI beschrieben. Weitere Informationen zu diesem Thema findest du unter http://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.

Zusammenfassung

Shell

codeql generate overlay-changes [--source-root=<dir>] [--output=<file>] <options>... -- <database>

codeql generate overlay-changes [--source-root=<dir>] [--output=<file>] <options>... -- <database>

Description

          \[Erforderlich] Generiere eine Datei, die für die `--overlay-changes`Option zum [Codeql-Datenbank erstellen](/code-security/codeql-cli/codeql-cli-manual/database-create) beim Extrahieren einer Overlay-Datenbank verwendet werden kann.

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.

Options

Primäre Optionen

`<database>`

          \[Erforderliche] Pfad zur _Basis_-Datenbank, in die das Overlay extrahiert werden soll.

`-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] Option an die JVM übergeben, die den Befehl ausführt.

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

          \[Erweitert] Lege die Ausführlichkeitsstufe explizit auf einen der Werte errors, warnings, progress, progress+, progress++, progress+++ fest. Überschreibt `-v` und `-q`:

`--logdir=<dir>`

          \[Erweitert] Detaillierte Protokolle in eine oder mehrere Dateien im angegebenen Verzeichnis schreiben, 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 Zwischenspeicherort von Datenträgern, die zwischen mehreren CLI-Ausführungen bestehen bleiben, wie 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.

Wer kann dieses Feature verwenden?

In diesem Artikel